Dynatrace supports full-stack monitoring for Kubernetes, from the application down to the infrastructure layer. However, if you don't have access to the infrastructure layer, Dynatrace also provides the option of application-only monitoring. See below for instructions on how to set up Dynatrace to monitor your applications running on Kubernetes.
Prerequisites
-
Generate an environment ID and a PaaS token
- Sign in using your Dynatrace account.
- Select Deploy Dynatrace from the left-hand menu.
- Select Set up PaaS integration.
- 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.
- 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.
- 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).
- 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 list of supported applications and versions.
Note: When deployed in application-only mode, OneAgent monitors only the memory of the processes within the container, not the total memory of the container.
Integrate OneAgent into your application
The following options explain how to integrate OneAgent with Kubernetes applications.
Integrate at container build time.
Follow the steps below to integrate OneAgent into the application image.
Sign in to Docker with your Dynatrace environment ID as username and PaaS token as password.
docker login -u <environmentID> <ACTIVEGATE-ADDRESS>
Add the following lines of code to the application image, after the last FROM command:
COPY --from=<ADDRESS>/linux/oneagent-codemodules:<TECHNOLOGY> / /
ENV LD_PRELOAD /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so
where:
<ADDRESS> is:
- EnvironmentActiveGate:
<ActiveGateaddress:9999>
- SAAS:
{yourenvid}.live.dynatrace.com
- Managed:
{ManagedAddress}
<TECHNOLOGY> is: The OneAgent code module required for your application. Valid options are all, java, apache, nginx, nodejs, dotnet, php, and go. You can specify several code modules, separated by hyphen (-), for example java-go. Including specific technology-support options, rather than support for all technology options, results in a smaller OneAgent package.
Build your application image.
Build the Docker image from your Dockerfile to use it in your Kubernetes environment.
$ docker build -t yourapp .
You can monitor your application containers with a different Dynatrace environment.
For OneAgent version 1.139 or higher, if you have an existing application image where you have already added the OneAgent code modules for a specific Dynatrace environment, you can have the OneAgent report to another Dynatrace environment without rebuilding your application image.
For this, you need to make a call to the REST endpoint of your second Dynatrace environment. Don't forget to adapt the respective placeholders <environmentID> and <token>.
$ curl "https://<environmentID>.live.dynatrace.com/api/v1/deployment/installer/agent/connectioninfo?Api-Token=<token>"
In return, you get a JSON object that covers the required information that needs to be passed as environment variable to the application container. Make sure you set the environment variables of the application container as described below:
DT_TENANT: equals tenantUUIDDT_TENANTTOKEN: equals tenantTokenDT_CONNECTION_POINT: semi-colon separated list of communicationEndpoints
Integrate at container runtime.
With the container runtime integration, OneAgent is made available to the application container via an initContainer—your application image remains unaffected.
To integrate OneAgent into your application at runtime, extend your deployment template as follows.
containers:
- name: customer-app
image: tomcat
env:
- name: LD_PRELOAD
value: /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so
volumeMounts:
- mountPath: /opt/dynatrace/oneagent
name: oneagent
initContainers:
- name: install-oneagent
image: alpine:3.8
command:
- /bin/sh
args:
- -c
- ARCHIVE=$(mktemp) && wget -O $ARCHIVE "$DT_API_URL/v1/deployment/installer/agent/unix/paas/latest?Api-Token=$DT_PAAS_TOKEN&$DT_ONEAGENT_OPTIONS" && unzip -o -d /opt/dynatrace/oneagent $ARCHIVE && rm -f $ARCHIVE
env:
- name: DT_API_URL
value: https://<Your-environment-ID>.live.dynatrace.com/api
- name: DT_PAAS_TOKEN
value: <paastoken>
- name: DT_ONEAGENT_OPTIONS
value: flavor=<FLAVOR>&include=<TECHNOLOGY>
volumeMounts:
- mountPath: /opt/dynatrace/oneagent
name: oneagent
volumes:
- name: oneagent
emptyDir: {}
-
In the # initContainer to download OneAgent and # Make OneAgent available as a volume sections, add the initContainer, which will download OneAgent and make it available as a volume.
-
In the DT_ONEAGENT_OPTIONS section, set the OneAgent code module required for your application (TECHNOLOGY). Valid options for flavor=default are all, java, apache, nginx, nodejs, dotnet, php, and go. You can specify several code modules, use the &include=<technology1>&include=<technology2> syntax for that.
Note: If you include specific technology-support options rather than 'support for all technologies' options, you'll get a smaller OneAgent package.
- In the
# your application containers section, add the newly created volume to the container of your application. Also add the LD_PRELOAD environment variable.
In case you run an environment with proxy, you need to set the DT_PROXY environment variable in the application container to pass the proxy credentials to OneAgent.
Note: For Alpine Linux-based containers, you might need to update the wget shipped with the Alpine image to allow for proxy authentication for the download of OneAgent.