Deploy the Dynatrace GCP metric integration in GCP Cloud Function
Dynatrace version 1.230+
Dynatrace GCP metric integration in GCP Cloud Function is not recommended for new clients and new setups. Please use other scenarios based on GKE.
As an alternative to the main deployment, that provides Google Cloud Platform monitoring for both metrics and logs, and where the deployment takes place in a GKE cluster, you can choose to set up monitoring for metrics only, in GCP Cloud Function. Note that the GCP Cloud Function deployment isn't recommended for large environments and doesn't support log forwarding. In this scenario, you will be able run the deployment script either in Google Cloud Shell or in bash. After installation, you'll get metrics, dashboards, and alerts for your configured services in Dynatrace.
For other deployment options, see Alternative deployment scenarios.
This page describes how to deploy version 1.0 of the Dynatrace GCP integration in GCP Cloud Function.
You can deploy the Dynatrace GCP integration in Google Cloud Shell or in bash.
If you use bash, you need to install
Running the deployment script requires a list of permissions. You need to create a custom role and use it to deploy
To create a custom role
Create a YAML file named
dynatrace-gcp-function-cloud-function-deployment-role.yamlwith the following content:dynatrace-gcp-function-cloud-function-deployment-role.yamlyaml
title: Dynatrace GCP Function cloud function deployment role description: Role for Dynatrace GCP function cloud function deployment stage: GA includedPermissions: - appengine.applications.get - appengine.applications.create - cloudfunctions.functions.create - cloudfunctions.functions.get - cloudfunctions.functions.list - cloudfunctions.functions.sourceCodeSet - cloudfunctions.functions.update - cloudfunctions.functions.getIamPolicy - cloudfunctions.operations.get - cloudfunctions.operations.list - cloudscheduler.locations.list - cloudscheduler.jobs.list - cloudscheduler.jobs.create - cloudscheduler.jobs.get - cloudscheduler.jobs.delete - pubsub.topics.list - pubsub.topics.create - pubsub.topics.update - secretmanager.secrets.list - secretmanager.versions.add - secretmanager.secrets.create - secretmanager.versions.list - secretmanager.secrets.getIamPolicy - secretmanager.secrets.setIamPolicy - resourcemanager.projects.get - resourcemanager.projects.getIamPolicy - resourcemanager.projects.setIamPolicy - serviceusage.services.enable - iam.serviceAccounts.actAs - iam.serviceAccounts.list - iam.serviceAccounts.create - iam.serviceAccounts.getIamPolicy - iam.serviceAccounts.setIamPolicy - iam.roles.list - iam.roles.create - iam.roles.update - monitoring.dashboards.list - monitoring.dashboards.create
Run the command below, replacing
<your_project_ID>with the project ID where you want to deploy the Dynatrace integration.bash
gcloud iam roles create dynatrace_function.cloud_function_deployment --project=<your_project_ID> --file=dynatrace-gcp-function-cloud-function-deployment-role.yaml
Note: Be sure to add this role to your GCP user. For details, see Grant or revoke a single role.
- API v1:
- Read configuration
- Write configuration
- API v2:
- Ingest metrics
- Read extensions
- Write extensions
- Read extension monitoring configurations
- Write extension monitoring configurations
- Read extension environment configurations
- Write extension environment configurations
Determine the URL for your environment.
- For Dynatrace SaaS:
- For Dynatrace Managed:
Note: To determine
<your-environment-id>, see environment ID.
You can deploy the Dynatrace GCP integration in Google Cloud Shell or in bash. To set up integration, follow the instructions below.
Note: For bash deployment, be sure to restart the console and initialize Cloud SDK before you start installation. To initialize Cloud SDK, run
Download the deployment package
wget -q "https://github.com/dynatrace-oss/dynatrace-gcp-function/releases/latest/download/function-deployment-package.zip" -O function-deployment-package.zip; unzip function-deployment-package.zip; chmod a+x *.sh
Adjust the parameters in the
activation-config.yamlfile from the deployment package.
Choose which services you want Dynatrace to monitor.
By default, the GCP integration starts monitoring a series of selected services. Uncomment any additional services you want Dynatrace to monitor in the
Note: For DDU consumption information, see Monitoring consumption.
Run the deployment script
Note: The script may ask you for confirmations during deployment. For CI/CD purposes, you can add the
-d option to make the script noninteractive.
After deploying the integration, you can see metrics from monitored services. If you want to add services to monitoring, see Change deployment settings below.
To check whether installation was successful
- In your Google Cloud console, go to Cloud Functions and make sure that
- Select the newly deployed GCP Function and go to Logs to make sure there are no error messages.
To activate alerting, you need to enable custom events for alerting in Dynatrace.
To enable custom events
- In the Dynatrace menu, go to Settings.
- In Anomaly detection, select Custom events for alerting.
- Filter for GCP alerts and turn on On/Off for the alerts you want to activate.
View enabled services
To find the list of currently enabled services, go to Cloud Function in your GCP console, and check the
ACTIVATION_CONFIG environment variable.
Change deployment settings
To add or remove services, or to update parameters, you need to redeploy the integration.
- Apply your changes to
Note: Be sure to use the same value for the
FUNCTION_NAME parameter as before.
To investigate potential deployment and connectivity issues
- Verify installation
- Enable self-monitoring optional
- Check the
dynatrace_gcp_<date_time>.loglog file created during the installation process.
- This file will be created each time the installation script runs.
- The debug information won't contain sensitive data such as the Dynatrace access key.
- If you are contacting Dynatrace ONE:
- Make sure to provide the
dynatrace_gcp_<date_time>.loglog file described in the previous step.
- Provide version information.
- For issues during installation, check the
- For issues during runtime, check function logs.
- For issues during installation, check the
- Make sure to provide the
- Go to your installation directory and run the command below.
- To remove all monitoring assets (dashboards, alerts, etc) from Dynatrace, you need to remove all GCP extensions.
To remove an extension
- In the Dynatrace menu, go to Extensions and search for the GCP extensions.
- Select an extension you want to remove, and then select the trash icon in the Actions column to remove it.
Repeat the procedure until you remove all GCP extensions.
All cloud services consume DDUs. The amount of DDU consumption per service instance depends on the number of monitored metrics and their dimensions (each metric dimension results in the ingestion of 1 data point; 1 data point consumes 0.001 DDUs). For details, see Extending Dynatrace (Davis data units).