1
0
mirror of https://github.com/imgproxy/imgproxy.git synced 2024-11-29 08:22:11 +02:00
imgproxy/docs/datadog.md

28 lines
1.8 KiB
Markdown
Raw Normal View History

2021-03-23 11:37:25 +02:00
# Datadog
imgproxy can send its metrics to Datadog. To use this feature, do the following:
1. Install & configure the Datadog Trace Agent (>= 5.21.1);
2. Set `IMGPROXY_DATADOG_ENABLE` environment variable to `true`;
3. Configure the Datadog tracer using `ENV` variables provided by [the package](https://github.com/DataDog/dd-trace-go):
* `DD_AGENT_HOST` – sets the address to connect to for sending metrics to the Datadog Agent. Default: `localhost`
* `DD_TRACE_AGENT_PORT` – sets the Datadog Agent Trace port. Default: `8126`
* `DD_DOGSTATSD_PORT` – set the DogStatsD port. Default: `8125`
* `DD_SERVICE` – sets desired application name. Default: `imgproxy`
* `DD_ENV` - sets the environment to which all traces will be submitted. Default: empty
* `DD_TRACE_SOURCE_HOSTNAME` - allows specifying the hostname with which to mark outgoing traces. Default: empty
* `DD_TRACE_REPORT_HOSTNAME` - when `true`, sets hostname to `os.Hostname()` with which to mark outgoing traces. Default: `false`
* `DD_TAGS` - sets a key/value pair which will be set as a tag on all traces. Example: `DD_TAGS=datacenter:njc,key2:value2`. Default: empty
* `DD_TRACE_ANALYTICS_ENABLED` - allows specifying whether Trace Search & Analytics should be enabled for integrations. Default: `false`
* `DD_RUNTIME_METRICS_ENABLED` - enables automatic collection of runtime metrics every 10 seconds. Default: `false`
* `DD_TRACE_STARTUP_LOGS` – causes various startup info to be written when the tracer starts. Default: `true`
* `DD_TRACE_DEBUG` – enables detailed logs. Default: `false`
imgproxy will send the following info to Datadog:
* Response time;
* Image downloading time;
* Image processing time;
* Errors that occurred while downloading and processing image.