Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KxSystems/prometheus-kdb-exporter
Kdb+ exporter for Prometheus
https://github.com/KxSystems/prometheus-kdb-exporter
grafana kdb prometheus prometheus-exporter q
Last synced: 3 months ago
JSON representation
Kdb+ exporter for Prometheus
- Host: GitHub
- URL: https://github.com/KxSystems/prometheus-kdb-exporter
- Owner: KxSystems
- License: apache-2.0
- Created: 2020-03-06T15:16:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T14:05:25.000Z (over 1 year ago)
- Last Synced: 2024-04-08T02:15:53.799Z (7 months ago)
- Topics: grafana, kdb, prometheus, prometheus-exporter, q
- Language: q
- Homepage: https://code.kx.com/q/interfaces
- Size: 103 KB
- Stars: 17
- Watchers: 5
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-q - prometheus-kdb-exporter
README
#  Prometheus Exporter for kdb+
[](https://github.com/kxsystems/prometheus-kdb-exporter/releases)
This interface provides a method by which to expose metrics from a kdb+ process or multiple processes to Prometheus for monitoring. This is done via the script `q/exporter.q` which exposes kdb+ process metrics which can be consumed by Prometheus.
This interface is part of the [_Fusion for kdb+_](https://code.kx.com/q/interfaces#fusion/) project.
## New to kdb+ ?
Kdb+ is the world's fastest time-series database, optimized for ingesting, analyzing and storing massive amounts of structured data. To get started with kdb+, visit https://code.kx.com/q/learn/ for downloads and developer information. For general information, visit https://kx.com/
## What is Prometheus ?
Prometheus is an open source monitoring solution which facilitates metrics gathering, querying and alerting for a wealth of different 3rd-party languages and applications. It also provides integration with Kubernetes for automatic discovery of supported applications.
Visualization and querying can be done through the Prometheus built in expression browser, or more commonly via Grafana.
The repo includes [an example](examples) of this using Docker.
## Quick start
Install the appropriate q scripts to `$QHOME`/`%QHOME%` using the `install.sh`/`install.bat` files
```bash
## Linux/MacOS
chmod +x install.sh && ./install.sh
## Windows
install.bat
```
Run kdb+ with the supplied q script. This script will expose metrics on port 8080 which can be monitored by Prometheus
```bash
q q/exporter.q -p 8080
```
Once running, use your web browser to view the currently exposed statistics on the metrics URL e.g. http://localhost:8080/metrics. The metrics exposed will be the metric values at the time at which the URL is requested.
## Unsupported functionality
This interface does not provide service discovery. Prometheus itself has support for multiple mechanisms such as DNS, Kubernetes, EC2, file based config, etc., to discover all the kdb+ instances within your environment.
## Documentation
:open_file_folder: [`docs`](docs)
## Status
The prometheus-kdb-exporter interface is provided here under an Apache 2.0 license.
If you find issues with the interface or have feature requests please [raise an issue](../../issues).
To contribute to this project, please follow the [contribution guide](CONTRIBUTING.md).