Skip to main content

Monitoring and Observability

Kafka Gateway captures telemetry data as metrics and events. Configure exporters to choose how and where you want to see that data.

telemetry:
  metrics:
    - http.duration
  exporters:
    stdout_logs_exporter:
      type: stdout

Telemetry Data Types

Metrics

Metrics are grouped by protocol, where the stream metrics relate to Kafka Gateway's internal message handler and the other protocols expose the metrics you would expect for that protocol. Use the zilla metrics command to see the raw metrics that Kafka Gateway has collected.

Logs

Logs signal important activities and collect relevant details with them. They are most useful for troubleshooting issues like model validation failures or failed secure access, and they also add observability around HTTP access. The easiest way to see logged events is to add the stdout exporter to your zilla.yaml config.

Exporters

Exporters determine how the collected telemetry data is exposed. The Prometheus exporter exposes any configured metrics on the standard /metrics endpoint that Prometheus scrapes. The stdout exporter logs all events to the host stdout, where any log aggregator can collect them. The OTLP, AWS CloudWatch, and Syslog exporters push logs and metrics to their respective external systems.