Skip to content

Commit 539042d

Browse files
authored
[chore] Update READMEs to point to security best practices doc (#36590)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description <!-- Issue number (e.g. #1234) or full URL to issue, if applicable. --> Counterpart to open-telemetry/opentelemetry-collector/pull/11773
1 parent 54691eb commit 539042d

File tree

17 files changed

+18
-19
lines changed

17 files changed

+18
-19
lines changed

extension/awsproxy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The TCP address and port on which this proxy listens for requests.
4141
4242
Default: `localhost:2000`
4343

44-
You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to `0.0.0.0:2000`. This feature gate will be removed in a future release.
44+
See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
4545

4646

4747
### proxy_address (Optional)

extension/healthcheckextension/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ liveness and/or readiness probe on Kubernetes.
2929

3030
The following settings are required:
3131

32-
- `endpoint` (default = localhost:13133): Address to publish the health check status. For full list of `ServerConfig` refer [here](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp). You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to 0.0.0.0:13133. This feature gate will be removed in a future release.
32+
- `endpoint` (default = localhost:13133): Address to publish the health check status. For full list of `ServerConfig` refer [here](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp). See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
3333
- `path` (default = "/"): Specifies the path to be configured for the health check server.
3434
- `response_body` (default = ""): Specifies a static body that overrides the default response returned by the health check service.
3535

extension/healthcheckv2extension/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ liveness and/or readiness probe on Kubernetes.
3535

3636
The following settings are required:
3737

38-
- `endpoint` (default = localhost:13133): Address to publish the health check status. For full list of `ServerConfig` refer [here](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp). You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to 0.0.0.0:13133. This feature gate will be removed in a future release.
38+
- `endpoint` (default = localhost:13133): Address to publish the health check status. For full list of `ServerConfig` refer [here](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp). See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
3939
- `path` (default = "/"): Specifies the path to be configured for the health check server.
4040
- `response_body` (default = ""): Specifies a static body that overrides the default response returned by the health check service.
4141
- `check_collector_pipeline:` (deprecated and ignored): Settings of collector pipeline health check

extension/jaegerremotesampling/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ By default, two listeners are made available:
1717
- `localhost:5778`, following the legacy remote sampling endpoint as defined by Jaeger
1818
- `localhost:14250`, following the gRPC remote sampling endpoint, also defined by Jaeger
1919

20-
You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to `0.0.0.0:5778` and `0.0.0.0:14250` respectively. This feature gate will be removed in a future release.
20+
See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
2121

2222

2323
Note that the port `14250` will clash with the Jaeger Receiver. When both are used, it's recommended to change this extension to use another port.

processor/remotetapprocessor/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The Remote Tap processor has two configurable fields: `endpoint` and `limit`:
2727

2828
- `endpoint`: The endpoint on which the WebSocket processor listens. Optional. Defaults
2929
to `localhost:12001`.
30-
You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to `0.0.0.0:12001`. This feature gate will be removed in a future release.
30+
See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
3131

3232
- `limit`: The rate limit over the WebSocket in messages per second. Can be a
3333
float or an integer. Optional. Defaults to `1`.

receiver/awsfirehosereceiver/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The address:port to bind the listener to.
3838
3939
default: `localhost:4433`
4040

41-
You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to `0.0.0.0:4433`. This feature gate will be removed in a future release.
41+
See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
4242

4343
### tls:
4444
See [documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md#server-configuration) for more details.

receiver/awsxrayreceiver/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ The UDP address and port on which this receiver listens for X-Ray segment docume
4545
4646
Default: `localhost:2000`
4747

48-
You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to `0.0.0.0:2000`. This feature gate will be removed in a future release.
49-
48+
See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
5049

5150
### transport (Optional)
5251
This should always be "udp" as X-Ray SDKs only send segments using UDP.
@@ -61,7 +60,7 @@ The TCP address and port on which this receiver listens for calls from the X-Ray
6160

6261
Default: `0.0.0.0:2000`
6362

64-
The `component.UseLocalHostAsDefaultHost` feature gate changes this to localhost:2000. This will become the default in a future release.
63+
See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
6564

6665
### proxy_address (Optional)
6766
Defines the proxy address that the local TCP server forwards HTTP requests to AWS X-Ray backend through. If left unconfigured, requests will be sent directly.

receiver/influxdbreceiver/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Write responses:
2727

2828
The following configuration options are supported:
2929

30-
* `endpoint` (default = localhost:8086) HTTP service endpoint for the line protocol receiver. You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to `0.0.0.0:8086`. This feature gate will be removed in a future release.
30+
* `endpoint` (default = localhost:8086) HTTP service endpoint for the line protocol receiver. See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
3131

3232
The full list of settings exposed for this receiver are documented in [config.go](config.go).
3333

receiver/jaegerreceiver/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ object configuration parameter.
2828
- `thrift_compact` (default `endpoint` = localhost:6831)
2929
- `thrift_http` (default `endpoint` = localhost:14268)
3030

31-
You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change tgese endpoints to 0.0.0.0:14250, 0.0.0.0:6832, 0.0.0.0:6831 and 0.0.0.0:14268. This feature gate will be removed in a future release.
31+
See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
3232

3333
Examples:
3434

receiver/lokireceiver/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This receiver runs HTTP and GRPC servers to ingest log entries in Loki format.
2121

2222
The settings are:
2323

24-
- `endpoint` (required, default = localhost:3500 for HTTP protocol, localhost:3600 gRPC protocol): host:port to which the receiver is going to receive data. You can temporarily disable the `component.UseLocalHostAsDefaultHost` feature gate to change this to `0.0.0.0:3500` and `0.0.0.0:3600`. This feature gate will be removed in a future release.
24+
- `endpoint` (required, default = localhost:3500 for HTTP protocol, localhost:3600 gRPC protocol): host:port to which the receiver is going to receive data. See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
2525
- `use_incoming_timestamp` (optional, default = false) if set `true` the timestamp from Loki log entry is used
2626

2727
Example:

0 commit comments

Comments
 (0)