https://github.com/hauptmedia/zbcat
Command line viewer for events produced by the Zeebe Workflow Automation Engine
https://github.com/hauptmedia/zbcat
zeebe zeebe-exporter zeebe-tool
Last synced: 3 months ago
JSON representation
Command line viewer for events produced by the Zeebe Workflow Automation Engine
- Host: GitHub
- URL: https://github.com/hauptmedia/zbcat
- Owner: hauptmedia
- License: apache-2.0
- Created: 2022-11-22T22:37:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-26T18:48:22.000Z (over 2 years ago)
- Last Synced: 2025-01-10T21:09:26.576Z (5 months ago)
- Topics: zeebe, zeebe-exporter, zeebe-tool
- Language: TypeScript
- Homepage:
- Size: 119 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
zbcat: Command line viewer for Zeebe events
===========================================
Displays Zeebe events from Kafka or Hazelcast export which can be produced with
[zeebe-kafka-exporter](https://github.com/camunda-community-hub/zeebe-kafka-exporter) or
[zeebe-hazelcast-exporter](https://github.com/camunda-community-hub/zeebe-hazelcast-exporter).
Currently only the JSON serialization format is supported!
You can use the Docker Images from [Zeebe with exporters](https://github.com/hauptmedia/docker-zeebe-with-exporters) to
kickstart a Zeebe instance with a configured Kafka or Hazelcast exporter.
## Usage
## Installation
### Using npx
```shell
npx @hauptmedia/zbcat
```
### Install globally
```shell
npm install -g @hauptmedia/zbcat
```
## Synopsis
```shell
Usage: zbcat [options]
Command line viewer for events produced by the Zeebe Workflow Automation Engine
Options:
--fields comma seperated list of fields from the record value which should be included (default:
"bpmnElementType,elementId,correlationKey,variables,decisionId,errorType,errorMessage")
--sample-rate sample rate in ms (default: "2000")
--from-beginning reprocess all available events from the beginning (default: false)
--kafka use kafka (default: true)
--kafka-brokers comma seperated list of kafka brokers (default: "localhost:9092")
--kafka-client-id kafka client id (default: "zbcat")
--kafka-group-id kafka group id, will randomly generated if not specified (default: "8ca558a6-4765-4137-90d9-f622f7171a45")
--kafka-topics comma seperated list of kafka topics to subscribe to (default: "zeebe")
--hazelcast use hazelcast (default: false)
--hazelcast-ringbuffer-name name of ringbuffer used in hazelcast (default: "zeebe")
--hazelcast-cluster-name name of cluster used in hazelcast (default: "dev")
--hazelcast-cluster-members comma seperated list of hazelcast cluster members (default: "localhost:5701")
-h, --help display help for command
```