This document describes how to configure your Google Kubernetes Engine deployment so that you can use Google Cloud Managed Service for Prometheus to collect metrics from Workflows Controller. This document shows you how to do the following:
- Set up Workflows Controller to report metrics.
- Configure a PodMonitoring resource for Managed Service for Prometheus to collect the exported metrics.
- Access a dashboard in Cloud Monitoring to view the metrics.
- Configure alerting rules to monitor the metrics.
These instructions apply only if you are using managed collection with Managed Service for Prometheus. If you are using self-deployed collection, then see the Workflows documentation for installation information.
These instructions are provided as an example and are expected to work in most Kubernetes environments. If you are having trouble installing an application or exporter due to restrictive security or organizational policies, then we recommend you consult open-source documentation for support.
For information about Workflows, see Argo Workflows.
Prerequisites
To collect metrics from Workflows Controller by using Managed Service for Prometheus and managed collection, your deployment must meet the following requirements:
- Your cluster must be running Google Kubernetes Engine version 1.21.4-gke.300 or later.
- You must be running Managed Service for Prometheus with managed collection enabled. For more information, see Get started with managed collection.
- To use dashboards available in Cloud Monitoring for the
Workflows integration, you must use
argo-workflows
version v3.4.3 or later.For more information about available dashboards, see View dashboards.
Set up port forwarding by using the following command:
kubectl -n NAMESPACE_NAME port-forward POD_NAME 9090
Access the endpoint
localhost:9090/metrics
by using the browser or thecurl
utility in another terminal session.
Define a PodMonitoring resource
For target discovery, the Managed Service for Prometheus Operator requires a PodMonitoring resource that corresponds to the Workflows exporter in the same namespace.
You can use the following PodMonitoring configuration:
Ensure that the values of theport
and matchLabels
fields match those of the Workflows pods you wish to monitor.
By default, Workflows exposes metrics on port 9090 and includes the label app: workflow-controller
.
To apply configuration changes from a local file, run the following command:
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
You can also use Terraform to manage your configurations.
Define rules and alerts
You can use the following Rules
configuration to define
alerts on your Workflows metrics:
To apply configuration changes from a local file, run the following command:
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
You can also use Terraform to manage your configurations.
For more information about applying rules to your cluster, see Managed rule evaluation and alerting.
You can adjust the alert thresholds to suit your application.Verify the configuration
You can use Metrics Explorer to verify that you correctly configured the Workflows exporter. It might take one or two minutes for Cloud Monitoring to ingest your metrics.
To verify the metrics are ingested, do the following:
-
In the Google Cloud console, go to the leaderboard Metrics explorer page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
- In the toolbar of the query-builder pane, select the button whose name is either code MQL or code PromQL.
- Verify that PromQL is selected in the Language toggle. The language toggle is in the same toolbar that lets you format your query.
- Enter and run the following query:
up{job="argo-workflows-controller", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}
View dashboards
The Cloud Monitoring integration includes the Workflows Prometheus Overview dashboard. Dashboards are automatically installed when you configure the integration. You can also view static previews of dashboards without installing the integration.
To view an installed dashboard, do the following:
-
In the Google Cloud console, go to the Dashboards page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
- Select the Dashboard List tab.
- Choose the Integrations category.
- Click the name of the dashboard, for example, Workflows Prometheus Overview.
To view a static preview of the dashboard, do the following:
-
In the Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
- Click the Kubernetes Engine deployment-platform filter.
- Locate the Argo Workflows integration and click View Details.
- Select the Dashboards tab.
Troubleshooting
For information about troubleshooting metric ingestion problems, see Problems with collection from exporters in Troubleshooting ingestion-side problems.