gcn-monitor

A Kafka client instrumented with Prometheus.

Configuration

The following environment variables may be used to configure the service:

Name	Value
KAFKA_*	Kafka client configuration as understood by Confluent Platform docker containers

How to contribute

This package uses Poetry for packaging and Python virtual environment management. To get started:

1. Fork and clone this repository.

2. Install pre-commit hooks by running the following two commands:

   pip install pre-commit
   pre-commit install
   

3. Install Poetry by following their installation instructions.

4. Install this package and its dependencies by running the following command inside your clone of this repository:

   poetry install --all-extras
   

5. Run the following command to launch a shell that is preconfigured with the project's virtual environment:

   poetry shell