Monitoring / Tracing

Tracing

The relay proxy is able to trace the requests it is handling. This is done by using OpenTelemetry.

Configuration

By default, the relay proxy will attempt to send traces to an OpenTelemetry collector or compatible agent running at http://localhost:4318 using the http/protobuf protocol. To override the endpoint, set the OTEL_EXPORTER_OTLP_ENDPOINT environment variable. To override the protocol, set the OTEL_EXPORTER_OTLP_PROTOCOL environment variable. See the OpenTelemetry documentation for more information.

All your requests will be traced and sent to the collector with the service name go-feature-flag.

To disable tracing, set the OTEL_SDK_DISABLED environment variable to true.

note

If you want to try the OpenTelemetry integration locally, follow this README to setup Jaeger and see your traces.

Monitoring

The relay proxy offers some endpoints for you to be able to see how it behaves.

/health

Making a GET request to the URL path /health will tell you if the relay proxy is ready to serve traffic.

This is useful especially for loadbalancer to know that they can send traffic to the service.

/info

Making a GET request to the URL path /info will give you information about the actual state of the relay proxy.

/metrics

This endpoint is providing metrics about the relay proxy in the prometheus format.

Use specific port for the monitoring

You can configure a different port for the monitoring endpoints.
This is useful if you want to expose the monitoring endpoints on a different port than the main service.

# ...
monitoringPort: 1032
# ...

note

By default the monitoring endpoints are exposed on the same port as the main service.