Set up the Dynatrace GCP metric and/or log integration in a Kubernetes container (legacy)

To ingest metrics and/or logs from Google Cloud Platform, you need to deploy a container on GKE (it also works on Google Autopilot). After it's deployed, you get metrics for services defined in the configmap, preset dashboards, and predefined alerts.

Set up generic log ingestion optional

For complete observability of your workloads, be sure to set up generic log ingestion before installation. This requires additional configuration and a second container to forward the logs. See below for instructions.

1. If you are using Log Monitoring v1, enable the latest version of Dynatrace Log Monitoring.

2. Create a Pub/Sub topic and add a subscription to it. There are two ways to do this:

   In the Google Cloud Platform console

   Set up a Pub/Sub topic and add a subscription to it.

   Note: When editing the subscription, we recommend the following values:

   • Acknowledgement deadline: 120 seconds
   • Message retention duration: 1 day
   • Retain acknowledged messages: not selected
   In Google Cloud Shell

   Run the following shell script in the GCP project you've selected for deployment.

   Note: Be sure to replace <your-subscription-name> and <your-topic-name> with your own values.

   plaintextcopydownload
   wget https://raw.githubusercontent.com/dynatrace-oss/dynatrace-gcp-monitor/master/scripts/deploy-pubsub.sh
   chmod +x deploy-pubsub.sh
   ./deploy-pubsub.sh --topic-name <your-topic-name> --subscription-name <your-subscription-name>

3. Configure log export to send the desired logs to the GCP Pub/Sub topic created in Step 2.

4. If you choose to use an existing ActiveGate during deployment, configure ActiveGate for generic log ingestion.

Prerequisites

To deploy the Dynatrace GCP Monitor in a Kubernetes container, you need to make sure the following GCP and Dynatrace requirements are met.

GCP requirements

Permissions

Running the deployment script requires a list of permissions. You can create a custom role (see below) and use it to deploy dynatrace-gcp-monitor.

1. Create a YAML file named dynatrace-gcp-monitor-helm-deployment-role.yaml with the following content:

yamlcopydownload
title: Dynatrace GCP Monitor helm deployment role
description: Role for Dynatrace GCP Monitor helm and pubsub deployment
stage: GA
includedPermissions:
  - container.clusters.get
  - container.configMaps.create
  - container.configMaps.delete
  - container.configMaps.get
  - container.configMaps.update
  - container.deployments.create
  - container.deployments.delete
  - container.deployments.get
  - container.deployments.update
  - container.namespaces.create
  - container.namespaces.get
  - container.pods.get
  - container.pods.list
  - container.replicaSets.create
  - container.replicaSets.get
  - container.replicaSets.getScale
  - container.replicaSets.getStatus
  - container.replicaSets.list
  - container.secrets.create
  - container.secrets.delete
  - container.secrets.get
  - container.secrets.list
  - container.secrets.update
  - container.serviceAccounts.create
  - container.serviceAccounts.delete
  - container.serviceAccounts.get
  - container.services.create
  - container.services.delete
  - container.services.get
  - container.statefulSets.create
  - container.statefulSets.delete
  - container.statefulSets.get
  - container.statefulSets.update
  - iam.roles.create
  - iam.roles.list
  - iam.roles.update
  - iam.serviceAccounts.actAs
  - iam.serviceAccounts.create
  - iam.serviceAccounts.getIamPolicy
  - iam.serviceAccounts.list
  - iam.serviceAccounts.setIamPolicy
  - pubsub.subscriptions.create
  - pubsub.subscriptions.get
  - pubsub.subscriptions.list
  - pubsub.topics.attachSubscription
  - pubsub.topics.create
  - pubsub.topics.getIamPolicy
  - pubsub.topics.list
  - pubsub.topics.setIamPolicy
  - pubsub.topics.update
  - resourcemanager.projects.get
  - resourcemanager.projects.getIamPolicy
  - resourcemanager.projects.setIamPolicy
  - serviceusage.services.enable
  - serviceusage.services.get

2. Run the command below, replacing <your_project_ID> with the project ID where you want to deploy the dynatrace integration.

bashcopydownload
gcloud iam roles create dynatrace_monitor.helm_deployment --project=<your_project_ID> --file=dynatrace-gcp-monitor-helm-deployment-role.yaml

Note: Be sure to add this role to your GCP user.

Tools

If you run the deployment from GCP Cloud Shell, you don't need to install additional tools.

If you run the deployment from any host with bash, you need to install:

• Google Cloud SDK
• Kubernetes CLI
• Helm

Settings

If you run the deployment on an existing GKE standard cluster, you need to:

• Enable Workload Identity on a cluster
• Enable GKE_METADATA on the GKE node pools

If you run the deployment on an existing GKE Autopilot cluster, or on a new Autopilot cluster that will be automatically created by deployment script, there are no additional settings.

Dynatrace requirements

Review the requirements for ActiveGate and tokens as described below.

ActiveGate

For ActiveGate, you have two options:

• Have the installation script create a dedicated ActiveGate (default option) recommended
• Use an existing ActiveGate (version 1.213+ required)

Tokens

The requirements for API and PaaS tokens are as follows:

• Create an API token
• Enable the following permissions for the API token as needed:
  • To ingest metrics: Ingest metrics (API v2), Read configuration (API v1), Write configuration (API v1)
  • To ingest logs: Ingest logs (API v2)
  • To ingest both logs and metrics: Ingest logs (API v2), Ingest metrics (API v2), Read configuration (API v1), Write configuration (API v1)
• Create a PaaS token (if you choose to set up a new ActiveGate during deployment)

Install

To install the GCP Monitor in a Kubernetes cluster, follow the instructions below.

Download the helm deployment package in Google Cloud Shell

Determine the URL for your environment

Configure parameter values

Connect your Kubernetes cluster

Run the script

Download the helm deployment package in Google Cloud Shell

Download and run the installation script below, making sure to replace <VERSION> with the release version you want to download, for example 0.1.19.

Note: Be sure to choose one of the versions before release-1.0.0, as the newer versions require different installation instructions.

bashcopydownload
wget -q "https://github.com/dynatrace-oss/dynatrace-gcp-monitor/releases/download/release-<VERSION>/helm-deployment-package.tar"; tar -xvf helm-deployment-package.tar; chmod +x helm-deployment-package/deploy-helm.sh

Determine the 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 (if you choose to use an existing ActiveGate to ingest logs): https://<your-active-gate-IP-or-hostname>:9999/e/<your-environment-id>

Note: To determine <your-environment-id>, see environment ID.

Configure parameter values

The values.yaml file located in helm-deployment-package/dynatrace-gcp-monitor allows you to set the required and optional parameter values. See below for the complete list of parameters available for this integration.

Parameters for metrics and logs ingestion (deployment type: all)

Optional additional parameters for metrics and logs ingestion

optional

Parameters for metrics-only ingestion (deployment type: metrics)

Optional additional parameters for metrics-only ingestion

optional

Parameters for logs-only ingestion (deployment type: logs)

Optional additional parameters for logs-only ingestion

optional

Connect your Kubernetes cluster

• If you want to have a new GKE Autopilot cluster created by the deployment script, add --create-autopilot-cluster to the script. No connection is needed in this case, because the deployment script will connect to the new cluster automatically.
• If you run the deployment on an existing GKE standard cluster or an existing GKE Autopilot cluster, you can connect to your cluster from the GCP console or via terminal. Follow the instructions below.

shcopydownload
gcloud container clusters get-credentials <cluster> --region <region> --project <project>

Run the script

• If you run the deployment on an existing GKE standard cluster or an existing GKE Autopilot cluster, the script will create an IAM service account with the necessary roles and deploy dynatrace-gcp-monitor to your Kubernetes cluster.
• If you run the deployment with the --create-autopilot-cluster option, the script will automatically create the new GKE Autopilot cluster and deploy dynatrace-gcp-monitor to it.

To run the script, follow the instructions below.

bashcopydownload
cd helm-deployment-package
./deploy-helm.sh

bashcopydownload
cd helm-deployment-package
./deploy-helm.sh [--service-account <service-account-to-be-created/updated>] [--role-name <role-to-be-created/updated>]

bashcopydownload
cd helm-deployment-package
./deploy-helm.sh --create-autopilot-cluster [--autopilot-cluster-name <name-of-new-cluster>]

Verify installation

To check whether installation was successful

1. Check if the container is running.

   Note: After the installation, it may take couple of minutes until the container is up and running.

   plaintextcopydownload
   kubectl -n dynatrace get pods

2. Check the container logs for errors or exceptions. You have two options:

3. Check if dashboards are imported (for deployments of type 'metrics' or 'all').

   In the Dynatrace menu, go to Dashboards and filter by Tag for Google Cloud. A number of dashboards for Google Cloud Services should be available.

View metrics and/or logs

After deploying the integration, depending on your deployment type, you can:

• See metrics from monitored services: in the Dynatrace menu, go to Metrics.
• View and analyze GCP logs: in the Dynatrace menu, go to Logs and, to look for GCP logs, filter by cloud.provider: gcp.

Troubleshoot

To investigate potential deployment and connectivity issues, see Troubleshoot Google Cloud Platform monitoring setup.