Back to Quickwit

ADR-NNN: Title

docs/internals/adr/000-template.md

0.9.01.9 KB
Original Source

ADR-NNN: Title

Metadata

  • Status: [Proposed | Accepted | Deprecated | Superseded]
  • Date: YYYY-MM-DD
  • Tags: [e.g., storage, query, protocol, testing, metrics, traces, logs]
  • Components: [e.g., quickwit-metrics-engine, quickwit-indexing]
  • Authors: [Names]

Context

What is the issue that we're seeing that is motivating this decision or change?

Decision

What is the change that we're proposing and/or doing?

Consequences

What becomes easier or more difficult to do because of this change?

Positive

  • ...

Negative

  • ...

Risks

  • ...

Signal Generalization

How does this decision apply across metrics, traces, and logs? If it only applies to one signal today, what would need to change for the others?

Decision Log

This section tracks how this ADR evolves as we learn more and make new decisions. Each entry should include the date, what was decided, and why.

DateDecisionRationale
YYYY-MM-DDInitial ADR created[Why this decision was made]

How to Add Entries

When making an architectural decision related to this ADR:

  1. Add a new row to the table above with today's date
  2. Briefly describe the decision made
  3. Explain the rationale (why this choice over alternatives)
  4. If the decision significantly changes the original ADR, update the relevant sections above

Examples of decisions to log:

  • Changed implementation approach based on learnings
  • Added constraints or requirements discovered during implementation
  • Chose between alternative approaches during development
  • Modified scope based on technical discoveries
  • Deferred or rejected features with reasoning

Implementation Status

Implemented

ComponentLocationStatus
.........

Validated

  • ...

Not Yet Implemented

ComponentNotes
......

References

  • ...