Sobre observabilidade

O Midaz exporta telemetria por meio do OpenTelemetry. Implante um collector no seu cluster Kubernetes e configure as cargas de trabalho do Midaz para enviar telemetria a ele.

Implante um collector

O chart do OpenTelemetry Collector da Lerian é executado como DaemonSet e recebe telemetria OTLP na porta gRPC 4317 e na porta HTTP 4318. Ele coleta traces, logs e métricas de cargas de trabalho do Kubernetes e os exporta para o backend central de telemetria da Lerian. Crie otel-values.yaml para tornar o collector local ao node e conectar o Secret da chave de API ao exporter:

opentelemetry-collector:
  hostNetwork: true
  dnsPolicy: ClusterFirstWithHostNet
  extraEnvs:
    - name: OTEL_API_KEY
      valueFrom:
        secretKeyRef:
          name: otel-api-key
          key: api-key
  config:
    exporters:
      otlphttp/server:
        headers:
          x-api-key: ${env:OTEL_API_KEY}

Crie o namespace e o Secret com a chave de API antes de instalar o chart:

kubectl create namespace midaz --dry-run=client -o yaml | kubectl apply -f -
kubectl create secret generic otel-api-key \
  --from-literal=api-key=<your-api-key> \
  -n midaz \
  --dry-run=client -o yaml | kubectl apply -f -

Instale o collector como um release separado:

helm install otel-collector-lerian \
  oci://registry-1.docker.io/lerianstudio/otel-collector-lerian \
  --version <version> \
  -n midaz \
  -f otel-values.yaml

Conecte as cargas de trabalho do Midaz

Nas versões 8.4.0 e posteriores do chart Midaz, otel-collector-lerian não é um subchart do Midaz. A configuração abaixo não instala um collector. Ela injeta HOST_IP, POD_IP, OTEL_EXPORTER_OTLP_ENDPOINT=$(HOST_IP):4317 e OTEL_RESOURCE_ATTRIBUTES=k8s.pod.ip=$(POD_IP) nos deployments de Ledger e CRM.

otel-collector-lerian:
  enabled: true

O padrão é true. Ele espera um collector local ao node escutando na porta 4317 por hostNetwork ou hostPort. Para usar outro endpoint, desative essa configuração e defina o endpoint diretamente para cada carga de trabalho:

otel-collector-lerian:
  enabled: false

ledger:
  configmap:
    OTEL_EXPORTER_OTLP_ENDPOINT: "https://your-collector.example.com:4317"
crm:
  configmap:
    OTEL_EXPORTER_OTLP_ENDPOINT: "https://your-collector.example.com:4317"

O chart Midaz aceita apenas enabled em otel-collector-lerian. Chaves legadas como external, extraEnvs, exporters e opentelemetry-collector são rejeitadas durante a instalação ou atualização do Helm.

O que o collector processa

O collector da Lerian enriquece a telemetria com metadados do Kubernetes e um atributo client.id. Ele aplica limitação de memória e batching, gera métricas RED a partir de spans, mascara dados sensíveis de payload e filtra a telemetria para os namespaces midaz e midaz-plugins antes da exportação. Antes de implantar, consulte os metadados e os valores do chart OpenTelemetry Collector para conhecer os parâmetros e as configurações de produção.

​Implante um collector

​Conecte as cargas de trabalho do Midaz

​O que o collector processa

Implante um collector

Conecte as cargas de trabalho do Midaz

O que o collector processa