https://github.com/galexrt/extended-ceph-exporter
A Prometheus exporter to provide "extended" metrics about a Ceph cluster's running components (e.g., RGW).
https://github.com/galexrt/extended-ceph-exporter
Last synced: 2 days ago
JSON representation
A Prometheus exporter to provide "extended" metrics about a Ceph cluster's running components (e.g., RGW).
- Host: GitHub
- URL: https://github.com/galexrt/extended-ceph-exporter
- Owner: galexrt
- License: apache-2.0
- Created: 2024-04-17T16:52:57.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-02-16T15:52:48.000Z (5 days ago)
- Last Synced: 2025-02-16T16:40:38.214Z (5 days ago)
- Language: Go
- Size: 344 KB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# extended-ceph-exporter
A Prometheus exporter to provide "extended" metrics about a Ceph cluster's running components (e.g., RGW).
Due to the closure of Koor Technologies, Inc. this repository has been made to continue the work on the extended-ceph-exporter project.
[](grafana/)
## Requirements
* Needs a Ceph cluster up and running (Rook Ceph clusters with CephObjectStores work as well, checkout the [Rook section](#rook)).
* Needs a RGW user with admin or the following "caps": `buckets=read;users=read;usage=read;metadata=read;zone=read`
```
radosgw-admin user create --uid extended-ceph-exporter --display-name "extended-ceph-exporter admin user" --caps "buckets=read;users=read;usage=read;metadata=read;zone=read"
# Access key / "Username"
radosgw-admin user info --uid extended-ceph-exporter | jq '.keys[0].access_key'
# Secret key / "Password
radosgw-admin user info --uid extended-ceph-exporter | jq '.keys[0].secret_key'
```
## Rook
If using Rook to manage RGWs, the admin user may also be created using a `CephOjectStoreUser` resource:
```yaml
apiVersion: ceph.rook.io/v1
kind: CephObjectStoreUser
metadata:
name: extended-ceph-exporter
namespace: rook-ceph
spec:
store:
clusterNamespace: rook-ceph
displayName: extended-ceph-exporter
capabilities:
buckets: read
users: read
usage: read
metadata: read
zone: read
```
Applying this will create an user with all permissions needed.
## Quickstart
* Clone the repository, download release binary or pull the container image:
```console
git clone https://github.com/galexrt/extended-ceph-exporter
cd extended-ceph-exporter
```
* Create a copy of the `config.example.yaml` and `realms.example.yaml` files, and rename the files to remove the `.example` from the names.
* Make sure to configure your RGW admin user credentials and endpoint in the `realms.yaml` file.
* Configure Prometheus to collect metrics from the exporter from `:9138/metrics` endpoint using a static configuration, here's a sample scrape job from the `prometheus.yml`:
```yaml
# For more information on Prometheus scrape_configs:
# https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config
scrape_configs:
- job_name: "extended-ceph-metrics"
# Override the global default and scrape targets from this job every 30 seconds.
scrape_interval: 30s
static_configs:
# Please change the ip address `127.0.0.1` to target the server the exporter is running on
- targets: ['127.0.0.1:9138']
```
* To run the exporter locally you can use one of the methods:
* Using `go` command, run `go run .`
* Download a [release binary](releases).
* Use the container image avaialble from [ghcr.io/galexrt/extended-ceph-exporter](https://github.com/galexrt/extended-ceph-exporter/pkgs/container/extended-ceph-exporter).
* [Helm chart](charts/extended-ceph-exporter/README.md) for Kubernetes/OpenShift deployment.
* Should you have Grafana running for metrics visulization, check out the available [Grafana dashboards](grafana/).
### Helm
To install the exporter to Kubernetes using Helm, please check out the [extended-ceph-exporter Helm Chart README.md file](charts/extended-ceph-exporter/README.md).
## Collectors
There is varying support for collectors. The tables
below list all existing collectors and the required Ceph components.
### Enabled by default
| Name | Description | Ceph Component |
| :--------------- | :---------------------------------------------------------------: | -------------- |
| `rgw_buckets` | Exposes RGW Bucket Usage and Quota metrics from the Ceph cluster. | RGW |
| `rgw_user_quota` | Exposes RGW User Quota metrics from the Ceph cluster. | RGW |
### Disabled by default
| Name | Description | Ceph Component |
| :------------ | :---------------------------------------------------------------------------: | -------------- |
| `rbd_volumes` | Exposes RBD volumes size (volume pool, id, and name are available as labels). | RBD |
## RGW: Multiple Realms
You can use the exporter to scrape metrics from multiple RGW realms by providing multiple RGWs in the realm config file.
An example realm config file can be found here [`realms.example.yaml`](realms.example.yaml).
## Flags
```console
$ extended-ceph-exporter --help
Usage of exporter:
--collectors-enabled strings List of enabled collectors (please refer to the readme for a list of all available collectors) (default [rgw_user_quota,rgw_buckets])
--config config.yaml Config file path (default name config.yaml , current and `/config` directory).
--realms-config --multi-realm-config Path to your realms.yaml config file (old flag name: --multi-realm-config) (default "realms.yaml")
--version Show version info and exit
pflag: help requested
exit status 2
```
## Development
### Requirements
* Golang 1.23.x (or higher should work)
* Ceph development files/libraries (`librados`, `librdb`)
* If you are using `nix`, the `flake.nix` should be satisfy these lib dependencies.
* `helm`
### Making Changes to the Helm Chart
When changing anything in the Helm Chart, the version in the `Chart.yaml` needs to be increased according to [Semver](https://semver.org/).
Additionally `make helm-doc` must be run afterwards and the changes to the Helm Chart's `README.md` must be commited as well.
### Debugging
A VSCode debug config is available to run and debug the project.
To make the exporter talk with a Ceph RGW S3 endpoint, create a copy of the `config.example.yaml` and `realms.example.yaml` files, and rename the files to remove the `.example` from the names.
Be sure ot add your Ceph RGW S3 endpoint and credentials in it.