From dbd477e2a8811f98f519db7bb9b3671eebd685ad Mon Sep 17 00:00:00 2001 From: Yiran Date: Tue, 8 Jul 2025 17:15:26 +0800 Subject: [PATCH 1/3] chore: remove OTLP SDK from cloud integrations --- docs/greptimecloud/integrations/otlp.md | 16 ---------------- .../current/greptimecloud/integrations/otlp.md | 15 --------------- .../greptimecloud/integrations/otlp.md | 15 --------------- .../greptimecloud/integrations/otlp.md | 16 ---------------- 4 files changed, 62 deletions(-) diff --git a/docs/greptimecloud/integrations/otlp.md b/docs/greptimecloud/integrations/otlp.md index 390e5ed93..f212efec9 100644 --- a/docs/greptimecloud/integrations/otlp.md +++ b/docs/greptimecloud/integrations/otlp.md @@ -10,22 +10,6 @@ via [OTLP](https://opentelemetry.io/docs/specs/otlp/) protocol. You can configure GreptimeDB as an OpenTelemetery collector for your applications or agents. -## OpenTelemetry API/SDK - -To send OpenTelemetry Metrics to GreptimeDB through OpenTelemetry SDK libraries, -use the following information: - -- URL: `https:///v1/otlp/v1/metrics` -- Headers: - - `X-Greptime-DB-Name`: `` - - `Authorization`: `Basic` authentication, which is a Base64 encoded string of `:`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/protocols/http#authentication) in HTTP API. - -The request uses binary protobuf to encode the payload, so you need to use packages that support `HTTP/protobuf`. For example, in Node.js, you can use [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto); in Go, you can use [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp); in Java, you can use [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp); and in Python, you can use [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/). - -:::tip NOTE -The package names may change according to OpenTelemetry, so we recommend that you refer to the official OpenTelemetry documentation for the most up-to-date information. -::: - ## OpenTelemetry Collector OpenTelemetry Collector is a vendor-agnostic implementation of OpenTelemetry, below is a sample configuration for diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md b/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md index cb6b5e022..3a376f51c 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md @@ -7,21 +7,6 @@ description: 介绍如何通过 OpenTelemetry Protocol (OTLP) 将指标数据发 你可以通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生消费 OpenTelemetry 指标。 -### OpenTelemetry API/SDK - -要通过 OpenTelemetry SDK 库将 OpenTelemetry 指标发送到 GreptimeDB，请使用以下信息： - -- URL: `https:///v1/otlp/v1/metrics` -- Headers: - - `X-Greptime-DB-Name`: `` - - `Authorization`: `Basic` 认证，是 `:` 的 Base64 编码字符串。更多信息，请参阅 HTTP API 中的[认证](https://docs.greptime.cn/user-guide/protocols/http#鉴权)。 - -由于请求中使用二进制 protobuf 编码的 payload，因此需要使用支持 `HTTP/protobuf` 的包。例如，在 Node.js 中，可以使用 [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto)；在 Go 中，可以使用 [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)；在 Java 中，可以使用 [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp)；在 Python 中，可以使用 [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/)。 - -:::tip 注意 -包名可能会被 OpenTelemetry 修改，因此建议你参考 OpenTelemetry 官方文档以获取最新信息。 -::: - ## OpenTelemetry Collector OpenTelemetry Collector 是 OpenTelemetry 的一个与厂商无关的实现，下面是一个导出到 GreptimeDB 的示例配置。你可以使用 [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) 将指标、日志和追踪数据发送到 GreptimeDB。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md b/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md index cb6b5e022..3a376f51c 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md @@ -7,21 +7,6 @@ description: 介绍如何通过 OpenTelemetry Protocol (OTLP) 将指标数据发 你可以通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生消费 OpenTelemetry 指标。 -### OpenTelemetry API/SDK - -要通过 OpenTelemetry SDK 库将 OpenTelemetry 指标发送到 GreptimeDB，请使用以下信息： - -- URL: `https:///v1/otlp/v1/metrics` -- Headers: - - `X-Greptime-DB-Name`: `` - - `Authorization`: `Basic` 认证，是 `:` 的 Base64 编码字符串。更多信息，请参阅 HTTP API 中的[认证](https://docs.greptime.cn/user-guide/protocols/http#鉴权)。 - -由于请求中使用二进制 protobuf 编码的 payload，因此需要使用支持 `HTTP/protobuf` 的包。例如，在 Node.js 中，可以使用 [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto)；在 Go 中，可以使用 [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)；在 Java 中，可以使用 [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp)；在 Python 中，可以使用 [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/)。 - -:::tip 注意 -包名可能会被 OpenTelemetry 修改，因此建议你参考 OpenTelemetry 官方文档以获取最新信息。 -::: - ## OpenTelemetry Collector OpenTelemetry Collector 是 OpenTelemetry 的一个与厂商无关的实现，下面是一个导出到 GreptimeDB 的示例配置。你可以使用 [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) 将指标、日志和追踪数据发送到 GreptimeDB。 diff --git a/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md b/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md index 390e5ed93..f212efec9 100644 --- a/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md +++ b/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md @@ -10,22 +10,6 @@ via [OTLP](https://opentelemetry.io/docs/specs/otlp/) protocol. You can configure GreptimeDB as an OpenTelemetery collector for your applications or agents. -## OpenTelemetry API/SDK - -To send OpenTelemetry Metrics to GreptimeDB through OpenTelemetry SDK libraries, -use the following information: - -- URL: `https:///v1/otlp/v1/metrics` -- Headers: - - `X-Greptime-DB-Name`: `` - - `Authorization`: `Basic` authentication, which is a Base64 encoded string of `:`. For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/protocols/http#authentication) in HTTP API. - -The request uses binary protobuf to encode the payload, so you need to use packages that support `HTTP/protobuf`. For example, in Node.js, you can use [`exporter-trace-otlp-proto`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto); in Go, you can use [`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp); in Java, you can use [`io.opentelemetry:opentelemetry-exporter-otlp`](https://mvnrepository.com/artifact/io.opentelemetry/opentelemetry-exporter-otlp); and in Python, you can use [`opentelemetry-exporter-otlp-proto-http`](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/). - -:::tip NOTE -The package names may change according to OpenTelemetry, so we recommend that you refer to the official OpenTelemetry documentation for the most up-to-date information. -::: - ## OpenTelemetry Collector OpenTelemetry Collector is a vendor-agnostic implementation of OpenTelemetry, below is a sample configuration for From 047e4a43effac31750498a9b1f30aca9d5f10386 Mon Sep 17 00:00:00 2001 From: Yiran Date: Wed, 9 Jul 2025 16:06:07 +0800 Subject: [PATCH 2/3] add necessary information --- docs/greptimecloud/integrations/otlp.md | 16 ++++++++++++---- .../current/greptimecloud/integrations/otlp.md | 9 +++++++++ .../greptimecloud/integrations/otlp.md | 9 +++++++++ .../greptimecloud/integrations/otlp.md | 16 ++++++++++++---- 4 files changed, 42 insertions(+), 8 deletions(-) diff --git a/docs/greptimecloud/integrations/otlp.md b/docs/greptimecloud/integrations/otlp.md index f212efec9..c8cc3b50b 100644 --- a/docs/greptimecloud/integrations/otlp.md +++ b/docs/greptimecloud/integrations/otlp.md @@ -5,10 +5,12 @@ description: Guide for using GreptimeDB as an observability backend with OpenTel # OpenTelemetry -GreptimeDB is an observability backend to consume OpenTelemetry Metrics natively -via [OTLP](https://opentelemetry.io/docs/specs/otlp/) protocol. You can -configure GreptimeDB as an OpenTelemetery collector for your applications or -agents. +GreptimeDB serves as an observability backend that natively consumes OpenTelemetry Metrics +via the [OTLP](https://opentelemetry.io/docs/specs/otlp/) protocol. +Please use the `/v1/otlp` endpoint with the HTTP/protobuf protocol and include the following required headers: + +- **Authentication**: Basic authentication credentials +- **x-greptime-db-name**: Your target database name ## OpenTelemetry Collector @@ -89,3 +91,9 @@ otelcol.auth.basic "credentials" { password = "" } ``` + +## References + +For more information on using GreptimeDB with OpenTelemetry, +please refer to the [OpenTelemetry Protocol documentation](https://docs.greptime.com/user-guide/ingest-data/for-observability/opentelemetry/) in the GreptimeDB user guide. + diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md b/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md index 3a376f51c..f27b8ea4d 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md @@ -6,6 +6,10 @@ description: 介绍如何通过 OpenTelemetry Protocol (OTLP) 将指标数据发 # OpenTelemetry Protocol (OTLP) 你可以通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生消费 OpenTelemetry 指标。 +请使用 `/v1/otlp` 接口与 HTTP/protobuf 协议，并包含以下必需的头部： + +- **Authentication**: Basic authentication 凭证 +- **x-greptime-db-name**: 你的目标数据库名称 ## OpenTelemetry Collector @@ -86,3 +90,8 @@ otelcol.auth.basic "credentials" { password = "" } ``` + +## 了解更多 + +请参考 GreptimeDB 用户指南中的 [OpenTelemetry Protocol 文档](https://docs.greptime.com/user-guide/ingest-data/for-observability/opentelemetry/) 以获取更多关于使用 GreptimeDB 和 OpenTelemetry 的信息。 + diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md b/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md index 3a376f51c..f27b8ea4d 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md @@ -6,6 +6,10 @@ description: 介绍如何通过 OpenTelemetry Protocol (OTLP) 将指标数据发 # OpenTelemetry Protocol (OTLP) 你可以通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生消费 OpenTelemetry 指标。 +请使用 `/v1/otlp` 接口与 HTTP/protobuf 协议，并包含以下必需的头部： + +- **Authentication**: Basic authentication 凭证 +- **x-greptime-db-name**: 你的目标数据库名称 ## OpenTelemetry Collector @@ -86,3 +90,8 @@ otelcol.auth.basic "credentials" { password = "" } ``` + +## 了解更多 + +请参考 GreptimeDB 用户指南中的 [OpenTelemetry Protocol 文档](https://docs.greptime.com/user-guide/ingest-data/for-observability/opentelemetry/) 以获取更多关于使用 GreptimeDB 和 OpenTelemetry 的信息。 + diff --git a/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md b/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md index f212efec9..c8cc3b50b 100644 --- a/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md +++ b/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md @@ -5,10 +5,12 @@ description: Guide for using GreptimeDB as an observability backend with OpenTel # OpenTelemetry -GreptimeDB is an observability backend to consume OpenTelemetry Metrics natively -via [OTLP](https://opentelemetry.io/docs/specs/otlp/) protocol. You can -configure GreptimeDB as an OpenTelemetery collector for your applications or -agents. +GreptimeDB serves as an observability backend that natively consumes OpenTelemetry Metrics +via the [OTLP](https://opentelemetry.io/docs/specs/otlp/) protocol. +Please use the `/v1/otlp` endpoint with the HTTP/protobuf protocol and include the following required headers: + +- **Authentication**: Basic authentication credentials +- **x-greptime-db-name**: Your target database name ## OpenTelemetry Collector @@ -89,3 +91,9 @@ otelcol.auth.basic "credentials" { password = "" } ``` + +## References + +For more information on using GreptimeDB with OpenTelemetry, +please refer to the [OpenTelemetry Protocol documentation](https://docs.greptime.com/user-guide/ingest-data/for-observability/opentelemetry/) in the GreptimeDB user guide. + From 01de84ba1d921aaace2e9f32dd56cd678ad89261 Mon Sep 17 00:00:00 2001 From: Yiran Date: Thu, 10 Jul 2025 14:57:33 +0800 Subject: [PATCH 3/3] refine the content --- docs/greptimecloud/integrations/otlp.md | 11 +++++++---- .../current/greptimecloud/integrations/otlp.md | 11 +++++++---- .../version-0.15/greptimecloud/integrations/otlp.md | 11 +++++++---- .../version-0.15/greptimecloud/integrations/otlp.md | 11 +++++++---- 4 files changed, 28 insertions(+), 16 deletions(-) diff --git a/docs/greptimecloud/integrations/otlp.md b/docs/greptimecloud/integrations/otlp.md index c8cc3b50b..c5973d78a 100644 --- a/docs/greptimecloud/integrations/otlp.md +++ b/docs/greptimecloud/integrations/otlp.md @@ -5,12 +5,15 @@ description: Guide for using GreptimeDB as an observability backend with OpenTel # OpenTelemetry -GreptimeDB serves as an observability backend that natively consumes OpenTelemetry Metrics +GreptimeDB serves as an observability backend that natively consumes OpenTelemetry Metrics, Logs and Traces via the [OTLP](https://opentelemetry.io/docs/specs/otlp/) protocol. -Please use the `/v1/otlp` endpoint with the HTTP/protobuf protocol and include the following required headers: -- **Authentication**: Basic authentication credentials -- **x-greptime-db-name**: Your target database name +Please use the following endpoint with the HTTP/protobuf protocol and include the required headers: + +- URL: `https:///v1/otlp/` +- Headers: + - `X-Greptime-DB-Name`: `` + - `Authentication`: `Basic `, For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/protocols/http#authentication) in HTTP API. ## OpenTelemetry Collector diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md b/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md index f27b8ea4d..693fb7dbe 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/greptimecloud/integrations/otlp.md @@ -5,11 +5,14 @@ description: 介绍如何通过 OpenTelemetry Protocol (OTLP) 将指标数据发 # OpenTelemetry Protocol (OTLP) -你可以通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生消费 OpenTelemetry 指标。 -请使用 `/v1/otlp` 接口与 HTTP/protobuf 协议，并包含以下必需的头部： +你可以通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生消费 OpenTelemetry metrics, logs 和 traces。 -- **Authentication**: Basic authentication 凭证 -- **x-greptime-db-name**: 你的目标数据库名称 +请使用以下接口和 HTTP/protobuf 协议，并包含必需的 header 参数： + +- URL: `https:///v1/otlp/` +- Headers: + - `X-Greptime-DB-Name`: `` + - `Authentication`: `Basic `, 请参考 [HTTP API 中的认证](https://docs.greptime.cn/user-guide/protocols/http#鉴权)获取更多信息 ## OpenTelemetry Collector diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md b/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md index f27b8ea4d..693fb7dbe 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-0.15/greptimecloud/integrations/otlp.md @@ -5,11 +5,14 @@ description: 介绍如何通过 OpenTelemetry Protocol (OTLP) 将指标数据发 # OpenTelemetry Protocol (OTLP) -你可以通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生消费 OpenTelemetry 指标。 -请使用 `/v1/otlp` 接口与 HTTP/protobuf 协议，并包含以下必需的头部： +你可以通过 [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) 协议原生消费 OpenTelemetry metrics, logs 和 traces。 -- **Authentication**: Basic authentication 凭证 -- **x-greptime-db-name**: 你的目标数据库名称 +请使用以下接口和 HTTP/protobuf 协议，并包含必需的 header 参数： + +- URL: `https:///v1/otlp/` +- Headers: + - `X-Greptime-DB-Name`: `` + - `Authentication`: `Basic `, 请参考 [HTTP API 中的认证](https://docs.greptime.cn/user-guide/protocols/http#鉴权)获取更多信息 ## OpenTelemetry Collector diff --git a/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md b/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md index c8cc3b50b..c5973d78a 100644 --- a/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md +++ b/versioned_docs/version-0.15/greptimecloud/integrations/otlp.md @@ -5,12 +5,15 @@ description: Guide for using GreptimeDB as an observability backend with OpenTel # OpenTelemetry -GreptimeDB serves as an observability backend that natively consumes OpenTelemetry Metrics +GreptimeDB serves as an observability backend that natively consumes OpenTelemetry Metrics, Logs and Traces via the [OTLP](https://opentelemetry.io/docs/specs/otlp/) protocol. -Please use the `/v1/otlp` endpoint with the HTTP/protobuf protocol and include the following required headers: -- **Authentication**: Basic authentication credentials -- **x-greptime-db-name**: Your target database name +Please use the following endpoint with the HTTP/protobuf protocol and include the required headers: + +- URL: `https:///v1/otlp/` +- Headers: + - `X-Greptime-DB-Name`: `` + - `Authentication`: `Basic `, For more information, please refer to [Authentication](https://docs.greptime.com/user-guide/protocols/http#authentication) in HTTP API. ## OpenTelemetry Collector