File: Logging.rst

package info (click to toggle)
robotraconteur 1.2.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 101,380 kB
  • sloc: cpp: 1,149,268; cs: 87,653; java: 58,127; python: 26,897; ansic: 356; sh: 152; makefile: 90; xml: 51
file content (170 lines) | stat: -rw-r--r-- 3,564 bytes parent folder | download
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
================
Logging and Taps
================

Logging is configured using environmental variables or command line option
``--robotraconteur-log-level=`` with the node setup classes, or using the
RobotRaconteur.SetLogLevel() with the RobotRaconteur.LogLevel_* enum values.

Log output target can be configured using RobotRaconter.RobotRaconturNode.SetLogRecordHandler().
By default the output is sent to ``stderr``. The
RobotRaconteur.RobotRaconteurNode.FileLogRecordHandler can be used to save the log to a file.

Taps are used to record log records and message traffic. The "local tap"
creates a local socket that a recording program can connect to record the traffic.
This can be enabled using the ``--robotraconteur-local-tap-enable=true`` and
``--robotraconteur-local-tap-name=`` command line options with the node setup classes.

RRLogRecord Class
=================

.. autoclass:: RobotRaconteur.RRLogRecord
   :members:

LogRecordHandler Class
======================

.. autoclass:: RobotRaconteur.LogRecordHandler
   :members:

FileLogRecordHandler Class
==========================

.. autoclass:: RobotRaconteur.FileLogRecordHandler
   :members:

LogLevel Enum
=============

.. data:: RobotRaconteur.LogLevel_Trace
   :value: 0

   `trace` log level

.. data:: RobotRaconteur.LogLevel_Debug
   :value: 1

   `debug` log level

.. data:: RobotRaconteur.LogLevel_Info
   :value: 2

   `info` log level

.. data:: RobotRaconteur.LogLevel_Warning
   :value: 3

   `warning` log level

.. data:: RobotRaconteur.LogLevel_Error
   :value: 4

   `error` log level

.. data:: RobotRaconteur.LogLevel_Fatal
   :value: 5

   `fatal` log level

.. data:: RobotRaconteur.LogLevel_Disable
   :value: 1000

   `disabled` log level

LogComponent Enum
=================

.. data:: RobotRaconteur.LogComponent_Default
   :value: 0

   default component

.. data:: RobotRaconteur.LogComponent_Node
   :value: 1

   Robot Raconteur Node component

.. data:: RobotRaconteur.LogComponent_Transport
   :value: 2

   tranport component

.. data:: RobotRaconteur.LogComponent_Message
   :value: 3

   message or message serialization component

.. data:: RobotRaconteur.LogComponent_Client
   :value: 4

   client component

.. data:: RobotRaconteur.LogComponent_Service
   :value: 5

   service component

.. data:: RobotRaconteur.LogComponent_Member
   :value: 6

   member component

.. data:: RobotRaconteur.LogComponent_Pack
   :value: 7

   data message packing component

.. data:: RobotRaconteur.LogComponent_Unpack
   :value: 8

   data message unpacking component

.. data:: RobotRaconteur.LogComponent_ServiceDefinition
   :value: 9

   service definition parser component

.. data:: RobotRaconteur.LogComponent_Discovery
   :value: 10

   node/service discovery component

.. data:: RobotRaconteur.LogComponent_Subscription
   :value: 11

   subscription component

.. data:: RobotRaconteur.LogComponent_NodeSetup
   :value: 12

   node setup component

.. data:: RobotRaconteur.LogComponent_Utility
   :value: 13

   utility component

.. data:: RobotRaconteur.LogComponent_RobDefLib
   :value: 14

   service definition standard library component (external)

.. data:: RobotRaconteur.LogComponent_User
   :value: 15

   user component (external)

.. data:: RobotRaconteur.LogComponent_UserClient
   :value: 16

   user client component (external)

.. data:: RobotRaconteur.LogComponent_UserService
   :value: 17

   user service component (external)

.. data:: RobotRaconteur.LogComponent_ThirdParty
   :value: 18

   third party library component (external)