Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tulios/burrow-stats
Dashboard for burrow kafka consumer lag checking
https://github.com/tulios/burrow-stats
Last synced: 14 days ago
JSON representation
Dashboard for burrow kafka consumer lag checking
- Host: GitHub
- URL: https://github.com/tulios/burrow-stats
- Owner: tulios
- Created: 2016-06-01T08:03:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T21:21:57.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T12:18:25.057Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 814 KB
- Stars: 49
- Watchers: 8
- Forks: 16
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Burrow Stats
Dashboard for burrow kafka consumer lag checking
## Running locally
```sh
yarn install
npm run dev
```
* Remember to create the [config file](#configs) (`configs.json`)
## Production
```sh
NODE_ENV=production npm run build
NODE_ENV=production npm start
```
## Docker
```sh
docker run \
-p 8022:8022 \
-e PORT=8022 \
-v /path/to/your/configs.json:/opt/burrow-stats/configs.json \
tulios/burrow-stats:latest
```
Burrow-stats requires a configuration file called `configs.json`. Take a look at [`configs.json.example`](https://raw.githubusercontent.com/tulios/burrow-stats/master/configs.json.example) for a complete example.
1) Consumers
```json
{
"consumers": [
{
"name": "consumer_name_1",
"status": "http://burrow-host:8000/v2/kafka/cluster_name/consumer/consumer_name_1/status",
"consumer_group_offset": "http://burrow-host:8000/v2/kafka/cluster_name/consumer/consumer_name_1/topic/topic_name_1",
"topic_offset": "http://burrow-host:8000/v2/kafka/cluster_name/topic/topic_name_1"
}
]
}
```
Accepts configurations for your consumers, if needed can aggregate data from different burrow instances.
2) Chart Options
```json
{
"chartOptions": {
"scaleOverride": false,
"scaleSteps": null,
"scaleStepWidth": null,
"scaleStartValue": null,
"scaleFontSize": 14
}
}
```
Allows you to change some behavior of the chart.
* __scaleOverride__ : Enable scale override with a hard coded values. Default `false`
* __scaleSteps__ : The number of steps in a hard coded scale (Requires `scaleOverride` true)
* __scaleStepWidth__ : The value jump in the hard coded scale (Requires `scaleOverride` true)
* __scaleStartValue__ : The scale starting value (Requires `scaleOverride` true)
* __scaleFontSize__ : Scale label font size in pixels. Default `14`
Example using hard coded values for scale. The Y axis will start with 0 and it will contain 20 steps of 10. All scale parameters are connected, you __must provide__ all of them when enabling `scaleOverride`.
```json
{
"scaleOverride": true,
"scaleSteps": 20,
"scaleStepWidth": 10,
"scaleStartValue": 0
}
```
3) Burrow Stats Options
```json
{
"burrowStatsOptions": {
"pollInterval": 60,
"cacheBinSize": 30,
"envLabel": "Staging",
"envLabelColor": "white",
"envLabelBgColor": "rgba(0, 137, 207, 1)"
}
}
```
Configure burrow-stats internals.
* __pollInterval__ : Frequency of data update in seconds. Default `60`
* __cacheBinSize__ : Number of data points stored. Default `30`
* __envLabel__ : Optional environment label. Default `null`
* __envLabelColor__: Default `white`
* __envLabelBgColor__: Default `rgba(0, 137, 207, 1)`