Helm Check

Supported OS Linux Windows

Overview

This check monitors Helm deployments through the Datadog Agent.

Helm supports multiple storage backends. In v3, Helm defaults to Kubernetes secrets and in v2, Helm defaults to ConfigMaps. This check supports both options.

Setup

Installation

The Helm check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

This is a cluster check. For more information, see the Cluster checks documentation.

Validation

Run the Agent’s status subcommand and look for helm under the Checks section.

Data Collected

Metrics

helm.release
(gauge)
a Helm release

Events

This check emits events when the collect_events option is set to true. The default is false.

When the option is enabled, the check emits events when:

  • A new release is deployed.
  • A release is deleted.
  • A release is upgraded (new revision).
  • There’s a status change, for example from deployed to superseded.

Service Checks

helm.release_state
Returns CRITICAL for a release when its latest revision is in failed state. Returns OK otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Additional helpful documentation, links, and articles: