Agent Check: Boundary

Overview

This check monitors Boundary through the Datadog Agent. The minimum supported version of Boundary is 0.8.0.

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

Configuration

Listener

A listener with an ops purpose must be set up in the config.hcl file to enable metrics collection. Here's an example listener stanza:

controller {
  name = "boundary-controller"
  database {
    url = "postgresql://<username>:<password>@10.0.0.1:5432/<database_name>"
  }
}

listener "tcp" {
  purpose = "api"
  tls_disable = true
}

listener "tcp" {
  purpose = "ops"
  tls_disable = true
}

The boundary.controller.health service check submits as WARNING when the controller is shutting down. To enable this shutdown grace period, update the controller block with a defined wait duration:

controller {
  name = "boundary-controller"
  database {
    url = "env://BOUNDARY_PG_URL"
  }
  graceful_shutdown_wait_duration = "10s"
}

Datadog Agent

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

2. Restart the Agent.

Validation

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

Data Collected

Metrics

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

Events

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