aboutsummaryrefslogtreecommitdiff
path: root/Documentation/libtraceevent-log.txt
blob: a236e2adac215941bd47eb2285e3e653ecd09f5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
libtraceevent(3)
================

NAME
----
tep_set_loglevel - Set log level of the library

SYNOPSIS
--------
[verse]
--
*#include <event-parse.h>*

enum *tep_loglevel* {
	TEP_LOG_NONE = 0,
	TEP_LOG_CRITICAL,
	TEP_LOG_ERROR,
	TEP_LOG_WARNING,
	TEP_LOG_INFO,
	TEP_LOG_DEBUG,
	TEP_LOG_ALL
};

int *tep_set_loglevel*(enum tep_loglevel _level_);

--
DESCRIPTION
-----------
The *tep_set_loglevel()* function sets the level of the library logs that will be printed
on the console. Library log levels are:
[verse]
--
	_TEP_LOG_NONE_ - Do not print any logs.
	_TEP_LOG_CRITICAL_ - Print critical logs, problem that may cause a crash.
	_TEP_LOG_ERROR_ - Print error logs, problem that could break the main logic of an API.
	_TEP_LOG_WARNING_ - Print warnings, problem that could limit the result of an API.
	_TEP_LOG_INFO_ - Print information about normal execution of an API.
	_TEP_LOG_DEBUG_ - Print debug information.
	_TEP_LOG_ALL_ - Print logs from all levels.
--
Setting the log level to specific value means that logs from the previous levels will be printed
too. For example _TEP_LOG_WARNING_ will print any logs with severity _TEP_LOG_WARNING_,
_TEP_LOG_ERROR_ and _TEP_LOG_CRITICAL_. The default log level is _TEP_LOG_CRITICAL_.


EXAMPLE
-------
[source,c]
--
#include <event-parse.h>

tep_set_loglevel(TEP_LOG_ALL);
...
/* call libtraceevent APIs and observe any logs they produce */
...
tep_set_loglevel(TEP_LOG_CRITICAL);
--

FILES
-----
[verse]
--
*event-parse.h*
	Header file to include in order to have access to the library APIs.
*-ltraceevent*
	Linker switch to add when building a program that uses the library.
--

SEE ALSO
--------
*libtraceevent*(3), *trace-cmd*(1)

AUTHOR
------
[verse]
--
*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
--
REPORTING BUGS
--------------
Report bugs to  <linux-trace-devel@vger.kernel.org>

LICENSE
-------
libtraceevent is Free Software licensed under the GNU LGPL 2.1

RESOURCES
---------
https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/