Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 7 additions & 15 deletions docs/en/latest/plugins/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,15 @@ The `opentelemetry` Plugin can be used to report tracing data according to the [

The Plugin only supports binary-encoded [OTLP over HTTP](https://opentelemetry.io/docs/reference/specification/protocol/otlp/#otlphttp).

## Configurations
## Enable `opentelemetry` Plugin

The `opentelemetry` Plugin is disabled by default. In `conf/config.yaml`, keep the complete list of Plugins used by your deployment and add `opentelemetry`. If you are starting from `conf/config.yaml.example`, uncomment the existing `opentelemetry` entry.

By default, configurations of the Service name, tenant ID, collector, and batch span processor are pre-configured in [default configuration](https://github.com/apache/apisix/blob/master/apisix/cli/config.lua).
Reload APISIX for the change to take effect.

You can change this configuration of the Plugin through the endpoint `apisix/admin/plugin_metadata/opentelemetry` For example:
## Configurations

The `opentelemetry` Plugin reads its plugin-level settings from Plugin Metadata. Configure the metadata through the endpoint `/apisix/admin/plugin_metadata/opentelemetry`. For example:

:::note
You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command:
Expand Down Expand Up @@ -110,18 +114,6 @@ apisix:
tracing: true
```

### Enable `opentelemetry` Plugin

By default, the `opentelemetry` Plugin is disabled in APISIX. To enable, add the Plugin to your configuration file as such:

```yaml title="config.yaml"
plugins:
- ...
- opentelemetry
```

Reload APISIX for changes to take effect.

### Send Traces to OpenTelemetry

The following example demonstrates how to trace requests to a Route and send traces to OpenTelemetry.
Expand Down
22 changes: 7 additions & 15 deletions docs/zh/latest/plugins/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,15 @@ description: opentelemetry 插件可用于根据 OpenTelemetry 协议规范上

`opentelemetry` 插件可用于根据 [OpenTelemetry Specification](https://opentelemetry.io/docs/reference/specification/) 协议规范上报 Traces 数据。该插件仅支持二进制编码的 OTLP over HTTP,即请求类型为 `application/x-protobuf` 的数据上报。

## 配置
## 启用 opentelemetry 插件

`opentelemetry` 插件默认处于禁用状态。在 `conf/config.yaml` 中保留部署使用的完整插件列表,并添加 `opentelemetry`。如果以 `conf/config.yaml.example` 为基础配置 APISIX,请取消注释已有的 `opentelemetry` 条目。

重新加载 APISIX 以使更改生效。

默认情况下,服务名称、租户 ID、collector 和 batch span processor 的配置已预配置在[默认配置](https://github.com/apache/apisix/blob/master/apisix/cli/config.lua)中。
## 配置

你可以通过端点 `apisix/admin/plugin_metadata/opentelemetry` 更改插件的配置,例如:
`opentelemetry` 插件从插件元数据中读取插件级配置。通过端点 `/apisix/admin/plugin_metadata/opentelemetry` 配置插件元数据,例如:

:::note
你可以从 `config.yaml` 中获取 `admin_key` 并存入环境变量:
Expand Down Expand Up @@ -109,18 +113,6 @@ apisix:
tracing: true
```

### 启用 opentelemetry 插件

默认情况下,APISIX 中的 `opentelemetry` 插件是禁用的。要启用它,请将插件添加到配置文件中,如下所示:

```yaml title="config.yaml"
plugins:
- ...
- opentelemetry
```

重新加载 APISIX 以使更改生效。

### 将 Traces 上报到 OpenTelemetry

以下示例展示了如何追踪对路由的请求并将 traces 发送到 OpenTelemetry。
Expand Down
Loading