blitz

README

Blitz

A load generation tool for Bindplane managed collectors.

Documentation

• Configuration Guide - Complete guide to configuring blitz with YAML files, environment variables, and command-line flags
• Architecture Overview - Detailed explanation of the application architecture, components, and data flow
• Metrics Documentation - Comprehensive guide to monitoring and metrics exposed by blitz
• Development Guide - Guidelines for contributing to the project
• Contributing Guidelines - How to contribute to the project

Installation

CLI

Download the binary for your platform from the latest release:

Extract the archive and run the binary directly in a terminal:

tar -xzf blitz_*_linux_amd64.tar.gz

Run with default NOP configuration:

./blitz

Run with JSON generator and TCP output:

./blitz \
  --generator-type json \
  --generator-json-workers 2 \
  --generator-json-rate 500ms \
  --output-type tcp \
  --output-tcp-host logs.example.com \
  --output-tcp-port 9090 \
  --output-tcp-workers 3 \
  --logging-level info

Linux Systemd Service

Download the appropriate package for your Linux distribution from the latest release:

• Debian/Ubuntu: blitz_amd64.deb or blitz_arm64.deb
• Red Hat/CentOS/Fedora: blitz_amd64.rpm or blitz_arm64.rpm

Install the package with your package manager:

Debian

sudo apt-get install -f ./blitz_amd64.deb

RHEL

sudo dnf install ./blitz_amd64.rpm

Edit the configuration file:

sudo vi /etc/blitz/config.yaml

Example minimal configuration for JSON generator and TCP output:

generator:
  type: json
  json:
    workers: 2
    rate: 500ms
output:
  type: tcp
  tcp:
    host: logs.example.com
    port: 9090
    workers: 3
logging:
  level: info

Enable and start the service

sudo systemctl enable blitz
sudo systemctl start blitz
sudo systemctl status blitz

View service logs:

sudo journalctl -u blitz -f

Container

Pull the Docker image from GitHub Container Registry and run it with environment variables for configuration:

Run with default NOP configuration:

docker run --rm ghcr.io/observiq/blitz:latest

Run with JSON generator and TCP output:

docker run --rm \
  -e BINDPLANE_GENERATOR_TYPE=json \
  -e BINDPLANE_GENERATOR_JSON_WORKERS=2 \
  -e BINDPLANE_GENERATOR_JSON_RATE=500ms \
  -e BINDPLANE_OUTPUT_TYPE=tcp \
  -e BINDPLANE_OUTPUT_TCP_HOST=logs.example.com \
  -e BINDPLANE_OUTPUT_TCP_PORT=9090 \
  -e BINDPLANE_OUTPUT_TCP_WORKERS=3 \
  -e BINDPLANE_LOGGING_LEVEL=info \
  ghcr.io/observiq/blitz:latest

For detailed configuration options, see the Configuration Guide.

Community

The Blitz is an open source project. If you'd like to contribute, take a look at our contribution guidelines and developer guide. We look forward to building with you.

Similar Tools

• flog - A fake log generator for common log formats