You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: gdi/opentelemetry/deployments/deployments-ecs-ec2.rst
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,7 @@ The following sections describe how to create a task definition and launch the C
30
30
31
31
Add the Collector as a Sidecar
32
32
---------------------------------
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.
36
34
37
35
Open the ECS task definition to which the Collector Sidecar is going to be added:
38
36
@@ -42,29 +40,32 @@ Open the ECS task definition to which the Collector Sidecar is going to be added
42
40
43
41
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>`.
44
42
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`.
48
46
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.
50
50
51
51
.. _ecs-ec2-custom-config:
52
52
53
53
Use a custom configuration
54
54
==============================
55
+
55
56
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.
56
57
57
58
Alternatively, you can specify the custom configuration YAML directly using the ``SPLUNK_CONFIG_YAML`` environment variable, as described in :ref:`ecs-observer-config`.
58
59
59
60
.. _ecs-observer-config:
60
61
61
-
``ecs_observer`` configuration
62
+
Configure ``ecs_observer``
62
63
--------------------------------
64
+
63
65
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.
64
66
65
67
.. code-block:: yaml
66
68
67
-
68
69
ecs:List*
69
70
ecs:Describe*
70
71
@@ -74,7 +75,6 @@ The results are written to ``/etc/ecs_sd_targets.yaml``. The ``prometheus`` rece
74
75
75
76
.. code-block:: yaml
76
77
77
-
78
78
extensions:
79
79
ecs_observer:
80
80
refresh_interval: 10s
@@ -114,7 +114,8 @@ The results are written to ``/etc/ecs_sd_targets.yaml``. The ``prometheus`` rece
114
114
.. _aws-parameter-store:
115
115
116
116
Launch the Collector as a Daemon
117
-
-------------------------------
117
+
--------------------------------------------
118
+
118
119
To launch the Collector from the Amazon ECS console:
0 commit comments