diff options
| author | David Mehren | 2021-04-25 20:34:03 +0200 |
|---|---|---|
| committer | GitHub | 2021-04-25 20:34:03 +0200 |
| commit | 2faf5b69741e2ff9b310b63295e4f8b50ce2ca80 (patch) | |
| tree | 718f172f6b8edf63a92682a512b5d9c6bc43b188 /docs | |
| parent | c8e2117452c905a75c4644e4e2c2dea95aaa8f81 (diff) | |
| parent | cbe7b03b59af80ae6ae3c51a19c334fe8e478da2 (diff) | |
Merge pull request #1150 from hedgedoc/feature/prometheus_metrics
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 | |