To deploy OneAgent on AWS Elastic Container Service (ECS) clusters with EC2 launch type, follow the instructions below.
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,
- 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
- ECS cluster with Linux-based container instances.
- Review the list of supported applications and versions.
- Create the
ecsinstanceRoleIAM role in the ECS console.
Deploy OneAgent as a daemon service
This approach describes the installation of OneAgent as a daemon service in its own container. ECS orchestrates the execution of the OneAgent task on each container instance that is part of the cluster.
On the ECS console, go to Task Definitions > Create new Task Definition. Select EC2 and then Next step.
In Configure task and container definitions, enter the following values:
- Task Definition Name:
- Network Mode:
- Scroll down to Volumes. Click Add volume and enter the following values:
- Volume type:
- Source path:
Click Add to add the volume.
- Scroll to Container Definitions and click Add container. In the Standard section, enter the following values:
- Container name:
- Memory limits: as needed
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 256 MiBs), as it's less restrictive, but you can adjust this setting as needed.
- In the Advanced container configuration section, go to Environment. Make sure that Essential is selected.
In Environment variables, define
ONEAGENT_INSTALLER_SCRIPT_URLdepending on how you connect to Dynatrace:
- For SaaS:
- For Managed:
- For ActiveGate:
Note: If you connect via an ActiveGate, you can skip the certificate check by adding the
ONEAGENT_INSTALLER_SKIP_CERT_CHECK key with the value
Add OneAgent installer parameters.
While still in Environment variables, you can customize your OneAgent installation by adding several OneAgent installer parameters in the command text box. Make sure to separate each parameter by a space. For example,
--set-infra-only=true --set-app-log-content-access=false --set-network-zone=<your.network.zone>.
Note: Set the
--set-network-zone=<your.network.zone> parameter if you want to configure network zones. See network zones for more information.
- Go to Storage and logging and enter the following values in Mount point:
- Source volume:
- Container path:
Scroll down to Security and set the container to run in Privileged mode.
Click Add to add the container definition.
While still in the task definition, go back to Volumes and click Configure via JSON. Add the following two parameters at the root level (for example, before the
"ipcMode": "host", "pidMode": "host",
Click Save to save the JSON configuration.
Click Create to save your task definition.
In the Task definitions menu, select the newly created OneAgent task and then click Actions > Create service. This will create a service to run your task.
In Configure service, enter the following values:
- Launch type:
- Task Definition:
- Service type:
- Service name: give a name to the the service.
Leave the rest of the settings set as they are by default. Follow the remaining steps until you reach and select Create service.
Once the service is created, the associated tasks will be executed. The
oneagent service creates a task to deploy OneAgent on each container instance of your cluster.
You can see the container instances displayed on the ECS cluster dashboard, and the corresponding hosts in your Dynatrace monitoring environment.
- After deploying OneAgent, restart the running application tasks to get service-level visibility.
See Docker security implications for details.
See Docker limitations for details.