1
0
mirror of https://github.com/imgproxy/imgproxy.git synced 2024-11-24 08:12:38 +02:00
imgproxy/docs/prometheus.md
Travis-Turner c51521961f
Docs/edits overhaul (#785)
* Update landing page / README.md

* Update GETTING_STARTED.md

* Update installation.md

* Update getting_the_image_info.md

* update signing_the_url.md

* Update watermark.md

* Update presets.md

* Update object_detection.md

* Update autoquality.md

* Update serving_local_files.md

* Update docs/serving_files_from_s3.md

* Update configuration.md

* Update generating_the_url.md

* Update chained_pipelines.md but chained pipelines section is not finished

* Update serving_files_from_google_cloud_storage.md

* Update new_relic.md

* Update prometheus.md

* Update datadog.md

* Update image_formats_support.md

* Update about_processing_pipeline.md

* Update healthcheck.md

* Update memory_usage_tweaks.md

* Remove GIF/ICO/BMP/HEIF/AVIF support sections from docs/image_formats_support.md

* Minor fixes of the docs

* Update serving_files_from_azure_blob_storage.md

* Fix issue with x and y offset for 're' watermark property

* Fix params description in docs/watermark.md

* Fix Alexander Madyankin GH name

* Special thanks to Travis

* Fix README

Co-authored-by: DarthSim <darthsim@gmail.com>
2022-02-01 15:43:36 +06:00

1.5 KiB

Prometheus

imgproxy can collect metrics for Prometheus. To use this feature, do the following:

  1. Set the IMGPROXY_PROMETHEUS_BIND environment variable to the address and port that will be listened to by the Prometheus server. Note that you can't bind the main server and Prometheus to the same port.
  2. (optional) Set the IMGPROXY_PROMETHEUS_NAMESPACE to prepend prefix to the names of metrics, i.e. with IMGPROXY_PROMETHEUS_NAMESPACE=imgproxy Names will appear like imgproxy_requests_total.
  3. Collect the metrics from any path on the specified binding.

imgproxy will collect the following metrics:

  • requests_total: a counter with the total number of HTTP requests imgproxy has processed
  • errors_total: a counter of the occurred errors separated by type (timeout, downloading, processing)
  • request_duration_seconds: a histogram of the response latency (in seconds)
  • download_duration_seconds: a histogram of the source image downloading latency (in seconds)
  • processing_duration_seconds: a histogram of the image processing latency (in seconds)
  • buffer_size_bytes: a histogram of the download/gzip buffers sizes (in bytes)
  • buffer_default_size_bytes: calibrated default buffer size (in bytes)
  • buffer_max_size_bytes: calibrated maximum buffer size (in bytes)
  • vips_memory_bytes: libvips memory usage
  • vips_max_memory_bytes: libvips maximum memory usage
  • vips_allocs: the number of active vips allocations
  • Some useful Go metrics like memstats and goroutines count