summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Mehren2021-04-22 22:34:17 +0200
committerDavid Mehren2021-04-25 20:06:56 +0200
commitcbe7b03b59af80ae6ae3c51a19c334fe8e478da2 (patch)
tree1f2f331863a021efc2f91743deb4b054ddee3e4d
parent5c70cc021fb1b372e7a54b222e0524e3c6626e02 (diff)
Document new Prometheus endpoint
Signed-off-by: David Mehren <git@herrmehren.de>
-rw-r--r--docs/content/dev/api.md7
-rw-r--r--public/docs/release-notes.md5
2 files changed, 8 insertions, 4 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 |
diff --git a/public/docs/release-notes.md b/public/docs/release-notes.md
index 12932ce5..b8906d6f 100644
--- a/public/docs/release-notes.md
+++ b/public/docs/release-notes.md
@@ -3,10 +3,13 @@
### Features
- Database migrations are now automatically applied on application startup.
The separate `.sequelizerc` configuration file is no longer necessary and can be safely deleted.
-
+- A Prometheus-endpoint is now available at `/metrics`, exposing the same stats as `/status`
+ in addition to various Node.js performance figures.
+
### Enhancements
- Removed dependency on external imgur library
+
## <i class="fa fa-tag"></i> 1.7.2 <i class="fa fa-calendar-o"></i> 2021-01-15
This release fixes a security issue. We recommend upgrading as soon as possible.
### Security Fixes