domain

Documentation

Overview

Package domain holds the core value types that flow through a ClassMesh pipeline. It has no dependencies and every other package depends on it.

Index

• type Classification
  • func (c Classification) IsValid() bool
• type Kind
• type Reason
• type Record

Types

type Classification

type Classification struct {
	// Category is the assigned label.
	Category string
	// Confidence is in [0, 1]. Deterministic stages emit 1.
	Confidence float64
	// Stage names the stage that produced this classification.
	Stage string
	// Reasons is optional evidence for the classification. Treat it as
	// read-only: a stage may hand back a shared slice (the rules stage does,
	// to stay allocation-free), so callers must not mutate it in place.
	Reasons []Reason
}

Classification is the outcome of running a Record through a stage.

func (Classification) IsValid

func (c Classification) IsValid() bool

IsValid reports whether the classification is well-formed: a non-empty category and a confidence within [0, 1].

type Kind

type Kind string

Kind identifies the shape of a Record's payload. The zero value is KindUnknown.

const (
	KindUnknown Kind = ""
	KindText    Kind = "text"
	KindLog     Kind = "log"
	KindEvent   Kind = "event"
	KindRecord  Kind = "record"
	KindJSON    Kind = "json"
)

type Reason

type Reason struct {
	// Code is a short tag for the evidence, like a rule ID.
	Code string `json:"code"`
	// Detail is a readable description.
	Detail string `json:"detail,omitempty"`
}

Reason explains why a stage picked a category. A stage may attach zero or more.

type Record

type Record struct {
	// ID uniquely identifies the record within a run. Sources assign it.
	ID string
	// Kind identifies the payload shape. Zero value is KindUnknown.
	Kind Kind
	// Data is the raw payload (a log line, a JSON document, ...).
	Data []byte
	// Fields holds structured attributes decoded from the payload, when a
	// source has them. Nil for unstructured payloads.
	Fields map[string]any
	// Meta carries source-specific context (file name, line number, ...).
	Meta map[string]string
}

Record is a single unit of data moving through the pipeline. Sources produce Records, stages classify them, sinks consume them.