Documentation
¶
Overview ¶
Package metrics provides a formula registry for computing derived signal metrics.
The registry allows pluggable Compute functions for metrics like frustration, momentum, reach, and urgency. Each formula is registered by name and can be retrieved and executed against a set of signals.
Example:
import "github.com/plexusone/omnisignal/metrics"
// Compute frustration for a signal group
formula := metrics.Get("frustration")
result, err := formula.Compute(ctx, signals, metrics.Options{
Weights: map[string]float64{"support_ticket": 1.5},
})
Index ¶
Constants ¶
const DefaultMomentumWindowDays = 30
Variables ¶
var ( ErrFormulaNotFound = errors.New("formula not found") ErrNoSignals = errors.New("no signals provided") ErrInvalidWeight = errors.New("invalid weight value") )
Common errors.
var DefaultFrustrationWeights = map[string]float64{
"support_ticket": 1.0,
"cloud_incident": 2.0,
"security_finding": 1.5,
"posture_drift": 0.5,
"alert": 0.5,
"outage": 3.0,
"vulnerability": 1.0,
"feedback": 0.8,
"enhancement_request": 0.5,
"competitive_gap": 0.3,
"competitor_launch": 0.2,
"analyst_finding": 0.2,
"market_observation": 0.1,
}
Default weights by signal type for frustration score.
var DefaultSeverityWeights = map[common.Severity]float64{ common.SeverityCritical: 4.0, common.SeverityHigh: 3.0, common.SeverityMedium: 2.0, common.SeverityLow: 1.0, common.SeverityInfo: 0.5, }
DefaultSeverityWeights maps severity levels to weights.
Functions ¶
func ClearRegistry ¶
func ClearRegistry()
ClearRegistry removes all formulas. Primarily for testing.
func IsRegistered ¶
IsRegistered checks if a formula is registered.
func Register ¶
func Register(f Formula)
Register adds a formula to the global registry. Later registrations with the same name override earlier ones.
func RegisterBuiltins ¶
func RegisterBuiltins()
RegisterBuiltins re-registers all built-in formulas. Use after ClearRegistry() in tests that need the standard formulas.
Types ¶
type Config ¶
type Config struct {
// Weights overrides default weights for signal types, sources, or severities.
Weights map[string]float64 `json:"weights,omitempty"`
// WindowDays is the default trailing window for time-bounded metrics.
WindowDays int `json:"window_days,omitempty"`
// Extra holds formula-specific configuration.
Extra map[string]any `json:"extra,omitempty"`
}
Config holds metrics configuration including weight overrides.
func ConfigFromProviderOptions ¶
ConfigFromProviderOptions extracts metrics Config from omnisignal.Config.Options. Looks for "metrics" key containing a Config-shaped object.
func LoadConfig ¶
LoadConfig reads metrics configuration from a JSON file.
func LoadConfigOrDefault ¶
LoadConfigOrDefault reads metrics configuration from a JSON file. If the file doesn't exist, returns an empty Config (no error).
type Formula ¶
type Formula interface {
// Name returns the metric identifier.
Name() string
// Description returns a brief explanation of what the metric measures.
Description() string
// Compute calculates the metric for the given signals.
Compute(ctx context.Context, signals []signal.Signal, opts Options) (Result, error)
}
Formula defines a pluggable metric computation.
type FormulaFunc ¶
type FormulaFunc struct {
// contains filtered or unexported fields
}
FormulaFunc adapts a function to the Formula interface.
func (FormulaFunc) Compute ¶
func (f FormulaFunc) Compute(ctx context.Context, signals []signal.Signal, opts Options) (Result, error)
Compute delegates to the wrapped function.
func (FormulaFunc) Description ¶
func (f FormulaFunc) Description() string
Description returns a brief explanation.
type Options ¶
type Options struct {
// Weights overrides default weights by signal type or source.
// Keys can be signal types (e.g., "support_ticket") or source names
// (e.g., "pagerduty"). More specific keys take precedence.
Weights map[string]float64
// Now overrides the current time for age calculations.
// Zero value uses time.Now().
Now time.Time
// WindowDays limits signals to those observed within this many days.
// Zero means no time window filter.
WindowDays int
// Extra holds formula-specific options.
Extra map[string]any
}
Options configures metric computation.
type Result ¶
type Result struct {
// Name is the metric name (e.g., "frustration", "momentum").
Name string
// Value is the computed metric value.
Value float64
// Breakdown provides per-component contributions to the value.
// Keys are component identifiers (signal types, sources, etc.).
Breakdown map[string]float64
// ComputedAt is when this result was generated.
ComputedAt time.Time
// SignalCount is the number of signals used in computation.
SignalCount int
// Metadata holds formula-specific additional data.
Metadata map[string]any
}
Result holds the output of a metric computation.