Skip to content

Commit c847752

Browse files
committed
Add More info in SSM w.r.t to AOT_CONFIG_CONTENT
1 parent e3d67c1 commit c847752

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

src/docs/partners/datadog.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ On each OpenTelemetry-instrumented application, set the resource attributes `dev
5353

5454
## Configuring the pipeline
5555

56-
Finally, add a `datadog` exporter pipeline to your `otel-collector-configuration.yml` file. This shows a `traces` pipeline:
56+
Finally, add a `datadog` exporter pipeline to your `otel-collector-configuration.yml` file. This shows a `traces` pipeline. Also, refer to [Setting up the OpenTelemetry Collector with the Datadog Exporter](https://docs.datadoghq.com/opentelemetry/otel_collector_datadog_exporter/?tab=onahost#setting-up-the-opentelemetry-collector-with-the-datadog-exporter) .
5757

5858
```yaml lineNumbers=true
5959
service:

src/docs/setup/ecs/config-through-ssm.mdx

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ and use it with AWS Distro for OpenTelemetry Collector.
1919
<SectionSeparator />
2020

2121
The AWS Distro for OpenTelemetry Collector can optionally be configured via an environment variable AOT_CONFIG_CONTENT. The value of this
22-
variable is expected to be a full Collector configuration file; it will override the config file used in the Collector
22+
variable is expected to be a full Collector configuration file; it will override the config file used in the Collector
2323
entrypoint command. In ECS, the values of environment variables can be set from AWS Systems Manager Parameters.
2424

2525

@@ -28,14 +28,14 @@ entrypoint command. In ECS, the values of environment variables can be set from
2828

2929
**1.1. Select Task Defintion**
3030

31-
Go to AWS Management Console and select Elastic Container Service. From the left side navigation, select [Task
32-
definition](https://us-west-2.console.aws.amazon.com/ecs/home?region=us-west-2#/taskDefinitions). Select the
31+
Go to AWS Management Console and select Elastic Container Service. From the left side navigation, select [Task
32+
definition](https://us-west-2.console.aws.amazon.com/ecs/home?region=us-west-2#/taskDefinitions). Select the
3333
TaskDefinition we created to run AWS Distro for OpenTelemetry Collector and click the `Create new revision` button on top.
3434

3535
**1.2. Add Environment Variable**
3636

3737
From the container definition section, click the **AWS Distro for OpenTelemetry Collector** container (image: `amazon/aws-otel-collector`) and go
38-
to the **Environment variables** section. Add a new environment variable- **AOT_CONFIG_CONTENT**. Select ValueFrom
38+
to the **Environment variables** section. Add a new environment variable- **AOT_CONFIG_CONTENT**. Select ValueFrom
3939
which will tell ECS to get the value from SSM Parameter, and set **otel-collector-config** (SSM parameter name which
4040
we will create in the next section) as the value. Finish updating the task definition and create a new revision.
4141

@@ -49,24 +49,26 @@ we will create in the next section) as the value. Finish updating the task defin
4949

5050
**2.1. Go to Parameter Store**
5151

52-
Let’s go to **System Manager** service from AWS Management Console and select
53-
[Parameter Store](https://us-west-2.console.aws.amazon.com/systems-manager/home?region=us-west-2) from the left
52+
Let’s go to **System Manager** service from AWS Management Console and select
53+
[Parameter Store](https://us-west-2.console.aws.amazon.com/systems-manager/home?region=us-west-2) from the left
5454
side navigation panel.
5555

5656
<img src={ssm_01} alt="Diagram" style="margin: 10px 0;" />
5757
<div style="height: 40px" />
5858

5959
**2.2. Create New Parameter**
6060

61-
From the top-right corner, click the **Create new parameter** button. Create a new parameter with the following
62-
information. The parameter name should be the same as we used in the environment variable of our task-definition.
61+
From the top-right corner, click the **Create new parameter** button. Create a new parameter with the following
62+
information. The parameter name should be the same as we used in the environment variable of our task-definition.
6363

6464
- **Name:** otel-collector-config
6565
- **Tier:** Standard
6666
- **Type:** String
6767
- **Data type:** Text
6868
- **Value:** Copy and paste your custom OpenTelemetry configuration file.
6969

70+
**NOTE** The collector configuration should not be used to store credentials in plain text. Instead, replacement instructions such as ${env:API_KEY}
71+
should be used to load values from an environment variable. These values can be populated either through a secrets manager (or) SSM parameter store on ECS (or) through Kubernetes secrets on EKS
7072

7173
<SectionSeparator />
7274

0 commit comments

Comments
 (0)