• Home
  • Deploy Dynatrace
  • Set up Dynatrace on cloud platforms
  • Amazon Web Services
  • Integrations
  • Monitor Amazon Web Services with Amazon CloudWatch metrics
  • Integrate Amazon CloudWatch Metric Streams

Integrate Amazon CloudWatch Metric Streams

Dynatrace integration with Amazon CloudWatch Metric Streams provides a simple and safe way to ingest AWS metrics. Amazon CloudWatch Metric Streams allows all metrics issued in a given AWS region to be streamed through Kinesis Firehose to the Dynatrace API.

ActiveGate isn't required for this integration.

Prerequisites

  • Create an API token in your Dynatrace environment and enable the Ingest metrics permission.
  • Determine the API URL for your environment:
    • For Dynatrace SaaS
      https://<your_environment_ID>.live.dynatrace.com
    • For Dynatrace Managed
      https://<your_domain>/e/<your_environment_ID>
    • For ActiveGate
      https://<your_active_gate_IP_or_hostname>:9999/e/<your_environment_ID>

To determine <your_environment_ID>, see environment ID.

Note: You need to have your Dynatrace tenant open to incoming Internet traffic (or at least to AWS traffic) to be able to receive the AWS metrics. Restrictive firewalls might block the streaming service.

Set up a Metric Streams client

You can set up a Metric Streams client with a CloudFormation template or in the AWS console. See below for instructions.

CloudFormation allows you to deploy a Metric Streams client using a single deployment command to create a stack that groups multiple AWS resources. This approach is faster and makes AWS resource management easier.

You need one client stack for each region you want to monitor. Once deployed, the client starts streaming all metrics produced in its region. You can restrict which metrics are streamed.

Deploy the Metric Streams client for a default region

To fetch the CloudFormation template and deploy it to your AWS account, run the command below. Be sure to replace <your_API_URL> and <your_API_token> with your own values. Consult the parameters table that follows for details.

Note: If you have AWS CLI configured, you can use a Bash-compliant shell. Otherwise, you can use CloudShell, which is available in the AWS console.

Parameters...
ParameterDescriptionDefault value
DYNATRACE_ENV_URLrequired Your API URL. See Prerequisites for instructions.
DYNATRACE_API_KEYrequired Your API token. See Prerequisites for instructions.
STACK_NAMErequired The name of your client stack.dynatrace-aws-metric-streams-client
REQUIRE_VALID_CERTIFICATEoptional If set to true, Dynatrace verifies the SSL certificate of your Dynatrace environment URL.true
DELIVERY_ENDPOINToptional One of these Metric Streams endpoints for Dynatrace:
Global: https://aws.cloud.dynatrace.com/
US: https://us.aws.cloud.dynatrace.com/
EU: https://eu.aws.cloud.dynatrace.com/
https://aws.cloud.dynatrace.com/
plaintext
DYNATRACE_ENV_URL=<your_API_URL> DYNATRACE_API_KEY=<your_API_token> STACK_NAME=dynatrace-aws-metric-streams-client DELIVERY_ENDPOINT=https://aws.cloud.dynatrace.com/ REQUIRE_VALID_CERTIFICATE=true wget -O dynatrace-aws-metric-streams-client.yaml https://assets.cloud.dynatrace.com/awsmetricstreaming/dynatrace-aws-metric-streams-client.yaml && \ aws cloudformation deploy --capabilities CAPABILITY_NAMED_IAM --template-file ./dynatrace-aws-metric-streams-client.yaml --stack-name $STACK_NAME --parameter-overrides DynatraceEnvironmentUrl=$DYNATRACE_ENV_URL DynatraceApiKey=$DYNATRACE_API_KEY RequireValidCertificate=$REQUIRE_VALID_CERTIFICATE FirehoseHttpDeliveryEndpoint=$DELIVERY_ENDPOINT

Deploy the Metric Streams client for other regions

The command above uses the default AWS CLI profile and its default region. To change the profile and region, you can export additional variables such as AWS_DEFAULT_REGION and AWS_PROFILE and rerun the deployment command. If you are using CloudShell, you can change the region in the AWS console instead. For details on how to configure the AWS CLI, see Environment variables to configure the AWS CLI.

Confirm that the Metric Streams client was deployed correctly optional

To ensure that the Metric Streams client was deployed correctly

  1. In the AWS console, go to CloudFormation.
  2. Select the stack you created in the CloudFormation deployment.
  3. On the Events tab, make sure all events completed successfully and there are no failed events.
  4. In Parameters tab, make sure all parameters you provided have correct values.

Restrict which metrics are streamed

If you want to restrict which metrics are streamed

  1. In the AWS console, go to CloudFormation.
  2. Select the stack you created in the CloudFormation deployment.
  3. On the Resources tab, find the resource with type AWS::CloudWatch::MetricStream and note its Physical ID.
  4. Go to CloudWatch.
  5. Under Metrics, select Streams.
  6. In the list of metric streams, select the one whose Name corresponds to the Physical ID that you noted in step 3 and then select Edit.
  7. Under Metrics to be streamed, select one of the following options:
    • All metrics, if you want to automatically stream all namespaces (you can manually select namespaces to exclude).
    • Selected namespaces, if you want to manually select the namespaces to stream.
  8. Select Save changes.

If you don't have access to the CloudFormation template, you can manually set up a Metric Streams client in the AWS console. Follow the steps below for instructions.

Create a Kinesis Data Firehose stream

Create a CloudWatch Metric Stream

Note: For each region that you want to monitor, you need to repeat the entire procedure: create a Kinesis Data Firehose stream and create a CloudWatch Metric Stream.

Create a Kinesis Data Firehose stream

  1. In the AWS console, go to Kinesis.
  2. Select Create delivery stream.

. Name and source

  1. Enter a stream name and save it for later use.
  2. In Source, make sure Direct PUT or other sources is selected.
  3. Select Next.

. Process records

  1. Make sure Data Transformation and Record format conversion are disabled.
  2. Select Next.

. Choose a destination

  1. Select Third-party service provider and choose Dynatrace.

  2. In HTTP endpoint URL, select one of available Dynatrace endpoints (Global, EU, US).

  3. In Access key, enter your API token. See Prerequisites for instructions.

  4. In Content encoding, make sure GZIP is selected.

  5. optional In Parameters, select Add parameter and enter the parameters and their values as follows:

    ParameterDescription
    dt-urlYour API URL. See Prerequisites for instructions.
    require-valid-certificateEnter true or false. If set to true, Dynatrace verifies the SSL certificate of your Dynatrace environment URL.
  6. In Retry duration, enter 900.

  7. In S3 backup mode, make sure Failed data only is selected.

  8. In S3 bucket, select Create new.

  9. Enter a name and (optionally) a region for the S3 bucket, and then select Create S3 bucket.

  10. Select Next.

. Configure settings

  1. Use the existing default settings.
  2. optional In Tags, enter tags to organize your AWS resources.
  3. Select Next.

. Review

  1. Review your configuration.
  2. Select Create delivery stream.

Create a CloudWatch Metric Stream

  1. In the AWS console, go to CloudWatch.
  2. Under Metrics, select Streams.
  3. Select Create metric stream.
  4. Select one of the options below:
    • All metrics, if you want to automatically stream all namespaces (you can manually select namespaces to exclude).
    • Selected namespaces, if you want to manually select the namespaces to stream.
  5. In Configuration, select Select an existing Firehose owned by your account and enter the name of the Firehose stream that you created in the previous section.
  6. In Change output format, make sure Open Telemetry 0.7 is selected.
  7. In Metric stream name, enter a name for your metric stream.
  8. Select Create metric stream.

View metrics using preset dashboards

Once you deploy the Metric Streams client, you can use the predefined dashboards from the GitHub repository in the Dynatrace web UI to visualize your ingested data.

Prerequisites
  • Install Python 3 (no additional libraries are required)
  • Enable the Read configuration and Write configuration permissions for your API token

To upload preset dashboards from GitHub

  1. Get upload_dashboards.py from the GitHub repository.
bash
curl -o upload_dashboards.py https://raw.githubusercontent.com/Dynatrace/snippets/master/product/dashboarding/upload_dashboards.py
  1. Create a dashboards directory next to upload_dashboards.py.

  2. Add any dashboard definition from GitHub to your dashboards directory.
    Note: Each dashboard definition is a single JSON file located in the folders of the GitHub repository.

  3. Run the script below. Be sure to replace <your_dynatrace_cluster_version>, <your_API_token>, and <your_API_URL> with your own values. Consult the parameters table that follows for details.

Parameters...
ParameterDescription
cluster-versionThe minor version of your Dynatrace Cluster. For instance, for version 1.210.1.xxxxx, you need to provide 210.
dynatrace-api-tokenYour API token. See Prerequisites for instructions.
dynatrace-env-urlYour API URL. See Prerequisites for instructions.
bash
python3 upload_dashboards.py --cluster-version <your_dynatrace_cluster_version> --dynatrace-api-token <your_API_token> --dynatrace-env-url <your_API_URL>

Example command

bash
python3 upload_dashboards.py --cluster-version 206 --dynatrace-api-token 123456789 --dynatrace-env-url https://my-cluster.com/e/1755ddb2-7938-41a2-b6bd-096e0fdcd3e0

Uninstall the Metric Streams client

If you deployed the Metric Streams client with a CloudFormation template

  1. In the AWS console, go to CloudFormation.
  2. Select the stack you created in the CloudFormation deployment.
  3. In Resources, find the resource with type AWS::S3::Bucket, select its link, and, in the S3 console, delete all objects in this bucket.
  4. Back in CloudFormation, in Stack information, select Delete.

If you deployed the Metric Streams client through the AWS console, delete all the resources you created (S3 bucket, Kinesis Firehose delivery stream, CloudWatch metric stream).

Metric Streams limitations

A metric won't be streamed if it is more than two hours old. You can determine a metric's age by graphing it in the CloudWatch console and checking the age of the last datapoint displayed.

For more limitations, see Amazon CloudWatch troubleshooting page

Related topics
  • Amazon Web Services Integrations

    Integrate Dynatrace on AWS