Просмотр кода страницы Включение конечных точек приема телеметрии Ключ-АСТРОМ

<code>Ключ-АСТРОМ Operator версии 1.6+</code>

Включите конечные точки телеметрии Ключ-АСТРОМ в '''Kubernetes''' для локального сбора данных кластера.

* Прием данных через конечные точки [https://opentelemetry.io/docs/specs/otel/protocol/ OTLP], [https://www.jaegertracing.io/ Jaeger], [https://github.com/statsd/statsd StatsD] или [https://zipkin.io/ Zipkin].
* Анализируйте контекстно-зависимые данные с помощью '''встроенных приложений''', '''DQL''', '''Notebooks''' и '''Дашбордов'''.

== Предустановка ==

* Для [[Токены доступа и разрешения|токена приема данных]] требуются области действия токена <code>openTelemetryTrace.ingest</code>, <code>logs.ingest</code>, и <code>metrics.ingest</code>, и они должны быть предоставлены через поле <code>dataIngestToken</code> в том же секрете, что и ваш токен '''API'''.

== Настройка и использование ==
Следующие два шага объясняют, как настроить и использовать конечные точки сбора телеметрических данных.

=== Создание DynaKube ===
Чтобы включить конечные точки для сбора телеметрических данных, укажите список необходимых протоколов в поле '''DynaKube''' <code>.spec.telemetryIngest.protocols</code>. 
{| class="wikitable"
|<u>Маршрутизация данных</u>

При работе АктивногоШлюза в кластере '''Kubernetes''' сборщик '''OpenTelemetry''' будет настроен на маршрутизацию всех полученных данных через АктивныйШлюз внутри кластера, а не на прямое подключение к общедоступному АктивномуШлюзу. Кроме того, будут автоматически включены функции, необходимые для сбора телеметрических данных.

Если внутрикластерный АктивныйШлюз не развернут (т.е. <code>.spec.activeGate</code> не указан), '''OpenTelemetry''' '''Collector''' будет настроен на прямую связь с вашим клиентом Ключ-АСТРОМ.
|}
{| class="wikitable"
|apiVersion: dynatrace.com/v1beta5

kind: DynaKube

metadata:

  name: dynakube

  namespace: dynatrace

spec:

  apiUrl:  <nowiki>https://ENVIRONMENTID.live.dynatrace.com/api</nowiki>

  activeGate:

    capabilities:

      - kubernetes-monitoring

    replicas: 1

    resources:

      requests:

        cpu: 500m

        memory: 1.5Gi

      limits:

        cpu: 1000m

        memory: 1.5Gi

  telemetryIngest:

    protocols:

    - jaeger

    - zipkin

    - otlp

    - statsd

  templates:

    otelCollector:

      imageRef:

        repository: public.ecr.aws/dynatrace/dynatrace-otel-collector

        tag: <tag>
|}
<u>Образ '''Collector''' '''OTel'''</u>

Образ '''Collector''' '''OTel''' получен из [[Использование публичного реестра|поддерживаемых нами публичных реестров]]. Убедитесь, что используемый образ <code>tag</code> существует! Вы также можете [[Использование частного реестра|использовать свой личный реестр]].

=== Настройка приложений ===
После применения '''DynaKube''' Ключ-АСТРОМ '''Operator''' развернёт Ключ-АСТРОМ '''OpenTelemetry''' '''Collector''' с образом по умолчанию (настраивается с помощью <code>.spec.templates.otelCollector.imageRef</code>) и сервисом '''Kubernetes''' с названием <code><dynakube-name>-telemetry-ingest.dynatrace</code>  (настраивается с помощью <code>.spec.telemetryIngest.serviceName</code>) для сбора телеметрических данных. Номер используемого порта зависит от протокола, поддерживаемого вашим приложением. Чтобы найти соответствующие номера портов, см. ссылку ниже.

В следующем фрагменте показано, как можно настроить приложение с помощью переменной среды, которая инструментируется с помощью '''OpenTelemetry''' '''SDK''':
{| class="wikitable"
|env:

  - name: OTEL_EXPORTER_OTLP_ENDPOINT

    value: <nowiki>http://dynakube-telemetry-ingest.dynatrace.svc:4317</nowiki>
|}

=== Справочник портов ===
Следующие порты открыты для приема телеметрических данных:
{| class="wikitable"
!Name
!Protocol
!Port
|-
|OTLP GRPC
|TCP
|4317
|-
|OTLP HTTP
|TCP
|4318
|-
|Zipkin
|TCP
|9411
|-
|Jaeger GRPC
|TCP
|14250
|-
|Jaeger Thrift Binary
|UDP
|6832
|-
|Jaeger Thrift Compact
|UDP
|6831
|-
|Jaeger Thrift HTTP
|TCP
|14268
|-
|StatsD
|UDP
|8125
|}

== Дополнительные конфигурации ==

=== Использование конечных точек HTTPS ===
По умолчанию конечные точки '''Ingest''' работают в режиме '''HTTP'''. Если вы хотите зашифровать телеметрический трафик с помощью '''HTTPS''', вы можете обратиться к [https://kubernetes.io/docs/reference/kubectl/generated/kubectl_create/kubectl_create_secret_tls/ секретному ключу Kubernetes TLS] через <code>.spec.telemetryIngest.tlsRefName</code>. После этого конечные точки '''Ingest''' будут настроены на использование указанных сертификатов и взаимодействие '''HTTPS'''.
{| class="wikitable"
|<u>Пример приложения OpenTelemetry, использующего HTTPS</u>
В следующем фрагменте показано, как можно настроить приложение, оснащенное '''OpenTelemetry''' '''SDK''', через переменную среды:
{| class="wikitable"
|env:

  - name: OTEL_EXPORTER_OTLP_ENDPOINT

    value: <nowiki>https://dynakube-telemetry-ingest.dynatrace.svc:4318</nowiki>
|}
|}

=== Настройка имени службы сбора телеметрических данных. ===
По умолчанию имя службы для сбора телеметрических данных — <code>telemetry-ingest.dynatrace</code>. Имя службы можно изменить, установив <code>.spec.telemetryIngest.serviceName</code>. Указанное значение будет использоваться в качестве имени службы, но службы по-прежнему будут находиться в пространстве имён '''DynaKube''', где также развёрнут Ключ-АСТРОМ '''OpenTelemetry''' '''Collector'''.

Имейте в виду, что наличие нескольких '''DynaKubes''' с одинаковым именем службы приведет к конфликтам имен служб.

Конечные точки доступны по адресу <code><nowiki>http://telemetry-service.dynatrace.svc.cluster.local:4318</nowiki></code>.
{| class="wikitable"
|<u>Пример</u>
{| class="wikitable"
|apiVersion: dynatrace.com/v1beta5

kind: DynaKube

metadata:

  name: dynakube

  namespace: dynatrace

spec:

  apiUrl:  <nowiki>https://ENVIRONMENTID.live.dynatrace.com/api</nowiki>

  telemetryIngest:

    serviceName: my-telemetry-service

    protocols:

    - jaeger

    - zipkin

    - otlp

    - statsd

  templates:

    otelCollector:

      imageRef:

        repository: public.ecr.aws/dynatrace/dynatrace-otel-collector

        tag: <tag>
|}
<u>Образ '''Collector''' '''OTel'''</u>

Образ '''Collector''' '''OTel''' получен из [[Использование публичного реестра|поддерживаемых нами публичных реестров]]. Убедитесь, что используемый образ <code>tag</code> существует! Вы также можете [[Использование частного реестра|использовать свой личный реестр]].
|}

=== Настройки прокси ===
Любой прокси-сервер, указанный в <code>.spec.proxy</code>, будет передан в '''OpenTelemetry''' '''Collector''' через переменные среды <code>HTTP_PROXY</code> и <code>HTTPS_PROXY</code>. Если используется внутрикластерный АктивныйШлюз, URL-адрес внутрикластерного АктивногоШлюза будет автоматически добавлен в переменную среды <code>NO_PROXY</code>, чтобы избежать ненужных циклов связи.

==== Доверенные центры сертификации ====
Если вам необходимо использовать сертификаты для связи через прокси, их можно указать в <code>.spec.trustedCAs</code>. Системные центры сертификации из образа контейнера '''OpenTelemetry''' '''Collector''' загружаются вместе с центрами сертификации в <code>trustedCAs</code>. Системные центры сертификации содержат сертификаты, необходимые для связи с публичными АктивнымиШлюзами.

=== Постоянное хранилище АктивногоШлюза ===
При использовании приёма телеметрических данных с внутрикластерным АктивнымШлюзом, полученные данные буферизуются на [[Настройка постоянного хранилища для АктивногоШлюза|PersistentVolume на АктивномШлюзе]] до тех пор, пока данные не будут успешно переданы. Для этого к АктивномуШлюзу монтируется '''PersistentVolumeClaim'''. В следующем примере показан '''PVC''' по умолчанию, настроенный '''Operator''' для АктивногоШлюза, если не указан пользовательский '''PVC''':
{| class="wikitable"
|apiVersion: v1

kind: PersistentVolumeClaim

metadata:

  name: <ActiveGate-name>

  namespace: dynatrace

spec:

  accessModes:

  - ReadWriteOnce

  resources:

    requests:

      storage: 1Gi
|}
<u>Класс хранения по умолчанию</u>

Убедитесь, что определён [https://kubernetes.io/docs/concepts/storage/persistent-volumes/#class-1 класс хранилища по умолчанию]. В противном случае '''PersistentVolumeClaim''' АктивныйШлюз не будет предоставлен.

Пользовательский '''PersistentVolumeClaim''' можно настроить в <code>.spec.activegate.volumeClaimTemplate</code>.

==== Эфемерный объем ====
В целях тестирования '''PVC''' можно заменить локальным эфемерным хранилищем с использованием <code>.spec.activeGate.useEphemeralVolume</code>.
{| class="wikitable"
|Не рекомендуется использовать <code>.spec.activeGate.useEphemeralVolume</code> в производственных средах.
|}

=== Время выключения АктивногоШлюза ===
Если АктивныйШлюз отключается (например, в сценариях масштабирования), ему требуется некоторое время для очистки буферов путём отправки всех буферизованных данных в Ключ-АСТРОМ. В больших средах это может занять некоторое время, и '''Kubernetes''' может потенциально завершить работу АктивногоШлюза слишком рано. Чтобы увеличить так называемый льготный период завершения, можно увеличить его продолжительность с помощью параметра <code>'.spec.activegate.terminationGracePeriodSeconds'</code>, чтобы дать поду АктивногоШлюза больше времени для корректного завершения работы.