<- Go to Data Types Go to ToC

1. Definition 2. Functional Requirements 3. Syntax 4. Semantics

1 Definition

The Trace Data Type captures the traceability information associated with the execution of an AIM Instance or Process within an MPAI‑AIF V3.0 environment.

2 Functional Requirements

2.1 General Requirements

The Trace object shall:

  • Include a Header matching the pattern
    OSD-TRC-V<major>.<minor>.
  • Include a TraceID uniquely identifying the trace record.
  • Include TraceData, a structured object containing the event source and timestamp.
  • Disallow any undefined fields at the root level
    (additionalProperties: false).

The Trace object may include:

  • MInstance
  • UEnvironment
  • DescrMetadata

2.2 Header – Functional Requirements

  • The header shall indicate the version of the Trace Data Type.
  • It shall match the regular expression:
    ^OSD-TRC-V[0-9]{1,2}[.][0-9]{1,2}$.

2.3 MInstance – Functional Requirements

  • MInstance is optional.
  • When present, it shall be a string uniquely identifying the Metaverse Instance in which the trace was generated.

2.4 UEnvironment – Functional Requirements

  • UEnvironment is optional.
  • When present, it shall be a string uniquely identifying the Universe Environment associated with the event.

2.5 TraceID – Functional Requirements

  • TraceID shall be present.
  • It shall uniquely identify a trace record within the system.

2.6 TraceData – Functional Requirements

The TraceData object shall:

  • Disallow additional properties (additionalProperties: false)
  • Contain:
    • Source (array)
    • Time (Time.json object)

2.6.1 Source – Functional Requirements

The Source field:

  • Shall be an array.
  • Each item in the array shall be one of:
  1. An AIM Instance reference
  2. A Process identifier

This allows representing a trace originating from:

  • a specific AIM instance,
  • or a process executed within a composite AIM or workflow.

2.6.2 Time – Functional Requirements

  • Time is required.
  • It shall reference an OSD time object defined by
    OSD/V1.5/data/Time.json.

The Time object provides the timestamp for the trace event in a standardised format.

3 Syntax

https://schemas.mpai.community/AIF/V3.0/data/Trace.json

4 Semantics

Label Description
Header Trace Header
– Standard-Trace The characters “AIF-TRC-V”
– Version Major version – 1 or 2 characters
– Dot-separator The character “.”
– Subversion Minor version – 1 or 2 characters
MInstance Optional identifier of the Metaverse Instance.
UEnvironment Optional identifier of the Universe Environment.
TraceID Unique identifier for this trace entry.
TraceData Required object containing event source + event time.
TraceData.Source Array of origin descriptors: each one is either an AIMInstance object or a ProcessID string.
TraceData.Time Timestamp of the trace event in OSD/V1.5 Time format.
DescrMetadata Optional free‑text descriptive metadata.

 

<- Go to Data Types    Go to ToC