CDviz Collector β
Collect events from your SDLC, transform them into CDEvents, and dispatch to various destinations.
Quick Start β
New to CDviz Collector? Get a working setup in 5 minutes:
π Quick Start Guide - Webhook β Transform β Save to files
Learning Paths β
π Tutorials (Learning-Oriented) β
Step-by-step lessons to build understanding:
- Quick Start - 5 min setup with webhook and file output
π§ How-to Guides (Problem-Oriented) β
Practical solutions for specific tasks:
Integrations:
- GitHub - Repository events with signatures
- Kubernetes - Cluster events via Kubewatch
Common Tasks:
- Troubleshooting - Debug configuration and connectivity issues
- Authentication - Secure outgoing requests
- Validation - Validate incoming webhooks
π Reference (Information-Oriented) β
Complete technical specifications:
Configuration:
- Configuration Guide - Main config structure and environment variables
- TOML Syntax - Configuration file format help
- CLI Usage - Command-line interface
Commands:
connect- Launch collector as a server to connect sources to sinks.send- Send JSON data directly to a sink for testing and scripting.transform- Transform local JSON files using configured transformers or test transformer.
Components:
- Sources - Event collection: Webhook, Files, SSE, Noop
- Transformers - Event processing with VRL
- Sinks - Event delivery: Database, HTTP, Files, SSE, Debug
π§ Explanation (Understanding-Oriented) β
Concepts and design decisions:
- CDEvents Standard - Why we use CDEvents for standardization
Architecture Concepts:
- Pipeline Flow: External Systems β Sources β Transformers β Sinks β Destinations
- Message Structure: All events have
metadata,headers, andbodycomponents - Parallel Processing: Sources, transformers, and sinks run independently
- Deployment Patterns: Single instance (simple) β Multiple instances (scalable) β Hub-and-spoke (enterprise)
Installation β
bash
# Quick install
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/cdviz-dev/cdviz-collector/releases/download/v0.6.4/cdviz-collector-installer.sh | sh
# Verify
cdviz-collector --versionFull Installation Guide - Docker, Kubernetes, Homebrew, and more options