Integrate OneAgent on Web App for Containers

Linux only

To monitor Web Apps for Containers in Azure App Services, you need to integrate OneAgent within your containerized application.

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 list of supported applications and versions
Docker version 17.05+
OneAgent version 1.155+

Install OneAgent

You can deploy OneAgent either with custom or built-in images.

Custom image Built-in image

To integrate OneAgent with the application image

Sign in to Docker with your Dynatrace environment ID as username, and with your 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, go, and sdk. 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.

What if my Docker image is based on Alpine Linux?
Dynatrace OneAgent supports Alpine Linux based environments.
Use this syntax:

COPY --from=<ACTIVEGATE-ADDRESS>/linux/oneagent-codemodules-musl:<TECHNOLOGY> / /
ENV LD_PRELOAD /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so

Valid options here are all, go, php, java, apache, nginx, and nodejs.

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 an environment variable to the application container.
Make sure you set the environment variables of the application container as described below:

DT_TENANT: equals tenantUUID
DT_TENANTTOKEN: equals tenantToken
DT_CONNECTION_POINT: semi-colon separated list of communicationEndpoints

Optional Configure network zones
You can configure network zones as an environment variable:
- DT_NETWORK_ZONE: equals your.network.zone
See network zones for more information.

Optional Configure a proxy address

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.

Create a resource group and a service plan for the web app where you want to install OneAgent.
Create the web app.

Example command:

az webapp create \
        --resource-group "$AZURE_RESOURCE_GROUP_NAME" \
        --plan "$AZURE_SERVICE_PLAN_NAME" \
        --name "$AZURE_APP_NAME" \
        --runtime "$RUNTIME" \
        --startup-file "$STARTUP_COMMAND"

where you need to replace

$AZURE_RESOURCE_GROUP_NAME, $AZURE_SERVICE_PLAN_NAME, $AZURE_APP_NAME, $RUNTIME with your own values.
$STARTUP_COMMAND with "curl -s \"${DT_API_URL}/v1/deployment/installer/agent/unix/paas-sh/latest?Api-Token=${DT_PAAS_TOKEN}&arch=x86\" -o /tmp/installer.sh && sh /tmp/installer.sh /home && LD_PRELOAD='/home/dynatrace/oneagent/agent/lib64/liboneagentproc.so' <BUILT-IN_IMAGE_STARTUP_COMMAND>". For <BUILT-IN_IMAGE_STARTUP_COMMAND> select your built-in image startup command value, as shown in built-in images in Microsoft documentation.

For more information on how to create the web app and what values to use, see the Microsoft examples.

Note: We don't recommend using the SKU free plan, as it doesn't provide enough resources for a given application and OneAgent.

Update OneAgent

Custom image Built-in image

Each time you want to leverage a new version of Dynatrace OneAgent, you must rebuild your local OneAgent code modules and application image. Any newly started pods from this application image will be monitored with the latest version of OneAgent.

If you've specified a default OneAgent installation version for new hosts and applications using OneAgent update settings, your Web Apps will be automatically monitored by the defined default version of OneAgent.

When an update is available, restart your application to update OneAgent.

Uninstall OneAgent

Custom image Built-in image

To uninstall OneAgent from application-only monitoring, remove references from your application or Docker image and redeploy the application.

Remove these two lines of code from the application image.

COPY --from=<ACTIVEGATE-ADDRESS>/linux/oneagent-codemodules:<TECHNOLOGY> / /
ENV LD_PRELOAD /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so

Rebuild the application image.

$ docker build -t yourapp .

To uninstall OneAgent

In Azure Portal, go to your web app > Configuration > General settings.
Remove your startup command (leave Startup Command empty).
Select Save.