From: Florian Forster <octo@collectd.org>
Date: Mon, 4 Dec 2023 16:20:23 +0000 (+0100)
Subject: write_open_telemetry plugin: Document configuration options.
X-Git-Tag: 6.0.0-rc0~17^2~27
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6b1f400bcdf7d9fb2af56f5a8a5cc867a218796e;p=thirdparty%2Fcollectd.git

write_open_telemetry plugin: Document configuration options.
---

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 8b7fa7987..d3be6a86c 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -2067,6 +2067,13 @@
 #	</Node>
 #</Plugin>
 
+#<Plugin write_open_telemetry>
+#  <Node "example">
+#    Host "localhost"
+#    Port "4317"
+#  </Node>
+#</Plugin>
+
 #<Plugin write_prometheus>
 #	Port "9103"
 #</Plugin>
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index edf82ec96..226addebf 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -11138,6 +11138,35 @@ want to use authentication all three fields must be set.
 
 =back
 
+=head2 Plugin C<write_open_telemetry>
+
+The I<write_open_telemetry plugin> will export metrics to an I<OpenTelemetry
+collector> using the gRPC based OTLP protocol.
+
+B<Synopsis:>
+
+ <Plugin "write_open_telemetry">
+   <Node "default">
+     Host "localhost"
+     Port "4317"
+   </Node>
+ </Plugin>
+
+The plugin can export metrics to multiple collectord by specifying multiple
+B<Node> blocks. Within the B<Node> blocks, the following options are available:
+
+=over 4
+
+=item B<Host> I<Address>
+
+Hostname or address to connect to. Defaults to C<localhost>.
+
+=item B<Port> I<Service>
+
+Service name or port number to connect to. Defaults to C<4317>.
+
+=back
+
 =head2 Plugin C<write_prometheus>
 
 The I<write_prometheus plugin> implements a tiny webserver that can be scraped