8 lttng-add-context - Add context fields to be recorded by LTTng
13 Add context fields to be recorded to the event records of one or more
17 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context*
18 (option:--kernel | option:--userspace | option:--jul | option:--log4j)
19 [option:--session='SESSION'] [option:--channel='CHANNEL']
20 option:--type='TYPE' [option:--type='TYPE']...
22 List the available context field types:
25 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context* option:--list
30 The `lttng add-context` command can:
32 Without the option:--list option::
33 Add one or more context fields to be recorded by LTTng to the event
36 With the option:--session='SESSION' option:::
37 The tracing session named 'SESSION'.
39 Without the option:--session option:::
40 The current tracing session (see man:lttng-concepts(7) to learn more
41 about the current tracing session).
43 With the option:--channel='CHANNEL':::
44 The channel named 'CHANNEL'.
46 Without the option:--channel option:::
47 *All* the channels of the selected tracing session.
49 With the option:--list option::
50 List the available context field types.
52 See man:lttng-concepts(7) to learn more about tracing sessions and
55 Repeat the option:--type='TYPE' option to add more than one context
56 field to be recorded. 'TYPE' is one of:
58 * A statically-known, or built-in context field named.
60 * A perf counter name:
66 Only available with the option:--kernel option.
69 Prefix: `perf:thread:`
71 Only available with the option:--userspace, option:--jul, or
72 option:--log4j option.
75 Add Performance Monitoring Unit (PMU) counter context fields by raw ID
76 with the ++perf:cpu:raw:r++__N__++:++__NAME__ (option:--kernel option)
77 or ++perf:thread:raw:r++__N__++:++__NAME__ (option:--userspace,
78 option:--jul, or option:--log4j option) types, with:
82 A hexadecimal event descriptor which follows the man:perf-record(1)
83 format: a concatenation of the event number and umask value which
84 the manufacturer of the processor provides.
86 The possible values for this part are processor-specific.
89 Custom name to identify the counter.
92 * An LTTng application-specific context field name:
95 $app.'PROVIDER':__TYPE__
103 IMPORTANT: Make sure to **single-quote** 'TYPE' when you run the
104 `add-context` command from a shell, as `$` is a special character for
105 variable substitution in most shells.
107 NOTE: As of LTTng{nbsp}{lttng_version}, you may :not: add context fields
108 to be recorded to the event records of a given channel once its tracing
109 session has been started (see man:lttng-start(1)) at least once.
112 include::common-lttng-cmd-options-head.txt[]
119 option:-j, option:--jul::
120 Add context fields to be recorded to the event records of one or
121 more channels of the `java.util.logging` (JUL) tracing domain.
123 option:-k, option:--kernel::
124 Add context fields to be recorded to the event records of one or
125 more channels of the Linux kernel tracing domain.
127 option:-l, option:--log4j::
128 Add context fields to be recorded to the event records of one or
129 more channels of the Apache log4j tracing domain.
131 option:-u, option:--userspace::
132 Add context fields to be recorded to the event records of one or
133 more channels of the user space tracing domain.
138 option:-c 'CHANNEL', option:--channel='CHANNEL'::
139 Add context fields to be recorded to the event records of a channel
140 named 'CHANNEL' instead of all the channels of the selected
143 option:-s 'SESSION', option:--session='SESSION'::
144 Add context fields to be recorded to the event records of one or
145 more channels of the tracing session named 'SESSION' instead of the
146 current tracing session.
152 List the available context field types.
154 You may :not: use this option with the option:--channel,
155 option:--session, or option:--type options.
157 option:-t 'TYPE', option:--type='TYPE'::
158 Add a context field having the type 'TYPE' to be recorded.
160 Repeat this option to add more than one context field.
163 include::common-lttng-cmd-help-options.txt[]
166 include::common-lttng-cmd-after-options.txt[]
169 include::common-footer.txt[]
175 man:lttng-enable-channel(1),
176 man:lttng-concepts(7)