Karavi Metrics for PowerFlex is part of Karavi Observability storage enabler, which provides Kubernetes administrators standardized approaches for storage observability in Kuberenetes environments.
Karavi Metrics for PowerFlex is an open source distributed solution that provides insight into storage usage and performance as it relates to the CSI (Container Storage Interface) Driver for Dell EMC PowerFlex. This project provides the following metrics:
- Storage System I/O Performance Metrics: Visibility into the I/O performance of a storage system (IOPs, bandwidth, latency) broken down by Kubernetes node and volume
- Storage Pool Consumption By CSI Driver: Visibility into the total, used, and available capacity for a storage pool/storage class
Karavi Metrics for PowerFlex captures telemetry data of storage usage and performance obtained through the CSI Driver for Dell EMC PowerFlex. The Metrics service then pushes it to the OpenTelemetry Collector, so it can be processed, and exported in a format consumable by Prometheus. Prometheus can then be configured to scrape the OpenTelemetry Collector exporter endpoint to provide metrics so they can be visualized in Grafana. Please see Getting Started Guide for information on requirements, deployment, and usage.
If you wish to clone and build the Karavi Metrics for PowerFlex service, a Linux host is required with the following installed:
| Component | Version | Additional Information |
|---|---|---|
| Docker | v19+ | Docker installation |
| Docker Registry | Access to a local/corporate Docker registry | |
| Golang | v1.14+ | Golang installation |
| gosec | gosec | |
| gomock | v.1.4.3 | Go Mock |
| git | latest | Git installation |
| gcc | Run sudo apt install build-essential |
|
| kubectl | 1.17-1.19 | Ensure you copy the kubeconfig file from the Kubernetes cluster to the linux host. kubectl installation |
| Helm | v.3.3.0 | Helm installation |
Once all prerequisites are on the Linux host, follow the steps below to clone and build the metrics service:
- Clone the repository:
git clone https://github.com/dell/karavi-metrics-powerflex.git - Set the DOCKER_REPO environment variable to point to the local Docker repository, example:
export DOCKER_REPO=<ip-address>:<port> - In the karavi-metrics-powerflex directory, run the following to build the Docker image called karavi-metrics-powerflex:
make clean build docker - To tag (with the "latest" tag) and push the image to the local Docker repository run the following:
make tag push
Note: Linux support only. If you are using a local insecure docker registry, ensure you configure the insecure registries on each of the Kubernetes worker nodes to allow access to the local docker repository
From the root directory where the repo was cloned, the unit tests can be executed as follows:
make testThis will also provide code coverage statistics for the various Go packages.
Don’t hesitate to ask! Contact the team and community on our support page. Open an issue if you found a bug on Github Issues.
This project is adhering to Semantic Versioning.
Karavi is 100% open source and community-driven. All components are available under Apache 2 License on GitHub.