icydb-core 0.179.5

//! Module: metrics::sink::events
//! Responsibility: stable instrumentation event taxonomy for metrics sinks.
//! Does not own: global metrics state mutation or report rendering.
//! Boundary: exposes event enums consumed by metrics sinks and runtime instrumentation.

use crate::error::{ErrorClass, InternalError};

///
/// ExecKind
///

#[derive(Clone, Copy, Debug)]
#[remain::sorted]
pub enum ExecKind {
    Delete,
    Load,
    Save,
}

///
/// ExecOutcome
///

#[derive(Clone, Copy, Debug)]
#[remain::sorted]
pub enum ExecOutcome {
    Aborted,
    ErrorConflict,
    ErrorCorruption,
    ErrorIncompatiblePersistedFormat,
    ErrorInternal,
    ErrorInvariantViolation,
    ErrorNotFound,
    ErrorUnsupported,
    Success,
}

///
/// CacheKind
///

#[derive(Clone, Copy, Debug)]
#[remain::sorted]
pub enum CacheKind {
    SharedQueryPlan,
    SqlCompiledCommand,
}

///
/// CacheOutcome
///

#[derive(Clone, Copy, Debug)]
#[remain::sorted]
pub enum CacheOutcome {
    Hit,
    Insert,
    Miss,
}

///
/// CacheMissReason
///
/// Stable cache miss reason buckets for cache identities that already have a
/// scoped entity path. These categories explain why a lookup missed without
/// exposing query text, field names, or schema hashes in the metrics report.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum CacheMissReason {
    Cold,
    DistinctKey,
    MethodVersion,
    SchemaFingerprint,
    SchemaVersion,
    Surface,
    Visibility,
}

impl ExecOutcome {
    // Map the crate's typed runtime error taxonomy into stable metrics buckets.
    #[remain::check]
    pub(super) const fn from_error(error: &InternalError) -> Self {
        #[remain::sorted]
        match error.class() {
            ErrorClass::Conflict => Self::ErrorConflict,
            ErrorClass::Corruption => Self::ErrorCorruption,
            ErrorClass::IncompatiblePersistedFormat => Self::ErrorIncompatiblePersistedFormat,
            ErrorClass::Internal => Self::ErrorInternal,
            ErrorClass::InvariantViolation => Self::ErrorInvariantViolation,
            ErrorClass::NotFound => Self::ErrorNotFound,
            ErrorClass::Unsupported => Self::ErrorUnsupported,
        }
    }
}

///
/// SaveMutationKind
///

#[derive(Clone, Copy, Debug)]
#[remain::sorted]
pub enum SaveMutationKind {
    Insert,
    Replace,
    Update,
}

///
/// MutationCommitClass
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum MutationCommitClass {
    DurableOnly,
    LiveOnly,
    MixedDurableAndLive,
}

///
/// SchemaReconcileOutcome
///
/// Stable startup/metadata reconciliation outcomes for the schema trust
/// boundary. The enum is intentionally low-cardinality so metrics can explain
/// schema acceptance failures without exposing field names or diagnostic text.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum SchemaReconcileOutcome {
    ExactMatch,
    FirstCreate,
    LatestSnapshotCorrupt,
    RejectedFieldSlot,
    RejectedOther,
    RejectedRowLayout,
    RejectedSchemaVersion,
    StoreWriteError,
}

///
/// SchemaTransitionOutcome
///
/// Stable schema transition policy buckets. These counters isolate the policy
/// decision for an existing accepted snapshot from broader reconciliation
/// outcomes such as first-create writes, corrupt stores, or store failures.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum SchemaTransitionOutcome {
    AppendOnlyNullableFields,
    ExactMatch,
    RejectedEntityIdentity,
    RejectedFieldContract,
    RejectedFieldSlot,
    RejectedRowLayout,
    RejectedSchemaVersion,
    RejectedSnapshot,
}

///
/// SqlCompileRejectPhase
///
/// Stable SQL compile rejection buckets. These counters identify the broad
/// admission phase that rejected a SQL command without exposing SQL text,
/// parser diagnostics, field names, or lowered query details.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum SqlCompileRejectPhase {
    CacheKey,
    Parse,
    Semantic,
}

///
/// SqlWriteKind
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum SqlWriteKind {
    Delete,
    Insert,
    InsertSelect,
    Update,
}

///
/// PlanKind
///

#[derive(Clone, Copy, Debug)]
#[remain::sorted]
pub enum PlanKind {
    ByKey,
    ByKeys,
    FullScan,
    IndexMultiLookup,
    IndexPrefix,
    IndexRange,
    Intersection,
    KeyRange,
    Union,
}

///
/// PlanChoiceReason
///
/// Stable selected-route reason buckets for non-index and primary-key access
/// choices. These counters explain why a query did not land on a secondary
/// index route without exposing predicates, literals, or index names.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum PlanChoiceReason {
    ConflictingPrimaryKeyChildrenAccessPreferred,
    ConstantFalsePredicate,
    EmptyChildAccessPreferred,
    FullScanAccess,
    IntentKeyAccessOverride,
    LimitZeroWindow,
    NonIndexAccess,
    PlannerCompositeNonIndex,
    PlannerFullScanFallback,
    PlannerKeySetAccess,
    PlannerPrimaryKeyLookup,
    PlannerPrimaryKeyRange,
    RequiredOrderPrimaryKeyRangePreferred,
    SingletonPrimaryKeyChildAccessPreferred,
}

///
/// PreparedShapeFinalizationOutcome
///
/// Stable executor authority outcome buckets for prepared static execution-planning contract
/// finalization. These counters show whether executor lowering preserved an
/// already-frozen schema-selected shape or applied the generated-model fallback.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum PreparedShapeFinalizationOutcome {
    AlreadyFinalized,
    GeneratedFallback,
}

///
/// GroupedPlanExecutionMode
///
/// Canonical grouped-plan mode carried by metrics events.
/// This keeps grouped metrics classification structured without routing
/// through string codes that the sink would immediately decode again.
///
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[remain::sorted]
pub enum GroupedPlanExecutionMode {
    HashMaterialized,
    OrderedMaterialized,
}

///
/// MetricsEvent
///

#[derive(Clone, Copy, Debug)]
#[remain::sorted]
pub enum MetricsEvent {
    AcceptedSchemaFootprint {
        entity_path: &'static str,
        fields: u64,
        nested_leaf_facts: u64,
    },
    Cache {
        entity_path: &'static str,
        kind: CacheKind,
        outcome: CacheOutcome,
    },
    CacheEntries {
        kind: CacheKind,
        entries: u64,
    },
    CacheMissReason {
        entity_path: &'static str,
        kind: CacheKind,
        reason: CacheMissReason,
    },
    ExecError {
        kind: ExecKind,
        entity_path: &'static str,
        outcome: ExecOutcome,
    },
    ExecFinish {
        kind: ExecKind,
        entity_path: &'static str,
        rows_touched: u64,
        inst_delta: u64,
        outcome: ExecOutcome,
    },
    ExecStart {
        kind: ExecKind,
        entity_path: &'static str,
    },
    IndexDelta {
        entity_path: &'static str,
        inserts: u64,
        removes: u64,
    },
    LoadRowEfficiency {
        entity_path: &'static str,
        candidate_rows_scanned: u64,
        candidate_rows_filtered: u64,
        result_rows_emitted: u64,
    },
    MutationCommitPlan {
        entity_path: &'static str,
        class: MutationCommitClass,
    },
    NonAtomicPartialCommit {
        entity_path: &'static str,
        committed_rows: u64,
    },
    Plan {
        entity_path: &'static str,
        kind: PlanKind,
        grouped_execution_mode: Option<GroupedPlanExecutionMode>,
    },
    PlanChoice {
        entity_path: &'static str,
        reason: PlanChoiceReason,
    },
    PreparedShapeFinalization {
        entity_path: &'static str,
        outcome: PreparedShapeFinalizationOutcome,
    },
    RelationValidation {
        entity_path: &'static str,
        reverse_lookups: u64,
        blocked_deletes: u64,
    },
    ReverseIndexDelta {
        entity_path: &'static str,
        inserts: u64,
        removes: u64,
    },
    RowsAggregated {
        entity_path: &'static str,
        rows_aggregated: u64,
    },
    RowsEmitted {
        entity_path: &'static str,
        rows_emitted: u64,
    },
    RowsFiltered {
        entity_path: &'static str,
        rows_filtered: u64,
    },
    RowsScanned {
        entity_path: &'static str,
        rows_scanned: u64,
    },
    SaveMutation {
        entity_path: &'static str,
        kind: SaveMutationKind,
        rows_touched: u64,
    },
    SchemaReconcile {
        entity_path: &'static str,
        outcome: SchemaReconcileOutcome,
    },
    SchemaStoreFootprint {
        encoded_bytes: u64,
        entity_path: &'static str,
        latest_snapshot_bytes: u64,
        snapshots: u64,
    },
    SchemaTransition {
        entity_path: &'static str,
        outcome: SchemaTransitionOutcome,
    },
    SqlCompileReject {
        entity_path: &'static str,
        phase: SqlCompileRejectPhase,
    },
    SqlWrite {
        entity_path: &'static str,
        kind: SqlWriteKind,
        matched_rows: u64,
        mutated_rows: u64,
        returning_rows: u64,
    },
    SqlWriteError {
        entity_path: &'static str,
        kind: SqlWriteKind,
        class: ErrorClass,
    },
    UniqueViolation {
        entity_path: &'static str,
    },
}