diff --git a/CHANGELOG.md b/CHANGELOG.md index 2179a18c0..30a0cdc12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ - ADDED: keepalive support to the osrm-routed HTTP server [#5518](https://github.com/Project-OSRM/osrm-backend/pull/5518) - ADDED: flatbuffers output format support [#5513](https://github.com/Project-OSRM/osrm-backend/pull/5513) - ADDED: Global 'skip_waypoints' option [#5556](https://github.com/Project-OSRM/osrm-backend/pull/5556) + - ADDED: monitoring endpoint in prometheus format [#5180](https://github.com/Project-OSRM/osrm-backend/pull/5180) - FIXED: Install the libosrm_guidance library correctly [#5604](https://github.com/Project-OSRM/osrm-backend/pull/5604) - FIXED: Http Handler can now deal witch optional whitespace between header-key and -value [#5606](https://github.com/Project-OSRM/osrm-backend/issues/5606) - Routing: diff --git a/docs/monitoring.md b/docs/monitoring.md new file mode 100644 index 000000000..7193bf099 --- /dev/null +++ b/docs/monitoring.md @@ -0,0 +1,15 @@ +## Abstract + +OSRM routed daemon publish helath information in prometheus format. +This option switched off by default. To enable this feature please set `-P ` option on OSRM routed startup. + + +## Available metrics + +- `osrm_routed_instance_info` metric with base instanse information inside labels +-- `algorithm` routing algorithm; +-- `code_version` OSRM version. Same with `-v` command line option; +-- `data_version` OSM data version if available. This value can be setted at the `osrm-extract` phase; +-- `working_threads` actual count of http requests processing threads; +- `http_requests_count` http calls count divided by plugins. And `invalid` count for requests were plugin wasn't set; +- `workers_busy` http workers count that process request at this moment;