Skip to content

Commit

Permalink
Update deployments-ecs-ec2.rst
Browse files Browse the repository at this point in the history
Minor edits
  • Loading branch information
aurbiztondo-splunk authored Oct 23, 2024
1 parent c30284f commit 1ce55f6
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions gdi/opentelemetry/deployments/deployments-ecs-ec2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ The following sections describe how to create a task definition and launch the C

Add the Collector as a Sidecar
---------------------------------
.. note::

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.
.. 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.

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

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

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>`.

.. note::
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`.
Notes:

* 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`.

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.
* To exclude metrics assign them as a stringified array 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.

.. _ecs-ec2-custom-config:

Use a custom configuration
==============================

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.

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

.. _ecs-observer-config:

``ecs_observer`` configuration
Configure ``ecs_observer``
--------------------------------

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.

.. code-block:: yaml
ecs:List*
ecs:Describe*
Expand All @@ -74,7 +75,6 @@ The results are written to ``/etc/ecs_sd_targets.yaml``. The ``prometheus`` rece

.. code-block:: yaml
extensions:
ecs_observer:
refresh_interval: 10s
Expand Down Expand Up @@ -114,7 +114,8 @@ The results are written to ``/etc/ecs_sd_targets.yaml``. The ``prometheus`` rece
.. _aws-parameter-store:

Launch the Collector as a Daemon
-------------------------------
--------------------------------------------

To launch the Collector from the Amazon ECS console:

#. Go to your cluster in the console.
Expand Down

0 comments on commit 1ce55f6

Please sign in to comment.