Deploy OneAgent on AWS Fargate and AWS App Runner

To deploy OneAgent on AWS Fargate or App Runner, read the instructions provided below.

Prerequisites

• Create an API token in your Dynatrace environment and enable the following permissions:
  • Access problem and event feed, metrics, and topology (API v1)
  • PaaS integration - Installer download
• Review the list of supported applications and versions.

Integrate OneAgent into your application image

There are three ways to integrate OneAgent with AWS Fargate applications.

Note: For AWS App Runner, you can only use the build-time injection.

• Automatic injection (for EKS only) manages upgrades and lifecycle.

• Build-time injection (for ECS, EKS, and App Runner) embeds OneAgent into your container image.

  Build-time injection

  Docker multi-stage image buildsClassic integration

  To use this option you need:

  • Docker version 17.05+.
  • OneAgent version 1.155+.

  1. Sign in to Docker with your Dynatrace environment ID as username and PaaS token as password.

     bashcopydownload
     docker login -u <your-environment-id> <your-environment-url>

  2. Add two additional lines of code to the application image, after the last FROM command:

     bashcopydownload
     COPY --from=<your-environment-url>/linux/oneagent-codemodules:<technology> / /
     ENV LD_PRELOAD /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so

     Note:

     • Replace <your-environment-url> with the URL or IP address of your environment or of your ActiveGate.

       • SaaS {your-environment-id}.live.dynatrace.com¹

       • Managed {your-domain}/e/{your-environment-id}¹

         ¹

         If you use your own environment ActiveGate, use the <ip-address>:9999 or <hostname>:9999 format.

     • Replace <technology> with the code module required for your application. Valid options are all, java, apache, nginx, nodejs, dotnet, php, sdk, 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.

     What if my Docker image is based on Alpine Linux?

     Dynatrace OneAgent supports Alpine Linux based environments. Use this syntax:

     bashcopydownload
     COPY --from=<your-activegate>/linux/oneagent-codemodules-musl:<technology> / /
     ENV LD_PRELOAD /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so

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

  3. Build your application image.

     Build the Docker image from your dockerfile to use it in your Kubernetes environment:

     bashcopydownload
     docker build -t yourapp .

     Note: You can monitor your application containers with a different Dynatrace environment. To do this, read the instructions below:

     For OneAgent version 1.139+, if you have an existing application image where you've 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. Make sure to adapt the respective placeholders <your-environment-id> and <your-paas-token>.

     bashcopydownload
     curl "https://<your-environment-id>.live.dynatrace.com/api/v1/deployment/installer/agent/connectioninfo?Api-Token=<your-paas-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

  1. Add the following commands to your current Dockerfile to integrate OneAgent and activate instrumentation of your application. Define variables with optional default values using ARG instructions.

     bashcopydownload
     ARG DT_API_URL="https://<your-environment-id>.live.dynatrace.com/api"
     ARG DT_API_TOKEN="<your-paas-token>"
     ARG DT_ONEAGENT_OPTIONS="flavor=default&include=<technology1>&include=<technology2>"
     ENV DT_HOME="/opt/dynatrace/oneagent"
     RUN mkdir -p "$DT_HOME" && \
         wget -O "$DT_HOME/oneagent.zip" "$DT_API_URL/v1/deployment/installer/agent/unix/paas/latest?Api-Token=$DT_API_TOKEN&$DT_ONEAGENT_OPTIONS" && \
         unzip -d "$DT_HOME" "$DT_HOME/oneagent.zip" && \
         rm "$DT_HOME/oneagent.zip"
     ENTRYPOINT [ "/opt/dynatrace/oneagent/dynatrace-agent64.sh" ]
     CMD [ "executable", "param1", "param2" ] # the command of your application, for example, Java

     Notes:

     • The commands above that use wget and unzip might fail if they aren't provided by the base image.

     • Replace <your-environment-id> with your Dynatrace environment ID. If you're using Dynatrace Managed, you need to provide your Dynatrace Cluster URL (https://<YourDynatraceServerURL>/e/<your-environment-id>/api).

     • Replace <your-paas-token> with your PaaS token.

     • DT_ONEAGENT_OPTIONS - this is the flavor (valid options are default or musl for Alpine images) and the technology (code module).

       • Syntax for default is flavor=default&include=all.
       • Syntax for musl is flavor=musl&include=all.

     What if my Docker image is based on Alpine Linux?

     Dynatrace OneAgent supports the flavor musl for Alpine Linux based environments. Valid options for flavor=musl are all, go, java, apache, nginx, and nodejs.

  2. Build your application image.

     Build the Docker image from your dockerfile to use it in your Kubernetes environment:

     bashcopydownload
     docker build -t yourapp .

     Note: You can monitor your application containers with a different Dynatrace environment. To do this, read the instructions below:

     For OneAgent version 1.139+, if you have an existing application image where you've 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. Make sure to adapt the respective placeholders <your-environment-id> and <your-paas-token>.

     bashcopydownload
     curl "https://<your-environment-id>.live.dynatrace.com/api/v1/deployment/installer/agent/connectioninfo?Api-Token=<your-paas-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

• Runtime injection (for ECS only) pulls OneAgent when the container starts.

  Runtime injection

  To install Dynatrace OneAgent at runtime, you must deploy your application using a task with two container definitions. One is for downloading and unzipping the OneAgent to a shared volume, the other is your application container, which must mount the same volume.

  For the runtime injection, follow the steps below.

  1. Go to Fargate Task Definition > Create New Task Definition > select Fargate > click Next Step.

  2. Name the task, optionally set roles and sizes, then scroll down to Volumes > Add volume. Add a volume of type Bind Mount named oneagent.

     Note: You must create a volume before creating container definitions in order to set the shared volume in each container.

  3. Scroll up to Container Definition > choose Add container, and in the Standard subsection, add a container named install-oneagent, set the image to Alpine versions 3.8+ ("alpine:3"), and select the memory limits.

     Note: There are two types of memory limits: soft and hard. ECS requires that you define the limit for at least one type of memory. We recommend using the default setting (soft limit of 128 MiBs), as it's less restrictive, but you can adjust it as needed.

  4. Scroll to Environment and do the following:

     • Uncheck the Essential parameter.

     • In the Entry point field, enter /bin/sh,-c.

     • In the Command field, enter 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.

  5. In the Environment variables subsection, define:

     • DT_API_URL - this is the API URL for your Dynatrace environment.

       • For SaaS: https://<your-environment-id>.live.dynatrace.com/api
       • For Managed: https://<cluster>/e/<your-environment-id>/api
       • For ActiveGate: https://<your-active-gate-IP-or-hostname>:9999/e/<your-environment-id>/api.

     • DT_ONEAGENT_OPTIONS- this is the flavor (valid options are default or musl for Alpine images) and the technology (code module).

       • Syntax for default is flavor=default&include=all.
       • Syntax for musl is flavor=musl&include=all.

     • DT_PAAS_TOKEN - this is your PaaS token to download the OneAgent code modules.

  6. Scroll to Storage and logging to define the mount point with the source volume oneagent and the container path /opt/dynatrace/oneagent.

  7. Click Add to create the container definition.

  8. Choose Add container again, this time to define your application, and complete the fields in the Standard subsection according to your application requirements.

  9. Scroll to Environment, and in Environment variable, define LD_PRELOAD with the value /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so.

  10. Scroll to Startup Dependency Ordering and enter the container name install-oneagent and the condition Complete.

  11. Scroll to Storage and logging to define the mount point with the source volume oneagent and the container path /opt/dynatrace/oneagent.

  12. Select Update to update your container definition.

  13. Deploy the new version of your task definition on your ECS cluster.

  Note:

  • On the Logs tab for the install-oneagent container, you can see the code modules' ZIP file being downloaded by wget and being unzipped.
  • On the Logs tab for your application workload container, you can see the code module being loaded by the process.

  In the Dynatrace web UI, your Fargate application workload container will show up in the Hosts section. The instrumented process will show up in Processes as a typical Docker container.

  

Note: The runtime approach requires Fargate versions 1.3+. For earlier versions, select the build-time approach.

Configure network zones optional

You can configure network zones as an environment variable:

• DT_NETWORK_ZONE: equals your.network.zone

See network zones for more information.