Document updated on Oct 24, 2022
Since | v0.7 |
---|---|
Namespace | telemetry/opencensus |
Log prefix | [SERVICE: Opencensus] |
Scope | service |
Source | krakend/krakend-opencensus |
Google Cloud’s operation suite (formerly Stackdriver) aggregates metrics, logs, and events from infrastructure, giving developers and operators a rich set of observable signals that speed root-cause analysis and reduce mean time to resolution (MTTR).
The Opencensus exporter allows you to export metrics and traces to Google Cloud. Enabling it only requires you to add the stackdriver
exporter in the opencensus module.
The following configuration snippet sends the data:
{
"extra_config": {
"telemetry/opencensus": {
"sample_rate": 100,
"reporting_period": 60,
"enabled_layers": {
"backend": true,
"router": true,
"pipe": true
},
"exporters": {
"stackdriver": {
"project_id": "my-krakend-project",
"metric_prefix": "krakend",
"default_labels": {
"env": "production"
}
}
}
}
}
}
As with all OpenCensus exporters, you can add optional settings in the telemetry/opencensus
level:
"telemetry/opencensus"
| 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 stackdriver
entry with the following properties:
"telemetry/opencensus": { "exporters":{} }
|
|
See also the additional settings of the Opencensus module that can be declared.
reporting_period
must be 60
or greater, otherwise, Google will reject the connection.The exporter searches for the Application Default Credentials. It looks for credentials in the following places, preferring the first location found:
GOOGLE_APPLICATION_CREDENTIALS
environment variable.gcloud
command-line tool (e.g.: $HOME/.config/gcloud/application_default_credentials.json
).The documentation is only a piece of the help you can get! Whether you are looking for Open Source or Enterprise support, see more support channels that can help you.