This document describes how to configure your Google Kubernetes Engine deploymentso that you can use Google Cloud Managed Service for Prometheus to collect metrics fromHashiCorp Consul. This document shows you how to do the following:

• Set up Consul to report metrics.
• Access a predefined dashboard in Cloud Monitoring to view the metrics.

These instructions apply only if you are usingmanaged collectionwith Managed Service for Prometheus.If you are using self-deployed collection, then see theConsul documentationfor installation information.

These instructions are provided as an example and are expected to work inmost Kubernetes environments.If you are having trouble installing anapplication or exporter due to restrictive security or organizational policies,then we recommend you consult open-source documentation for support.

For information about HashiCorp Consul, seeConsul.

Prerequisites

To collect metrics fromthe Consul exporterby usingManaged Service for Prometheus and managed collection, your deployment mustmeet the following requirements:

• Your cluster must be running Google Kubernetes Engine version 1.28.15-gke.2475000 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 Consul integration, you must useconsul version 1.13.3 or later.

  For more information about available dashboards, seeView dashboards.

Modify the Consul configuration

Modify the Consul configuration as shown in the followingexample:

#Copyright2022GoogleLLC##LicensedundertheApacheLicense,Version2.0(the"License");#youmaynotusethisfileexceptincompliancewiththeLicense.#YoumayobtainacopyoftheLicenseat##https://www.apache.org/licenses/LICENSE-2.0##Unlessrequiredbyapplicablelaworagreedtoinwriting,software#distributedundertheLicenseisdistributedonan"AS IS"BASIS,#WITHOUTWARRANTIESORCONDITIONSOFANYKIND,eitherexpressorimplied.#SeetheLicenseforthespecificlanguagegoverningpermissionsand#limitationsundertheLicense.kind:StatefulSetmetadata:name:consulspec:serviceName:consulselector:matchLabels:+app.kubernetes.io/name:consultemplate:metadata:labels:+app.kubernetes.io/name:consulspec:containers:-name:consulimage:hashicorp/consul:1.16.0ports:-containerPort:8500name:consulprotocol:TCP+volumeMounts:+-mountPath:/consul/config/metrics.hcl+subPath:metrics.hcl+name:consul-telemetry+volumes:+-name:consul-telemetry+configMap:+name:consul-telemetry+items:+-key:metrics.hcl+path:metrics.hcl

You must add any lines preceded by the+ symbol to yourconfiguration.

To apply configuration changes from a local file, run the following command:

kubectl apply -nNAMESPACE_NAME -fFILE_NAME

You can alsouse Terraformto manage your configurations.

  kubectl exec -nNAMESPACE_NAMEPOD_NAME -- curl -sS localhost:8500/v1/agent/metrics?format=prometheus

Define a PodMonitoring resource

For target discovery, the Managed Service for Prometheus Operatorrequires a PodMonitoring resource that corresponds tothe Consul exporter in the same namespace.

You can use the following PodMonitoring configuration:

# Copyright 2022 Google LLC## Licensed under the Apache License, Version 2.0 (the "License");# you may not use this file except in compliance with the License.# You may obtain a copy of the License at##     https://www.apache.org/licenses/LICENSE-2.0## Unless required by applicable law or agreed to in writing, software# distributed under the License is distributed on an "AS IS" BASIS,# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.# See the License for the specific language governing permissions and# limitations under the License.apiVersion:monitoring.googleapis.com/v1kind:PodMonitoringmetadata:name:consullabels:app.kubernetes.io/name:consulapp.kubernetes.io/part-of:google-cloud-managed-prometheusspec:endpoints:-port:8500scheme:httpinterval:30spath:/v1/agent/metricsparams:format:-prometheusselector:matchLabels:app.kubernetes.io/name:consul

To apply configuration changes from a local file, run the following command:

kubectl apply -nNAMESPACE_NAME -fFILE_NAME

You can alsouse Terraformto manage your configurations.

Verify the configuration

You can use Metrics Explorer to verify that you correctly configuredthe Consul exporter. It might take one or two minutes forCloud Monitoring to ingest your metrics.

To verify the metrics are ingested, do the following:

1. In the Google Cloud console, go to theleaderboard Metrics explorer page:

   Go toMetrics explorer

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. In the toolbar of thequery-builder pane, select the button whose name is eithercode MQL orcode PromQL.
3. Verify thatPromQL is selectedin theLanguage toggle. The language toggle is in the same toolbar thatlets you format your query.
4. Enter and run the following query:
   

   up{job="consul", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

View dashboards

The Cloud Monitoring integration includestheConsul Prometheus Overview dashboard.Dashboards are automatically installed when you configure the integration.You can also view static previews of dashboards without installing theintegration.

To view an installed dashboard, do the following:

1. In the Google Cloud console, go to thedashboard Dashboards page:

   Go toDashboards

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. Select theDashboard List tab.
3. Choose theIntegrations category.
4. Click the name of the dashboard, for example,Consul Prometheus Overview.

To view a static preview of the dashboard, do the following:

1. In the Google Cloud console, go to the Integrations page:

   Go toIntegrations

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. Click theKubernetes Engine deployment-platform filter.
3. Locate the HashiCorp Consul integration and clickView Details.
4. Select theDashboards tab.

Troubleshooting

For information about troubleshooting metric ingestion problems, seeProblems with collection from exporters inTroubleshooting ingestion-side problems.