Docs » Configure application receivers » Configure application receivers for hosts and servers » Amazon ECS Task Metadata

Amazon ECS Task Metadata 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the ecs-metadata monitor type by using the Smart Agent Receiver.

This integration reads container stats from Amazon ECS Task Metadata Endpoint version 2. The task metadata endpoint retrieves various task metadata and Docker stats.

This monitor does not currently support CPU share/quota metrics.

This monitor is available on Linux and Windows.

Benefits 🔗

After you’ve configured the integration, you can:

  • View metrics using the built-in dashboard. For information about dashboards, see View dashboards in Observability Cloud.

  • View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.

  • Access Metric Finder and search for metrics sent by the monitor. For information about Metric Finder, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy the integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the next section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. The Smart Agent Receiver allows you to use existing Smart Agent monitors as OpenTelemetry Collector metric receivers.

Using this monitor assumes that you have a properly configured environment with a functional Smart Agent release bundle on your system, which is already provided for x86_64/amd64 Splunk Distribution of OpenTelemetry Collector installation paths.

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your configuration (YAML) file:

receivers:
  smartagent/ecs-metadata:
    type: ecs-metadata
    ...  # Additional config

To complete the integration, include the monitor in a metrics pipeline. To do this, add the monitor item to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/ecs-metadata]

Metrics 🔗

These are the metrics available for this integration.

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud:

  • Ask questions and get answers through community support at Splunk Answers.

  • If you have a support contract, file a case using the Splunk Support Portal. See Support and Services.

  • To get professional help with optimizing your Splunk software investment, see Splunk Services.