Skip to content

Latest commit

 

History

History

temporal

README.md

Agent Check: Temporal

Overview

This check monitors Temporal through the Datadog Agent.

Note: This check can only be installed if you are self-hosting Temporal. To monitor your Temporal Cloud instance, follow the Datadog Temporal Cloud integration documentation.

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 Temporal check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

  1. Configure your Temporal services to expose metrics via a prometheus endpoint by following the official Temporal documentation.

  2. Edit the temporal.d/conf.yaml file located in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your Temporal performance data.

To get started, configure the openmetrics_endpoint option to match the listenAddress and handlerPath options from your Temporal server configuration.

Note that when Temporal services in a cluster are deployed independently, every service exposes its own metrics. As a result, you need to configure the prometheus endpoint for every service that you want to monitor and define a separate instance on the integration's configuration for each of them.

See the sample temporal.d/conf.yaml for all available configuration options.

Log collection

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

    logs_enabled: true

  2. Configure your Temporal Cluster to output logs to a file by following the official documentation.

  3. Uncomment and edit the logs configuration block in your temporal.d/conf.yaml file, and set the path to point to the file you configured on your Temporal Cluster:

logs:
  - type: file
    path: /var/log/temporal/temporal-server.log
    source: temporal
  1. Restart the Agent.

Validation

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

Data Collected

Metrics

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

Events

The Temporal integration does not include any events.

Service Checks

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

Logs

The Temporal integration can collect logs from the Temporal Cluster and forward them to Datadog.

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Additional helpful documentation, links, and articles: