Enterprise Documentation
Granular OpenTelemetry by endpoint
Document updated on Apr 18, 2024
Only applies to KrakenD Enterprise
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
| Override exporter configuration for this endpoint
| ||||||||
| 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
|
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
| Reports the activity between KrakenD and each of your backend services. This is the more granular layer.
| ||||||||
| 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
|
