Deploy OneAgent on IBM Cloud Foundry for application-only monitoring

Applications deployed on Cloud Foundry are usually run through technology-specific buildpacks that provide framework and runtime support for applications running on the Cloud Foundry platform. For complete details, see how buildpacks work.

Note: When deployed in application-only mode, OneAgent monitors the memory, disk, CPU, and networking of processes within the container only. Host metrics aren't monitored.

Prerequisites

Generate an environment ID and a PaaS token
1. Sign in using your Dynatrace account.
2. Select Deploy Dynatrace from the left-hand menu.
3. Select Set up PaaS integration.
4. Your environment ID appears in the Environment ID text box. You'll need this ID to link your Dynatrace account with your PaaS environment. Select Copy to copy the ID to the clipboard. You can do this at any time by revisiting this page.
5. To generate a PaaS token, select Generate new token.
  The PaaS token is essentially an API token that's used in combination with your environment ID to download OneAgent. As you'll see, there's also a default InstallerDownload token available that you can alternatively use. However, for security reasons, it's recommended that you create several discrete tokens for each environment you have.
6. Enter a meaningful name for your PaaS token. A meaningful token name might be the name of the PaaS platform you want to monitor (for example, azure, cloud-foundry, or openshift).
7. Select Generate to create the PaaS token. The newly created PaaS token will appear in the list below. Select Copy to copy the generated token to the clipboard. You can do this at any time by revisiting this page and selecting Show token next to the relevant PaaS token.
Alternatively you can use the POST a new token API call to generate a token with the InstallerDownload and SupportAlert permissions.
Review the supported applications and versions.

Deploy OneAgent

Create a Dynatrace service in your IBM Cloud Foundry environment.
There are two ways of defining a service instance, choose one:

Option 1: Create a user-provided service

Create a single service instance for Dynatrace with the name dynatrace as a substring, like in the example below. You will then be prompted for your environment ID and API token. The API token corresponds to the token mentioned above.

Dynatrace SaaS Dynatrace Managed

cf cups dynatrace-service -p "environmentid, apitoken"

cf cups dynatrace-service -p "environmentid, apitoken, apiurl"

The apiurl parameter specifies the API endpoint of your Dynatrace Cluster and needs to be set to https://<YourDynatraceClusterURL>/e/<environmentID>/api.

Option 2: Create a service instance via service broker

If you want to maintain Dynatrace credentials in a central location, use a service broker. For details, visit GitHub. You need to configure and run the broker as an application, add the service broker to Cloud Foundry, enable service access to users, and finally, create the service instance.

Bind Dynatrace service to your application.

You can bind the created Dynatrace service to your application in your manifest.yml file. If your application is already started, you need to restage it.

In case of a Java application, if you're deploying to IBM Cloud Foundry, be sure to accept IBM licenses by setting the proper environment variables. For details, see the buildpack readme.

---
applications:
- name: demo-helloworld
  path: target/JavaHelloWorldApp.war
  buildpack: https://github.com/cloudfoundry/ibm-websphere-liberty-buildpack.git
  memory: 512M
  instances: 1
  host: hello-world-${random-word}
  disk_quota: 1024M
services:
  - dynatrace-service
env:
  IBM_LIBERTY_LICENSE: <liberty-license-key>
  IBM_JVM_LICENSE: <jvm-license-key>

Optional Configure the default OneAgent log stream for Cloud Foundry.

By default, OneAgent logs are written to the Cloud Foundry standard error stream. All you have to do is set the environment variable DT_LOGSTREAM to either stdout or stderr.

For example:

cf set-env APP_NAME DT_LOGSTREAM stdout

Optional Configure a proxy address.

If your environment uses a proxy, you need to set the DT_PROXY environment variable to pass the proxy credentials to OneAgent as shown below.

cf set-env <application> DT_PROXY <proxy address>

Optional Configure network zones.

You can configure network zones in two ways.

Via UserProvidedService:

cf cups dynatrace-service -p "environmentid, apitoken, networkzone"

As an environment variable per application:

cf set-env <application> DT_NETWORK_ZONE <your_network_zone>

See network zones for more information.