https://github.com/dell/csm-metrics-powermax
Metrics for PowerMax is part of Dell Container Storage Modules (CSM) for Observability and provides Kubernetes administrators insight into storage usage and performance for containerized applications using Dell products
https://github.com/dell/csm-metrics-powermax
Last synced: 9 months ago
JSON representation
Metrics for PowerMax is part of Dell Container Storage Modules (CSM) for Observability and provides Kubernetes administrators insight into storage usage and performance for containerized applications using Dell products
- Host: GitHub
- URL: https://github.com/dell/csm-metrics-powermax
- Owner: dell
- License: apache-2.0
- Created: 2022-08-30T14:28:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-09T12:41:27.000Z (9 months ago)
- Last Synced: 2025-09-09T12:56:46.200Z (9 months ago)
- Language: Go
- Size: 406 KB
- Stars: 4
- Watchers: 13
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# :lock: **Important Notice**
Starting with the release of **Container Storage Modules v1.16.0**, this repository will no longer be maintained as an open source project. Future development will continue under a closed source model. This change reflects our commitment to delivering even greater value to our customers by enabling faster innovation and more deeply integrated features with the Dell storage portfolio.
For existing customers using Dell’s Container Storage Modules, you will continue to receive:
* **Ongoing Support & Community Engagement**
You will continue to receive high-quality support through Dell Support and our community channels. Your experience of engaging with the Dell community remains unchanged.
* **Streamlined Deployment & Updates**
Deployment and update processes will remain consistent, ensuring a smooth and familiar experience.
* **Access to Documentation & Resources**
All documentation and related materials will remain publicly accessible, providing transparency and technical guidance.
* **Continued Access to Current Open Source Version**
The current open-source version will remain available under its existing license for those who rely on it.
Moving to a closed source model allows Dell’s development team to accelerate feature delivery and enhance integration across our Enterprise Kubernetes Storage solutions ultimately providing a more seamless and robust experience.
We deeply appreciate the contributions of the open source community and remain committed to supporting our customers through this transition.
For questions or access requests, please contact the maintainers via [Dell Support](https://www.dell.com/support/kbdoc/en-in/000188046/container-storage-interface-csi-drivers-and-container-storage-modules-csm-how-to-get-support).
# Observability Module for PowerMax
[](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
[](LICENSE)
[](https://hub.docker.com/r/dellemc/csm-metrics-powermax)
[](go.mod)
[](https://github.com/dell/csm-metrics-powermax/releases/latest)
Metrics for PowerMax is part of Dell Container Storage Modules (CSM) for Observability, which provides Kubernetes administrators standardized approaches for storage observability in Kuberenetes environments.
Metrics for PowerMax 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 PowerMax.
Metrics for PowerMax captures telemetry data of storage usage and performance obtained through the CSI Driver for Dell PowerMax. The Metrics service 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.
For documentation, please visit [Container Storage Modules documentation](https://dell.github.io/csm-docs/).
## Table of Contents
- [Code of Conduct](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
- [Maintainer Guide](https://github.com/dell/csm/blob/main/docs/MAINTAINER_GUIDE.md)
- [Committer Guide](https://github.com/dell/csm/blob/main/docs/COMMITTER_GUIDE.md)
- [Contributing Guide](https://github.com/dell/csm/blob/main/docs/CONTRIBUTING.md)
- [Branching Strategy](https://github.com/dell/csm/blob/main/docs/BRANCHING.md)
- [List of Adopters](https://github.com/dell/csm/blob/main/ADOPTERS.md)
- [Maintainers](https://github.com/dell/csm/blob/main/docs/MAINTAINERS.md)
- [Dell support](https://www.dell.com/support/incidents-online/en-us/contactus/product/container-storage-modules)
- [Security](https://github.com/dell/csm/blob/main/docs/SECURITY.md)
- [About](#about)
## Building Metrics for PowerMax
If you wish to clone and build the Metrics for PowerMax service, a Linux host is required with the following installed:
| Component | Version | Additional Information |
| --------------- | --------- | ---------------------- |
| Podman | v5.x.x | [Podman installation](https://podman.io/docs/installation) |
| Docker Registry | | Access to a local/corporate [Docker registry](https://docs.docker.com/registry/) |
| Golang | v1.25.x | [Golang installation](https://github.com/travis-ci/gimme) |
| gomock | v1.6.0 | [Go Mock](https://github.com/golang/mock) |
| gosec | | [gosec](https://github.com/securego/gosec) |
| git | latest | [Git installation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) |
| gcc | | Run `sudo apt install build-essential` |
| kubectl | 1.32-1.34 | Ensure you copy the kubeconfig file from the Kubernetes cluster to the linux host. [kubectl installation](https://kubernetes.io/docs/tasks/tools/install-kubectl/) |
| Helm | v3.x.x | [Helm installation](https://helm.sh/docs/intro/install/) |
Once all prerequisites are on the Linux host, follow the steps below to clone and build the metrics service:
1. Clone the repository using the following command: `git clone https://github.com/dell/csm-metrics-powermax.git`
2. Set the DOCKER_REPO environment variable to point to the local Docker repository, for example: `export DOCKER_REPO=:`
3. In the csm-metrics-powermax directory, run the following command to build the container image called csm-metrics-powermax: `make podman`
4. Tag (with the "latest" tag) and push the image to the local Docker repository by running the following command: `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.
## Testing the Observability Module for PowerMax
From the root directory where the repo was cloned, the unit tests can be executed using the following command:
```console
make test
```
This will also provide code coverage statistics for the various Go packages.
## Versioning
This project is adhering to [Semantic Versioning](https://semver.org/).
## About
Dell Container Storage Modules (CSM) is 100% open source and community-driven. All components are available
under [Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0.html) on
GitHub.