Document updated on Apr 18, 2024
Granular OpenTelemetry by endpoint
The OpenTelemetry configuration is declared at the service level, but in the Enterprise edition you have more granularity and you can override metrics and traces per endpoint and per backend as follows.
Endpoint Override of metrics and traces
The following example overrides properties that could be declared at the service level.
{
"endpoints": [
{
"endpoint": "/example",
"backend": [
{
"host": [
"example.com"
],
"url_pattern": "/example"
}
],
"extra_config": {
"telemetry/opentelemetry": {
"proxy": {
"disable_metrics": false,
"disable_traces": false
},
"exporters_override": {
"metric_reporting_period": 10,
"trace_sample_rate": 1,
"metric_exporters": [
"local_prometheus"
],
"trace_exporters": [
"debug_jaeger",
"newrelic",
"local_tempo"
]
}
}
}
}
]
}
Exporter names must be typed exactly as in the service level. The options are:
Fields of OpenTelemetry Endpoint Override
* required fields
exporters_overrideobject- Override exporter configuration for this endpoint
metric_exportersarray- Overrides the metrics exporters used in this endpointExample:
["local_prometheus"] metric_reporting_periodinteger- Override how often you want to report and flush the metrics in seconds.
trace_exportersarray- Overrides the trace exporters used in this endpointExample:
["debug_jaeger","newrelic","local_tempo"] trace_sample_ratenumber- Overrides the sample rate for traces defines the percentage of reported traces. This option is key to reduce the amount of data generated (and resource usage), while you still can debug and troubleshoot issues. For instance, a number of
0.25will report a 25% of the traces seen in the system.Example:0.25
proxyobject- Reports the activity at the beginning of the proxy layer, including spawning the required requests to multiple backends, merging, endpoint transformation and any other internals of the proxy between the request processing and the backend communication
disable_metricsboolean- Whether you want to disable all metrics in this endpoint or not.Defaults to
false disable_tracesboolean- Whether you want to disable all traces in this endpoint or not.Defaults to
false
Backend Override of metrics and traces
For instance, you have a specific backend that is adding noise to your dashboards and you’d like to disable all layers:
{
"backend": [
{
"extra_config": {
"telemetry/opentelemetry": {
"proxy": {
"disable_metrics": true,
"disable_traces": true
},
"backend": {
"metrics": {
"disable_stage": true
},
"traces": {
"disable_stage": true
}
}
}
},
"url_pattern": "/noise",
"host": [
"example.com"
]
}
]
}
These are the options:
Fields of OpenTelemetry Backend Override
* required fields
backendobject- Reports the activity between KrakenD and each of your backend services. This is the more granular layer.
metricsobjectdisable_stageboolean- Whether to turn off the metrics or not. Setting this to
truemeans stop reporting any data.Defaults tofalse
tracesobjectdisable_stageboolean- Whether to turn off the traces or not. Setting this to
truemeans stop reporting any data.Defaults tofalse
proxyobject- Reports the activity at the beginning of the proxy layer, including spawning the required requests to multiple backends, merging, endpoint transformation and any other internals of the proxy between the request processing and the backend communication
disable_metricsboolean- Whether you want to disable all metrics in this endpoint or not.Defaults to
false disable_tracesboolean- Whether you want to disable all traces in this endpoint or not.Defaults to
false
