From c0b641e25ff76a881745b109fe99f605bd2a6351 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 11:36:15 +0100 Subject: [PATCH 01/14] Replace or add loopback address --- .../building/authenticator-extension.md | 2 ++ .../en/docs/collector/building/connector.md | 4 ++-- .../en/docs/collector/building/receiver.md | 10 +++++---- content/en/docs/collector/configuration.md | 21 +++++++++++++----- content/en/docs/collector/deployment/agent.md | 3 +++ .../en/docs/collector/deployment/gateway.md | 3 +++ content/en/docs/collector/management.md | 14 ++++++------ content/en/docs/collector/scaling.md | 2 ++ content/en/docs/demo/architecture.md | 22 +++++++++---------- content/en/docs/kubernetes/operator/_index.md | 1 + .../en/docs/kubernetes/operator/automatic.md | 2 ++ content/en/docs/languages/js/exporters.md | 2 ++ content/en/docs/languages/python/distro.md | 2 ++ content/en/docs/languages/python/exporters.md | 2 ++ .../docs/languages/python/getting-started.md | 3 +++ .../sdk-configuration/otlp-exporter.md | 16 +++++++------- 16 files changed, 71 insertions(+), 38 deletions(-) diff --git a/content/en/docs/collector/building/authenticator-extension.md b/content/en/docs/collector/building/authenticator-extension.md index 45cb4d524cef..5980e0b07c7c 100644 --- 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 index af7fb94862d3..4a1e606e54ff 100644 --- 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 index a5aeff3d5e38..d62d3336a7a9 100644 --- a/content/en/docs/collector/building/receiver.md +++ b/content/en/docs/collector/building/receiver.md @@ -88,7 +88,7 @@ docker run -d --name jaeger \ ``` Once the container is up and running, you can access Jaeger UI by: - + Now, create a Collector config file named `config.yaml` to set up the Collector's components and pipelines. @@ -108,6 +108,7 @@ receivers: otlp: protocols: grpc: + endpoint: 0.0.0.0:4317 processors: batch: @@ -117,7 +118,7 @@ exporters: debug: verbosity: detailed otlp/jaeger: - endpoint: localhost:14317 + endpoint: 0.0.0.0:14317 tls: insecure: true @@ -177,7 +178,7 @@ telemetrygen traces --otlp-insecure --traces 1 ``` You should be able to see detailed logs in the console and the traces in Jaeger -UI through URL: . +UI through URL: . Press Ctrl + C to stop the Collector instance in the Collector console. @@ -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 @@ -1047,7 +1049,7 @@ exporters: debug: verbosity: detailed otlp/jaeger: - endpoint: localhost:14317 + endpoint: 0.0.0.0:14317 tls: insecure: true diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index 6d4be5622ba3..a3ef9f3a7ec4 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -46,8 +46,9 @@ receivers: otlp: protocols: grpc: + endpoint: 0.0.0.0:4317 http: - + endpoint: 0.0.0.0:4318 processors: batch: @@ -87,7 +88,9 @@ receivers: otlp: protocols: grpc: + endpoint: 0.0.0.0:4317 http: + endpoint: 0.0.0.0:4318 otlp/2: protocols: grpc: @@ -137,6 +140,7 @@ receivers: otlp: protocols: grpc: + endpoint: 0.0.0.0:4317 exporters: ${file:exporters.yaml} @@ -163,6 +167,7 @@ receivers: otlp: protocols: grpc: + endpoint: 0.0.0.0:4317 exporters: otlp: @@ -217,6 +222,7 @@ receivers: jaeger: protocols: grpc: + endpoint: 0.0.0.0:4317 thrift_binary: thrift_compact: thrift_http: @@ -232,7 +238,9 @@ receivers: otlp: protocols: grpc: + endpoint: 0.0.0.0:4317 http: + endpoint: 0.0.0.0:4318 # Data sources: metrics prometheus: @@ -241,7 +249,7 @@ receivers: - job_name: otel-collector scrape_interval: 5s static_configs: - - targets: [localhost:8888] + - targets: [0.0.0.0:8888] # Data sources: traces zipkin: @@ -392,7 +400,7 @@ exporters: # Data sources: metrics prometheus: - endpoint: localhost:8889 + endpoint: 0.0.0.0:8889 namespace: default # Data sources: metrics @@ -716,13 +724,14 @@ Collector acting as agent: ```yaml extensions: oidc: - issuer_url: http://localhost:8080/auth/realms/opentelemetry + issuer_url: http://0.0.0.0:8080/auth/realms/opentelemetry audience: collector receivers: otlp/auth: protocols: grpc: + endpoint: 0.0.0.0:4317 auth: authenticator: oidc @@ -752,13 +761,13 @@ extensions: oauth2client: client_id: agent client_secret: some-secret - token_url: http://localhost:8080/auth/realms/opentelemetry/protocol/openid-connect/token + token_url: http://0.0.0.0:8080/auth/realms/opentelemetry/protocol/openid-connect/token 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 index 5c63759a2d44..97ce2ba24d99 100644 --- 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 index 5276e0f2a04d..3711979f3c17 100644 --- 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/management.md b/content/en/docs/collector/management.md index d41987eea02b..b9f4f46d4167 100644 --- a/content/en/docs/collector/management.md +++ b/content/en/docs/collector/management.md @@ -174,21 +174,21 @@ $ go run . 2023/02/08 13:32:54 Enabling own metrics pipeline in the config 2023/02/08 13:32:54 Effective config changed. 2023/02/08 13:32:54 Config is changed. Signal to restart the agent. -2023/02/08 13:32:54 Agent is not healthy: Get "http://localhost:13133": dial tcp [::1]:13133: connect: connection refused +2023/02/08 13:32:54 Agent is not healthy: Get "http://0.0.0.0:13133": dial tcp [::1]:13133: connect: connection refused 2023/02/08 13:32:54 Stopping the agent to apply new config. 2023/02/08 13:32:54 Stopping agent process, PID=13553 2023/02/08 13:32:54 Agent process PID=13553 successfully stopped. 2023/02/08 13:32:54 Starting agent /usr/local/bin/otelcol 2023/02/08 13:32:54 Agent process started, PID=13554 -2023/02/08 13:32:54 Agent is not healthy: Get "http://localhost:13133": dial tcp [::1]:13133: connect: connection refused -2023/02/08 13:32:55 Agent is not healthy: health check on http://localhost:13133 returned 503 -2023/02/08 13:32:55 Agent is not healthy: health check on http://localhost:13133 returned 503 -2023/02/08 13:32:56 Agent is not healthy: health check on http://localhost:13133 returned 503 +2023/02/08 13:32:54 Agent is not healthy: Get "http://0.0.0.0:13133": dial tcp [::1]:13133: connect: connection refused +2023/02/08 13:32:55 Agent is not healthy: health check on http://0.0.0.0:13133 returned 503 +2023/02/08 13:32:55 Agent is not healthy: health check on http://0.0.0.0:13133 returned 503 +2023/02/08 13:32:56 Agent is not healthy: health check on http://0.0.0.0:13133 returned 503 2023/02/08 13:32:57 Agent is healthy. ``` If everything worked out you should now be able to go to -[http://localhost:4321/](http://localhost:4321/) and access the OpAMP server UI +[http://0.0.0.0:4321/](http://0.0.0.0:4321/) and access the OpAMP server UI where you should see your collector listed, managed by the supervisor: ![OpAMP example setup](../img/opamp-server-ui.png) @@ -197,7 +197,7 @@ You can also query the collector for the metrics exported (note the label values): ```console -$ curl localhost:8888/metrics +$ curl 0.0.0.0:8888/metrics ... # HELP otelcol_receiver_accepted_metric_points Number of metric points successfully pushed into the pipeline. # TYPE otelcol_receiver_accepted_metric_points counter diff --git a/content/en/docs/collector/scaling.md b/content/en/docs/collector/scaling.md index c6f35723ff60..7633c12c4cd4 100644 --- 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/demo/architecture.md b/content/en/docs/demo/architecture.md index d97b4892ef14..21d91057e056 100644 --- a/content/en/docs/demo/architecture.md +++ b/content/en/docs/demo/architecture.md @@ -140,8 +140,8 @@ subgraph tdf[Telemetry Data Flow] subgraph oc[OTel Collector] style oc fill:#97aef3,color:black; - oc-grpc[/"OTLP Receiver
listening on
grpc://localhost:4317/"/] - oc-http[/"OTLP Receiver
listening on
http://localhost:4318/
https://localhost:4318/"/] + oc-grpc[/"OTLP Receiver
listening on
grpc://0.0.0.0:4317/"/] + oc-http[/"OTLP Receiver
listening on
http://0.0.0.0:4318/
https://0.0.0.0:4318/"/] oc-proc(Processors) oc-prom[/"OTLP HTTP Exporter"/] oc-otlp[/"OTLP Exporter"/] @@ -153,27 +153,27 @@ subgraph tdf[Telemetry Data Flow] oc-proc --> oc-otlp end - oc-prom -->|"http://localhost:9090/api/v1/otlp"| pr-sc + oc-prom -->|"http://0.0.0.0:9090/api/v1/otlp"| pr-sc oc-otlp -->|gRPC| ja-col subgraph pr[Prometheus] style pr fill:#e75128,color:black; pr-sc[/"Prometheus OTLP Write Receiver"/] pr-tsdb[(Prometheus TSDB)] - pr-http[/"Prometheus HTTP
listening on
http://localhost:9090"/] + pr-http[/"Prometheus HTTP
listening on
http://0.0.0.0:9090"/] pr-sc --> pr-tsdb pr-tsdb --> pr-http end pr-b{{"Browser
Prometheus UI"}} - pr-http ---->|"http://localhost:9090/graph"| pr-b + pr-http ---->|"http://0.0.0.0:9090/graph"| pr-b subgraph ja[Jaeger] style ja fill:#60d0e4,color:black; ja-col[/"Jaeger Collector
listening on
grpc://jaeger:4317/"/] ja-db[(Jaeger DB)] - ja-http[/"Jaeger HTTP
listening on
http://localhost:16686"/] + ja-http[/"Jaeger HTTP
listening on
http://0.0.0.0:16686"/] ja-col --> ja-db ja-db --> ja-http @@ -182,19 +182,19 @@ subgraph tdf[Telemetry Data Flow] subgraph gr[Grafana] style gr fill:#f8b91e,color:black; gr-srv["Grafana Server"] - gr-http[/"Grafana HTTP
listening on
http://localhost:3000"/] + gr-http[/"Grafana HTTP
listening on
http://0.0.0.0:3000"/] gr-srv --> gr-http end - pr-http --> |"http://localhost:9090/api"| gr-srv - ja-http --> |"http://localhost:16686/api"| gr-srv + pr-http --> |"http://0.0.0.0:9090/api"| gr-srv + ja-http --> |"http://0.0.0.0:16686/api"| gr-srv ja-b{{"Browser
Jaeger UI"}} - ja-http ---->|"http://localhost:16686/search"| ja-b + ja-http ---->|"http://0.0.0.0:16686/search"| ja-b gr-b{{"Browser
Grafana UI"}} - gr-http -->|"http://localhost:3000/dashboard"| gr-b + gr-http -->|"http://0.0.0.0:3000/dashboard"| gr-b end end ``` diff --git a/content/en/docs/kubernetes/operator/_index.md b/content/en/docs/kubernetes/operator/_index.md index 75a07ff191aa..df2953de03c1 100644 --- a/content/en/docs/kubernetes/operator/_index.md +++ b/content/en/docs/kubernetes/operator/_index.md @@ -49,6 +49,7 @@ spec: otlp: protocols: grpc: + endpoint: 0.0.0.0:4317 http: processors: diff --git a/content/en/docs/kubernetes/operator/automatic.md b/content/en/docs/kubernetes/operator/automatic.md index 6a4244362232..80be39261880 100644 --- 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 index 0c29bd3241e7..0a2d10568aaa 100644 --- 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 index c79a9f6f9a41..9b445589a588 100644 --- 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 index b0c79d636f53..26debb37396c 100644 --- 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 index b9e291389f93..44961611e9d3 100644 --- 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: diff --git a/content/en/docs/languages/sdk-configuration/otlp-exporter.md b/content/en/docs/languages/sdk-configuration/otlp-exporter.md index 2a7546dadf80..a6cb53fba2a6 100644 --- a/content/en/docs/languages/sdk-configuration/otlp-exporter.md +++ b/content/en/docs/languages/sdk-configuration/otlp-exporter.md @@ -17,8 +17,8 @@ endpoint and want one environment variable to control the endpoint. **Default value:** -- gRPC: `"http://localhost:4317"` -- HTTP: `"http://localhost:4318"` +- gRPC: `"http://0.0.0.0:4317"` +- HTTP: `"http://0.0.0.0:4318"` **Example:** @@ -40,8 +40,8 @@ Typically ends with `v1/traces` when using OTLP/HTTP. **Default value:** -- gRPC: `"http://localhost:4317"` -- HTTP: `"http://localhost:4318/v1/traces"` +- gRPC: `"http://0.0.0.0:4317"` +- HTTP: `"http://0.0.0.0:4318/v1/traces"` **Example:** @@ -57,8 +57,8 @@ Typically ends with `v1/metrics` when using OTLP/HTTP. **Default value:** -- gRPC: `"http://localhost:4317"` -- HTTP: `"http://localhost:4318/v1/metrics"` +- gRPC: `"http://0.0.0.0:4317"` +- HTTP: `"http://0.0.0.0:4318/v1/metrics"` **Example:** @@ -74,8 +74,8 @@ Typically ends with `v1/logs` when using OTLP/HTTP. **Default value:** -- gRPC: `"http://localhost:4317"` -- HTTP: `"http://localhost:4318/v1/logs"` +- gRPC: `"http://0.0.0.0:4317"` +- HTTP: `"http://0.0.0.0:4318/v1/logs"` **Example:** From 66be24ec884eba70985ffc58b74d01999f4188cc Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 11:43:08 +0100 Subject: [PATCH 02/14] Fix formatting --- content/en/docs/collector/building/receiver.md | 4 ++-- content/en/docs/collector/configuration.md | 18 +++++++++--------- content/en/docs/collector/deployment/agent.md | 6 +++--- .../en/docs/collector/deployment/gateway.md | 6 +++--- content/en/docs/collector/scaling.md | 2 +- content/en/docs/languages/js/exporters.md | 4 ++-- content/en/docs/languages/python/distro.md | 4 ++-- content/en/docs/languages/python/exporters.md | 4 ++-- .../docs/languages/python/getting-started.md | 4 ++-- 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/content/en/docs/collector/building/receiver.md b/content/en/docs/collector/building/receiver.md index d62d3336a7a9..ec15cca1ae7c 100644 --- a/content/en/docs/collector/building/receiver.md +++ b/content/en/docs/collector/building/receiver.md @@ -108,7 +108,7 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 processors: batch: @@ -1036,7 +1036,7 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + 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 index a3ef9f3a7ec4..bd6ee02c3b05 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -46,9 +46,9 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 http: - endpoint: 0.0.0.0:4318 + endpoint: 0.0.0.0:4318 processors: batch: @@ -88,9 +88,9 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 http: - endpoint: 0.0.0.0:4318 + endpoint: 0.0.0.0:4318 otlp/2: protocols: grpc: @@ -140,7 +140,7 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 exporters: ${file:exporters.yaml} @@ -167,7 +167,7 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 exporters: otlp: @@ -222,7 +222,7 @@ receivers: jaeger: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 thrift_binary: thrift_compact: thrift_http: @@ -238,9 +238,9 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 http: - endpoint: 0.0.0.0:4318 + endpoint: 0.0.0.0:4318 # Data sources: metrics prometheus: diff --git a/content/en/docs/collector/deployment/agent.md b/content/en/docs/collector/deployment/agent.md index 97ce2ba24d99..6db6d6b233ee 100644 --- a/content/en/docs/collector/deployment/agent.md +++ b/content/en/docs/collector/deployment/agent.md @@ -43,7 +43,7 @@ receivers: otlp: # the OTLP receiver the app is sending traces to protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 processors: batch: @@ -67,7 +67,7 @@ receivers: otlp: # the OTLP receiver the app is sending metrics to protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 processors: batch: @@ -91,7 +91,7 @@ receivers: otlp: # the OTLP receiver the app is sending logs to protocols: grpc: - endpoint: 0.0.0.0:4317 + 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 index 3711979f3c17..e4d7f03cf720 100644 --- a/content/en/docs/collector/deployment/gateway.md +++ b/content/en/docs/collector/deployment/gateway.md @@ -118,7 +118,7 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 exporters: loadbalancing: @@ -147,7 +147,7 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 exporters: loadbalancing: @@ -173,7 +173,7 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 exporters: loadbalancing: diff --git a/content/en/docs/collector/scaling.md b/content/en/docs/collector/scaling.md index 7633c12c4cd4..c6335eb9ca2e 100644 --- a/content/en/docs/collector/scaling.md +++ b/content/en/docs/collector/scaling.md @@ -361,7 +361,7 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 processors: diff --git a/content/en/docs/languages/js/exporters.md b/content/en/docs/languages/js/exporters.md index 0a2d10568aaa..b70b1f0fe92a 100644 --- a/content/en/docs/languages/js/exporters.md +++ b/content/en/docs/languages/js/exporters.md @@ -37,9 +37,9 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 http: - endpoint: 0.0.0.0:4318 + 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 index 9b445589a588..4f43dfcd6dce 100644 --- a/content/en/docs/languages/python/distro.md +++ b/content/en/docs/languages/python/distro.md @@ -38,9 +38,9 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 http: - endpoint: 0.0.0.0:4318 + 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 index 26debb37396c..07c33a782c81 100644 --- a/content/en/docs/languages/python/exporters.md +++ b/content/en/docs/languages/python/exporters.md @@ -40,9 +40,9 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 http: - endpoint: 0.0.0.0:4318 + 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 index 44961611e9d3..28385e345a71 100644 --- a/content/en/docs/languages/python/getting-started.md +++ b/content/en/docs/languages/python/getting-started.md @@ -663,9 +663,9 @@ receivers: otlp: protocols: grpc: - endpoint: 0.0.0.0:4317 + endpoint: 0.0.0.0:4317 http: - endpoint: 0.0.0.0:4318 + endpoint: 0.0.0.0:4318 exporters: # NOTE: Prior to v0.86.0 use `logging` instead of `debug`. debug: From cd87af0e3e463e3f06a534cc79d0def9547ad2b0 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 11:45:55 +0100 Subject: [PATCH 03/14] Revert examples --- content/en/docs/collector/building/receiver.md | 4 ++-- content/en/docs/collector/management.md | 2 +- content/en/docs/demo/architecture.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/collector/building/receiver.md b/content/en/docs/collector/building/receiver.md index ec15cca1ae7c..1fb8528be793 100644 --- a/content/en/docs/collector/building/receiver.md +++ b/content/en/docs/collector/building/receiver.md @@ -88,7 +88,7 @@ docker run -d --name jaeger \ ``` Once the container is up and running, you can access Jaeger UI by: - + Now, create a Collector config file named `config.yaml` to set up the Collector's components and pipelines. @@ -178,7 +178,7 @@ telemetrygen traces --otlp-insecure --traces 1 ``` You should be able to see detailed logs in the console and the traces in Jaeger -UI through URL: . +UI through URL: . Press Ctrl + C to stop the Collector instance in the Collector console. diff --git a/content/en/docs/collector/management.md b/content/en/docs/collector/management.md index b9f4f46d4167..3def641c5bee 100644 --- a/content/en/docs/collector/management.md +++ b/content/en/docs/collector/management.md @@ -188,7 +188,7 @@ $ go run . ``` If everything worked out you should now be able to go to -[http://0.0.0.0:4321/](http://0.0.0.0:4321/) and access the OpAMP server UI +[http://localhost:4321/](http://localhost:4321/) and access the OpAMP server UI where you should see your collector listed, managed by the supervisor: ![OpAMP example setup](../img/opamp-server-ui.png) diff --git a/content/en/docs/demo/architecture.md b/content/en/docs/demo/architecture.md index 21d91057e056..c241af8df0b4 100644 --- a/content/en/docs/demo/architecture.md +++ b/content/en/docs/demo/architecture.md @@ -188,10 +188,10 @@ subgraph tdf[Telemetry Data Flow] end pr-http --> |"http://0.0.0.0:9090/api"| gr-srv - ja-http --> |"http://0.0.0.0:16686/api"| gr-srv + ja-http --> |"http://localhost:16686/api"| gr-srv ja-b{{"Browser
Jaeger UI"}} - ja-http ---->|"http://0.0.0.0:16686/search"| ja-b + ja-http ---->|"http://localhost:16686/search"| ja-b gr-b{{"Browser
Grafana UI"}} gr-http -->|"http://0.0.0.0:3000/dashboard"| gr-b From 3517c7dc90ee772a82316dd41524a85e417fd4e1 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 23 Jan 2024 12:42:18 +0100 Subject: [PATCH 04/14] Revert non-receiver changes --- content/en/docs/collector/building/receiver.md | 4 ++-- content/en/docs/collector/management.md | 12 ++++++------ content/en/docs/demo/architecture.md | 14 +++++++------- .../languages/sdk-configuration/otlp-exporter.md | 16 ++++++++-------- 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/content/en/docs/collector/building/receiver.md b/content/en/docs/collector/building/receiver.md index 1fb8528be793..a5dfc6a06231 100644 --- a/content/en/docs/collector/building/receiver.md +++ b/content/en/docs/collector/building/receiver.md @@ -118,7 +118,7 @@ exporters: debug: verbosity: detailed otlp/jaeger: - endpoint: 0.0.0.0:14317 + endpoint: localhost:14317 tls: insecure: true @@ -1049,7 +1049,7 @@ exporters: debug: verbosity: detailed otlp/jaeger: - endpoint: 0.0.0.0:14317 + endpoint: localhost:14317 tls: insecure: true diff --git a/content/en/docs/collector/management.md b/content/en/docs/collector/management.md index 3def641c5bee..d41987eea02b 100644 --- a/content/en/docs/collector/management.md +++ b/content/en/docs/collector/management.md @@ -174,16 +174,16 @@ $ go run . 2023/02/08 13:32:54 Enabling own metrics pipeline in the config 2023/02/08 13:32:54 Effective config changed. 2023/02/08 13:32:54 Config is changed. Signal to restart the agent. -2023/02/08 13:32:54 Agent is not healthy: Get "http://0.0.0.0:13133": dial tcp [::1]:13133: connect: connection refused +2023/02/08 13:32:54 Agent is not healthy: Get "http://localhost:13133": dial tcp [::1]:13133: connect: connection refused 2023/02/08 13:32:54 Stopping the agent to apply new config. 2023/02/08 13:32:54 Stopping agent process, PID=13553 2023/02/08 13:32:54 Agent process PID=13553 successfully stopped. 2023/02/08 13:32:54 Starting agent /usr/local/bin/otelcol 2023/02/08 13:32:54 Agent process started, PID=13554 -2023/02/08 13:32:54 Agent is not healthy: Get "http://0.0.0.0:13133": dial tcp [::1]:13133: connect: connection refused -2023/02/08 13:32:55 Agent is not healthy: health check on http://0.0.0.0:13133 returned 503 -2023/02/08 13:32:55 Agent is not healthy: health check on http://0.0.0.0:13133 returned 503 -2023/02/08 13:32:56 Agent is not healthy: health check on http://0.0.0.0:13133 returned 503 +2023/02/08 13:32:54 Agent is not healthy: Get "http://localhost:13133": dial tcp [::1]:13133: connect: connection refused +2023/02/08 13:32:55 Agent is not healthy: health check on http://localhost:13133 returned 503 +2023/02/08 13:32:55 Agent is not healthy: health check on http://localhost:13133 returned 503 +2023/02/08 13:32:56 Agent is not healthy: health check on http://localhost:13133 returned 503 2023/02/08 13:32:57 Agent is healthy. ``` @@ -197,7 +197,7 @@ You can also query the collector for the metrics exported (note the label values): ```console -$ curl 0.0.0.0:8888/metrics +$ curl localhost:8888/metrics ... # HELP otelcol_receiver_accepted_metric_points Number of metric points successfully pushed into the pipeline. # TYPE otelcol_receiver_accepted_metric_points counter diff --git a/content/en/docs/demo/architecture.md b/content/en/docs/demo/architecture.md index c241af8df0b4..20e07ae7f8f3 100644 --- a/content/en/docs/demo/architecture.md +++ b/content/en/docs/demo/architecture.md @@ -153,27 +153,27 @@ subgraph tdf[Telemetry Data Flow] oc-proc --> oc-otlp end - oc-prom -->|"http://0.0.0.0:9090/api/v1/otlp"| pr-sc + oc-prom -->|"http://localhost:9090/api/v1/otlp"| pr-sc oc-otlp -->|gRPC| ja-col subgraph pr[Prometheus] style pr fill:#e75128,color:black; pr-sc[/"Prometheus OTLP Write Receiver"/] pr-tsdb[(Prometheus TSDB)] - pr-http[/"Prometheus HTTP
listening on
http://0.0.0.0:9090"/] + pr-http[/"Prometheus HTTP
listening on
http://localhost:9090"/] pr-sc --> pr-tsdb pr-tsdb --> pr-http end pr-b{{"Browser
Prometheus UI"}} - pr-http ---->|"http://0.0.0.0:9090/graph"| pr-b + pr-http ---->|"http://localhost:9090/graph"| pr-b subgraph ja[Jaeger] style ja fill:#60d0e4,color:black; ja-col[/"Jaeger Collector
listening on
grpc://jaeger:4317/"/] ja-db[(Jaeger DB)] - ja-http[/"Jaeger HTTP
listening on
http://0.0.0.0:16686"/] + ja-http[/"Jaeger HTTP
listening on
http://localhost:16686"/] ja-col --> ja-db ja-db --> ja-http @@ -182,19 +182,19 @@ subgraph tdf[Telemetry Data Flow] subgraph gr[Grafana] style gr fill:#f8b91e,color:black; gr-srv["Grafana Server"] - gr-http[/"Grafana HTTP
listening on
http://0.0.0.0:3000"/] + gr-http[/"Grafana HTTP
listening on
http://localhost:3000"/] gr-srv --> gr-http end - pr-http --> |"http://0.0.0.0:9090/api"| gr-srv + pr-http --> |"http://localhost:9090/api"| gr-srv ja-http --> |"http://localhost:16686/api"| gr-srv ja-b{{"Browser
Jaeger UI"}} ja-http ---->|"http://localhost:16686/search"| ja-b gr-b{{"Browser
Grafana UI"}} - gr-http -->|"http://0.0.0.0:3000/dashboard"| gr-b + gr-http -->|"http://localhost:3000/dashboard"| gr-b end end ``` diff --git a/content/en/docs/languages/sdk-configuration/otlp-exporter.md b/content/en/docs/languages/sdk-configuration/otlp-exporter.md index a6cb53fba2a6..2a7546dadf80 100644 --- a/content/en/docs/languages/sdk-configuration/otlp-exporter.md +++ b/content/en/docs/languages/sdk-configuration/otlp-exporter.md @@ -17,8 +17,8 @@ endpoint and want one environment variable to control the endpoint. **Default value:** -- gRPC: `"http://0.0.0.0:4317"` -- HTTP: `"http://0.0.0.0:4318"` +- gRPC: `"http://localhost:4317"` +- HTTP: `"http://localhost:4318"` **Example:** @@ -40,8 +40,8 @@ Typically ends with `v1/traces` when using OTLP/HTTP. **Default value:** -- gRPC: `"http://0.0.0.0:4317"` -- HTTP: `"http://0.0.0.0:4318/v1/traces"` +- gRPC: `"http://localhost:4317"` +- HTTP: `"http://localhost:4318/v1/traces"` **Example:** @@ -57,8 +57,8 @@ Typically ends with `v1/metrics` when using OTLP/HTTP. **Default value:** -- gRPC: `"http://0.0.0.0:4317"` -- HTTP: `"http://0.0.0.0:4318/v1/metrics"` +- gRPC: `"http://localhost:4317"` +- HTTP: `"http://localhost:4318/v1/metrics"` **Example:** @@ -74,8 +74,8 @@ Typically ends with `v1/logs` when using OTLP/HTTP. **Default value:** -- gRPC: `"http://0.0.0.0:4317"` -- HTTP: `"http://0.0.0.0:4318/v1/logs"` +- gRPC: `"http://localhost:4317"` +- HTTP: `"http://localhost:4318/v1/logs"` **Example:** From 7ac5ddb14eef5d110e3a5944a7e609277aa22b3a Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Thu, 25 Jan 2024 16:06:12 +0100 Subject: [PATCH 05/14] Revert some edits --- content/en/docs/collector/configuration.md | 6 +++--- content/en/docs/demo/architecture.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index bd6ee02c3b05..ddbf712c5d4b 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -249,7 +249,7 @@ receivers: - job_name: otel-collector scrape_interval: 5s static_configs: - - targets: [0.0.0.0:8888] + - targets: [localhost:8888] # Data sources: traces zipkin: @@ -724,7 +724,7 @@ Collector acting as agent: ```yaml extensions: oidc: - issuer_url: http://0.0.0.0:8080/auth/realms/opentelemetry + issuer_url: http://localhost:8080/auth/realms/opentelemetry audience: collector receivers: @@ -761,7 +761,7 @@ extensions: oauth2client: client_id: agent client_secret: some-secret - token_url: http://0.0.0.0:8080/auth/realms/opentelemetry/protocol/openid-connect/token + token_url: http://localhost:8080/auth/realms/opentelemetry/protocol/openid-connect/token receivers: otlp: diff --git a/content/en/docs/demo/architecture.md b/content/en/docs/demo/architecture.md index 20e07ae7f8f3..d97b4892ef14 100644 --- a/content/en/docs/demo/architecture.md +++ b/content/en/docs/demo/architecture.md @@ -140,8 +140,8 @@ subgraph tdf[Telemetry Data Flow] subgraph oc[OTel Collector] style oc fill:#97aef3,color:black; - oc-grpc[/"OTLP Receiver
listening on
grpc://0.0.0.0:4317/"/] - oc-http[/"OTLP Receiver
listening on
http://0.0.0.0:4318/
https://0.0.0.0:4318/"/] + oc-grpc[/"OTLP Receiver
listening on
grpc://localhost:4317/"/] + oc-http[/"OTLP Receiver
listening on
http://localhost:4318/
https://localhost:4318/"/] oc-proc(Processors) oc-prom[/"OTLP HTTP Exporter"/] oc-otlp[/"OTLP Exporter"/] From 1b4712c51aa282212635f3dc91e0132297d71c5b Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Thu, 25 Jan 2024 16:23:05 +0100 Subject: [PATCH 06/14] Add note --- .../building/authenticator-extension.md | 6 +++++ .../en/docs/collector/building/connector.md | 3 +++ .../en/docs/collector/building/receiver.md | 6 +++++ content/en/docs/collector/configuration.md | 27 +++++++++++++++++++ content/en/docs/collector/deployment/agent.md | 9 +++++++ .../en/docs/collector/deployment/gateway.md | 9 +++++++ content/en/docs/collector/scaling.md | 6 +++++ content/en/docs/faas/lambda-collector.md | 6 +++++ content/en/docs/kubernetes/helm/collector.md | 6 +++++ content/en/docs/kubernetes/operator/_index.md | 3 +++ .../en/docs/kubernetes/operator/automatic.md | 3 +++ content/en/docs/languages/js/exporters.md | 3 +++ content/en/docs/languages/python/distro.md | 3 +++ content/en/docs/languages/python/exporters.md | 3 +++ .../docs/languages/python/getting-started.md | 3 +++ 15 files changed, 96 insertions(+) diff --git a/content/en/docs/collector/building/authenticator-extension.md b/content/en/docs/collector/building/authenticator-extension.md index 5980e0b07c7c..016d25ae1118 100644 --- a/content/en/docs/collector/building/authenticator-extension.md +++ b/content/en/docs/collector/building/authenticator-extension.md @@ -78,6 +78,9 @@ receivers: otlp/auth: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 auth: authenticator: oidc @@ -108,6 +111,9 @@ receivers: otlp/auth: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. 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 index 4a1e606e54ff..af747cb24c15 100644 --- a/content/en/docs/collector/building/connector.md +++ b/content/en/docs/collector/building/connector.md @@ -87,6 +87,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/collector/building/receiver.md b/content/en/docs/collector/building/receiver.md index a5dfc6a06231..5b2095f3037a 100644 --- a/content/en/docs/collector/building/receiver.md +++ b/content/en/docs/collector/building/receiver.md @@ -108,6 +108,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -1036,6 +1039,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 tailtracer: # this line represents the ID of your receiver interval: 1m diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index ddbf712c5d4b..ba7603ca2eed 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -46,6 +46,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 @@ -88,12 +91,18 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 otlp/2: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:55690 processors: @@ -140,6 +149,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: ${file:exporters.yaml} @@ -167,6 +179,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -222,6 +237,9 @@ receivers: jaeger: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 thrift_binary: thrift_compact: @@ -238,6 +256,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 @@ -731,6 +752,9 @@ receivers: otlp/auth: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 auth: authenticator: oidc @@ -767,6 +791,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. 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 index 6db6d6b233ee..9a12a708cec1 100644 --- a/content/en/docs/collector/deployment/agent.md +++ b/content/en/docs/collector/deployment/agent.md @@ -43,6 +43,9 @@ receivers: otlp: # the OTLP receiver the app is sending traces to protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -67,6 +70,9 @@ receivers: otlp: # the OTLP receiver the app is sending metrics to protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -91,6 +97,9 @@ receivers: otlp: # the OTLP receiver the app is sending logs to protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: diff --git a/content/en/docs/collector/deployment/gateway.md b/content/en/docs/collector/deployment/gateway.md index e4d7f03cf720..c1f8b53b7e4e 100644 --- a/content/en/docs/collector/deployment/gateway.md +++ b/content/en/docs/collector/deployment/gateway.md @@ -118,6 +118,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -147,6 +150,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -173,6 +179,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: diff --git a/content/en/docs/collector/scaling.md b/content/en/docs/collector/scaling.md index c6335eb9ca2e..a060f14039c8 100644 --- a/content/en/docs/collector/scaling.md +++ b/content/en/docs/collector/scaling.md @@ -157,6 +157,9 @@ spec: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -361,6 +364,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. 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 index 4a9dbc0ccaea..5205bec79a8d 100644 --- a/content/en/docs/faas/lambda-collector.md +++ b/content/en/docs/faas/lambda-collector.md @@ -53,6 +53,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 'localhost:4317' http: endpoint: 'localhost:4318' @@ -105,6 +108,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 'localhost:4317' http: endpoint: 'localhost:4318' diff --git a/content/en/docs/kubernetes/helm/collector.md b/content/en/docs/kubernetes/helm/collector.md index 6ff80c7d9355..fb91f9804a18 100644 --- a/content/en/docs/kubernetes/helm/collector.md +++ b/content/en/docs/kubernetes/helm/collector.md @@ -53,6 +53,9 @@ receivers: jaeger: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: ${env:MY_POD_IP}:14250 thrift_compact: endpoint: ${env:MY_POD_IP}:6831 @@ -61,6 +64,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: ${env:MY_POD_IP}:4317 http: endpoint: ${env:MY_POD_IP}:4318 diff --git a/content/en/docs/kubernetes/operator/_index.md b/content/en/docs/kubernetes/operator/_index.md index df2953de03c1..125b5af95e00 100644 --- a/content/en/docs/kubernetes/operator/_index.md +++ b/content/en/docs/kubernetes/operator/_index.md @@ -49,6 +49,9 @@ spec: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: processors: diff --git a/content/en/docs/kubernetes/operator/automatic.md b/content/en/docs/kubernetes/operator/automatic.md index 80be39261880..571121005c49 100644 --- a/content/en/docs/kubernetes/operator/automatic.md +++ b/content/en/docs/kubernetes/operator/automatic.md @@ -68,6 +68,9 @@ spec: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/js/exporters.md b/content/en/docs/languages/js/exporters.md index b70b1f0fe92a..4c2a9ef1c9c1 100644 --- a/content/en/docs/languages/js/exporters.md +++ b/content/en/docs/languages/js/exporters.md @@ -37,6 +37,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/distro.md b/content/en/docs/languages/python/distro.md index 4f43dfcd6dce..e776dc97b045 100644 --- a/content/en/docs/languages/python/distro.md +++ b/content/en/docs/languages/python/distro.md @@ -38,6 +38,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/exporters.md b/content/en/docs/languages/python/exporters.md index 07c33a782c81..b83d6feb56b6 100644 --- a/content/en/docs/languages/python/exporters.md +++ b/content/en/docs/languages/python/exporters.md @@ -40,6 +40,9 @@ receivers: otlp: protocols: grpc: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/getting-started.md b/content/en/docs/languages/python/getting-started.md index 28385e345a71..b4f789f1f8f8 100644 --- 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: + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 From 3c073b7fc4d2be3b94b5f7ee46283ea234ab4691 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Thu, 25 Jan 2024 16:23:58 +0100 Subject: [PATCH 07/14] Add note --- .../building/authenticator-extension.md | 8 +-- .../en/docs/collector/building/connector.md | 6 +-- .../en/docs/collector/building/receiver.md | 12 ++--- content/en/docs/collector/configuration.md | 54 +++++++++---------- content/en/docs/collector/deployment/agent.md | 18 +++---- .../en/docs/collector/deployment/gateway.md | 18 +++---- content/en/docs/collector/scaling.md | 6 +-- content/en/docs/faas/lambda-collector.md | 12 ++--- content/en/docs/kubernetes/helm/collector.md | 12 ++--- content/en/docs/kubernetes/operator/_index.md | 4 +- .../en/docs/kubernetes/operator/automatic.md | 4 +- content/en/docs/languages/js/exporters.md | 6 +-- content/en/docs/languages/python/distro.md | 6 +-- content/en/docs/languages/python/exporters.md | 6 +-- .../docs/languages/python/getting-started.md | 6 +-- 15 files changed, 89 insertions(+), 89 deletions(-) diff --git a/content/en/docs/collector/building/authenticator-extension.md b/content/en/docs/collector/building/authenticator-extension.md index 016d25ae1118..f047b55d5817 100644 --- a/content/en/docs/collector/building/authenticator-extension.md +++ b/content/en/docs/collector/building/authenticator-extension.md @@ -78,8 +78,8 @@ receivers: otlp/auth: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most # appropriate value for your environment. endpoint: 0.0.0.0:4317 auth: @@ -111,8 +111,8 @@ receivers: otlp/auth: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most # appropriate value for your environment. endpoint: 0.0.0.0:4317 auth: diff --git a/content/en/docs/collector/building/connector.md b/content/en/docs/collector/building/connector.md index af747cb24c15..b4fdadf6f5c6 100644 --- a/content/en/docs/collector/building/connector.md +++ b/content/en/docs/collector/building/connector.md @@ -87,9 +87,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/collector/building/receiver.md b/content/en/docs/collector/building/receiver.md index 5b2095f3037a..099735171bc8 100644 --- a/content/en/docs/collector/building/receiver.md +++ b/content/en/docs/collector/building/receiver.md @@ -108,9 +108,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -1039,9 +1039,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 tailtracer: # this line represents the ID of your receiver interval: 1m diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index ba7603ca2eed..6c4771a6e434 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -46,9 +46,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 @@ -91,18 +91,18 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 otlp/2: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:55690 processors: @@ -149,9 +149,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: ${file:exporters.yaml} @@ -179,9 +179,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -237,9 +237,9 @@ receivers: jaeger: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 thrift_binary: thrift_compact: @@ -256,9 +256,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 @@ -752,9 +752,9 @@ receivers: otlp/auth: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 auth: authenticator: oidc @@ -791,9 +791,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. 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 index 9a12a708cec1..516ad673f8e8 100644 --- a/content/en/docs/collector/deployment/agent.md +++ b/content/en/docs/collector/deployment/agent.md @@ -43,9 +43,9 @@ receivers: otlp: # the OTLP receiver the app is sending traces to protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -70,9 +70,9 @@ receivers: otlp: # the OTLP receiver the app is sending metrics to protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -97,9 +97,9 @@ receivers: otlp: # the OTLP receiver the app is sending logs to protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: diff --git a/content/en/docs/collector/deployment/gateway.md b/content/en/docs/collector/deployment/gateway.md index c1f8b53b7e4e..8c79a7fce463 100644 --- a/content/en/docs/collector/deployment/gateway.md +++ b/content/en/docs/collector/deployment/gateway.md @@ -118,9 +118,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -150,9 +150,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -179,9 +179,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: diff --git a/content/en/docs/collector/scaling.md b/content/en/docs/collector/scaling.md index a060f14039c8..85b16c876274 100644 --- a/content/en/docs/collector/scaling.md +++ b/content/en/docs/collector/scaling.md @@ -364,9 +364,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. 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 index 5205bec79a8d..a0f720274c71 100644 --- a/content/en/docs/faas/lambda-collector.md +++ b/content/en/docs/faas/lambda-collector.md @@ -53,9 +53,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 'localhost:4317' http: endpoint: 'localhost:4318' @@ -108,9 +108,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 'localhost:4317' http: endpoint: 'localhost:4318' diff --git a/content/en/docs/kubernetes/helm/collector.md b/content/en/docs/kubernetes/helm/collector.md index fb91f9804a18..af0269a411fe 100644 --- a/content/en/docs/kubernetes/helm/collector.md +++ b/content/en/docs/kubernetes/helm/collector.md @@ -53,9 +53,9 @@ receivers: jaeger: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: ${env:MY_POD_IP}:14250 thrift_compact: endpoint: ${env:MY_POD_IP}:6831 @@ -64,9 +64,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: ${env:MY_POD_IP}:4317 http: endpoint: ${env:MY_POD_IP}:4318 diff --git a/content/en/docs/kubernetes/operator/_index.md b/content/en/docs/kubernetes/operator/_index.md index 125b5af95e00..87d4b6ffe880 100644 --- a/content/en/docs/kubernetes/operator/_index.md +++ b/content/en/docs/kubernetes/operator/_index.md @@ -49,8 +49,8 @@ spec: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: diff --git a/content/en/docs/kubernetes/operator/automatic.md b/content/en/docs/kubernetes/operator/automatic.md index 571121005c49..da706f204430 100644 --- a/content/en/docs/kubernetes/operator/automatic.md +++ b/content/en/docs/kubernetes/operator/automatic.md @@ -68,8 +68,8 @@ spec: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: diff --git a/content/en/docs/languages/js/exporters.md b/content/en/docs/languages/js/exporters.md index 4c2a9ef1c9c1..18b2a0cec1cd 100644 --- a/content/en/docs/languages/js/exporters.md +++ b/content/en/docs/languages/js/exporters.md @@ -37,9 +37,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/distro.md b/content/en/docs/languages/python/distro.md index e776dc97b045..25ff60e5f725 100644 --- a/content/en/docs/languages/python/distro.md +++ b/content/en/docs/languages/python/distro.md @@ -38,9 +38,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/exporters.md b/content/en/docs/languages/python/exporters.md index b83d6feb56b6..38b786e55236 100644 --- a/content/en/docs/languages/python/exporters.md +++ b/content/en/docs/languages/python/exporters.md @@ -40,9 +40,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/getting-started.md b/content/en/docs/languages/python/getting-started.md index b4f789f1f8f8..65370e2b9254 100644 --- a/content/en/docs/languages/python/getting-started.md +++ b/content/en/docs/languages/python/getting-started.md @@ -663,9 +663,9 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. + # Tells the Collector to listen on all interfaces + # and addresses. Make sure to set the most + # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 From 18e801ac10a41400d866d8f33276325e6466addd Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 30 Jan 2024 10:28:27 +0100 Subject: [PATCH 08/14] Update content/en/docs/kubernetes/helm/collector.md Co-authored-by: Severin Neumann --- content/en/docs/kubernetes/helm/collector.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/content/en/docs/kubernetes/helm/collector.md b/content/en/docs/kubernetes/helm/collector.md index af0269a411fe..5f4315b2ee33 100644 --- a/content/en/docs/kubernetes/helm/collector.md +++ b/content/en/docs/kubernetes/helm/collector.md @@ -64,9 +64,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: ${env:MY_POD_IP}:4317 http: endpoint: ${env:MY_POD_IP}:4318 From 45eeae062aa676ed864acef69ab7bfc0152db752 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 30 Jan 2024 10:28:33 +0100 Subject: [PATCH 09/14] Update content/en/docs/kubernetes/helm/collector.md Co-authored-by: Severin Neumann --- content/en/docs/kubernetes/helm/collector.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/content/en/docs/kubernetes/helm/collector.md b/content/en/docs/kubernetes/helm/collector.md index 5f4315b2ee33..6ff80c7d9355 100644 --- a/content/en/docs/kubernetes/helm/collector.md +++ b/content/en/docs/kubernetes/helm/collector.md @@ -53,9 +53,6 @@ receivers: jaeger: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: ${env:MY_POD_IP}:14250 thrift_compact: endpoint: ${env:MY_POD_IP}:6831 From a0e87d840a93cab8b57b8fe9e70f7cece801fdb8 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 30 Jan 2024 10:33:32 +0100 Subject: [PATCH 10/14] Tech review --- content/en/docs/faas/lambda-collector.md | 4 ++-- content/en/docs/kubernetes/operator/_index.md | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/content/en/docs/faas/lambda-collector.md b/content/en/docs/faas/lambda-collector.md index a0f720274c71..43d7bbfdae3f 100644 --- a/content/en/docs/faas/lambda-collector.md +++ b/content/en/docs/faas/lambda-collector.md @@ -56,9 +56,9 @@ receivers: # Tells the Collector to listen on all interfaces # and addresses. Make sure to set the most # appropriate value for your environment. - 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 index 87d4b6ffe880..c86b9e4381bb 100644 --- a/content/en/docs/kubernetes/operator/_index.md +++ b/content/en/docs/kubernetes/operator/_index.md @@ -54,6 +54,7 @@ spec: # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: + endpoint: 0.0.0.0:4318 processors: exporters: From 1a45b7b699952fee381d1c1a8641c11d5f70ad9a Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 30 Jan 2024 21:18:36 +0100 Subject: [PATCH 11/14] Eliminate note --- .../building/authenticator-extension.md | 6 ----- .../en/docs/collector/building/connector.md | 3 --- .../en/docs/collector/building/receiver.md | 6 ----- content/en/docs/collector/configuration.md | 27 ------------------- content/en/docs/collector/deployment/agent.md | 9 ------- .../en/docs/collector/deployment/gateway.md | 9 ------- content/en/docs/collector/scaling.md | 4 --- content/en/docs/faas/lambda-collector.md | 6 ----- content/en/docs/kubernetes/operator/_index.md | 3 --- .../en/docs/kubernetes/operator/automatic.md | 3 --- content/en/docs/languages/js/exporters.md | 3 --- content/en/docs/languages/python/distro.md | 3 --- content/en/docs/languages/python/exporters.md | 3 --- .../docs/languages/python/getting-started.md | 3 --- 14 files changed, 88 deletions(-) diff --git a/content/en/docs/collector/building/authenticator-extension.md b/content/en/docs/collector/building/authenticator-extension.md index f047b55d5817..5980e0b07c7c 100644 --- a/content/en/docs/collector/building/authenticator-extension.md +++ b/content/en/docs/collector/building/authenticator-extension.md @@ -78,9 +78,6 @@ receivers: otlp/auth: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 auth: authenticator: oidc @@ -111,9 +108,6 @@ receivers: otlp/auth: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. 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 index b4fdadf6f5c6..4a1e606e54ff 100644 --- a/content/en/docs/collector/building/connector.md +++ b/content/en/docs/collector/building/connector.md @@ -87,9 +87,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/collector/building/receiver.md b/content/en/docs/collector/building/receiver.md index 099735171bc8..a5dfc6a06231 100644 --- a/content/en/docs/collector/building/receiver.md +++ b/content/en/docs/collector/building/receiver.md @@ -108,9 +108,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -1039,9 +1036,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 tailtracer: # this line represents the ID of your receiver interval: 1m diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index 6c4771a6e434..ddbf712c5d4b 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -46,9 +46,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 @@ -91,18 +88,12 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 otlp/2: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:55690 processors: @@ -149,9 +140,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: ${file:exporters.yaml} @@ -179,9 +167,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -237,9 +222,6 @@ receivers: jaeger: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 thrift_binary: thrift_compact: @@ -256,9 +238,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 @@ -752,9 +731,6 @@ receivers: otlp/auth: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 auth: authenticator: oidc @@ -791,9 +767,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. 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 index 516ad673f8e8..6db6d6b233ee 100644 --- a/content/en/docs/collector/deployment/agent.md +++ b/content/en/docs/collector/deployment/agent.md @@ -43,9 +43,6 @@ receivers: otlp: # the OTLP receiver the app is sending traces to protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -70,9 +67,6 @@ receivers: otlp: # the OTLP receiver the app is sending metrics to protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -97,9 +91,6 @@ receivers: otlp: # the OTLP receiver the app is sending logs to protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: diff --git a/content/en/docs/collector/deployment/gateway.md b/content/en/docs/collector/deployment/gateway.md index 8c79a7fce463..e4d7f03cf720 100644 --- a/content/en/docs/collector/deployment/gateway.md +++ b/content/en/docs/collector/deployment/gateway.md @@ -118,9 +118,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -150,9 +147,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: @@ -179,9 +173,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 exporters: diff --git a/content/en/docs/collector/scaling.md b/content/en/docs/collector/scaling.md index 85b16c876274..06171f0d64fa 100644 --- a/content/en/docs/collector/scaling.md +++ b/content/en/docs/collector/scaling.md @@ -159,7 +159,6 @@ spec: grpc: # Tells the Collector to listen on all interfaces # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 processors: @@ -364,9 +363,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. 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 index 43d7bbfdae3f..bc6cee1daae0 100644 --- a/content/en/docs/faas/lambda-collector.md +++ b/content/en/docs/faas/lambda-collector.md @@ -53,9 +53,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: '0.0.0.0:4317' http: endpoint: '0.0.0.0:4318' @@ -108,9 +105,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 'localhost:4317' http: endpoint: 'localhost:4318' diff --git a/content/en/docs/kubernetes/operator/_index.md b/content/en/docs/kubernetes/operator/_index.md index c86b9e4381bb..6f1e26ed48af 100644 --- a/content/en/docs/kubernetes/operator/_index.md +++ b/content/en/docs/kubernetes/operator/_index.md @@ -49,9 +49,6 @@ spec: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/kubernetes/operator/automatic.md b/content/en/docs/kubernetes/operator/automatic.md index da706f204430..80be39261880 100644 --- a/content/en/docs/kubernetes/operator/automatic.md +++ b/content/en/docs/kubernetes/operator/automatic.md @@ -68,9 +68,6 @@ spec: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/js/exporters.md b/content/en/docs/languages/js/exporters.md index 18b2a0cec1cd..b70b1f0fe92a 100644 --- a/content/en/docs/languages/js/exporters.md +++ b/content/en/docs/languages/js/exporters.md @@ -37,9 +37,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/distro.md b/content/en/docs/languages/python/distro.md index 25ff60e5f725..4f43dfcd6dce 100644 --- a/content/en/docs/languages/python/distro.md +++ b/content/en/docs/languages/python/distro.md @@ -38,9 +38,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/exporters.md b/content/en/docs/languages/python/exporters.md index 38b786e55236..07c33a782c81 100644 --- a/content/en/docs/languages/python/exporters.md +++ b/content/en/docs/languages/python/exporters.md @@ -40,9 +40,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 diff --git a/content/en/docs/languages/python/getting-started.md b/content/en/docs/languages/python/getting-started.md index 65370e2b9254..28385e345a71 100644 --- a/content/en/docs/languages/python/getting-started.md +++ b/content/en/docs/languages/python/getting-started.md @@ -663,9 +663,6 @@ receivers: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most - # appropriate value for your environment. endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 From 24a6e4735469b825d6ba1ce9bd37be8912ec14e5 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Wed, 31 Jan 2024 10:57:42 +0100 Subject: [PATCH 12/14] Update content/en/docs/collector/scaling.md Co-authored-by: Patrice Chalin --- content/en/docs/collector/scaling.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/en/docs/collector/scaling.md b/content/en/docs/collector/scaling.md index 06171f0d64fa..c6335eb9ca2e 100644 --- a/content/en/docs/collector/scaling.md +++ b/content/en/docs/collector/scaling.md @@ -157,8 +157,6 @@ spec: otlp: protocols: grpc: - # Tells the Collector to listen on all interfaces - # and addresses. Make sure to set the most endpoint: 0.0.0.0:4317 processors: From c52e382ea922fe3c44a87ab64357abf674264b49 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 31 Jan 2024 05:15:31 -0500 Subject: [PATCH 13/14] Add note --- content/en/docs/collector/configuration.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index ddbf712c5d4b..11fc841341f4 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -38,8 +38,23 @@ 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: + 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: From 91288ce928bd0baccfaf68f3f2e1d79f08000aa6 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 31 Jan 2024 05:22:45 -0500 Subject: [PATCH 14/14] Fix format --- content/en/docs/collector/configuration.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index 11fc841341f4..6e6c8c62c43d 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -38,9 +38,8 @@ 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. + The following is an example of Collector +configuration with a receiver, a processor, an exporter, and three extensions. {{% alert title="Important" color="warning" %}}