mirror of
https://github.com/zitadel/zitadel.git
synced 2025-07-12 06:18:31 +00:00
599a1ddd78
* Modified quick start guide to reflect the new onboarding changes. * Modified titles to optimize indexing. Left thet titles in title case for now. * Added side bar labels and also made minor changes to titles. * Update docs/docs/apis/openidoauth/endpoints.mdx Co-authored-by: Fabi <fabienne@zitadel.com> --------- Co-authored-by: Fabi <fabienne@zitadel.com>
16 lines
1.0 KiB
Markdown
16 lines
1.0 KiB
Markdown
---
|
|
title: ZITADEL Metrics
|
|
sidebar_label: Metrics
|
|
---
|
|
|
|
ZITADEL provides a `metrics` endpoint with the help of the [opentelemetry-go](https://github.com/open-telemetry/opentelemetry-go) package.
|
|
|
|
If you are self-hosting ZITADEL, you can access this endpoint with on the path `/debug/metrics`.
|
|
For example when running ZITADEL locally the endpoint is accessible on `http://localhost:8080/debug/metrics`.
|
|
The metrics endpoint can be scrubbed by any tool of choice that supports the `otel` format, e.g an existing Prometheus.
|
|
|
|
For our [Kubernetes/Helm](/docs/self-hosting/deploy/kubernetes) users, we provide an out of the box support for the [ServiceMonitor](https://github.com/zitadel/zitadel-charts/blob/main/charts/zitadel/templates/servicemonitor.yaml) custom resource.
|
|
|
|
By default, metrics are enabled but can be turned off through ZITADEL's [configuration](/docs/self-hosting/manage/configure).
|
|
The (default) configuration is located in the [defaults.yaml](https://github.com/zitadel/zitadel/blob/main/cmd/defaults.yaml).
|