docs/modules/yaml/pages/trace-obj.adoc

   1 = YAML trace object
   2
   3 A _**trace object**_ represents a
   4 xref:how-barectf-works:ctf-primer.adoc[CTF trace].
   5
   6 A trace object has a xref:trace-type-obj.adoc[type] and an
   7 optional environment.
   8
   9 As of barectf{nbsp}{page-component-version}, a
  10 xref:cfg-obj.adoc[configuration object] has a single trace object.
  11
  12 == Properties
  13
  14 [%autowidth.stretch, cols="d,d,a,d,d"]
  15 |===
  16 |Name |Type |Description |{req-abbr} |Default
  17
  18 |[[type-prop]]`type`
  19 |xref:trace-type-obj.adoc[Trace type object]
  20 |Type of this trace (metadata part).
  21 |Yes
  22 |
  23
  24 |[[env-prop]]`environment`
  25 |Mapping of string keys to integer or string values
  26 |This trace's environment variables.
  27
  28 Keys of this mapping are environment variable names. They must be valid
  29 xref:index.adoc#tsdl-ident[TSDL identifiers].
  30
  31 A CTF trace reader can read the variables of this mapping.
  32 |No
  33 |Empty mapping
  34
  35 |[[include-prop]]`$include`
  36 |Sequence of strings.
  37 |See xref:include.adoc[].
  38 |No
  39 |No inclusions
  40 |===
  41
  42 == Examples
  43
  44 NOTE: The following examples omit the <<type-prop,trace type object>>
  45 for clarity.
  46
  47 .Basic trace object.
  48 ====
  49 [source,yaml]
  50 ----
  51 type:
  52   # ...
  53 ----
  54 ====
  55
  56 .Trace object with <<env-prop,environment variables>>.
  57 ====
  58 [source,yaml]
  59 ----
  60 type:
  61   # ...
  62 environment:
  63   my_program_version_major: 1
  64   my_program_version_minor: 6
  65   os: Palm OS
  66 ----
  67 ====
  68
  69 .Trace object with an <<include-prop,inclusion>>.
  70 ====
  71 [source,yaml]
  72 ----
  73 type:
  74   # ...
  75 $include: [my-env.yaml]
  76 ----
  77 ====