From a099f0a70ea80992a320e8265eaf345b74fc78ac Mon Sep 17 00:00:00 2001
From: hagen1778 <roman@victoriametrics.com>
Date: Mon, 25 Nov 2024 13:10:14 +0100
Subject: [PATCH] docs: update otel docs
* cross-link related doc chapters and guides about otel
* mention different URL format for cluster version of VM
Signed-off-by: hagen1778 <roman@victoriametrics.com>
---
docs/README.md | 3 +++
docs/guides/getting-started-with-opentelemetry/README.md | 5 +++--
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 37a48a4942..61651e71b4 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1574,6 +1574,9 @@ exporters:
encoding: proto
endpoint: http://<collector/vmagent>.<namespace>.svc.cluster.local:<port>/opentelemetry
```
+> Note, [cluster version of VM](https://docs.victoriametrics.com/cluster-victoriametrics/#url-format) expects specifying tenant ID, i.e. `http://<vminsert>:<port>/insert/<accountID>/opentelemetry`.
+> See more about [multitenancy](https://docs.victoriametrics.com/cluster-victoriametrics/#multitenancy).
+
Remember to add the exporter to the desired service pipeline in order to activate the exporter.
```yaml
service:
diff --git a/docs/guides/getting-started-with-opentelemetry/README.md b/docs/guides/getting-started-with-opentelemetry/README.md
index 35a6fe638c..545539746f 100644
--- a/docs/guides/getting-started-with-opentelemetry/README.md
+++ b/docs/guides/getting-started-with-opentelemetry/README.md
@@ -1,4 +1,4 @@
-VictoriaMetrics supports metrics ingestion with [OpenTelemetry metrics format](https://opentelemetry.io/docs/specs/otel/metrics/).
+VictoriaMetrics supports metrics ingestion with [OpenTelemetry metrics format](https://docs.victoriametrics.com/single-server-victoriametrics/#sending-data-via-opentelemetry).
This guide covers data ingestion via [opentelemetry-collector](https://opentelemetry.io/docs/collector/) and direct metrics push from application.
## Pre-Requirements
@@ -64,6 +64,8 @@ config:
otlphttp/victoriametrics:
compression: gzip
encoding: proto
+ # Setting below will work for sending data to VictoriaMetrics single-node version.
+ # Cluster version of VictoriaMetrics will require a different URL - https://docs.victoriametrics.com/cluster-victoriametrics/#url-format
endpoint: http://victoria-metrics-victoria-metrics-single-server.default.svc.cluster.local:8428/opentelemetry
tls:
insecure: true
@@ -90,7 +92,6 @@ kubectl port-forward service/victoria-metrics-victoria-metrics-single-server 842
# forward port to local machine to setup opentelemetry-collector locally
kubectl port-forward otl-collector-opentelemetry-collector 4318
-
```
The full version of possible configuration options could be found in [OpenTelemetry docs](https://opentelemetry.io/docs/collector/configuration/).