Skip to content

knob-naming vocabulary inconsistent across 14 patterndetector window knobs #399

Description

@trilamsr

The patterndetector exposes 14 time-bounded knobs across 11 detectors. The shape per knob is consistent (audit landed in PR #388 / closes #367), but the YAML key suffix vocabulary is inconsistent for the same shape:

One-sided lookback knobs (same shape, four different suffixes):

Trailing-window-rate knobs (collide with lookback suffix):

Operators reading the YAML cannot tell from the key whether a _window knob is a lookback or a trailing-rate window. Both shapes use _window.

Wall-clock freshness knobs (same shape, two different suffixes):

Proposed convention (for v1.0 knob-migration window)

  • Lookback windows: <pattern>_lookback_window
  • Trailing-rate windows: <pattern>_rate_window
  • Asymmetric windows: <pattern>_backward_window / <pattern>_forward_window (already consistent on pattern Add developer foundation: Git hooks suite, issue templates, editorconfig #11)
  • Freshness thresholds: <pattern>_freshness_threshold
  • Pattern-anchored prefix mandatory (pod_evicted_lookback_window, not bare join_window).

Why this is filed as a follow-up not a same-PR fix

A YAML knob rename is operator-visible and breaking. It needs:

  1. A deprecation period (alias old knob → new knob, warn on use, drop in v1.x).
  2. Coordinated documentation across all detector pattern docs.
  3. A migration script for operators on existing tracecore deployments.

Land this in a single coordinated v0.x → v1.0 knob-migration PR rather than scattered across patch releases. The current names are not wrong per se — they just don't compose into a vocabulary an operator can predict.

Refs #367 (audit landed in #388, decision documented in docs/patterns/README.md §Correlation-window semantics).

Metadata

Metadata

Assignees

No one assigned

    Labels

    rc1-prepv1.0-rc1 preparation tasks per docs/v1-rc1-operational-gaps.md

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions