Velero

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 Velero. This document shows you how to do the following:

• Set up Velero to report metrics.
• Access a predefined 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 Velero 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 Velero, see Velero.

Prerequisites

To collect metrics from the Velero Prometheus exporter 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.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 Velero integration, you must use velero version v1.7.1 or later.

  For more information about available dashboards, see View dashboards.

1. Set up port forwarding by using the following command:

    kubectl -n NAMESPACE_NAME port-forward deploy/velero 8085 

2. Access the endpoint localhost:8085/metrics by using the browser or the curl 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 Velero Prometheus exporter in the same namespace.

You can use the following PodMonitoring configuration:

# Copyright 2024 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 # # http://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/v1 kind: PodMonitoring metadata:  name: velero  labels:  app.kubernetes.io/name: velero  app.kubernetes.io/part-of: google-cloud-managed-prometheus spec:  endpoints:  - port: metrics  scheme: http  interval: 30s  path: /metrics  selector:  matchLabels:  deploy: velero 

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 Velero metrics:

# Copyright 2024 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 # # http://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/v1 kind: Rules metadata:  name: velero-rules  labels:  app.kubernetes.io/component: rules  app.kubernetes.io/name: velero-rules  app.kubernetes.io/part-of: google-cloud-managed-prometheus spec:  groups:  - name: velero  interval: 30s  rules:  - alert: VeleroBackupFailure  annotations:  description: |-  Velero backup failure  VALUE = {{ $value }}  LABELS: {{ $labels }}  summary: Velero backup failure (instance {{ $labels.instance }})  expr: velero_backup_failure_total > 0  for: 5m  labels:  severity: critical  - alert: VeleroPartialBackupFailure  annotations:  description: |-  Velero partial backup failure  VALUE = {{ $value }}  LABELS: {{ $labels }}  summary: Velero partial backup failure (instance {{ $labels.instance }})  expr: velero_backup_partial_failure_total > 0  for: 5m  labels:  severity: warning  - alert: VeleroRestoreFailure  annotations:  description: |-  Velero restore failure  VALUE = {{ $value }}  LABELS: {{ $labels }}  summary: Velero restore failure (instance {{ $labels.instance }})  expr: velero_restore_failed_total > 0  for: 5m  labels:  severity: critical 

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.

Verify the configuration

You can use Metrics Explorer to verify that you correctly configured the Velero Prometheus exporter. It might take one or two minutes for Cloud Monitoring to ingest your metrics.

To verify the metrics are ingested, do the following:

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

   Go to Metrics explorer

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

2. In the toolbar of the query-builder pane, select the button whose name is either code MQL or code PromQL.
3. Verify that PromQL is selected in the Language toggle. The language toggle is in the same toolbar that lets you format your query.
4. Enter and run the following query:
   

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

View dashboards

The Cloud Monitoring integration includes the Velero 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:

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

   Go to Dashboards

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

2. Select the Dashboard List tab.
3. Choose the Integrations category.
4. Click the name of the dashboard, for example, Velero 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 to Integrations

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

2. Click the Kubernetes Engine deployment-platform filter.
3. Locate the Velero integration and click View Details.
4. Select the Dashboards tab.

Troubleshooting

For information about troubleshooting metric ingestion problems, see Problems with collection from exporters in Troubleshooting ingestion-side problems.