/** * Benchkit OTLP Semantic Conventions * * Canonical attribute names and valid values for the benchkit OTLP contract. * Source of truth: docs/otlp-semantic-conventions.md * * Every benchkit OTLP producer and consumer should import from this module * rather than hard-coding attribute strings. */ /** Unique run artifact identifier, e.g. `"12345678-1"`. Required. */ export declare const ATTR_RUN_ID = "benchkit.run_id"; /** Benchmark kind: code, workflow, or hybrid. Required. */ export declare const ATTR_KIND = "benchkit.kind"; /** Parser / origin format that produced the OTLP data. Required. */ export declare const ATTR_SOURCE_FORMAT = "benchkit.source_format"; /** Git ref (branch or tag). Strongly recommended. */ export declare const ATTR_REF = "benchkit.ref"; /** Full commit SHA. Strongly recommended. */ export declare const ATTR_COMMIT = "benchkit.commit"; /** GitHub Actions workflow name. Strongly recommended. */ export declare const ATTR_WORKFLOW = "benchkit.workflow"; /** GitHub Actions job name. Strongly recommended. */ export declare const ATTR_JOB = "benchkit.job"; /** Retry/rerun attempt number. Optional. */ export declare const ATTR_RUN_ATTEMPT = "benchkit.run_attempt"; /** Human-readable runner description. Optional. */ export declare const ATTR_RUNNER = "benchkit.runner"; /** OpenTelemetry standard service name. Strongly recommended. */ export declare const ATTR_SERVICE_NAME = "service.name"; /** Application or service version. Optional. */ export declare const ATTR_SERVICE_VERSION = "service.version"; /** All resource attributes that MUST be present. */ export declare const REQUIRED_RESOURCE_ATTRIBUTES: readonly ["benchkit.run_id", "benchkit.kind", "benchkit.source_format"]; /** Primary benchmark scenario / workload name. Required. */ export declare const ATTR_SCENARIO = "benchkit.scenario"; /** Series identity within a scenario. Required. */ export declare const ATTR_SERIES = "benchkit.series"; /** Metric improvement direction. Required for comparison-eligible metrics. */ export declare const ATTR_METRIC_DIRECTION = "benchkit.metric.direction"; /** Metric role: outcome or diagnostic. Recommended. */ export declare const ATTR_METRIC_ROLE = "benchkit.metric.role"; /** * Datapoint attributes consumed internally by the projection logic. * These are not forwarded as user-visible benchmark tags. */ export declare const RESERVED_DATAPOINT_ATTRIBUTES: Set; /** Valid values for `benchkit.kind`. */ export declare const VALID_RUN_KINDS: readonly ["code", "workflow", "hybrid"]; export type RunKind = (typeof VALID_RUN_KINDS)[number]; /** Valid values for `benchkit.metric.direction`. */ export declare const VALID_DIRECTIONS: readonly ["bigger_is_better", "smaller_is_better"]; export type Direction = (typeof VALID_DIRECTIONS)[number]; /** Valid values for `benchkit.metric.role`. */ export declare const VALID_METRIC_ROLES: readonly ["outcome", "diagnostic"]; export type MetricRole = (typeof VALID_METRIC_ROLES)[number]; /** Valid values for `benchkit.source_format`. */ export declare const VALID_SOURCE_FORMATS: readonly ["go", "otlp", "rust", "hyperfine", "pytest-benchmark", "benchmark-action"]; export type SourceFormat = (typeof VALID_SOURCE_FORMATS)[number]; /** Default Git branch name used for storing benchmark data. */ export declare const DEFAULT_DATA_BRANCH = "bench-data"; /** * Prefix reserved for infrastructure / diagnostic metrics emitted by the * benchkit monitor action (e.g. `_monitor.cpu_user_pct`). */ export declare const MONITOR_METRIC_PREFIX = "_monitor."; //# sourceMappingURL=otlp-conventions.d.ts.map