Skip to content

Update docs to reflect Kanae's Prometheus exporter #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
No767 merged 1 commit into from
Jul 27, 2025
Merged

Update docs to reflect Kanae's Prometheus exporter #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/projects/kanae/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,7 @@ docker compose -f docker/docker-compose.dev.yml up -d
Kanae actively uses [type hinting](https://docs.python.org/3/library/typing.html) in order to verify for types before runtime.
[Pyright](https://github.com/microsoft/pyright) is used to enforce this standard. Checks happen before you commit, and on Github actions.
This also can be activated in VSCode, and Pyright is available as a LSP on Neovim.

### Prometheus

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.