You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2022/01/17 08:03:25 UTC

[skywalking] branch master updated: Support SkyWalking meter format in OpenTelemetry collector. (#8438)

This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git


The following commit(s) were added to refs/heads/master by this push:
     new fc27f76  Support SkyWalking meter format in OpenTelemetry collector. (#8438)
fc27f76 is described below

commit fc27f766c5da0f4165152025a6ba4080d034d1fc
Author: liqiangz <li...@gmail.com>
AuthorDate: Mon Jan 17 16:01:27 2022 +0800

    Support SkyWalking meter format in OpenTelemetry collector. (#8438)
---
 docs/en/setup/backend/backend-meter.md          | 21 ++++++++++++++++++++-
 docs/en/setup/backend/opentelemetry-receiver.md |  2 ++
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/docs/en/setup/backend/backend-meter.md b/docs/en/setup/backend/backend-meter.md
index 231b628..119b360 100644
--- a/docs/en/setup/backend/backend-meter.md
+++ b/docs/en/setup/backend/backend-meter.md
@@ -18,7 +18,9 @@ kafka-fetcher:
     bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092}
 ```
 
-## Meter collection
+## Report Meter Telemetry Data
+
+### Manual Meter API
 
 Custom metrics may be collected by Manual Meter API.
 Custom metrics collected cannot be used directly, they should be configured in `meter-analyzer-config` configuration files, which is described in next part.
@@ -29,6 +31,23 @@ for identification of the metric data.
 
 A typical manual meter API set is [Spring Sleuth APIs](spring-sleuth-setup.md)
 
+### OpenTelemetry Exporter
+
+You can use OpenTelemetry Collector to transport the metrics to SkyWalking OAP.
+Read the doc on [Skywalking Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/skywalkingexporter/README.md) for a detailed guide.
+
+The following is the correspondence between the OpenTelemetry Metric Data Type and the Skywalking Data Collect Protocol: 
+
+| OpenTelemetry Metric Data Type | Skywalking Data Collect Protocol |
+|-----|-----|
+|MetricDataTypeGauge| MeterSingleValue |
+|MetricDataTypeSum| MeterSingleValue |
+|MetricDataTypeHistogram| MeterHistogram and two MeterSingleValues containing `$name_sum` and `$name_count` metrics. |
+|MetricDataTypeSummary| A series of MeterSingleValue containing tag `quantile` and two MeterSingleValues containing `$name_sum` and `$name_count` metrics. |
+|MetricDataTypeExponentialHistogram| Not Supported|
+
+Note: `$name` is the original metric name.
+
 ## Configuration file
 The meter receiver is configured via a configuration file. The configuration file defines everything related to receiving 
  from agents, as well as which rule files to load.
diff --git a/docs/en/setup/backend/opentelemetry-receiver.md b/docs/en/setup/backend/opentelemetry-receiver.md
index 8b93bae..b28e099 100644
--- a/docs/en/setup/backend/opentelemetry-receiver.md
+++ b/docs/en/setup/backend/opentelemetry-receiver.md
@@ -35,3 +35,5 @@ for identification of the metric data.
 |k8s-cluster| Metrics of K8s cluster | otel-oc-rules/k8s-cluster.yaml | K8s kube-state-metrics -> OpenTelemetry Collector --OC format--> SkyWalking OAP Server |
 |k8s-node| Metrics of K8s cluster | otel-oc-rules/k8s-node.yaml | cAdvisor & K8s kube-state-metrics -> OpenTelemetry Collector --OC format--> SkyWalking OAP Server |
 |k8s-service| Metrics of K8s cluster | otel-oc-rules/k8s-service.yaml | cAdvisor & K8s kube-state-metrics -> OpenTelemetry Collector --OC format--> SkyWalking OAP Server |
+
+Note: You can also use OpenTelemetry exporter to directly transport the metrics to SkyWalking OAP. See [OpenTelemetry Exporter](./backend-meter.md#opentelemetry-exporter).