xref: /aosp_15_r20/external/libtraceevent/Documentation/libtraceevent-log.txt (revision 436bf2bcd5202612ffffe471bbcc1f277cc8d28e)
1*436bf2bcSAndroid Build Coastguard Workerlibtraceevent(3)
2*436bf2bcSAndroid Build Coastguard Worker================
3*436bf2bcSAndroid Build Coastguard Worker
4*436bf2bcSAndroid Build Coastguard WorkerNAME
5*436bf2bcSAndroid Build Coastguard Worker----
6*436bf2bcSAndroid Build Coastguard Workertep_set_loglevel - Set log level of the library
7*436bf2bcSAndroid Build Coastguard Worker
8*436bf2bcSAndroid Build Coastguard WorkerSYNOPSIS
9*436bf2bcSAndroid Build Coastguard Worker--------
10*436bf2bcSAndroid Build Coastguard Worker[verse]
11*436bf2bcSAndroid Build Coastguard Worker--
12*436bf2bcSAndroid Build Coastguard Worker*#include <event-parse.h>*
13*436bf2bcSAndroid Build Coastguard Worker
14*436bf2bcSAndroid Build Coastguard Workerenum *tep_loglevel* {
15*436bf2bcSAndroid Build Coastguard Worker	TEP_LOG_NONE = 0,
16*436bf2bcSAndroid Build Coastguard Worker	TEP_LOG_CRITICAL,
17*436bf2bcSAndroid Build Coastguard Worker	TEP_LOG_ERROR,
18*436bf2bcSAndroid Build Coastguard Worker	TEP_LOG_WARNING,
19*436bf2bcSAndroid Build Coastguard Worker	TEP_LOG_INFO,
20*436bf2bcSAndroid Build Coastguard Worker	TEP_LOG_DEBUG,
21*436bf2bcSAndroid Build Coastguard Worker	TEP_LOG_ALL
22*436bf2bcSAndroid Build Coastguard Worker};
23*436bf2bcSAndroid Build Coastguard Worker
24*436bf2bcSAndroid Build Coastguard Workerint *tep_set_loglevel*(enum tep_loglevel _level_);
25*436bf2bcSAndroid Build Coastguard Worker
26*436bf2bcSAndroid Build Coastguard Worker--
27*436bf2bcSAndroid Build Coastguard WorkerDESCRIPTION
28*436bf2bcSAndroid Build Coastguard Worker-----------
29*436bf2bcSAndroid Build Coastguard WorkerThe *tep_set_loglevel()* function sets the level of the library logs that will be printed
30*436bf2bcSAndroid Build Coastguard Workeron the console. Library log levels are:
31*436bf2bcSAndroid Build Coastguard Worker[verse]
32*436bf2bcSAndroid Build Coastguard Worker--
33*436bf2bcSAndroid Build Coastguard Worker	_TEP_LOG_NONE_ - Do not print any logs.
34*436bf2bcSAndroid Build Coastguard Worker	_TEP_LOG_CRITICAL_ - Print critical logs, problem that may cause a crash.
35*436bf2bcSAndroid Build Coastguard Worker	_TEP_LOG_ERROR_ - Print error logs, problem that could break the main logic of an API.
36*436bf2bcSAndroid Build Coastguard Worker	_TEP_LOG_WARNING_ - Print warnings, problem that could limit the result of an API.
37*436bf2bcSAndroid Build Coastguard Worker	_TEP_LOG_INFO_ - Print information about normal execution of an API.
38*436bf2bcSAndroid Build Coastguard Worker	_TEP_LOG_DEBUG_ - Print debug information.
39*436bf2bcSAndroid Build Coastguard Worker	_TEP_LOG_ALL_ - Print logs from all levels.
40*436bf2bcSAndroid Build Coastguard Worker--
41*436bf2bcSAndroid Build Coastguard WorkerSetting the log level to specific value means that logs from the previous levels will be printed
42*436bf2bcSAndroid Build Coastguard Workertoo. For example _TEP_LOG_WARNING_ will print any logs with severity _TEP_LOG_WARNING_,
43*436bf2bcSAndroid Build Coastguard Worker_TEP_LOG_ERROR_ and _TEP_LOG_CRITICAL_. The default log level is _TEP_LOG_CRITICAL_.
44*436bf2bcSAndroid Build Coastguard Worker
45*436bf2bcSAndroid Build Coastguard Worker
46*436bf2bcSAndroid Build Coastguard WorkerEXAMPLE
47*436bf2bcSAndroid Build Coastguard Worker-------
48*436bf2bcSAndroid Build Coastguard Worker[source,c]
49*436bf2bcSAndroid Build Coastguard Worker--
50*436bf2bcSAndroid Build Coastguard Worker#include <event-parse.h>
51*436bf2bcSAndroid Build Coastguard Worker
52*436bf2bcSAndroid Build Coastguard Workertep_set_loglevel(TEP_LOG_ALL);
53*436bf2bcSAndroid Build Coastguard Worker...
54*436bf2bcSAndroid Build Coastguard Worker/* call libtraceevent APIs and observe any logs they produce */
55*436bf2bcSAndroid Build Coastguard Worker...
56*436bf2bcSAndroid Build Coastguard Workertep_set_loglevel(TEP_LOG_CRITICAL);
57*436bf2bcSAndroid Build Coastguard Worker--
58*436bf2bcSAndroid Build Coastguard Worker
59*436bf2bcSAndroid Build Coastguard WorkerFILES
60*436bf2bcSAndroid Build Coastguard Worker-----
61*436bf2bcSAndroid Build Coastguard Worker[verse]
62*436bf2bcSAndroid Build Coastguard Worker--
63*436bf2bcSAndroid Build Coastguard Worker*event-parse.h*
64*436bf2bcSAndroid Build Coastguard Worker	Header file to include in order to have access to the library APIs.
65*436bf2bcSAndroid Build Coastguard Worker*-ltraceevent*
66*436bf2bcSAndroid Build Coastguard Worker	Linker switch to add when building a program that uses the library.
67*436bf2bcSAndroid Build Coastguard Worker--
68*436bf2bcSAndroid Build Coastguard Worker
69*436bf2bcSAndroid Build Coastguard WorkerSEE ALSO
70*436bf2bcSAndroid Build Coastguard Worker--------
71*436bf2bcSAndroid Build Coastguard Worker*libtraceevent*(3), *trace-cmd*(1)
72*436bf2bcSAndroid Build Coastguard Worker
73*436bf2bcSAndroid Build Coastguard WorkerAUTHOR
74*436bf2bcSAndroid Build Coastguard Worker------
75*436bf2bcSAndroid Build Coastguard Worker[verse]
76*436bf2bcSAndroid Build Coastguard Worker--
77*436bf2bcSAndroid Build Coastguard Worker*Steven Rostedt* <[email protected]>, author of *libtraceevent*.
78*436bf2bcSAndroid Build Coastguard Worker*Tzvetomir Stoyanov* <[email protected]>, author of this man page.
79*436bf2bcSAndroid Build Coastguard Worker--
80*436bf2bcSAndroid Build Coastguard WorkerREPORTING BUGS
81*436bf2bcSAndroid Build Coastguard Worker--------------
82*436bf2bcSAndroid Build Coastguard WorkerReport bugs to  <[email protected]>
83*436bf2bcSAndroid Build Coastguard Worker
84*436bf2bcSAndroid Build Coastguard WorkerLICENSE
85*436bf2bcSAndroid Build Coastguard Worker-------
86*436bf2bcSAndroid Build Coastguard Workerlibtraceevent is Free Software licensed under the GNU LGPL 2.1
87*436bf2bcSAndroid Build Coastguard Worker
88*436bf2bcSAndroid Build Coastguard WorkerRESOURCES
89*436bf2bcSAndroid Build Coastguard Worker---------
90*436bf2bcSAndroid Build Coastguard Workerhttps://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
91