https://github.com/dell/csm-metrics-powerstore
Metrics for PowerStore 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 PowerStore
https://github.com/dell/csm-metrics-powerstore
Last synced: about 1 year ago
JSON representation
Metrics for PowerStore 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 PowerStore
- Host: GitHub
- URL: https://github.com/dell/csm-metrics-powerstore
- Owner: dell
- License: apache-2.0
- Created: 2021-04-14T11:46:31.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-27T12:03:44.000Z (about 1 year ago)
- Last Synced: 2025-04-27T13:19:37.878Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 295 KB
- Stars: 8
- Watchers: 15
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Observability Module for PowerStore
[](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
[](LICENSE)
[](https://hub.docker.com/r/dellemc/csm-metrics-powerstore)
[](go.mod)
[](https://github.com/dell/csm-metrics-powerstore/releases/latest)
Metrics for PowerStore is part of Dell Container Storage Modules (CSM) for Observability, which provides Kubernetes administrators standardized approaches for storage observability in Kuberenetes environments.
Metrics for PowerStore 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 PowerStore.
Metrics for PowerStore captures telemetry data of storage usage and performance obtained through the CSI Driver for Dell PowerStore. 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)
- [List of Adopters](https://github.com/dell/csm/blob/main/docs/ADOPTERS.md)
- [Support](https://github.com/dell/csm/blob/main/docs/SUPPORT.md)
- [Security](https://github.com/dell/csm/blob/main/docs/SECURITY.md)
- [About](#about)
## Building Metrics for PowerStore
If you wish to clone and build the Metrics for PowerStore 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.24.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.30-1.32 | 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-powerstore.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-powerstore directory, run the following command to build the container image called csm-metrics-powerstore: `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 PowerStore
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.