From cbe7b03b59af80ae6ae3c51a19c334fe8e478da2 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Thu, 22 Apr 2021 22:34:17 +0200 Subject: Document new Prometheus endpoint Signed-off-by: David Mehren --- docs/content/dev/api.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/content/dev/api.md b/docs/content/dev/api.md index 0700ecc3..a8cd22a2 100644 --- a/docs/content/dev/api.md +++ b/docs/content/dev/api.md @@ -36,6 +36,7 @@ These endpoints return information about the current logged-in user and it's not ## HedgeDoc-server These endpoints return information about the running HedgeDoc instance. -| Endpoint | HTTP-Method | Description | -| --------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `/status` | `GET` | **Returns the current status of the HedgeDoc instance.**
The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more. | +| Endpoint | HTTP-Method | Description | +| ---------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `/status` | `GET` | **Returns the current status of the HedgeDoc instance.**
The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more. | +| `/metrics` | `GET` | **Prometheus-compatible endpoint**
Exposes the same stats as `/status` in addition to various Node.js performance figures. Available since HedgeDoc 1.8 | -- cgit v1.2.3