Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linkedin/Burrow

Kafka Consumer Lag Checking
https://github.com/linkedin/Burrow

Last synced: about 1 month ago
JSON representation

Kafka Consumer Lag Checking

Host: GitHub
URL: https://github.com/linkedin/Burrow
Owner: linkedin
License: apache-2.0
Created: 2015-06-02T01:15:25.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-07-25T21:31:34.000Z (5 months ago)
Last Synced: 2024-10-29T11:28:31.480Z (about 1 month ago)
Language: Go
Homepage:
Size: 981 KB
Stars: 3,751
Watchers: 129
Forks: 797
Open Issues: 244
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

my-awesome - linkedin/Burrow - 07 star:3.8k fork:0.8k Kafka Consumer Lag Checking (Go)
awesome-kafka - Burrow - Kafka Consumer Lag Checking. (Libraries / Kafka)
awesome-kafka - Burrow - Kafka Consumer Lag Checking

README

[![Join the chat at https://gitter.im/linkedin-Burrow/Lobby](https://badges.gitter.im/linkedin-Burrow/Lobby.svg)](https://gitter.im/linkedin-Burrow/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://github.com/linkedin/Burrow/actions/workflows/ci.yml/badge.svg)]([https://travis-ci.org/linkedin/Burrow](https://github.com/linkedin/Burrow/actions/workflows/ci.yml/badge.svg))
[![go report card](https://goreportcard.com/badge/github.com/linkedin/Burrow)](https://goreportcard.com/report/github.com/linkedin/Burrow)
[![Coverage Status](https://coveralls.io/repos/github/linkedin/Burrow/badge.svg?branch=master)](https://coveralls.io/github/linkedin/Burrow?branch=master)
[![GoDoc](https://godoc.org/github.com/linkedin/Burrow?status.svg)](https://godoc.org/github.com/linkedin/Burrow)

# Burrow - Kafka Consumer Lag Checking

Burrow is a monitoring companion for [Apache Kafka](http://kafka.apache.org) that provides consumer lag checking as a service without the need for specifying thresholds. It monitors committed offsets for all consumers and calculates the status of those consumers on demand. An HTTP endpoint is provided to request status on demand, as well as provide other Kafka cluster information. There are also configurable notifiers that can send status out via email or HTTP calls to another service.

## Features
* NO THRESHOLDS! Groups are evaluated over a sliding window.
* Multiple Kafka Cluster support
* Automatically monitors all consumers using Kafka-committed offsets
* Configurable support for Zookeeper-committed offsets
* Configurable support for Storm-committed offsets
* HTTP endpoint for consumer group status, as well as broker and consumer information
* Configurable emailer for sending alerts for specific groups
* Configurable HTTP client for sending alerts to another system for all groups

## Getting Started
### Prerequisites
Burrow is written in Go, so before you get started, you should [install and set up Go](https://golang.org/doc/install). As the dependencies
are managed using Go module, the lowest version of Go supported is 1.11, though we recommend using version 1.12 for development.

### Build and Install
```
$ Clone github.com/linkedin/Burrow to a directory outside of $GOPATH. Alternatively, you can export GO111MODULE=on to enable Go module.
$ cd to the source directory.
$ go mod tidy
$ go install
```

### Running Burrow
```
$ $GOPATH/bin/Burrow --config-dir /path/containing/config
```

### Using Docker
A Docker file is available which builds this project on top of an Alpine Linux image.
To use it, build your docker container, mount your Burrow configuration into `/etc/burrow` and run docker.

A [Docker Compose](docker-compose.yml) is also available for quick and easy development.

Install [Docker Compose](https://docs.docker.com/compose/) and then:

1. Build the docker container:
```
docker-compose build
```

2. Run the docker compose stack which includes kafka and zookeeper:
```
docker-compose down; docker-compose up
```

3. Some test topics have already been created by default and Burrow can be accessed on `http://localhost:8000/v3/kafka`.

### Configuration
For information on how to write your configuration file, check out the [detailed wiki](https://github.com/linkedin/Burrow/wiki)

## License
Copyright 2017 LinkedIn Corp. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied.