Enterprise Documentation
You are viewing a previous version of KrakenD Enterprise Edition (v2.5)
, go to the latest version
AWS X-Ray Telemetry Integration
Document updated on Oct 24, 2022
About this feature
| Namespace | telemetry/opencensus |
|---|---|
| Log prefix | [SERVICE: Opencensus] |
| Scope | service |
| Source | krakend/krakend-opencensus |
AWS X-Ray is a service offered by Amazon that provides an end-to-end view of requests as they travel through your application, and shows a map of your application’s underlying components.
The Opencensus exporter allows you export data to AWS X-Ray. Enabling it only requires you to add the xray exporter in the opencensus module.
The following configuration snippet sends data to your X-Ray:
{
"extra_config": {
"telemetry/opencensus": {
"sample_rate": 100,
"reporting_period": 0,
"exporters": {
"xray": {
"version": "latest",
"region": "eu-west-1",
"use_env": false,
"access_key_id": "myaccesskey",
"secret_access_key": "mysecretkey"
}
}
}
}
}
As with all OpenCensus exporters, you can add optional settings in the telemetry/opencensus level:
Fields of "telemetry/opencensus"
* required fields
| Lets you specify what data you want to export. All layers are enabled by default unless you declare this section.
| ||||||
| The number of seconds passing between reports. If duration is less than or equal to zero, it enables the default behavior of each exporter. Defaults to 0 | ||||||
| A number between 0 (no requests at all) and 100 (all requests) representing the percentage of sampled requests you want to send to the exporter. Sampling the 100% of the requests is generally discouraged when the relationship between traffic and dedicated resources is sparse. Defaults to 0 |
Then, the exporters key must contain an xray entry with the following properties:
Fields of "telemetry/opencensus": { "exporters":{} }
* required fields
| AWS X-Ray is a service offered by Amazon that provides an end-to-end view of requests as they travel through your application, and shows a map of your application’s underlying components. * Required one of: ( region
+
version
+
access_key_id
+
secret_access_key
)
, or
(
region
+
version
+
use_env
)
|
See also the additional settings of the Opencensus module that can be declared.
