Skip to content

Commit 270cd46

Browse files
authored
Merge pull request #424 from open-o11y/change_name
Modify to use the appropriate nomenclature
2 parents 96655c9 + 79f1c8e commit 270cd46

19 files changed

+75
-70
lines changed

src/docs/components/ecs-metrics-receiver.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ where the `{ClusterName}` placeholder will be replaced with actual cluster name.
202202
[AWS EMF Exporter](https://aws-otel.github.io/docs/getting-started/cloudwatch-metrics) documentation to see and
203203
explore the metrics in Amazon CloudWatch.
204204

205-
**Note:** AWS OpenTelemetry Collector has a [default configuration](https://github.com/aws-observability/aws-otel-collector/blob/main/config/ecs/container-insights/otel-task-metrics-config.yaml)
205+
**Note:** AWS Distro for OpenTelemetry Collector has a [default configuration](https://github.com/aws-observability/aws-otel-collector/blob/main/config/ecs/container-insights/otel-task-metrics-config.yaml)
206206
backed into it for Container Insights experience which is smiliar to this one. Follow our [setup doc](https://aws-otel.github.io/docs/setup/ecs) to check how to use that default config.
207207

208208

src/docs/components/statsd-receiver.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Getting Started with StatsD Receiver in AWS OpenTelemetry Collector'
2+
title: 'Getting Started with StatsD Receiver in AWS Distro for OpenTelemetry Collector'
33
description:
44
StatsD receiver is an agent that collects [StatsD metrics](https://github.com/statsd/statsd/blob/master/docs/metric_types.md)
55
and do the aggregation in a customer defined interval(default value is 60s). You can send counters, gauges and timer/histogram to StatsD receiver.

src/docs/components/x-ray-receiver.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Getting Started with X-Ray Receiver in AWS OpenTelemetry Collector'
2+
title: 'Getting Started with X-Ray Receiver in AWS Distro for OpenTelemetry Collector'
33
description:
44
AWS X-Ray is a service that collects data about requests that your application serves, and provides tools you can
55
use to view, filter, and gain insights into that data to identify issues and opportunities for optimization. For

src/docs/getting-started/cloudwatch-metrics.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ The available dimension roll-up options in EMF exporter,
8787
8888
```
8989
awsemf:
90-
log_group_name: 'AOTLogGroup'
91-
log_stream_name: 'AOTLogStream'
92-
namespace: 'AOTMetricNS'
90+
log_group_name: 'ADOTLogGroup'
91+
log_stream_name: 'ADOTLogStream'
92+
namespace: 'ADOTMetricNS'
9393
dimension_rollup_option: 1
9494
log_retention: 60
9595
```

src/docs/getting-started/js-sdk/metric-manual-instr.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Metrics on AWS Distro for OpenTelemetry JavaScript SDK'
33
description:
4-
Metrics auto instrumentation has not been supported in AOT/OpenTelemetry yet. We have to manually instrumenting code
4+
Metrics auto instrumentation has not been supported in ADOT/OpenTelemetry yet. We have to manually instrumenting code
55
in the application to generate application metrics. Here is an example with steps for modifying application code to
66
create metrics with JavaScript SDK.
77
path: '/docs/getting-started/js-sdk/metric-manual-instr'
@@ -11,7 +11,7 @@ import SectionSeparator from "components/MdxSectionSeparator/sectionSeparator.js
1111
import img2 from "assets/img/docs/img2.png"
1212
import { Link } from "gatsby"
1313

14-
Metrics auto instrumentation has not been supported in AOT/OpenTelemetry yet. We have to manually instrumenting code in the application to generate application metrics. Here is an example with steps for modifying application code to create metrics with JavaScript SDK.
14+
Metrics auto instrumentation has not been supported in ADOT/OpenTelemetry yet. We have to manually instrumenting code in the application to generate application metrics. Here is an example with steps for modifying application code to create metrics with JavaScript SDK.
1515

1616
OpenTelemetry JavaScript SDK has provided metrics API for metrics instrumentation in applications. You can follow the steps and sample code below to create OpenTelemetry Metrics and send it over to ADOT Collector.
1717

src/docs/partners/datadog.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ service:
121121
exporters: [datadog/api]
122122
```
123123

124-
Supply the relative path to this configuration file when you start the collector by passing it in using the `--config=<path/to/configuration_file>` command line argument. For examples of supplying a configuration file, see the [AWS OpenTelemetry Collector documentation](https://aws-otel.github.io/docs/getting-started/collector) for your target platform.
124+
Supply the relative path to this configuration file when you start the collector by passing it in using the `--config=<path/to/configuration_file>` command line argument. For examples of supplying a configuration file, see the [ADOT Collector documentation](https://aws-otel.github.io/docs/getting-started/collector) for your target platform.
125125

126126
## Resources
127127

src/docs/partners/logzio.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Once your account is created, in the platform menu tabs, **activate** your Metr
3030

3131
## Configuring the Logz.io Exporter
3232

33-
To send data to Logz.io you will need to configure the AWS OpenTelemetry collector. Trace data and Metric data are configured separately. The only change needed to your OpenTelemetry configuration is to add the Logz.io exporter. This is the component used to direct the data to Logz.io from the AWS OpenTelemetry collector.
33+
To send data to Logz.io you will need to configure the ADOT collector. Trace data and Metric data are configured separately. The only change needed to your OpenTelemetry configuration is to add the Logz.io exporter. This is the component used to direct the data to Logz.io from the AWS OpenTelemetry collector.
3434
Add a Logz.io exporter to the YAML file for your OpenTelemetry configuration, along with your Logz.io tokens. Check out the exporter part of the [sample yaml file that is available from OpenTelemetry](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/logzioexporter).
3535

3636
*Note that based on your deployment, you’ll need to use your customized OpenTelemetry collector configuration changes, instead of the default OpenTelemetry file available from the AWS Distro.*

src/docs/setup/build-collector-as-debian.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import SectionSeparator from "components/MdxSectionSeparator/sectionSeparator.js
99

1010
<SectionSeparator />
1111

12-
## Run AWSOTelCollector Beta on AWS EC2 Debian(ubuntu)
12+
## Run ADOTCollector Beta on AWS EC2 Debian(ubuntu)
1313

14-
To run AWSOTelCollector on AWS EC2 debian host, you can choose to install AWSOTelCollector Debian on your host by the following steps.
14+
To run ADOTCollector on AWS EC2 debian host, you can choose to install ADOTCollector Debian on your host by the following steps.
1515

1616
**Steps,**
1717

@@ -24,23 +24,23 @@ make package-deb
2424
```
2525
sudo dpkg -i -E ./aws-otel-collector.deb
2626
```
27-
3. Once DEB is installed, it will create AWSOTelCollector in directory /opt/aws/aws-otel-collector/
27+
3. Once DEB is installed, it will create ADOTCollector in directory /opt/aws/aws-otel-collector/
2828

29-
4. We provided a control script to manage AWSOTelCollector. Customer can use it to Start, Stop and Check Status of AWSOTelCollector.
29+
4. We provided a control script to manage ADOTCollector. Customer can use it to Start, Stop and Check Status of ADOTCollector.
3030

31-
* Start AWSOTelCollector with CTL script. The config.yaml is optional, if it is not provided the default config will be applied.
31+
* Start ADOTCollector with CTL script. The config.yaml is optional, if it is not provided the default config will be applied.
3232
```
3333
sudo /opt/aws/aws-otel-collector/bin/aws-otel-collector-ctl -c </path/config.yaml> -a start
3434
```
35-
* Stop the running AWSOTelCollector when finish the testing.
35+
* Stop the running ADOTCollector when finish the testing.
3636
```
3737
sudo /opt/aws/aws-otel-collector/bin/aws-otel-collector-ctl -a stop
3838
```
39-
* Check the status of AWSOTelCollector
39+
* Check the status of ADOTCollector
4040
```
4141
sudo /opt/aws/aws-otel-collector/bin/aws-otel-collector-ctl -a status
4242
```
43-
5. Test the data with the running AWSOTelCollector on EC2. you can run the following command on EC2 host. (Docker app has to be pre-installed)
43+
5. Test the data with the running ADOTCollector on EC2. you can run the following command on EC2 host. (Docker app has to be pre-installed)
4444
```
4545
docker run --rm -it -e "otlp_endpoint=172.17.0.1:4317" -e "otlp_instance_id=test_insance" mxiamxia/aws-otel-metric-generator:latest
4646
```

src/docs/setup/build-collector-as-rpm.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import SectionSeparator from "components/MdxSectionSeparator/sectionSeparator.js
99

1010
<SectionSeparator />
1111

12-
## Run AWSOTelCollector Beta on AWS EC2 Linux
12+
## Run ADOTCollector Beta on AWS EC2 Linux
1313

14-
To run AWSOTelCollector on AWS EC2 Linux host, you can choose to install AWSOTelCollector RPM on your host by the following steps.
14+
To run ADOTCollector on AWS EC2 Linux host, you can choose to install ADOTCollector RPM on your host by the following steps.
1515

1616
**Steps,**
1717

@@ -24,34 +24,34 @@ make package-rpm
2424
```
2525
sudo rpm -Uvh ./aws-otel-collector.rpm
2626
```
27-
3. Once RPM is installed, it will create AWSOTelCollector in directory ```/opt/aws/aws-otel-collector/```
27+
3. Once RPM is installed, it will create ADOTCollector in directory ```/opt/aws/aws-otel-collector/```
2828

29-
4. We provided a control script to manage AWSOTelCollector. Customer can use it to Start, Stop and Check Status of AWSOTelCollector.
29+
4. We provided a control script to manage ADOTCollector. Customer can use it to Start, Stop and Check Status of ADOTCollector.
3030

31-
* Start AWSOTelCollector with CTL script. The config.yaml is optional, if it is not provided the default [config](../../config.yaml) will be applied.
31+
* Start ADOTCollector with CTL script. The config.yaml is optional, if it is not provided the default [config](../../config.yaml) will be applied.
3232
```
3333
sudo /opt/aws/aws-otel-collector/bin/aws-otel-collector-ctl -c </path/config.yaml> -a start
3434
```
35-
* Stop the running AWSOTelCollector when finish the testing.
35+
* Stop the running ADOTCollector when finish the testing.
3636
```
3737
sudo /opt/aws/aws-otel-collector/bin/aws-otel-collector-ctl -a stop
3838
```
39-
* Check the status of AWSOTelCollector
39+
* Check the status of ADOTCollector
4040
```
4141
sudo /opt/aws/aws-otel-collector/bin/aws-otel-collector-ctl -a status
4242
```
4343

44-
5. Test the data with the running AWSOTelCollector on EC2. you can run the following command on EC2 host. (Docker app has to be pre-installed)
44+
5. Test the data with the running ADOTCollector on EC2. you can run the following command on EC2 host. (Docker app has to be pre-installed)
4545
```
46-
docker run --rm -it -e "OTEL_OTLP_ENDPOINT=172.17.0.1:4317" -e "otlp_instance_id=test_insance_rpm" -e "OTEL_RESOURCE_ATTRIBUTES=service.namespace=AWSOTelCollectorRPMDemo,service.name=AWSOTelCollectorRPMDemoService" -e S3_REGION=us-west-2 aottestbed/aws-otel-collector-sample-app:java-0.1.0
46+
docker run --rm -it -e "OTEL_OTLP_ENDPOINT=172.17.0.1:4317" -e "otlp_instance_id=test_insance_rpm" -e "OTEL_RESOURCE_ATTRIBUTES=service.namespace=ADOTCollectorRPMDemo,service.name=ADOTCollectorRPMDemoService" -e S3_REGION=us-west-2 aottestbed/aws-otel-collector-sample-app:java-0.1.0
4747
```
4848

4949
**View Your Metrics**
50-
You should now be able to view your metrics in your [CloudWatch console](https://console.aws.amazon.com/cloudwatch/). In the navigation bar, click on **Metrics**. The collected AWSOTelCollector metrics can be found in the **AWSOTelCollectorRPMDemo/AWSOTelCollectorRPMDemoService** namespace.
50+
You should now be able to view your metrics in your [CloudWatch console](https://console.aws.amazon.com/cloudwatch/). In the navigation bar, click on **Metrics**. The collected ADOTCollector metrics can be found in the **ADOTCollectorRPMDemo/ADOTCollectorRPMDemoService** namespace.
5151

52-
### Installing AWSOTelCollector via CloudFormation
53-
### Install AWSOTelCollector on ECS EC2
54-
Download CloudFormation template file for installing AWSOTelCollector on ECS EC2 mode
52+
### Installing ADOTCollector via CloudFormation
53+
### Install ADOTCollector on ECS EC2
54+
Download CloudFormation template file for installing ADOTCollector on ECS EC2 mode
5555
```
5656
curl -O https://github.com/mxiamxia/aws-opentelemetry-collector/blob/master/deployment-template/ec2/aws-otel-ec2-deployment-cfn.template
5757
```
@@ -60,7 +60,7 @@ Run CloudFormation the following command once ```IAMRole```, ```Region```, ```EC
6060
Region=<aws-region>
6161
IAMRole=<iam-role>
6262
EC2Key=<ec2-ssh-key-name>
63-
aws cloudformation create-stack --stack-name AWSOTelCollectorEC2-Test \
63+
aws cloudformation create-stack --stack-name ADOTCollectorEC2-Test \
6464
--template-body file://<CFN_File_Downloaded> \
6565
--parameters ParameterKey=IAMRole,ParameterValue=${IAMRole} \
6666
ParameterKey=KeyName,ParameterValue=${EC2Key} \

src/docs/setup/build-collector-on-windows.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import SectionSeparator from "components/MdxSectionSeparator/sectionSeparator.js
99

1010
<SectionSeparator />
1111

12-
## Run AWSOTelCollector on AWS Windows Ec2 Host
12+
## Run ADOTCollector on AWS Windows Ec2 Host
1313

14-
To run AWSOTelCollector on AWS windows ec2 host, you can choose to install AWSOTelCollector MSI on your host by the following steps.
14+
To run ADOTCollector on AWS windows ec2 host, you can choose to install ADOTCollector MSI on your host by the following steps.
1515

1616
**Steps,**
1717
1. Login on AWS Windows EC2 host and download aws-otel-collector source code and build MSI file with the following command.
@@ -24,22 +24,22 @@ git clone https://github.com/aws-observability/aws-otel-collector.git
2424
msiexec /i aws-otel-collector.msi
2525
or can be installed by double clicking the windows msi file.
2626
```
27-
While Installing the AWSOTelCollector it will show a popup mentioning that the software is not from verified publisher,
27+
While Installing the ADOTCollector it will show a popup mentioning that the software is not from verified publisher,
2828
this is because we have not signed the MSI one it is signed this popup will be gone
2929

30-
3. Once MSI is installed, it will create AWSOTelCollector in directory C:\Program Files\Amazon\AwsOpentelemetryCollector
30+
3. Once MSI is installed, it will create ADOTCollector in directory C:\Program Files\Amazon\AwsOpentelemetryCollector
3131

32-
4. We provided a control script to manage AWSOTelCollector. Customer can use it to Start, Stop and Check Status of AWSOTelCollector.
33-
* Start AWSOTelCollector with CTL script. The config.yaml is optional, if it is not provided the default config will be applied.
32+
4. We provided a control script to manage ADOTCollector. Customer can use it to Start, Stop and Check Status of ADOTCollector.
33+
* Start ADOTCollector with CTL script. The config.yaml is optional, if it is not provided the default config will be applied.
3434
```
3535
& '.\Program Files\Amazon\AwsOpentelemetryCollector\aws-otel-collector-ctl.ps1' -a start
3636
```
37-
* Stop the running AWSOTelCollector when finish the testing.
37+
* Stop the running ADOTCollector when finish the testing.
3838
```
3939
& '.\Program Files\Amazon\AwsOpentelemetryCollector\aws-otel-collector-ctl.ps1' -a stop
4040
4141
```
42-
* Check the status of AWSOTelCollector
42+
* Check the status of ADOTCollector
4343
```
4444
& '.\Program Files\Amazon\AwsOpentelemetryCollector\aws-otel-collector-ctl.ps1' -a status
4545
```

0 commit comments

Comments
 (0)