github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 19:26:31 -05:00
Code Issues Projects Releases Packages Wiki Activity

Document new Prometheus endpoint

Browse source 
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-04-22 22:34:17 +02:00
parent 5c70cc021f
commit cbe7b03b59
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
2 changed files with 8 additions and 4 deletions
Show stats 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 ## HedgeDoc-server
These endpoints return information about the running HedgeDoc instance. These endpoints return information about the running HedgeDoc instance.
| Endpoint | HTTP-Method | Description | | 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. | | `/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 |

3
public/docs/release-notes.md
View file

@ -3,10 +3,13 @@
### Features ### Features
- Database migrations are now automatically applied on application startup. - Database migrations are now automatically applied on application startup.
The separate `.sequelizerc` configuration file is no longer necessary and can be safely deleted. 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 ### Enhancements
- Removed dependency on external imgur library - 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 ## <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. This release fixes a security issue. We recommend upgrading as soon as possible.
### Security Fixes ### Security Fixes