Replace or add loopback address in Collector OTLP examples (#3847)

open-telemetry · Jan 31, 2024 · 018acd8 · 018acd8
1 parent e9b5253
commit 018acd8
Show file tree

Hide file tree

Showing 14 changed files with 57 additions and 9 deletions.
diff --git a/content/en/docs/collector/building/authenticator-extension.md b/content/en/docs/collector/building/authenticator-extension.md
@@ -78,6 +78,7 @@ receivers:
   otlp/auth:
     protocols:
       grpc:
+         endpoint: 0.0.0.0:4317
         auth:
           authenticator: oidc
 
@@ -107,6 +108,7 @@ receivers:
   otlp/auth:
     protocols:
       grpc:
+         endpoint: 0.0.0.0:4317
         auth:
           authenticator: oidc/some-provider
 

diff --git a/content/en/docs/collector/building/connector.md b/content/en/docs/collector/building/connector.md
@@ -87,9 +87,9 @@ receivers:
   otlp:
     protocols:
       grpc:
-        endpoint: localhost:4317
+        endpoint: 0.0.0.0:4317
       http:
-        endpoint: localhost:4318
+        endpoint: 0.0.0.0:4318
 
 exporters:
   # NOTE: Prior to v0.86.0 use the `logging` instead of `debug`.

diff --git a/content/en/docs/collector/building/receiver.md b/content/en/docs/collector/building/receiver.md
@@ -108,6 +108,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 processors:
   batch:
@@ -1035,6 +1036,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
   tailtracer: # this line represents the ID of your receiver
     interval: 1m
     number_of_traces: 1

diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md
@@ -38,16 +38,31 @@ which provide capabilities that can be added to the Collector, such as
 diagnostic tools. Extensions don't require direct access to telemetry data and
 are enabled through the [service](#service) section.
 
-The following is an example of Collector configuration with a receiver, a
-processor, an exporter, and three extensions:
+<a id="endpoint-0.0.0.0-warning"></a> The following is an example of Collector
+configuration with a receiver, a processor, an exporter, and three extensions.
+
+{{% alert title="Important" color="warning" %}}
+
+While it is generally preferable to bind endpoints to `localhost` when all
+clients are local, our example configurations use the "unspecified" address
+`0.0.0.0` as a convenience. The Collector currently defaults to `0.0.0.0`, but
+the default will be changed to `localhost` in the near future. For details
+concerning either of these choices as endpoint configuration value, see
+[Safeguards against denial of service attacks].
+
+[Safeguards against denial of service attacks]:
+  https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security-best-practices.md#safeguards-against-denial-of-service-attacks
+
+{{% /alert %}}
 
 ```yaml
 receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
       http:
-
+        endpoint: 0.0.0.0:4318
 processors:
   batch:
 
@@ -87,7 +102,9 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
       http:
+        endpoint: 0.0.0.0:4318
   otlp/2:
     protocols:
       grpc:
@@ -137,6 +154,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 exporters: ${file:exporters.yaml}
 
@@ -163,6 +181,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 exporters:
   otlp:
@@ -217,6 +236,7 @@ receivers:
   jaeger:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
       thrift_binary:
       thrift_compact:
       thrift_http:
@@ -232,7 +252,9 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
       http:
+        endpoint: 0.0.0.0:4318
 
   # Data sources: metrics
   prometheus:
@@ -392,7 +414,7 @@ exporters:
 
   # Data sources: metrics
   prometheus:
-    endpoint: localhost:8889
+    endpoint: 0.0.0.0:8889
     namespace: default
 
   # Data sources: metrics
@@ -723,6 +745,7 @@ receivers:
   otlp/auth:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
         auth:
           authenticator: oidc
 
@@ -758,7 +781,7 @@ receivers:
   otlp:
     protocols:
       grpc:
-        endpoint: localhost:4317
+        endpoint: 0.0.0.0:4317
 
 processors:
 

diff --git a/content/en/docs/collector/deployment/agent.md b/content/en/docs/collector/deployment/agent.md
@@ -43,6 +43,7 @@ receivers:
   otlp: # the OTLP receiver the app is sending traces to
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 processors:
   batch:
@@ -66,6 +67,7 @@ receivers:
   otlp: # the OTLP receiver the app is sending metrics to
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 processors:
   batch:
@@ -89,6 +91,7 @@ receivers:
   otlp: # the OTLP receiver the app is sending logs to
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 processors:
   batch:

diff --git a/content/en/docs/collector/deployment/gateway.md b/content/en/docs/collector/deployment/gateway.md
@@ -118,6 +118,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 exporters:
   loadbalancing:
@@ -146,6 +147,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 exporters:
   loadbalancing:
@@ -171,6 +173,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 exporters:
   loadbalancing:

diff --git a/content/en/docs/collector/scaling.md b/content/en/docs/collector/scaling.md
@@ -157,6 +157,7 @@ spec:
       otlp:
         protocols:
           grpc:
+            endpoint: 0.0.0.0:4317
     processors:
 
     exporters:
@@ -360,6 +361,7 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
 
 processors:
 

diff --git a/content/en/docs/faas/lambda-collector.md b/content/en/docs/faas/lambda-collector.md
@@ -53,9 +53,9 @@ receivers:
   otlp:
     protocols:
       grpc:
-        endpoint: 'localhost:4317'
+        endpoint: '0.0.0.0:4317'
       http:
-        endpoint: 'localhost:4318'
+        endpoint: '0.0.0.0:4318'
 
 exporters:
   # NOTE: Prior to v0.86.0 use `logging` instead of `debug`.

diff --git a/content/en/docs/kubernetes/operator/_index.md b/content/en/docs/kubernetes/operator/_index.md
@@ -49,7 +49,9 @@ spec:
       otlp:
         protocols:
           grpc:
+            endpoint: 0.0.0.0:4317
           http:
+            endpoint: 0.0.0.0:4318
     processors:
 
     exporters:

diff --git a/content/en/docs/kubernetes/operator/automatic.md b/content/en/docs/kubernetes/operator/automatic.md
@@ -68,7 +68,9 @@ spec:
       otlp:
         protocols:
           grpc:
+            endpoint: 0.0.0.0:4317
           http:
+            endpoint: 0.0.0.0:4318
     processors:
       memory_limiter:
         check_interval: 1s

diff --git a/content/en/docs/languages/js/exporters.md b/content/en/docs/languages/js/exporters.md
@@ -37,7 +37,9 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
       http:
+        endpoint: 0.0.0.0:4318
 exporters:
   debug:
     verbosity: detailed

diff --git a/content/en/docs/languages/python/distro.md b/content/en/docs/languages/python/distro.md
@@ -38,7 +38,9 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
       http:
+        endpoint: 0.0.0.0:4318
 exporters:
   # NOTE: Prior to v0.86.0 use `logging` instead of `debug`.
   debug:

diff --git a/content/en/docs/languages/python/exporters.md b/content/en/docs/languages/python/exporters.md
@@ -40,7 +40,9 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
       http:
+        endpoint: 0.0.0.0:4318
 exporters:
   debug:
     verbosity: detailed

diff --git a/content/en/docs/languages/python/getting-started.md b/content/en/docs/languages/python/getting-started.md
@@ -663,6 +663,9 @@ receivers:
   otlp:
     protocols:
       grpc:
+        endpoint: 0.0.0.0:4317
+      http:
+        endpoint: 0.0.0.0:4318
 exporters:
   # NOTE: Prior to v0.86.0 use `logging` instead of `debug`.
   debug: