Files
git.stella-ops.org/docs/modules/timeline-indexer/README.md

57 lines
1.5 KiB
Markdown

# Timeline Indexer
> Timeline event indexing and query service.
## Purpose
TimelineIndexer provides fast, indexed access to timeline events across all StellaOps services. It enables efficient querying of vulnerability history, scan timelines, and policy evaluation trails.
## Quick Links
- [Architecture](./architecture.md) - Technical design and implementation details
- [Guides](./guides/) - Query and configuration guides
## Status
| Attribute | Value |
|-----------|-------|
| **Maturity** | Production |
| **Last Reviewed** | 2025-12-29 |
| **Maintainer** | Platform Guild |
## Key Features
- **Event Indexing**: Index events from multiple StellaOps services
- **Time-Range Queries**: Efficient time-series queries with filtering
- **Event Stream Integration**: Consume from NATS/Valkey event streams
- **PostgreSQL Storage**: Time-series indexes for fast retrieval
## Dependencies
### Upstream (this module depends on)
- **PostgreSQL** - Event storage with time-series indexes
- **NATS/Valkey** - Event stream consumption
- **Authority** - Authentication
### Downstream (modules that depend on this)
- **Web Console** - Timeline visualization
- **CLI** - Timeline queries
- **ExportCenter** - Timeline data exports
## Configuration
```yaml
timeline_indexer:
event_sources:
- nats://events.stellaops.local
retention_days: 365
```
## Notes
TimelineIndexer indexes events; it does not generate them. Events are received from event streams published by other services.
## Related Documentation
- [Telemetry Architecture](../telemetry/architecture.md)