Debian Codegraph @

rfc5427.html

raw
1 <pre>Network Working Group G. Keeni
2 Request for Comments: 5427 Cyber Solutions Inc.
3 Category: Standards Track March 2009
4
5
6 <span class="h1">Textual Conventions for Syslog Management</span>
7
8 Status of This Memo
9
10 This document specifies an Internet standards track protocol for the
11 Internet community, and requests discussion and suggestions for
12 improvements. Please refer to the current edition of the "Internet
13 Official Protocol Standards" (STD 1) for the standardization state
14 and status of this protocol. Distribution of this memo is unlimited.
15
16 Copyright Notice
17
18 Copyright (c) 2009 IETF Trust and the persons identified as the
19 document authors. All rights reserved.
20
21 This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
22 Provisions Relating to IETF Documents in effect on the date of
23 publication of this document (<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>).
24 Please review these documents carefully, as they describe your rights
25 and restrictions with respect to this document.
26
27 This document may contain material from IETF Documents or IETF
28 Contributions published or made publicly available before November
29 10, 2008. The person(s) controlling the copyright in some of this
30 material may not have granted the IETF Trust the right to allow
31 modifications of such material outside the IETF Standards Process.
32 Without obtaining an adequate license from the person(s) controlling
33 the copyright in such materials, this document may not be modified
34 outside the IETF Standards Process, and derivative works of it may
35 not be created outside the IETF Standards Process, except to format
36 it for publication as an RFC or to translate it into languages other
37 than English.
38
39 Abstract
40
41 This MIB module defines textual conventions to represent Facility and
42 Severity information commonly used in syslog messages. The intent is
43 that these textual conventions will be imported and used in MIB
44 modules that would otherwise define their own representations.
45
46
47
48
49
50
51
52 <span class="grey">Keeni Standards Track [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc5427">RFC 5427</a> Syslog MIB-TC March 2009</span>
55
56
57 Table of Contents
58
59 <a href="#section-1">1</a>. The Internet-Standard Management Framework ......................<a href="#page-2">2</a>
60 <a href="#section-2">2</a>. Background ......................................................<a href="#page-2">2</a>
61 <a href="#section-3">3</a>. The Syslog Textual Conventions MIB ..............................<a href="#page-3">3</a>
62 <a href="#section-4">4</a>. Security Considerations .........................................<a href="#page-7">7</a>
63 <a href="#section-5">5</a>. IANA Considerations .............................................<a href="#page-7">7</a>
64 <a href="#section-6">6</a>. References ......................................................<a href="#page-8">8</a>
65 <a href="#section-6.1">6.1</a>. Normative References .......................................<a href="#page-8">8</a>
66 <a href="#section-6.2">6.2</a>. Informative References .....................................<a href="#page-8">8</a>
67 <a href="#section-7">7</a>. Acknowledgments .................................................<a href="#page-8">8</a>
68
69 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. The Internet-Standard Management Framework</span>
70
71 For a detailed overview of the documents that describe the current
72 Internet-Standard Management Framework, please refer to <a href="./rfc3410#section-7">section&nbsp;7 of
73 RFC 3410</a> [<a href="./rfc3410" title="&quot;Introduction and Applicability Statements for Internet- Standard Management Framework&quot;">RFC3410</a>].
74
75 Managed objects are accessed via a virtual information store, termed
76 the Management Information Base or MIB. MIB objects are generally
77 accessed through the Simple Network Management Protocol (SNMP).
78 Objects in the MIB are defined using the mechanisms defined in the
79 Structure of Management Information (SMI). This memo specifies a MIB
80 module that is compliant to the SMIv2, which is described in STD 58,
81 <a href="./rfc2578">RFC 2578</a> [<a href="./rfc2578" title="&quot;Structure of Management Information Version 2 (SMIv2)&quot;">RFC2578</a>], STD 58, <a href="./rfc2579">RFC 2579</a> [<a href="./rfc2579" title="&quot;Textual Conventions for SMIv2&quot;">RFC2579</a>] and STD 58, <a href="./rfc2580">RFC 2580</a>
82 [<a href="./rfc2580" title="&quot;Conformance Statements for SMIv2&quot;">RFC2580</a>].
83
84 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Background</span>
85
86 Operating systems, processes, and applications, collectively termed
87 "Facilities" in the following, generate messages indicating their own
88 status or the occurrence of events. These messages have come to be
89 known as syslog messages. A syslog message in general will contain
90 among other things a code representing the Facility that generated
91 the message and a code representing the Severity of the message. The
92 Facility and the Severity codes are commonly used to categorize and
93 select received syslog messages for processing and display. The
94 Facility codes have been useful in qualifying the originator of the
95 content of the messages but in some cases they are not specific
96 enough to explicitly identify the originator. Implementations of the
97 syslog protocol [<a href="./rfc5424" title="&quot;The Syslog Protocol&quot;">RFC5424</a>] that contain structured data elements
98 (SDEs) should use these SDEs to clarify the entity that originated
99 the content of the message.
100
101 This document defines a set of textual conventions (TCs) that can be
102 used to represent Facility and Severity codes commonly used in syslog
103 messages.
104
105
106
107
108 <span class="grey">Keeni Standards Track [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc5427">RFC 5427</a> Syslog MIB-TC March 2009</span>
111
112
113 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
114 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
115 document are to be interpreted as described in <a href="./rfc2119">RFC 2119</a> [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>].
116
117 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. The Syslog Textual Conventions MIB</span>
118
119 SYSLOG-TC-MIB DEFINITIONS ::= BEGIN
120
121 IMPORTS
122 MODULE-IDENTITY, mib-2
123 FROM SNMPv2-SMI -- [<a href="./rfc2578" title="&quot;Structure of Management Information Version 2 (SMIv2)&quot;">RFC2578</a>]
124 TEXTUAL-CONVENTION
125 FROM SNMPv2-TC; -- [<a href="./rfc2579" title="&quot;Textual Conventions for SMIv2&quot;">RFC2579</a>]
126
127 syslogTCMIB MODULE-IDENTITY
128 LAST-UPDATED "200903300000Z" -- 30 March 2009
129 ORGANIZATION "IETF Syslog Working Group"
130 CONTACT-INFO
131 " Glenn Mansfield Keeni
132 Postal: Cyber Solutions Inc.
133 6-6-3, Minami Yoshinari
134 Aoba-ku, Sendai, Japan 989-3204.
135 Tel: +81-22-303-4012
136 Fax: +81-22-303-4015
137 EMail: [email protected]
138
139 Support Group EMail: [email protected]
140 "
141
142 DESCRIPTION
143 "The MIB module containing textual conventions for syslog
144 messages.
145
146 Copyright (c) 2009 IETF Trust and the persons
147 identified as authors of the code. All rights reserved.
148
149 Redistribution and use in source and binary forms, with or
150 without modification, are permitted provided that the
151 following conditions are met:
152
153 - Redistributions of source code must retain the above
154 copyright notice, this list of conditions and the
155 following disclaimer.
156
157 - Redistributions in binary form must reproduce the above
158 copyright notice, this list of conditions and the
159 following disclaimer in the documentation and/or other
160 materials provided with the distribution.
161
162
163
164 <span class="grey">Keeni Standards Track [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc5427">RFC 5427</a> Syslog MIB-TC March 2009</span>
167
168
169 - Neither the name of Internet Society, IETF or IETF
170 Trust, nor the names of specific contributors, may be
171 used to endorse or promote products derived from this
172 software without specific prior written permission.
173
174 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
175 CONTRIBUTORS 'AS IS' AND ANY EXPRESS OR IMPLIED
176 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
177 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
178 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
179 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
180 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
181 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
182 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
183 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
184 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
185 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
186 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
187 POSSIBILITY OF SUCH DAMAGE.
188
189 This version of this MIB module is part of <a href="./rfc5427">RFC 5427</a>;
190 see the RFC itself for full legal notices.
191 "
192
193 REVISION "200903300000Z" -- 30 March 2009
194 DESCRIPTION
195 "The initial version, published as <a href="./rfc5427">RFC 5427</a>."
196
197 ::= { mib-2 173 }
198
199 -- -------------------------------------------------------------
200 -- Textual Conventions
201 -- -------------------------------------------------------------
202
203 SyslogFacility ::= TEXTUAL-CONVENTION
204 STATUS current
205 DESCRIPTION
206 "This textual convention enumerates the Facilities that
207 originate syslog messages.
208
209 The Facilities of syslog messages are numerically coded
210 with decimal values. For interoperability and backwards-
211 compatibility reasons, this document specifies a
212 normative mapping between a label, which represents a
213 Facility, and the corresponding numeric value. This label
214 could be used in, for example, SNMP Manager user
215 interfaces.
216
217
218
219
220 <span class="grey">Keeni Standards Track [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc5427">RFC 5427</a> Syslog MIB-TC March 2009</span>
223
224
225 The label itself is often semantically meaningless
226 because it is impractical to attempt to enumerate all
227 possible Facilities, and many daemons and processes do
228 not have an explicitly assigned Facility code or label.
229 For example, there is no Facility label corresponding to
230 an HTTP service. An HTTP service implementation might log
231 messages as coming from, for example, 'local7' or 'uucp'.
232 This is typical current practice, and originators, relays,
233 and collectors can be configured to properly handle this
234 situation. For improved accuracy, an application can also
235 include an APP-NAME structured data element.
236
237 Note that operating system mechanisms for configuring
238 syslog, such as syslog.conf, have not yet been standardized
239 and might use different sets of Facility labels and/or
240 mapping between Facility labels and Facility codes than the
241 MIB.
242
243 In particular, the labels corresponding to Facility codes 4,
244 10, 13, and 14, and the code corresponding to the Facility
245 label 'cron' are known to vary across different operating
246 systems. To distinguish between the labels corresponding
247 to Facility codes 9 and 15, a label of 'cron2' is assigned
248 to the Facility code 15. This list is not intended to be
249 exhaustive; other differences might exist, and new
250 differences might be introduced in the future.
251
252 The mapping specified here MUST be used in a MIB network
253 management interface, even though a particular syslog
254 implementation might use a different mapping in a
255 different network management interface.
256 "
257 REFERENCE "The Syslog Protocol (<a href="./rfc5424">RFC5424</a>): Table 1"
258 SYNTAX INTEGER
259 {
260
261 kern (0), -- kernel messages
262 user (1), -- user-level messages
263 mail (2), -- mail system messages
264 daemon (3), -- system daemons' messages
265 auth (4), -- authorization messages
266 syslog (5), -- messages generated internally by
267 -- syslogd
268 lpr (6), -- line printer subsystem messages
269 news (7), -- network news subsystem messages
270 uucp (8), -- UUCP subsystem messages
271 cron (9), -- clock daemon messages
272 authpriv (10),-- security/authorization messages
273
274
275
276 <span class="grey">Keeni Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc5427">RFC 5427</a> Syslog MIB-TC March 2009</span>
279
280
281 ftp (11),-- ftp daemon messages
282 ntp (12),-- NTP subsystem messages
283 audit (13),-- audit messages
284 console (14),-- console messages
285 cron2 (15),-- clock daemon messages
286 local0 (16),
287 local1 (17),
288 local2 (18),
289 local3 (19),
290 local4 (20),
291 local5 (21),
292 local6 (22),
293 local7 (23)
294 }
295
296 SyslogSeverity ::= TEXTUAL-CONVENTION
297 STATUS current
298 DESCRIPTION
299 "This textual convention enumerates the Severity levels
300 of syslog messages.
301
302 The Severity levels of syslog messages are numerically
303 coded with decimal values. For interoperability and
304 backwards-compatibility reasons, this document specifies
305 a normative mapping between a label, which represents a
306 Severity level, and the corresponding numeric value.
307 This label could be used in, for example, SNMP Manager
308 user interfaces.
309
310 The label itself is often semantically meaningless
311 because it is impractical to attempt to strictly define
312 the criteria for each Severity level, and the criteria
313 that is used by syslog originators is, and has
314 historically been, implementation-dependent.
315
316 Note that operating system mechanisms for configuring
317 syslog, such as syslog.conf, have not yet been standardized
318 and might use different sets of Severity labels and/or
319 mapping between Severity labels and Severity codes than the
320 MIB.
321
322 For example, the foobar application might log messages as
323 'crit' based on some subjective criteria. Yet the operator
324 can configure syslog to forward these messages, even though
325 the criteria for 'crit' may differ from one originator to
326 another. This is typical current practice, and originators,
327 relays, and collectors can be configured to properly handle
328 this situation.
329
330
331
332 <span class="grey">Keeni Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc5427">RFC 5427</a> Syslog MIB-TC March 2009</span>
335
336
337 "
338 REFERENCE "The Syslog Protocol (<a href="./rfc5424">RFC5424</a>): Table 2"
339 SYNTAX INTEGER
340 {
341 emerg (0), -- emergency; system is unusable
342 alert (1), -- action must be taken immediately
343 crit (2), -- critical condition
344 err (3), -- error condition
345 warning (4), -- warning condition
346 notice (5), -- normal but significant condition
347 info (6), -- informational message
348 debug (7) -- debug-level messages
349
350 }
351
352 END
353
354 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Security Considerations</span>
355
356 This module does not define any management objects. Instead, it
357 defines a set of textual conventions which may be used by other MIB
358 modules to define management objects. Meaningful security
359 considerations can only be written in the MIB modules that define
360 management objects. This document has therefore no impact on the
361 security of the Internet. Since objects defined using the TCs
362 defined in this document may introduce security issues, the user of
363 these TCs should read the security considerations section of
364 [<a href="./rfc5424" title="&quot;The Syslog Protocol&quot;">RFC5424</a>].
365
366 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. IANA Considerations</span>
367
368 The MIB modules in this document use the following IANA-assigned
369 OBJECT IDENTIFIER values recorded in the SMI Numbers registry:
370
371 Descriptor OBJECT IDENTIFIER value
372 ---------- -----------------------
373
374 syslogTCMIB { mib-2 173 }
375
376
377
378
379
380
381
382
383
384
385
386
387
388 <span class="grey">Keeni Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc5427">RFC 5427</a> Syslog MIB-TC March 2009</span>
391
392
393 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. References</span>
394
395 <span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Normative References</span>
396
397 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
398 Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
399
400 [<a id="ref-RFC2578">RFC2578</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder,
401 "Structure of Management Information Version 2 (SMIv2)",
402 STD 58, <a href="./rfc2578">RFC 2578</a>, April 1999.
403
404 [<a id="ref-RFC2579">RFC2579</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder,
405 "Textual Conventions for SMIv2", STD 58, <a href="./rfc2579">RFC 2579</a>, April
406 1999.
407
408 [<a id="ref-RFC2580">RFC2580</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder,
409 "Conformance Statements for SMIv2", STD 58, <a href="./rfc2580">RFC 2580</a>,
410 April 1999.
411
412 [<a id="ref-RFC5424">RFC5424</a>] Gerhards, R., "The Syslog Protocol", <a href="./rfc5424">RFC 5424</a>, March 2009.
413
414 <span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Informative References</span>
415
416 [<a id="ref-RFC3410">RFC3410</a>] Case, J., Mundy, R., Partain, D., and B. Stewart,
417 "Introduction and Applicability Statements for Internet-
418 Standard Management Framework", <a href="./rfc3410">RFC 3410</a>, December 2002.
419
420 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Acknowledgments</span>
421
422 This document is a product of the Syslog Working Group. The author
423 would like to thank Chris Lonvick, David Harrington, Juergen
424 Schoenwaelder, and Pasi Eronen for their comments and suggestions.
425
426 Author's Address
427
428 Glenn Mansfield Keeni
429 Cyber Solutions Inc.
430 6-6-3 Minami Yoshinari
431 Aoba-ku, Sendai 989-3204
432 Japan
433
434 Phone: +81-22-303-4012
435 EMail: [email protected]
436
437
438
439
440
441
442
443
444 Keeni Standards Track [Page 8]
445 </pre>