Interfaces

SemanticGrain

Interface: SemanticGrain

Defined in: src/lib/semantics/types.ts:86

The grain — what one value MEANS, stated when it is not what a reader would assume. This is the field that stops a model from adding jobs_local to jobs_replicated_in and announcing a fleet size nobody has.

Properties

aggregation?

readonly optional aggregation?: string

Defined in: src/lib/semantics/types.ts:90

How the values were folded ('avg', 'max', 'sum', 'count', …).


collapsed?

readonly optional collapsed?: string

Defined in: src/lib/semantics/types.ts:99

What was folded away ('per-port rows collapsed to per-switch').


interval?

readonly optional interval?: string

Defined in: src/lib/semantics/types.ts:88

The collection interval the values live on ('30m', '1h', 'daily').


is_counter?

readonly optional is_counter?: boolean

Defined in: src/lib/semantics/types.ts:97

Whether the values are counters. MUST be stated (true or false) whenever aggregation is counter-looking (see COUNTER_AGGREGATION_WORDS): summing two counters double-counts, and a reader cannot tell a counter from a gauge by looking at a number.

On this page