Search…
2.10.X
Observability
This section describes how to measure and monitor TrilioVault for Kubernetes.

Trilio Metrics Exporter for Prometheus

Trilio Metrics Exporter is a component of TrilioVault for Kubernetes written in Golang to export TrilioVault metrics. The project is based on the official Prometheus client library: prometheus_client.
Trilio Metrics Exporter runs as a separate deployment and is installed by the Operator as part of the installation process. A complete list of Prometheus metrics and their details are provided in the Appendix section - TrilioVault Prometheus Metrics
In order to leverage the OpenShift built-in Prometheus instance hosted in the openshift-monitoring namespace, extra permissions will be required for the service account (openshift-monitoring:prometheus-k8s) to pull metrics from the openshift-operators namespace, where TrilioVault is deployed.

Consuming Metrics - Inside the Cluster

There are two methods to scrape the metrics from Trilio Exporter:

Using Annotations

Prometheus can discover any metric in cluster exporter using the standard annotation set on the exporter pod.
The annotations are described below:
  • prometheus.io/scrape: The default configuration will scrape all pods and, if set to false, this annotation will exclude the pod from the scraping process.
  • prometheus.io/path: If the metrics path is not /metrics, define it with this annotation.
  • prometheus.io/port: Scrape the pod on the indicated port instead of the pod’s declared ports, Here it is 8080.
TrilioVault for Kubernetes has pre-configured the above annotations on the Metrics Exporter pod. If you have a cluster with Prometheus already installed and configured, then your Prometheus instance should start collecting TrilioVault for Kubernetes metrics without any configuration change.

Using Scrape Job

You will need to configure a prometheus server to scrape the metrics from your newly running exporter. Add the following scrape job to your prometheus.yml configuration file.
- job_name: trilio_exporter
scrape_interval: 30s
file_sd_configs:
static_configs:
- targets: ['EXPORTER_ADDRESS:8080']
EXPORTER_ADDRESS is the IP of the Prometheus exporter pod which can be found by running the following
#kubectl get pod -o wide |grep -i export
k8s-triliovault-exporter-787c7dd446-bcgkr 1/1 Running 0 6d4h 192.168.140.126 slave2 <none> <none>

Using ServiceMonitor

Step 1: Expose TrilioVault Exporter: To expose the TrilioVault metrics, you need to create a Kubernetes Service. If your Prometheus setup is not present in this cluster then expose it via a LoadBalancer Service.
You can create a LoadBalancer Service using the following .YAML
kind: Service
apiVersion: v1
metadata:
name: k8s-triliovault-exporter
labels:
app: k8s-triliovault-exporter
spec:
ports:
- name: web
protocol: TCP
port: 8080
targetPort: 8080
selector:
app: k8s-triliovault-exporter
type: NodePort
Step 2. Create ServiceMonitor: You will need to configure a ServiceMonitor for Prometheus to scrape the metrics from your k8s-triliovault-exporter-service. Apply the following .YAML to the namespace where TVK is installed.
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: k8s-triliovault-exporter
labels:
app: k8s-triliovault-exporter
spec:
selector:
matchLabels:
app: k8s-triliovault-exporter
endpoints:
- port: web
Once the configuration is completed. You can find k8s-triliovault-exporter as active targets in Prometheus UI.
Please wait a couple of minutes for Prometheus to start scraping metrics. Access prometheus console at http://<prometheus-server-ip>/graph
TrilioVault Prometheus Metrics
If you leverage the Prometheus Operator stack, then configure the ServiceMonitor the same way as above configurations.

Consuming Metrics - Outside the cluster

To expose TVK metrics outside the cluster, perform the following two steps.
  1. 1.
    Expose TrilioVault Exporter: TrilioVault metrics can be exposed outside the cluster via a LoadBalancer Service. Leverage kubectl to create service for k8s-triliovault-exporter
kubectl expose deployment k8s-triliovault-exporter --type=LoadBalancer --name=exporter --namespace triliovault-integration
OR you can create a LoadBalancer Service using a .yaml file
kind: Service
apiVersion: v1
metadata:
name: k8s-triliovault-exporter
labels:
app: k8s-triliovault-exporter
spec:
ports:
- protocol: TCP
port: 8080
targetPort: 8080
selector:
app: k8s-triliovault-exporter
type: LoadBalancer
Once the Service is available capture the Public IP for k8s-triliovault-exporter-service, this will be used in second step.
  1. 1.
    Scrape Job: You will need to configure a prometheus server to scrape the metrics from your newly running exporter. Add the following scrape job to your prometheus.yml configuration file.
    - job_name: trilio_exporter
    scrape_interval: 30s
    file_sd_configs:
    static_configs:
    - targets: ['EXPORTER_PUBLIC_IP:8080']

Visualizing Metrics with Grafana

Metrics from Prometheus can be visualized leveraging Grafana. Dashboards can be created in Grafana with the TrilioVault metrics exposed through Prometheus.

TrilioVault Grafana Dashboards

Trilio provides pre-created Grafana dashboards with the product to make monitoring and observing your backup landscape easy.
Grafana dashboards are pivoted on the following themes and provide high-level overview, summary and details around each theme.
  1. 1.
    Backups
  2. 2.
    Restores
  3. 3.
    Targets
  4. 4.
    BackupPlans/Application

Import Grafana Dashboards

TVK dashboards can be found on the Grafana within the Trilio org page.
Please ensure that the dependencies mentioned for each dashboard are fulfilled. The TVK dashboards will not work as expected if these dependencies are not met.
  1. 1.
    The dashboards can be imported into a Grafana instance following instructions from the Grafana project page.
  2. 2.
    Instructions for downloading and importing are provided with the dashboards.
Grafana Dashboard Example
Copy link
Outline
Trilio Metrics Exporter for Prometheus
Consuming Metrics - Inside the Cluster
Using Annotations
Using Scrape Job
Using ServiceMonitor
Consuming Metrics - Outside the cluster
Visualizing Metrics with Grafana