mirror of
https://github.com/fleetdm/fleet
synced 2026-04-21 21:47:20 +00:00
544d2a4731
We are planning to productize OTEL for our on-prem customers. This makes our on-prem offering more attractive against our competition. As part of our on-prem story, we need to make telemetry a first-class experience. --------- Co-authored-by: Luke Heath <luke@fleetdm.com>
49 lines
2.2 KiB
Markdown
49 lines
2.2 KiB
Markdown
# Architectural Decision Records (ADRs)
|
|
|
|
This directory contains Architectural Decision Records (ADRs) for Fleet.
|
|
|
|
## What are ADRs?
|
|
|
|
Architectural Decision Records (ADRs) are documents that capture important architectural decisions made along with their context and consequences. They provide a record of architectural decisions that affect the system, the context in which they were made, and the rationale behind them.
|
|
|
|
## Why use ADRs?
|
|
|
|
ADRs help teams:
|
|
- Document important decisions for future reference
|
|
- Communicate the reasoning behind decisions
|
|
- Onboard new team members by providing context
|
|
- Track the evolution of the system architecture over time
|
|
|
|
## ADR format
|
|
|
|
Each ADR follows a standard format:
|
|
|
|
1. **Title**: A descriptive title that summarizes the decision
|
|
2. **Status**: Proposed, Accepted, Rejected, Deprecated, or Superseded
|
|
3. **Context**: The context and problem statement that led to this decision
|
|
4. **Decision**: The decision that was made
|
|
5. **Consequences**: The consequences of the decision, both positive and negative
|
|
6. **References**: Any references to related documents or resources
|
|
|
|
## Creating a new ADR
|
|
|
|
To create a new ADR:
|
|
|
|
1. Copy the [template](template.md) to a new file named `NNNN-descriptive-title.md` where `NNNN` is the next number in sequence
|
|
2. Fill in the template with your decision
|
|
3. Submit a pull request with your new ADR
|
|
|
|
## ADR index
|
|
|
|
<!-- Add new ADRs to this list -->
|
|
|
|
- [ADR Template](template.md)
|
|
- [ADR-0001: Pilot service layer packages](0001-pilot-service-layer-packages.md)
|
|
- [ADR-0002: Do not use GitHub Discussions](0002-github-discussions.md)
|
|
- [ADR-0003: Fork management](0003-fork-management.md) (Rejected)
|
|
- [ADR-0004: Third-party library vendoring](0004-third-party-vendoring.md)
|
|
- [ADR-0005: Standardize on OpenTelemetry for observability](0005-opentelemetry-standardization.md)
|
|
- [ADR-0006: Replace "No Team" with real default team](0006-replace-no-team-with-default-team.md)
|
|
- [ADR-0007: Pilot activity bounded context](0007-pilot-activity-bounded-context.md)
|
|
- [ADR-0008: Migrate from go-kit/log to slog](0008-migrate-to-slog.md)
|
|
- [ADR-0009: Attribute naming conventions for logs, traces, and metrics](0009-otel-attribute-naming-conventions.md)
|