VMware Tanzu Application Service
Overview
Any VMware Tanzu Application Service (formerly known as Pivotal Cloud Foundry, see the VMware announcement for more information) deployment can send metrics and events to Datadog. You can track the health and availability of all nodes in the deployment, monitor the jobs they run, collect metrics from the Loggregator Firehose, and more.
For the best experience, use this page to automatically set up monitoring through Tanzu Ops Manager for your application on VMware Tanzu Application Service and your VMware Tanzu Application Service cluster. For manual setup steps, see the VMware Tanzu Application Service Manual Setup Guide.
There are three main components for the VMware Tanzu Application Service integration with Datadog. First, the buildpack is used to collect custom metrics from your applications. Second, the BOSH Release collects metrics from the platform. Third, the Loggregator Firehose Nozzle collects all other metrics from your infrastructure. Read the Datadog VMware Tanzu Application Service architecture guide for more information.
Monitor your applications
Use the VMware Tanzu installation and configuration guide to install the integration through the Tanzu Ops Manager. For manual setup steps, read the Monitor your applications section in the manual setup guide.
Configuration
Metric collection
Set an API Key in your environment to enable the buildpack:
# set the environment variable
cf set-env <YOUR_APP> DD_API_KEY <DATADOG_API_KEY>
# restage the application to make it pick up the new environment variable and use the buildpack
cf restage <YOUR_APP>
Trace and profile collection
The Datadog Trace Agent (APM) is enabled by default. Learn more about setup for your specific language in APM setup and Profiling setup.
Log collection
Log collection is not supported for this site.
Enable log collection
To start collecting logs from your application in VMware Tanzu Application Service, the Agent contained in the buildpack needs to be activated and log collection enabled.
cf set-env <YOUR_APP_NAME> DD_LOGS_ENABLED true
# Disable the Agent core checks to disable system metrics collection
cf set-env <YOUR_APP_NAME> DD_ENABLE_CHECKS false
# Redirect Container Stdout/Stderr to a local port so the Agent collects the logs
cf set-env <YOUR_APP_NAME> STD_LOG_COLLECTION_PORT <PORT>
# Configure the Agent to collect logs from the wanted port and set the value for source and service
cf set-env <YOUR_APP_NAME> LOGS_CONFIG '[{"type":"tcp","port":"<PORT>","source":"<SOURCE>","service":"<SERVICE>"}]'
# restage the application to make it pick up the new environment variable and use the buildpack
cf restage <YOUR_APP_NAME>
The following table describes the parameters above, and how they can be used to configure log collection:
| Parameter | Description |
|---|
DD_LOGS_ENABLED | Set to true to enable Datadog Agent log collection. |
DD_ENABLE_CHECKS | Set to false to disable the Agent’s system metrics collection through core checks. |
STD_LOG_COLLECTION_PORT | Must be used when collecting logs from stdout or stderr. It redirects the stdout or stderr stream to the corresponding local port value. |
LOGS_CONFIG | Use this option to configure the Agent to listen to a local TCP port and set the value for the service and source parameters. |
Example:
A Java application named app01 is running in VMware Tanzu Application Service. The following configuration redirects the container stdout/stderr to the local port 10514. It then configures the Agent to collect logs from that port while setting the proper value for service and source:
# Redirect Stdout/Stderr to port 10514
cf set-env app01 STD_LOG_COLLECTION_PORT 10514
# Configure the Agent to listen to port 10514
cf set-env app01 LOGS_CONFIG '[{"type":"tcp","port":"10514","source":"java","service":"app01"}]'
For Agent version 6.12 or greater, when using a proxy configuration with the buildpack, a verification is made to check if the connection can be established. Log collection is started depending on the result of this test.
If the connection fails to establish and log collection does not start, an event like this appears in the Events Explorer. Set up a monitor to track these events and be notified when a misconfigured Buildpack is deployed:
In order to add custom tags to your application, set the DD_TAGS environment variable through the manifest.yml file or the CF CLI command:
# set the environment variable
cf set-env <YOUR_APP> DD_TAGS key1=value1,key2=value2
# restage the application to make it pick up the new environment variable and use the new tags
cf restage <YOUR_APP>
DogStatsD
You can use DogStatsD to send custom application metrics to Datadog. See Metric Submission: DogStatsD for more information. There is a list of DogStatsD libraries compatible with a wide range of applications.
Monitor your VMware Tanzu Application Service cluster
Use the VMware Tanzu installation and configuration guide to install the integration through the Tanzu Ops Manager. For manual setup steps, read the Monitor your VMware Tanzu Application Service cluster section in the manual setup guide.
Data Collected
Metrics
The following metrics are sent by the Datadog Firehose Nozzle and are prefixed with cloudfoundry.nozzle. The Datadog Agent sends metrics from any Agent checks you configure in the Director runtime configuration, and system, network, disk, and NTP metrics by default.
The Datadog Firehose Nozzle only collects CounterEvents (as metrics, not events), ValueMetrics, and ContainerMetrics; it ignores LogMessages and Errors.
Your specific list of metrics may vary based on the PCF version and the deployment. Datadog collects counter and gauge metrics emitted from the Loggregator v2 API. See Cloud Foundry Component Metrics for a list of metrics emitted by default.
Further reading
Additional helpful documentation, links, and articles:
