Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 1ce55f6

Browse files
Update deployments-ecs-ec2.rst
Minor edits
1 parent c30284f commit 1ce55f6

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

gdi/opentelemetry/deployments/deployments-ecs-ec2.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ The following sections describe how to create a task definition and launch the C
3030

3131
Add the Collector as a Sidecar
3232
---------------------------------
33-
.. note::
34-
35-
Knowledge of Amazon ECS using launch type EC2 is assumed. See :new-page:`Getting started with the classic console using Amazon EC2 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/getting-started-ecs-ec2.html>` for further reading.
33+
.. note:: To use this option you need to be familiar with Amazon ECS EC2 launch type. See :new-page:`Getting started with the classic console using Amazon EC2 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/getting-started-ecs-ec2.html>` for further reading.
3634

3735
Open the ECS task definition to which the Collector Sidecar is going to be added:
3836

@@ -42,29 +40,32 @@ Open the ECS task definition to which the Collector Sidecar is going to be added
4240

4341
The Collector is configured to use the default configuration file ``/etc/otel/collector/ecs_ec2_config.yaml``. The Collector image Dockerfile is available at :new-page:`Dockerfile <https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/Dockerfile>` and the contents of the default configuration file can be seen at :new-page:`ECS EC2 configuration <https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/config/collector/ecs_ec2_config.yaml>`.
4442

45-
.. note::
46-
47-
You do not need the ``awsecscontainermetrics`` receiver in the default configuration file if all you want is tracing. You can take the default configuration, remove the receiver, then use the configuration in a custom configuration following the directions in :ref:`ecs-ec2-custom-config`.
43+
Notes:
44+
45+
* You do not need the ``awsecscontainermetrics`` receiver in the default configuration file if all you want is tracing. You can take the default configuration, remove the receiver, then use the configuration in a custom configuration following the directions in :ref:`ecs-ec2-custom-config`.
4846

49-
Assign a stringified array of metrics you want excluded to environment variable ``METRICS_TO_EXCLUDE``. You can set the memory limit for the ``memory_limiter`` processor using environment variable ``SPLUNK_MEMORY_LIMIT_MIB``. The default memory limit is 512 MiB.
47+
* To exclude metrics assign them as a stringified array to environment variable ``METRICS_TO_EXCLUDE``.
48+
49+
* You can set the memory limit for the ``memory_limiter`` processor using environment variable ``SPLUNK_MEMORY_LIMIT_MIB``. The default memory limit is 512 MiB.
5050

5151
.. _ecs-ec2-custom-config:
5252

5353
Use a custom configuration
5454
==============================
55+
5556
To use a custom configuration file, replace the value of the ``SPLUNK_CONFIG`` environment variable with the file path of the custom configuration file in the Collector task definition.
5657

5758
Alternatively, you can specify the custom configuration YAML directly using the ``SPLUNK_CONFIG_YAML`` environment variable, as described in :ref:`ecs-observer-config`.
5859

5960
.. _ecs-observer-config:
6061

61-
``ecs_observer`` configuration
62+
Configure ``ecs_observer``
6263
--------------------------------
64+
6365
Use extension Amazon Elastic Container Service Observer (``ecs_observer``) in your custom configuration to discover metrics targets in running tasks, filtered by service names, task definitions, and container labels. ``ecs_observer`` is currently limited to Prometheus targets and requires the read-only permissions below. The Collector should be configured to run as an ECS Daemon. You can add the permissions to the task role by adding them to a customer-managed policy that is attached to the task role.
6466

6567
.. code-block:: yaml
6668
67-
6869
ecs:List*
6970
ecs:Describe*
7071
@@ -74,7 +75,6 @@ The results are written to ``/etc/ecs_sd_targets.yaml``. The ``prometheus`` rece
7475

7576
.. code-block:: yaml
7677
77-
7878
extensions:
7979
ecs_observer:
8080
refresh_interval: 10s
@@ -114,7 +114,8 @@ The results are written to ``/etc/ecs_sd_targets.yaml``. The ``prometheus`` rece
114114
.. _aws-parameter-store:
115115

116116
Launch the Collector as a Daemon
117-
-------------------------------
117+
--------------------------------------------
118+
118119
To launch the Collector from the Amazon ECS console:
119120

120121
#. Go to your cluster in the console.

0 commit comments

Comments
 (0)