https://github.com/fagnercarvalho/prometheus-iotdb-exporter
Prometheus IoTDB exporter
https://github.com/fagnercarvalho/prometheus-iotdb-exporter
golang iotdb metrics prometheus prometheus-exporter prometheus-iotdb-exporter
Last synced: 22 days ago
JSON representation
Prometheus IoTDB exporter
- Host: GitHub
- URL: https://github.com/fagnercarvalho/prometheus-iotdb-exporter
- Owner: fagnercarvalho
- License: mit
- Created: 2020-12-14T05:00:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-09-02T03:35:06.000Z (over 2 years ago)
- Last Synced: 2024-06-19T05:59:33.905Z (over 1 year ago)
- Topics: golang, iotdb, metrics, prometheus, prometheus-exporter, prometheus-iotdb-exporter
- Language: Go
- Homepage:
- Size: 98.6 KB
- Stars: 9
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## IoTDB Server Exporter [](https://github.com/fagnercarvalho/prometheus-iotdb-exporter/actions?query=workflow%3AGoo)
[](https://goreportcard.com/report/github.com/fagnercarvalho/prometheus-iotdb-exporter) [](https://pkg.go.dev/github.com/fagnercarvalho/prometheus-iotdb-exporter) [](https://hub.docker.com/r/fagner/prometheus-iotdb-exporter)  [](https://codecov.io/gh/fagnercarvalho/prometheus-iotdb-exporter)
Prometheus exporter for IoTDB server metrics.
Supported version: 0.11.0.
##### Running (Linux)
```
export IOTDB_PASSWORD=root
./prometheus-iotdb-exporter
```
##### Running (Windows)
```
set IOTDB_PASSWORD=root
prometheus-iotdb-exporter.exe
```
Then go to localhost:8092 to see your metrics.
##### Flags
| Name | Description | Default |
| ------------- | ----------------------- | --------- |
| listenPort | exporter listening port | 8092 |
| iotDBHost | IoTDB server host | 127.0.0.1 |
| iotDBPort | IoTDB server port | 6667 |
| iotDBUsername | IoTDB username | root |
For security reasons the server password needs to be set by using `IOTDB_PASSWORD` environment variable.
##### Metrics
| Name | Metric Name | Description |
| --------------------- | ----------------------------- | ------------------------------------------------------------ |
| Write Ahead File Size | iotdb_write_ahead_file_size_bytes | Write Ahead File Size (extracted from the root.stats.file_size.WAL time series) in bytes. For this metric to be collected the enable_stat_monitor option must be enabled in the /iotdb/conf/iotdb-engine.properties config file. To update the config file check the [server_example](/server_example) folder. |
| System File Size | iotdb_system_file_size_bytes | System File Size (extracted from the root.stats.file_size.SYS time series) in bytes. For this metric to be collected the enable_stat_monitor option must be enabled in the /iotdb/conf/iotdb-engine.properties config file. To update the config file check the [server_example](/server_example) folder. |
| Storage Group Count | iotdb_storage_groups | Storage group count |
| Timeseries Count | iotdb_time_series | Timeseries (across all storage groups) count |
| Users Count | iotdb_users | Database users count |
##### Docker
You can deploy this exporter by using the [fagner/prometheus-iotdb-exporter](https://hub.docker.com/r/fagner/prometheus-iotdb-exporter/) Docker image.
```
docker pull fagner/prometheus-iotdb-exporter
docker run -d -p "2000:8092" --name iotdb-exporter fagner/prometheus-iotdb-exporter
```
Or clone the repo and run the following commands.
```
docker build -t iotdb-exporter .
docker run -d -p "2000:8092" --name iotdb-exporter iotdb-exporter
```