Skip to content
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

Clarify that metrics are available for Prometheus and OpenTelemetry #3706

Merged
merged 2 commits into from
Aug 30, 2023
Merged

Clarify that metrics are available for Prometheus and OpenTelemetry #3706

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6520b6
Clarify that metrics are available for Prometheus and OTLP
shorgi Aug 29, 2023
9c67f14
copy edit
shorgi Aug 29, 2023
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
10 changes: 5 additions & 5 deletions docs/source/configuration/metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ telemetry:
# (Optional)
service_namespace: "apollo"
prometheus:
# By setting this endpoint you enable the prometheus exporter
# By setting this endpoint you enable the Prometheus exporter
# All our endpoints exposed by plugins are namespaced by the name of the plugin
enabled: true
listen: 127.0.0.1:9090
Expand All @@ -26,16 +26,16 @@ telemetry:

### Using in a containers environment

The prometheus endpoint listens to 127.0.0.1 by default, which won't allow connections issued from a network.
While this is a safe default, _other containers won't be able to access the prometheus endpoint_, which will disable metric scraping.
The Prometheus endpoint listens to 127.0.0.1 by default, which won't allow connections issued from a network.
While this is a safe default, _other containers won't be able to access the Prometheus endpoint_, which will disable metric scraping.

You can change this by setting:

```yaml title="router.yaml"
telemetry:
metrics:
prometheus:
# By setting this endpoint you enable other containers and pods to access the prometheus endpoint
# By setting this endpoint you enable other containers and pods to access the Prometheus endpoint
enabled: true
listen: 0.0.0.0:9090
path: /metrics
Expand All @@ -58,7 +58,7 @@ apollo_router_http_request_duration_seconds_bucket{le="0.9"} 1

### Available metrics

The following metrics are available when using Prometheus. Attributes are listed where applicable.
The following metrics are available for Prometheus and OpenTelemetry. Attributes are listed where applicable.

#### HTTP

Expand Down