Crusher

Crusher generates statistics from raw events.

Requirements

• REview 0.48.0 or higher
• Giganto 0.27.0 or higher

Usage

You can run Crusher by invoking the following command:

crusher \
 --cert <CERT_PATH> \
 --key <KEY_PATH> \
 --ca-certs <CA_CERTS_PATH> \
 <SERVER_NAME>@<SERVER_IP>:<SERVER_PORT>

To run Crusher with a local configuration file, with multiple CA certificates:

crusher \
 -c <CONFIG_PATH> \
 --cert <CERT_PATH> \
 --key <KEY_PATH> \
 --ca-certs <CA_CERTS_PATH1>[,<CA_CERTS_PATH2>,...] \
 <SERVER_NAME>@<SERVER_IP>:<SERVER_PORT>

Arguments

• <CONFIG_PATH>: Path to the TOML configuration file (optional).
  • If provided, Crusher runs in local mode, ignoring configuration updates from the manager server.
  • If omitted, Crusher runs in remote mode, with its configuration managed by the manager server.
• <CERT_PATH>: Path to the certificate file (required).
• <KEY_PATH>: Path to the private key file (required).
• <CA_CERTS_PATH>: Path to the CA certificates file (required). Multiple values can be provided as a comma-separated list.
• <SERVER_NAME>: Name of the manager server. This must match with the DNS name in the certificate (required).
• <SERVER_IP>:<SERVER_PORT>: The IP address and port number of the manager server (required).

Example

• Remote mode

crusher \
 --cert path/to/cert.pem \
 --key path/to/key.pem \
 --ca-certs path/to/ca_cert.pem \
 manager@10.0.0.1:38390

• Local mode

crusher \
 -c path/to/config.toml \
 --cert path/to/cert.pem \
 --key path/to/key.pem \
 --ca-certs path/to/ca_cert.pem \
 manager@10.0.0.1:38390

Configuration

In the configuration file, you can specify the following options:

Field	Description	Required	Default
giganto_name	Name of the Giganto server	No	-
giganto_ingest_srv_addr	Giganto's ingest IP address and port number	Yes	-
giganto_publish_srv_addr	Giganto's publish IP address and port number	Yes	-
last_timestamp_data	JSON file that stores the timestamp of the last time series per sampling policy	Yes	-
log_path	Log file path	No	-

• giganto_publish_srv_addr and giganto_ingest_srv_addr are required. giganto_name is optional; when present, it takes precedence for the Giganto connection name. When absent, the IP from the addresses is used only if both point to the same IP; otherwise a configuration error is returned.
• giganto_name: This must match with the DNS name in the certificate.
• log_path: If not provided, logs are printed to stdout.

Configuration Examples

Without giganto_name (the IP from giganto_publish_srv_addr is used as the connection name):

giganto_ingest_srv_addr = "127.0.0.1:38370"
giganto_publish_srv_addr = "127.0.0.1:38371"
last_timestamp_data = "path/to/time_data.json"

With giganto_name (takes precedence over the address IP):

giganto_name = "my-giganto"
giganto_ingest_srv_addr = "127.0.0.1:38370"
giganto_publish_srv_addr = "127.0.0.1:38371"
last_timestamp_data = "path/to/time_data.json"
log_path = "path/to/time_series_generator.log"

Documentation

• Manual entry point: docs/en/index.md (English)
• 매뉴얼 시작점: docs/ko/index.md (한국어)

Build locally:

brew install python gh
python3 -m venv .venv
# zsh/bash:
source .venv/bin/activate
# fish:
source .venv/bin/activate.fish
pip install mkdocs-material mkdocs-static-i18n mkdocs-with-pdf PyYAML
./scripts/fetch-theme.sh
mkdocs serve -a 127.0.0.1:8000 --livereload --dirtyreload

Command notes:

• brew install python gh: installs Python and GitHub CLI (one-time per machine). gh is required to fetch the shared docs theme.
• python3 -m venv .venv: creates a local virtualenv for this repo.
• source .venv/bin/activate: activates the virtualenv for the current shell.
• pip install ...: installs MkDocs tooling into the virtualenv.
• Run the pip install ... step once after creating the virtualenv (per clone).
• ./scripts/fetch-theme.sh: fetches the shared docs theme from aicers/docs-theme. The version and template are declared in docs/theme.toml. Subsequent runs skip the download if the installed version already matches.
• mkdocs serve -a 127.0.0.1:8000 --livereload --dirtyreload: runs a local docs server.
• mkdocs build: builds static files into site/.

PDF Generation

Native dependencies (macOS):

brew install cairo pango gdk-pixbuf libffi

Build a PDF manual:

./scripts/build-docs-pdf.sh en|ko

The script produces site/pdf/crusher-manual.{locale}.pdf.

Copyright

• Copyright 2023-2026 ClumL Inc.