Agent Check: Traffic Server

Overview

This check monitors Traffic Server through the Datadog Agent.

Enable the Datadog-Apache Traffic Server integration to:

• Ensure the availability and performance of online resources, such as websites and applications.
• Track metrics such as hits, volume, and changes in traffic to websites and applications.
• Determine average response times and sizes for requests.
• Monitor system and error logs.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The Traffic Server check is included in the Datadog Agent package.

To enable monitoring in Traffic Server, enable the Stats Over HTTP plugin on your Traffic Server by adding the following line to your plugin.config file and reloading Traffic Server:

stats_over_http.so

Configuration

1. Edit the traffic_server.d/conf.yaml file in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your Traffic Server performance data. See the sample traffic_server.d/conf.yaml for all available configuration options.

Note: When using the default configuration file, not all metrics are collected by default.

Comment out the metric_patterns option to collect all available metrics, or edit it to collect a different subset of metrics:

    ## @param metric_patterns - mapping - optional
    ## A mapping of metrics to include or exclude, with each entry being a regular expression.
    ##
    ## Metrics defined in `exclude` will take precedence in case of overlap.
    ## Comment out this option to collect all available metrics.
    #
    metric_patterns:
      include:
         - <METRIC_1>
         - <METRIC_2>

2. Restart the Agent.

Validation

Run the Agent's status subcommand and look for traffic_server under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Log collection

Available for Agent versions >6.0

1. Traffic Server logs are highly customizable, but Datadog's integration pipeline supports the default conversion pattern. Clone and edit the integration pipeline if you have a different format.

2. Collecting logs is disabled by default in the Datadog Agent. Enable it in your datadog.yaml file:

   logs_enabled: true

3. Uncomment and edit the logs configuration block in your traffic_server.d/conf.yaml file. Change the path and service parameter values based on your environment. See the sample traffic_server.d/conf.yaml for all available configuration options.

   logs:
      - type: file
        path: /opt/trafficserver/var/log/trafficserver/traffic.out
        source: traffic_server
      - type: file
        path: /opt/trafficserver/var/log/trafficserver/diags.log
        source: traffic_server
      - type: file
        path: /opt/trafficserver/var/log/trafficserver/error.log
        source: traffic_server

Events

The Traffic Server integration does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.