Runtime configuration files for Log10x applications and pipelines. This is the main working directory where you configure and customize Log10x deployments.
Full Documentation: doc.log10x.com/config
┌─────────────────────────────────────────────────────────────────────────┐
│ Configuration Flow │
│ │
│ ┌───────────────┐ ┌───────────────┐ ┌───────────────────────┐ │
│ │ apps/ │ │ pipelines/ │ │ data/ │ │
│ │ │ │ │ │ │ │
│ │ config.yaml │───►│ config.yaml │───►│ symbols, samples │ │
│ │ (app entry) │ │ (modules) │ │ templates │ │
│ └───────────────┘ └───────────────┘ └───────────────────────┘ │
│ │ │ │ │
│ └────────────────────┼────────────────────────┘ │
│ ▼ │
│ ┌────────────────────┐ │
│ │ 10x Engine │ │
│ │ │ │
│ │ log10x run/compile │ │
│ └────────────────────┘ │
└─────────────────────────────────────────────────────────────────────────┘
config/
├── apps/ # Application entry points
│ ├── edge/ # Edge applications
│ │ ├── optimizer/ # Log volume reduction
│ │ ├── regulator/ # Policy-based filtering
│ │ ├── reporter/ # Cost attribution
│ │ └── policy/ # Compliance enforcement
│ ├── cloud/ # Cloud applications
│ │ ├── reporter/ # Analyzer cost analysis
│ │ └── streamer/ # S3 data lake (index/query)
│ ├── compiler/ # Symbol compilation
│ └── dev/ # Local development
│
├── pipelines/ # Pipeline module configurations
│ ├── compile/ # Compile pipeline modules
│ │ ├── pull/ # Source retrieval (github, docker, helm)
│ │ ├── scanners/ # Code analysis (antlr, text, archive)
│ │ ├── link/ # Symbol linking
│ │ └── push/ # Artifact output
│ ├── run/ # Run pipeline modules
│ │ ├── input/ # Event sources (forwarders, analyzers)
│ │ ├── initialize/ # Field enrichment (level, k8s, geoIP)
│ │ ├── aggregate/ # Event summarization
│ │ ├── regulate/ # Policy enforcement
│ │ ├── output/ # Event & metric outputs
│ │ └── transform/ # Event processing
│ ├── gitops/ # GitOps workflow config
│ └── doc/ # Documentation generation
│
├── data/ # Runtime data
│ ├── sample/ # Sample log files for testing
│ ├── templates/ # Log templates
│ ├── compile/sources/ # Source code for compilation
│ └── shared/ # Shared assets
│
└── log4j2.yaml # Engine logging configuration
Application configs are entry points that include pipeline modules. Edit these to customize your deployment.
| Application | Config Path | Documentation |
|---|---|---|
| Edge Optimizer | apps/edge/optimizer/config.yaml |
Overview | Run |
| Edge Regulator | apps/edge/regulator/config.yaml |
Overview | Run |
| Edge Reporter | apps/edge/reporter/config.yaml |
Overview | Run |
| Edge Policy | apps/edge/policy/config.yaml |
Overview | Run |
| Cloud Reporter | apps/cloud/reporter/config.yaml |
Overview | Run |
| Storage Streamer | apps/cloud/streamer/*/config.yaml |
Overview | Run |
| Compiler | apps/compiler/config.yaml |
Overview | Run |
| Dev | apps/dev/config.yaml |
Overview | Run |
| Module | Config Path | Documentation |
|---|---|---|
| Pull/GitHub | pipelines/compile/pull/github/ |
Pull Modules |
| Pull/Docker | pipelines/compile/pull/docker/ |
Pull Modules |
| Pull/Helm | pipelines/compile/pull/helm/ |
Pull Modules |
| Scanners | pipelines/compile/scanners/ |
Scanner Modules |
| Link | pipelines/compile/link/ |
Compile Pipeline |
| Push | pipelines/compile/push/ |
Compile Pipeline |
| Module | Config Path | Documentation |
|---|---|---|
| Input/Forwarders | pipelines/run/input/forwarder/ |
Forwarders |
| Input/Analyzers | pipelines/run/input/analyzer/ |
Analyzers |
| Input/Object Storage | pipelines/run/input/objectStorage/ |
Object Storage |
| Initialize | pipelines/run/initialize/ |
Initialize |
| Aggregate | pipelines/run/aggregate/ |
Aggregate |
| Regulate | pipelines/run/regulate/ |
Regulate |
| Output/Event | pipelines/run/output/event/ |
Event Output |
| Output/Metric | pipelines/run/output/metric/ |
Metric Output |
| Transform | pipelines/run/transform/ |
Transform |
All configuration formats are documented at doc.log10x.com/config.
| Format | Description | Documentation |
|---|---|---|
| YAML | Primary config format with +include directives |
YAML Reference |
| JSON | REST request format and schema definitions | JSON Reference |
| JavaScript | Custom scripting and expressions | JavaScript |
| CLI | Command-line arguments | CLI Reference |
| Concept | Description | Documentation |
|---|---|---|
| App Configuration | Entry point config with module includes | App Config |
| Module Configuration | Pipeline module settings | Module Config |
| Symbol Files | Compiled log templates | Symbols |
| Folder Loading | Load configs from disk folders | Folders |
| GitHub Loading | Pull configs from GitHub repos | GitHub |
| Pattern Matching | Regex-based config parsing | Match |
| GitOps Workflow | Centralized config management | GitOps |
Each module folder typically contains:
module-name/
├── config.yaml # Default configuration
├── schema.json # JSON Schema for validation
└── readme.md # Module-specific documentation
apps/config.yaml to uncomment desired modulespipelines/For detailed setup instructions, see the documentation for each application.
| Resource | URL |
|---|---|
| Configuration Hub | doc.log10x.com/config |
| Applications | doc.log10x.com/apps |
| Run Pipeline | doc.log10x.com/run |
| Compile Pipeline | doc.log10x.com/compile |
| Architecture | doc.log10x.com/apps |
| API Reference | doc.log10x.com/api |
This repository is licensed under the Apache License 2.0.
This repository is designed for you to fork and customize. You are free to:
However, running Log10x requires a commercial license.
| What’s Open Source | What Requires License |
|---|---|
| Configuration files in this repo | Log10x engine/runtime |
| Module definitions | Log10x apps (Reporter, Optimizer, etc.) |
| YAML/JSON schemas | Executing pipelines |
The configuration files in this repository are designed for use with the Log10x engine. Think of this like Kubernetes manifests - the YAML is freely available, but you need a cluster to run it.
Get a Log10x License: