Skip to content

Commit 9e7ff82

Browse files
authored
Update docs to reflect Kanae's Prometheus exporter (#34)
1 parent 3f27bae commit 9e7ff82

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/projects/kanae/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,3 +139,7 @@ docker compose -f docker/docker-compose.dev.yml up -d
139139
Kanae actively uses [type hinting](https://docs.python.org/3/library/typing.html) in order to verify for types before runtime.
140140
[Pyright](https://github.com/microsoft/pyright) is used to enforce this standard. Checks happen before you commit, and on Github actions.
141141
This also can be activated in VSCode, and Pyright is available as a LSP on Neovim.
142+
143+
### Prometheus
144+
145+
Kanae also comes bundled with an Prometheus exporter for metrics collections. By default, it is not enabled, you can enable it with the `kanae.prometheus.enabled` key. By default, no efforts are made for whether the endpoint is exposed publicly, as this is the responsibility of the web server (i.e, NGINX and co.), not the application. The endpoint is exposed under the `/metrics` path of the application.

0 commit comments

Comments
 (0)