Мониторинг Ruby приложений с помощью Proto Observability

Rails или Hanami

1. Добавьте datadog gem в ваш Gemfile:

   source 'https://rubygems.org'
   gem 'datadog', require: 'datadog/auto_instrument'
   

2. Установите gem с помощью bundle install

3. Создайте файл config/initializers/datadog.rb содержащий:

   Datadog.configure do |c|
     c.remote.enabled = false                                     # обязательно
     c.telemetry.enabled = false                                  # обязательно
     c.tracing.contrib.global_default_service_name.enabled = true # обязательно
     c.service = 'my-app-name'  # имя сервиса для отображения в интерфейсе ProtoOBP, необходимо задать
     c.env = ENV['RACK_ENV']    # окружение для отображения в интерфейсе ProtoOBP, необходимо задать
   
     # дополнительная конфигурация интеграций и трейсера может быть здесь
   end
   

   Используя этот блок можно:

   • добавлять дополнительные параметры конфигурации
   • активировать или реконфигурировать инструментацию

Выполните пункты по установке и настройке трейсера, указанные выше, и добавьте следующие переменные окружения:

• DD_AGENT_HOST – адрес Агента, на который будет отсылать данные трейсер:
  • если Агент запущен в Docker контейнере, укажите имя Docker контейнера Агента:

    ENV DD_AGENT_HOST="protoobp-agent"
    

    Убедитесь, что контейнер Агента и контейнер приложения находятся в одной Docker сети. Адрес агента должен быть доступен из Docker контейнера приложения.
  • если Агент запущен на хосте как сервис (не в контейнере):

    ENV DD_AGENT_HOST="host.docker.internal"
    

    Убедитесь что в конфигурации Агента разрешен прием APM данных от контейнеров:

    apm_config:
      apm_non_local_traffic: true
    

Пример Dockefile:

# необходимые переменные окружения для работы трейсера Datadog
ENV DD_SERVICE="имя_вашего_сервиса" \
    DD_TRACE_TELEMETRY_ENABLED="false"

Далее задайте значение переменной DD_AGENT_HOST – адрес Агента, на который будет отсылать данные трейсер, например, в файле docker-compose.yaml:

   DD_AGENT_HOST: protoobp-agent

Дополнительно необходимо передать поду переменную окружения DD_AGENT_HOST со значением IP адреса воркер-ноды, а также переменные окружения для связи трейсов с инфраструктурой (имя k8s кластера нужно задать вручную).

apiVersion: apps/v1
kind: Deployment
#(...)
    spec:
      containers:
      - name: "<CONTAINER_NAME>"
        image: "<CONTAINER_IMAGE>/<TAG>"
        env:
          - name: DD_SERVICE
            value: dispatch			
          - name: DD_AGENT_HOST
            valueFrom:
              fieldRef:
                fieldPath: status.hostIP
          - name: NODE_NAME
            valueFrom:
              fieldRef:
                fieldPath: spec.nodeName
          - name: POD_NAMESPACE
            valueFrom:
              fieldRef:
                fieldPath: metadata.namespace
          - name: POD_NAME
            valueFrom:
              fieldRef:
                fieldPath: metadata.name
          - name: DD_TAGS
            value: "pod_name:$(POD_NAME),node:$(NODE_NAME),kube_namespace:$(POD_NAMESPACE),kube_cluster_name:<my_cluster_name>"