Skip to content

Commit a87fab9

Browse files
maycmleedussault-antoine
authored andcommitted
add env vars (#32763)
1 parent 5d7e326 commit a87fab9

File tree

9 files changed

+52
-34
lines changed

9 files changed

+52
-34
lines changed

content/en/observability_pipelines/destinations/google_pubsub.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,7 @@ Set up the Google Pub/Sub destination and its environment variables when you [se
114114

115115
{{< img src="observability_pipelines/destinations/google_pubsub_env_var.png" alt="The install page showing the Google Pub/Sub environment variable field" style="width:70%;" >}}
116116

117-
By default the Worker sends data to the global endpoint: `https://pubsub.googleapis.com`.
118-
119-
If your Pub/Sub topic is region-specific, configure the Google Pub/Sub alternative endpoint URL with the regional endpoint. See [About Pub/Sub endpoints][5] for more information.
120-
121-
Stored as the environment variable: `DD_OP_DESTINATION_GCP_PUBSUB_ENDPOINT_URL`.
117+
{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/google_pubsub %}}
122118

123119
## Troubleshooting
124120

@@ -163,7 +159,6 @@ A batch of events is flushed when one of these parameters is met. See [event bat
163159
[2]: https://cloud.google.com/docs/authentication#auth-flowchart
164160
[3]: https://cloud.google.com/pubsub/docs/access-control#roles
165161
[4]: https://console.cloud.google.com/iam-admin/serviceaccounts
166-
[5]: https://cloud.google.com/pubsub/docs/reference/service_apis_overview#pubsub_endpoints
167162
[6]: /observability_pipelines/destinations/#event-batching
168163
[7]:https://cloud.google.com/kubernetes-engine/docs/concepts/workload-identity
169164
[8]: /observability_pipelines/monitoring_and_maintenance/pipeline_usage_metrics/

content/en/observability_pipelines/destinations/kafka.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -78,22 +78,7 @@ Click **Advanced** if you want to set any of the following fields:
7878

7979
### Set environment variables
8080

81-
#### Kafka bootstrap servers
82-
- The host and port of the Kafka bootstrap servers.
83-
- This is the bootstrap server that the client uses to connect to the Kafka cluster and discover all the other hosts in the cluster. The host and port must be entered in the format of `host:port`, such as `10.14.22.123:9092`. If there is more than one server, use commas to separate them.
84-
- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_BOOTSTRAP_SERVERS`.
85-
86-
#### TLS (when enabled)
87-
88-
- If TLS is enabled, the Kafka TLS passphrase is needed.
89-
- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_KEY_PASS`.
90-
91-
#### SASL (when enabled)
92-
93-
- Kafka SASL username
94-
- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_SASL_USERNAME`.
95-
- Kafka SASL password
96-
- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_SASL_PASSWORD`.
81+
{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/kafka %}}
9782

9883
## librdkafka options
9984

content/en/observability_pipelines/guide/environment_variables.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ Some Observability Pipelines components require setting up environment variables
3939
### Logstash
4040
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/logstash %}}
4141

42+
### OpenTelemetry
43+
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/opentelemetry %}}
44+
4245
### Socket
4346

4447
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/socket %}}
@@ -91,6 +94,12 @@ Some Observability Pipelines components require setting up environment variables
9194
### Elasticsearch
9295
{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/elasticsearch %}}
9396

97+
### Kafka
98+
{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/kafka %}}
99+
100+
### Google Pub/Sub
101+
{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/google_pubsub %}}
102+
94103
### HTTP Client
95104
{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/http_client %}}
96105

content/en/observability_pipelines/sources/opentelemetry.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,7 @@ Optionally, toggle the switch to enable TLS. If you enable TLS, the following ce
3232

3333
{{< img src="observability_pipelines/sources/otel_env_vars.png" alt="The install page showing the OpenTelemetry environment variable field" style="width:75%;" >}}
3434

35-
You must provide both HTTP and gRPC endpoints. Configure your OTLP exporters to point to one of these endpoints. See [Send logs to the Observability Pipelines Worker](#send-logs-to-the-observability-pipelines-worker) for more information.
36-
37-
- HTTP listener address
38-
- The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector.
39-
- Stored as the environment variable `DD_OP_SOURCE_OTEL_HTTP_ADDRESS`.
40-
41-
- gRPC listener address
42-
- The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector.
43-
- Stored as the environment variable `DD_OP_SOURCE_OTEL_GRPC_ADDRESS`.
35+
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/splunk_hec %}}
4436

4537
## Send logs to the Observability Pipelines Worker
4638

content/en/observability_pipelines/sources/socket.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,8 @@ Select and set up this source when you [set up a pipeline][1]. The information b
1515

1616
{{% observability_pipelines/source_settings/socket %}}
1717

18+
## Set the environment variables
19+
20+
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/socket %}}
21+
1822
[1]: /observability_pipelines/configuration/set_up_pipelines/
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
By default the Worker sends data to the global endpoint: `https://pubsub.googleapis.com`.
2+
3+
If your Pub/Sub topic is region-specific, configure the Google Pub/Sub alternative endpoint URL with the regional endpoint. See [About Pub/Sub endpoints][10240] for more information.
4+
5+
Stored as the environment variable: `DD_OP_DESTINATION_GCP_PUBSUB_ENDPOINT_URL`.
6+
7+
[10240]: https://cloud.google.com/pubsub/docs/reference/service_apis_overview#pubsub_endpoints
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#### Kafka bootstrap servers
2+
- The host and port of the Kafka bootstrap servers.
3+
- This is the bootstrap server that the client uses to connect to the Kafka cluster and discover all the other hosts in the cluster. The host and port must be entered in the format of `host:port`, such as `10.14.22.123:9092`. If there is more than one server, use commas to separate them.
4+
- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_BOOTSTRAP_SERVERS`.
5+
6+
#### TLS (when enabled)
7+
8+
- If TLS is enabled, the Kafka TLS passphrase is needed.
9+
- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_KEY_PASS`.
10+
11+
#### SASL (when enabled)
12+
13+
- Kafka SASL username
14+
- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_SASL_USERNAME`.
15+
- Kafka SASL password
16+
- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_SASL_PASSWORD`.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
You must provide both HTTP and gRPC endpoints. Configure your OTLP exporters to point to one of these endpoints. See [Send logs to the Observability Pipelines Worker][10230] for more information.
2+
3+
- HTTP listener address
4+
- The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector.
5+
- Stored as the environment variable `DD_OP_SOURCE_OTEL_HTTP_ADDRESS`.
6+
7+
- gRPC listener address
8+
- The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector.
9+
- Stored as the environment variable `DD_OP_SOURCE_OTEL_GRPC_ADDRESS`.
10+
11+
[10230]: /observability_pipelines/sources/opentelemetry/#send-logs-to-the-observability-pipelines-worker
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
- Socket address:
22
- The address and port where the Observability Pipelines Worker listens for incoming logs.
3-
- Stored as the environment variable `DD_OP_SOURCE_SOCKET_ADDRESS`
3+
- Stored as the environment variable `DD_OP_SOURCE_SOCKET_ADDRESS`.
44

5-
- TLS passphrase:
6-
- Used if TLS is enabled.
5+
- TLS passphrase (when enabled)
76
- Stored as the environment variable `DD_OP_SOURCE_SOCKET_KEY_PASS`.

0 commit comments

Comments
 (0)