This is an automated email from the ASF dual-hosted git repository.
traky pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 64a72a625 docs: clarify the configuration of the Prometheus and
Opentelemetry plugins in standalone mode (#11396)
64a72a625 is described below
commit 64a72a6253cd31d1a17dd85aa30c16bf2c17dc1e
Author: Ronny Bremer <[email protected]>
AuthorDate: Sun Aug 4 16:32:27 2024 +0200
docs: clarify the configuration of the Prometheus and Opentelemetry plugins
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.
---
docs/en/latest/plugins/opentelemetry.md | 4 ++--
docs/en/latest/plugins/prometheus.md | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/en/latest/plugins/opentelemetry.md
b/docs/en/latest/plugins/opentelemetry.md
index 9a0ed1373..09a17a82d 100644
--- a/docs/en/latest/plugins/opentelemetry.md
+++ b/docs/en/latest/plugins/opentelemetry.md
@@ -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:
@@ -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"
diff --git a/docs/en/latest/plugins/prometheus.md
b/docs/en/latest/plugins/prometheus.md
index 2db3e1a84..01301c284 100644
--- a/docs/en/latest/plugins/prometheus.md
+++ b/docs/en/latest/plugins/prometheus.md
@@ -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`):
