Skip to content

Commit

Permalink
docs: clarify the configuration of the Prometheus and Opentelemetry p…
Browse files Browse the repository at this point in the history
…lugins in standalone mode (#11396)

* aligned the references to config/config.yaml

* replaced the misleading heading API with Metrics endpoint

Users reading the documentation can easily get confused by the term "API". When running in standalone mode, the "API" is disabled, leading to the misconception that the Prometheus endpoint cannot be exposed.

As the Prometheus metrics endpoint is not part of APISIX's API, this confusion can be avoided.
  • Loading branch information
ronnybremer authored Aug 4, 2024
1 parent 564247d commit 64a72a6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/en/latest/plugins/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ For instance, a possible scenario occurs when the plugin attribute `trace_id_sou

:::

You can configure these as shown below:
You can configure these as shown below in your configuration file (`conf/config.yaml`):

```yaml title="conf/config.yaml"
plugin_attr:
Expand Down Expand Up @@ -105,7 +105,7 @@ The following nginx variables are set by OpenTelemetry:

How to use variables? you have to add it to your configuration file (`conf/config.yaml`):

```yaml title="./conf/config.yaml"
```yaml title="conf/config.yaml"
http:
enable_access_log: true
access_log: "/dev/stdout"
Expand Down
4 changes: 2 additions & 2 deletions docs/en/latest/plugins/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ plugin_attr:
- 505
```

## API
## Metrics endpoint

This Plugin will add the API endpoint `/apisix/prometheus/metrics` or your custom export URI for exposing the metrics.
This Plugin will add the metrics endpoint `/apisix/prometheus/metrics` or your custom export URI for exposing the metrics.

These metrics are exposed by a separate Prometheus server address. By default, the address is `127.0.0.1:9091`. You can change it in your configuration file (`conf/config.yaml`):

Expand Down

0 comments on commit 64a72a6

Please sign in to comment.