diff options
| author | David Mehren | 2021-04-22 22:34:17 +0200 |
|---|---|---|
| committer | David Mehren | 2021-04-25 20:06:56 +0200 |
| commit | cbe7b03b59af80ae6ae3c51a19c334fe8e478da2 (patch) | |
| tree | 1f2f331863a021efc2f91743deb4b054ddee3e4d /docs | |
| parent | 5c70cc021fb1b372e7a54b222e0524e3c6626e02 (diff) | |
Document new Prometheus endpoint
Signed-off-by: David Mehren <git@herrmehren.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/dev/api.md | 7 |
1 files changed, 4 insertions, 3 deletions
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.**<br>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.**<br>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**<br>Exposes the same stats as `/status` in addition to various Node.js performance figures. Available since HedgeDoc 1.8 | |