1BABELTRACE2-QUERY-(7) Babeltrace 2 manual BABELTRACE2-QUERY-(7)
2
3
4
6 babeltrace2-query-babeltrace.support-info - Babeltrace 2's support info
7 query object
8
10 The babeltrace.support-info Babeltrace 2 query object indicates, for a
11 given source component class, whether or not its instance can handle a
12 given input, and if so, what’s the confidence of this support.
13
14 Said input can be a simple string, an existing file path, or an
15 existing directory path. Components which expect some form of URI can
16 handle a string input, while components which expect an existing file
17 or directory can handle a file/directory path input.
18
19 When the source component class’s query method replies that its
20 component can handle a given input, it can also specify the name of a
21 group in which to put that input. All the inputs of a given group, for
22 a given component class, should be passed when instantiating the
23 component class as its inputs initialization parameter (array of
24 strings).
25
26 The babeltrace2-convert(1) command queries this object from specific
27 source component classes to find the most appropriate for a given
28 non-option argument.
29
31 input=INPUT [string]
32 Check input INPUT.
33
34 Depending on the type parameter, this is a simple string, a file
35 path, or a directory path.
36
37 type=(string | file | directory) [string]
38 Input type, one of:
39
40 string
41 input parameter is a simple string.
42
43 file
44 input parameter is a file path.
45
46 directory
47 input parameter is a directory path.
48
49 It is expected that the query method does not recurse into this
50 directory: the result object indicates whether or not the
51 component class supports this specific directory (input).
52
54 The result object can be one of:
55
56 • A simple real value which is the weight, between 0 and 1, of the
57 support by the component class for the given input.
58
59 A weight of 0 means the input is unsupported while a weight of 1
60 means it’s fully supported. Any value in between shows how
61 confident the component class is about the support of the given
62 input.
63
64 • A map with a weight and an optional group name.
65
66 When it’s a map, the expected entries are:
67
68 group=GROUP-NAME [optional string]
69 Put the given input into a group named GROUP-NAME for this
70 component class.
71
72 If this entry is missing, then the given input gets its own, unique
73 group.
74
75 weight=WEIGHT [real]
76 Weight, between 0 and 1, of the support by the component class for
77 the given input.
78
79 The semantics are the same as when the result object is a simple
80 real value.
81
83 Query parameters
84 Example 1. String input.
85
86 input: net://relayd177/host/node23/active
87 type: string
88
89 Example 2. File path input.
90
91 input: /home/user/traces/2019-08-26/quad.tr
92 type: file
93
94 Result object
95 Example 3. Simple weight (unique group).
96
97 0.5
98
99 Example 4. Weight and specific group.
100
101 group: 63a4b7e5-37f0-4254-a048-a0cff9e5b761
102 weight: 0.75
103
104 Example 5. Weight within a map (unique group).
105
106 weight: 0.6
107
109 If you encounter any issue or usability problem, please report it on
110 the Babeltrace bug tracker (see
111 <https://bugs.lttng.org/projects/babeltrace>).
112
114 The Babeltrace project shares some communication channels with the
115 LTTng project (see <https://lttng.org/>).
116
117 • Babeltrace website (see <https://babeltrace.org/>)
118
119 • Mailing list (see <https://lists.lttng.org>) for support and
120 development: lttng-dev@lists.lttng.org
121
122 • IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on
123 irc.oftc.net
124
125 • Bug tracker (see <https://bugs.lttng.org/projects/babeltrace>)
126
127 • Git repository (see <https://git.efficios.com/?p=babeltrace.git>)
128
129 • GitHub project (see <https://github.com/efficios/babeltrace>)
130
131 • Continuous integration (see
132 <https://ci.lttng.org/view/Babeltrace/>)
133
134 • Code review (see <https://review.lttng.org/q/project:babeltrace>)
135
137 The Babeltrace 2 project is the result of hard work by many regular
138 developers and occasional contributors.
139
140 The current project maintainer is Jérémie Galarneau
141 <mailto:jeremie.galarneau@efficios.com>.
142
144 This query object is part of the Babeltrace 2 project.
145
146 Babeltrace is distributed under the MIT license (see
147 <https://opensource.org/licenses/MIT>).
148
150 babeltrace2-intro(7), babeltrace2-query(1), babeltrace2-convert(1)
151
152
153
154Babeltrace 2.0.4 14 September 2019 BABELTRACE2-QUERY-(7)