Sobre la observabilidad

Configura la recolección de OpenTelemetry para las cargas de trabajo de Midaz con el Helm chart independiente del Lerian OpenTelemetry Collector.

Midaz exporta telemetría mediante OpenTelemetry. Despliega un colector en tu clúster de Kubernetes y luego configura las cargas de trabajo de Midaz para que le envíen telemetría.

​

Despliega un colector

---

El chart del Lerian OpenTelemetry Collector se ejecuta como DaemonSet y recibe telemetría OTLP en el puerto gRPC 4317 y en el puerto HTTP 4318. Recoge trazas, logs y métricas de las cargas de trabajo de Kubernetes y las exporta al backend central de telemetría de Lerian.

El chart liga el colector a la red del nodo y lee la clave de API de exportación desde un Secret llamado otel-api-key, clave api-key, en el namespace del release. Crea el namespace y ese Secret antes de instalar el chart:

CHART_VERSION=replace-with-chart-version
read -rsp 'OpenTelemetry API key: ' OTEL_API_KEY; printf '\n'
kubectl create namespace midaz --dry-run=client -o yaml | kubectl apply -f -
printf '%s' "$OTEL_API_KEY" | kubectl -n midaz create secret generic otel-api-key \
  --from-file=api-key=/dev/stdin
unset OTEL_API_KEY

Instala el colector como un release separado, sin anular values:

helm install otel-collector-lerian \
  oci://registry-1.docker.io/lerianstudio/otel-collector-lerian \
  --version "$CHART_VERSION" -n midaz

No definas opentelemetry-collector.extraEnvs en tus propios values para agregar la clave. Helm reemplaza esa lista en lugar de fusionarla. Las entradas propias del chart, la clave de API y el nombre del nodo que lee el receptor de kubelet, desaparecen con ella.

​

Conecta las cargas de trabajo de Midaz

---

En las versiones 8.4.0 y posteriores del chart de Midaz, otel-collector-lerian no es un subchart de Midaz. El ajuste de abajo no instala un colector. Inyecta HOST_IP, POD_IP, OTEL_EXPORTER_OTLP_ENDPOINT=$(HOST_IP):4317 y OTEL_RESOURCE_ATTRIBUTES=k8s.pod.ip=$(POD_IP) en los deployments de Ledger y CRM.

otel-collector-lerian:
  enabled: true

El valor predeterminado es true. Espera un colector local en el nodo que escuche en el puerto 4317 mediante hostNetwork o hostPort.

Para usar otro endpoint, deshabilita este cableado y configura el endpoint directamente para cada carga de trabajo:

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"

El chart de Midaz acepta solo enabled debajo de otel-collector-lerian. El chart rechaza claves heredadas como external, extraEnvs, exporters y opentelemetry-collector durante la instalación o la actualización con Helm.

​

Qué procesa el colector

---

El colector de Lerian enriquece la telemetría con metadatos de Kubernetes y un atributo client.id. Aplica limitación de memoria y agrupación en lotes, genera métricas RED a partir de los spans, enmascara datos sensibles del payload y filtra la telemetría a los namespaces midaz y midaz-plugins antes de exportar.

Para los parámetros del chart y las anulaciones de producción, inspecciona los metadatos y los values del chart de OpenTelemetry Collector antes de desplegar.