# sentry-kafka-management

**Repository Path**: mirrors_getsentry/sentry-kafka-management

## Basic Information

- **Project Name**: sentry-kafka-management
- **Description**: Libraries for managing our Kafka clusters/consumers, as well as Taskbroker.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-13
- **Last Updated**: 2026-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sentry-kafka-management
Libraries for managing our Kafka clusters/consumers, as well as Taskbroker.


### Usage
- `make install-dev` to install the development environment
- `make tests` to run the unit tests
- `make typecheck` to run Python type checking
- `make lint` to lint the code base and apply auto generated changes
- `make build` to build the wheels for the project and package the release

### Local kafka
- `devservices up` to spin up a local kafka node
- `docker exec kafka-kafka-1 kafka-topics --bootstrap-server localhost:9092 --topic test-topic --create` to create a test topic for the cluster
  - TODO: find a way to auto-create a test topic on the local kafka

### Docker

Build the image:

```bash
docker build -t sentry-kafka-management:local .
```

Show CLI help (router):

```bash
docker run --rm sentry-kafka-management:local --help
```

Run a script against your local devservices kafka via the unified CLI router:

```bash
docker run --rm \
  -v "$PWD/devservices/kafka-conf:/config" \
  --network "devservices" \
  sentry-kafka-management:local \
  list-topics \
  -c /config/local.yml \
  -n <cluster-name>
```