Skip to content

Commit 5e0b45e

Browse files
committed
Add new metrics docs
1 parent 4b73018 commit 5e0b45e

File tree

5 files changed

+10
-1
lines changed

5 files changed

+10
-1
lines changed

docs/monitoring/cloud_watch.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ imgproxy can send its metrics to Amazon CloudWatch. To use this feature, do the
1313

1414
imgproxy sends the following metrics to CloudWatch:
1515

16+
* `Workers`: the configured number of imgproxy workers
1617
* `RequestsInProgress`: the number of requests currently in progress
1718
* `ImagesInProgress`: the number of images currently in progress
18-
* `WorkersUtilization`, `ConcurrencyUtilization`: the percentage of imgproxy's workers utilization. Calculated as `RequestsInProgress / IMGPROXY_WORKERS * 100`
19+
* `WorkersUtilization`, `ConcurrencyUtilization`: the percentage of imgproxy's workers utilization. Calculated as `RequestsInProgress / Workers * 100`
1920
* `BufferSize`: a summary of the download buffers sizes (in bytes)
2021
* `BufferDefaultSize`: calibrated default buffer size (in bytes)
2122
* `BufferMaxSize`: calibrated maximum buffer size (in bytes)

docs/monitoring/datadog.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@ imgproxy will send the following info to Datadog:
3636

3737
When the `IMGPROXY_DATADOG_ENABLE_ADDITIONAL_METRICS` environment variable is set to `true`, imgproxy will send the following additional metrics to Datadog:
3838

39+
* `imgproxy.workers`: the configured number of imgproxy workers
3940
* `imgproxy.requests_in_progress`: the number of requests currently in progress
4041
* `imgproxy.images_in_progress`: the number of images currently in progress
42+
* `imgproxy.workers_utilization`: the percentage of imgproxy's workers utilization. Calculated as `imgproxy.requests_in_progress / imgproxy.workers * 100`
4143
* `imgproxy.buffer.size`: a histogram of the download buffers sizes (in bytes)
4244
* `imgproxy.buffer.default_size`: calibrated default buffer size (in bytes)
4345
* `imgproxy.buffer.max_size`: calibrated maximum buffer size (in bytes)

docs/monitoring/new_relic.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ imgproxy will send the following info to New Relic:
2222

2323
Additionally, imgproxy sends the following metrics over [Metrics API](https://docs.newrelic.com/docs/data-apis/ingest-apis/metric-api/introduction-metric-api/):
2424

25+
* `imgproxy.workers`: the configured number of imgproxy workers
2526
* `imgproxy.requests_in_progress`: the number of requests currently in progress
2627
* `imgproxy.images_in_progress`: the number of images currently in progress
28+
* `imgproxy.workers_utilization`: the percentage of imgproxy's workers utilization. Calculated as `imgproxy.requests_in_progress / imgproxy.workers * 100`
2729
* `imgproxy.buffer.size`: a summary of the download buffers sizes (in bytes)
2830
* `imgproxy.buffer.default_size`: calibrated default buffer size (in bytes)
2931
* `imgproxy.buffer.max_size`: calibrated maximum buffer size (in bytes)

docs/monitoring/open_telemetry.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@ imgproxy will send the following info to the collector:
5050

5151
If `IMGPROXY_OPEN_TELEMETRY_ENABLE_METRICS` is set to `true`, imgproxy will also send the following metrics to the collector:
5252

53+
* `workers`: the configured number of imgproxy workers
5354
* `requests_in_progress`: the number of requests currently in progress
5455
* `images_in_progress`: the number of images currently in progress
56+
* `workers_utilization`: the percentage of imgproxy's workers utilization. Calculated as `requests_in_progress / workers * 100`
5557
* `buffer_size_bytes`: a histogram of buffer sizes (in bytes)
5658
* `buffer_default_size_bytes`: calibrated default buffer size (in bytes)
5759
* `buffer_max_size_bytes`: calibrated maximum buffer size (in bytes)

docs/monitoring/prometheus.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ imgproxy will collect the following metrics:
1717
* `errors_total`: a counter of the occurred errors separated by type (timeout, downloading, processing)
1818
* `request_duration_seconds`: a histogram of the request latency (in seconds)
1919
* `request_span_duration_seconds`: a histogram of the request latency (in seconds) separated by span (queue, downloading, processing)
20+
* `workers`: the configured number of imgproxy workers
2021
* `requests_in_progress`: the number of requests currently in progress
2122
* `images_in_progress`: the number of images currently in progress
23+
* `workers_utilization`: the percentage of imgproxy's workers utilization. Calculated as `requests_in_progress / workers * 100`
2224
* `buffer_size_bytes`: a histogram of the download buffers sizes (in bytes)
2325
* `buffer_default_size_bytes`: calibrated default buffer size (in bytes)
2426
* `buffer_max_size_bytes`: calibrated maximum buffer size (in bytes)

0 commit comments

Comments
 (0)