Cloud Foundry API

Supported OS Linux Mac OS Windows

Integration version4.0.0

Overview

This check queries the Cloud Foundry API to collect audit events and send them to Datadog through the Agent.

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

Configuration

  1. Edit the cloud_foundry_api.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Cloud Foundry API data. See the sample cloud_foundry_api.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Validation

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

Data Collected

Metrics

cloud_foundry_api.events.count
(count)
The count of events collected by this check
Shown as event

Events

The Cloud Foundry API integration collects the configured audit events.

Service Checks

cloud_foundry_api.api.can_connect
Returns OK if the check is able to connect to the API and collect audit events, CRITICAL otherwise.
Statuses: ok, critical

cloud_foundry_api.uaa.can_authenticate
Returns OK if the check is able to authenticate with the UAA server and obtain an oauth token, CRITICAL otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.