sa6anw/hedgedoc-hedgeagent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1150 from hedgedoc/feature/prometheus_metrics

Browse Source
This commit is contained in:
David Mehren
2021-04-25 20:34:03 +02:00
committed by GitHub
parent c8e2117452 cbe7b03b59
commit 2faf5b6974
6 changed files with 221 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/content/dev/api.md
View File

@@ -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 |