TelemetrySample platform.telemetry-sample@1

Generated at from openvibe-contracts v0.84.0 and openvibe-sdk v0.26.0.

Version
1.0.0
Owner
network
Visibility
public
Status
active
Compatibility
backward
Decision
ADR-034
Schema
https://openvibe.network/contracts/platform/telemetry-sample.v1.json

Universal operation observation for routing and autoscaling, with product dimensions in extra (T1 Universal Fabric; ADR-034 proposed).

Fields

FieldTypeRequiredDescriptionConstraints
servicestringyes
projectstring
  • pattern ^prj_[0-9A-HJKMNP-TV-Z]{26}$
subjectstring
resourcestring
providerstring
nodestring
cellstring
regionstring
operationstringyes
atstringyes
  • format date-time
latency_msnumber
  • minimum 0
queue_delay_msnumber
  • minimum 0
ttfb_msnumberTime to first byte in milliseconds
  • minimum 0
throughput_per_secondnumberOperation units per second
  • minimum 0
bytesinteger
  • minimum 0
statusstring
cache_statusstring
cost_estimatenumberEstimated USD
  • minimum 0
route_epochinteger
  • minimum 0
trace_idstring
extraobjectProduct-specific scalar dimensions; no payloads or secrets

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: example
{
  "service": "media",
  "project": "prj_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "subject": "user:usr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "resource": "object-1",
  "provider": "local",
  "node": "node-1",
  "cell": "cell-west",
  "region": "us-west",
  "operation": "deliver",
  "at": "2026-09-30T10:00:00Z",
  "latency_ms": 28,
  "queue_delay_ms": 2,
  "ttfb_ms": 11,
  "throughput_per_second": 1048576,
  "bytes": 4096,
  "status": "ok",
  "cache_status": "hit",
  "cost_estimate": 0.0001,
  "route_epoch": 3,
  "trace_id": "tr-42",
  "extra": {
    "transport": "http"
  }
}
Rejected: missing-service
{
  "project": "prj_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "subject": "user:usr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "resource": "object-1",
  "provider": "local",
  "node": "node-1",
  "cell": "cell-west",
  "region": "us-west",
  "operation": "deliver",
  "at": "2026-09-30T10:00:00Z",
  "latency_ms": 28,
  "queue_delay_ms": 2,
  "ttfb_ms": 11,
  "throughput_per_second": 1048576,
  "bytes": 4096,
  "status": "ok",
  "cache_status": "hit",
  "cost_estimate": 0.0001,
  "route_epoch": 3,
  "trace_id": "tr-42",
  "extra": {
    "transport": "http"
  }
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('platform.telemetry-sample@1', value);   // { valid, errors: [{ path, message }] }