Skip to content

Commit 91dc2fc

Browse files
Merge pull request #277971 from michaelkira/private/michdai/updateotelagentdoc
Update opentelemetry agent document
2 parents 68164d4 + 2cb0f42 commit 91dc2fc

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

articles/container-apps/opentelemetry-agents.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,14 @@ Before you run this command, replace placeholders surrounded by `<>` with your v
8686

8787
```azurecli
8888
az containerapp env telemetry app-insights set \
89+
--resource-group <YOUR_RESOURCE_GROUP_NAME> \
90+
--name <YOUR_ENVIRONMENT_NAME> \
8991
--connection-string <YOUR_APP_INSIGHTS_CONNECTION_STRING> \
9092
--enable-open-telemetry-traces true \
9193
--enable-open-telemetry-logs true
9294
```
95+
>[!NOTE]
96+
> Due to the sensitivity of the connection-string, you will not be able to see the detail values of the connection string when the command returns. The system will display it as null.
9397
9498
---
9599

@@ -140,11 +144,15 @@ Before you run this command, replace placeholders surrounded by `<>` with your v
140144

141145
```azurecli
142146
az containerapp env telemetry data-dog set \
147+
--resource-group <YOUR_RESOURCE_GROUP_NAME> \
148+
--name <YOUR_ENVIRONMENT_NAME> \
143149
--site "<YOUR_DATADOG_SUBDOMAIN>.datadoghq.com" \
144150
--key <YOUR_DATADOG_KEY> \
145151
--enable-open-telemetry-traces true \
146152
--enable-open-telemetry-metrics true
147153
```
154+
>[!NOTE]
155+
> Due to the sensitivity of the key, you will not be able to see the detail values of the key when the command returns. The system will display it as null.
148156
149157
---
150158

@@ -200,25 +208,33 @@ While you can set up as many OTLP-configured endpoints as you like, each endpoin
200208

201209
```azurecli
202210
az containerapp env telemetry otlp add \
203-
--name "otlp1" \
211+
--resource-group <YOUR_RESOURCE_GROUP_NAME> \
212+
--name <YOUR_ENVIRONMENT_NAME> \
213+
--otlp-name "otlp1" \
204214
--endpoint "ENDPOINT_URL_1" \
205215
--insecure false \
206216
--headers "api-key-1=key" \
207217
--enable-open-telemetry-traces true \
208218
--enable-open-telemetry-metrics true
209219
az containerapp env telemetry otlp add \
210-
--name "otlp2" \
220+
--resource-group <YOUR_RESOURCE_GROUP_NAME> \
221+
--name <YOUR_ENVIRONMENT_NAME> \
222+
--otlp-name "otlp2" \
211223
--endpoint "ENDPOINT_URL_2" \
212224
--insecure true \
213225
--enable-open-telemetry-traces true \
214226
--enable-open-telemetry-logs true
215227
```
228+
>[!NOTE]
229+
> Due to the sensitivity of the headers value, you will not be able to see the detail values of the headers value when the command returns. The system will display them as null.
216230
217231
---
218232

219233
| Name | Description |
220234
|---|---|
221-
| `name` | A name you select to identify your OTLP-configured endpoint. |
235+
| `resource-group` | Name of resource group. You can configure the default group using `az configure --defaults group=<NAME>`. |
236+
| `name` | Name of the Container Apps environment. |
237+
| `otlp-name` | A name you select to identify your OTLP-configured endpoint. |
222238
| `endpoint` | The URL of the destination that receives collected data. |
223239
| `insecure` | Default true. Defines whether to enable client transport security for the exporter's gRPC connection. If false, the `headers` parameter is required. |
224240
| `headers` | Space-separated values, in 'key=value' format, that provide required information for the OTLP endpoints' security. Example: `"api-key=key other-config-value=value"`. |

0 commit comments

Comments
 (0)