# Concord v1.1.0 - Table of Contents

## Pages

- Getting Started
  - [Concord](readme.md)
  - [Getting Started](getting-started.md)

- Guides
  - [Elixir API Guide](elixir-guide.md)
  - [Observability](observability.md)
  - [Backup and Restore](backup-restore.md)
  - [Configuration](configuration.md)
  - [Production Deployment](deployment.md)

- HTTP API
  - [Concord HTTP API Design](api_design.md)
  - [Concord HTTP API Usage Examples](api_usage_examples.md)

- Architecture
  - [Project Concord: Design Blueprint](design.md)

- Release Notes
  - [Changelog](changelog.md)
  - [LICENSE](license.md)

## Modules

- [Concord](Concord.md): Public API for the Concord distributed key-value store.
- [Concord.Application](Concord.Application.md): Application supervisor for Concord distributed key-value store.
Starts and manages all the necessary processes including clustering,
telemetry, HTTP API, and the Raft consensus algorithm.

- [Concord.AuditLog](Concord.AuditLog.md): Comprehensive audit logging for Concord operations.
- [Concord.AuditLog.TelemetryHandler](Concord.AuditLog.TelemetryHandler.md): Telemetry handler that automatically creates audit log entries from
Concord operations.
- [Concord.Backup](Concord.Backup.md): Backup and restore functionality for Concord distributed KV store.
- [Concord.Compression](Concord.Compression.md): Value compression for Concord KV store.
- [Concord.EventStream](Concord.EventStream.md): Real-time event streaming for Concord operations using GenStage.
- [Concord.Index](Concord.Index.md): Secondary index support for efficient value-based queries.
- [Concord.Index.Extractor](Concord.Index.Extractor.md): Declarative index extractor specifications.
- [Concord.Prometheus](Concord.Prometheus.md): Prometheus metrics exporter for Concord.
- [Concord.Query](Concord.Query.md): Query language for Concord key-value store.
- [Concord.StateMachine](Concord.StateMachine.md): The Raft state machine for Concord (Version 3).
- [Concord.TTL](Concord.TTL.md): TTL (Time-To-Live) management for Concord.
- [Concord.Telemetry](Concord.Telemetry.md): Telemetry integration for Concord.
Emits metrics for monitoring cluster health and performance.

- [Concord.Telemetry.Poller](Concord.Telemetry.Poller.md)
- [Concord.Tracing](Concord.Tracing.md): OpenTelemetry distributed tracing for Concord operations.
- [Concord.Tracing.TelemetryBridge](Concord.Tracing.TelemetryBridge.md): Bridges Concord's Telemetry events to OpenTelemetry spans.
- [Concord.Web.APIController](Concord.Web.APIController.md): Main API controller for Concord HTTP API endpoints.
- [Concord.Web.AuthenticatedRouter](Concord.Web.AuthenticatedRouter.md): Authenticated router for Concord HTTP API endpoints.
- [Concord.Web.HealthController](Concord.Web.HealthController.md): Health check controller for Concord HTTP API.
- [Concord.Web.Router](Concord.Web.Router.md): Main router for Concord HTTP API.
- [Concord.Web.Supervisor](Concord.Web.Supervisor.md): Supervisor for Concord HTTP API web server.
- [Concord.Web.TracingPlug](Concord.Web.TracingPlug.md): Plug for extracting and propagating OpenTelemetry trace context in HTTP requests.

## Mix Tasks

- [mix concord.backup](Mix.Tasks.Concord.Backup.md): Concord backup management tasks.
- [mix concord.cluster](Mix.Tasks.Concord.Cluster.md): Mix tasks for managing Concord clusters.

- [mix concord.gen.cert](Mix.Tasks.Concord.Gen.Cert.md): Generates self-signed TLS certificates for development and testing.