Remove unneeded "will"s + minor fixes
[lttng-docs.git] / contents / understanding-lttng / core-concepts / event.md
CommitLineData
5e0cbfb0
PP
1---
2id: event
3---
4
5An _event_, in LTTng's realm, is a term often used metonymically,
6having multiple definitions depending on the context:
7
8 1. When tracing, an event is a _point in space-time_. Space, in a
9 tracing context, is the set of all executable positions of a
10 compiled application by a logical processor. When a program is
11 executed by a processor and some instrumentation point, or
12 _probe_, is encountered, an event occurs. This event is accompanied
13 by some contextual payload (values of specific variables at this
14 point of execution) which may or may not be recorded.
15 2. In the context of a recorded trace file, the term _event_ implies
16 a _recorded event_.
17 3. When configuring a tracing session, _enabled events_ refer to
18 specific rules which could lead to the transfer of actual
19 occurring events (1) to recorded events (2).
20
0c9c0c96 21The whole [Core concepts](#doc-core-concepts) section focuses on the
5e0cbfb0
PP
22third definition. An event is always registered to _one or more_
23channels and may be enabled or disabled at will per channel. A disabled
47bfcb75 24event never leads to a recorded event, even if its channel is enabled.
5e0cbfb0
PP
25
26An event (3) is enabled with a few conditions that must _all_ be met
27when an event (1) happens in order to generate a recorded event (2):
28
29 1. A _probe_ or group of probes in the traced application must be
30 executed.
31 2. **Optionally**, the probe must have a log level matching a
32 log level range specified when enabling the event.
33 3. **Optionally**, the occurring event must satisfy a custom
34 expression, or _filter_, specified when enabling the event.
35
36The following illustration summarizes how tracing sessions, domains,
37channels and events are related:
38
39<div class="img img-90">
4280f592
PP
40<object data="/images/docs26/core-concepts.svg" type="image/svg+xml">
41 <img src="/images/docs26/core-concepts.svg">
5e0cbfb0
PP
42</object>
43</div>
44
45This diagram also shows how events may be individually enabled/disabled
46(green/grey) and how a given event may be registered to more than one
47channel.
This page took 0.024569 seconds and 4 git commands to generate.