Format for the Session Initiation Protocol (SIP) Common Log Format (CLF)
RFC 6873
| Document | Type |
RFC - Proposed Standard
(February 2013; No errata)
Updated by RFC 7355
|
|
|---|---|---|---|
| Last updated | 2015-10-14 | ||
| Replaces | draft-salgueiro-sipclf-indexed-ascii | ||
| Stream | IETF | ||
| Formats | plain text pdf html bibtex | ||
| Reviews | |||
| Stream | WG state | WG Document | |
| Document shepherd | No shepherd assigned | ||
| Shepherd write-up | Show (last changed 2012-12-03) | ||
| IESG | IESG state | RFC 6873 (Proposed Standard) | |
| Consensus Boilerplate | Unknown | ||
| Telechat date | |||
| Responsible AD | Robert Sparks | ||
| IESG note | Peter Musgrave (musgravepj@gmail.com) is the document shepherd. | ||
| Send notices to | (None) | ||
Internet Engineering Task Force (IETF) G. Salgueiro
Request for Comments: 6873 Cisco Systems
Category: Standards Track V. Gurbani
ISSN: 2070-1721 Bell Labs, Alcatel-Lucent
A. B. Roach
Mozilla
February 2013
Format for the Session Initiation Protocol (SIP)
Common Log Format (CLF)
Abstract
The SIPCLF working group has defined a Common Log Format (CLF)
framework for Session Initiation Protocol (SIP) servers. This CLF
mimics the successful event logging format found in well-known web
servers like Apache and web proxies like Squid. This document
proposes an indexed text encoding format for the SIP CLF that retains
the key advantages of a text-based format while significantly
increasing processing performance over a purely text-based
implementation. This file format adheres to the SIP CLF information
model and provides an effective encoding scheme for all mandatory and
optional fields that appear in a SIP CLF record.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in Section 2 of RFC 5741.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
http://www.rfc-editor.org/info/rfc6873.
Salgueiro, et al. Standards Track [Page 1]
RFC 6873 Format for SIP CLF February 2013
Copyright Notice
Copyright (c) 2013 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction ....................................................3
2. Terminology .....................................................3
3. Document Conventions ............................................4
4. Format ..........................................................5
4.1. Index Pointers .............................................8
4.2. Mandatory Fields ..........................................10
4.3. SIP CLF Encoding and Character Escaping Requirements ......13
4.4. Optional Fields ...........................................14
5. Example SIP CLF Record .........................................22
6. Text Tool Considerations .......................................24
7. Security Considerations ........................................24
8. Operational Guidance ...........................................25
9. IANA Considerations ............................................25
9.1. SIP CLF Version ...........................................25
9.2. SIP CLF Transport Flag ....................................26
10. Acknowledgments ...............................................26
11. References ....................................................27
11.1. Normative References .....................................27
11.2. Informative References ...................................27
Salgueiro, et al. Standards Track [Page 2]
RFC 6873 Format for SIP CLF February 2013
1. Introduction
The extensive list of benefits and the widespread adoption of the
Apache Common Log Format (CLF) has prompted the development of an
analogous event logging mechanism for the Session Initiation Protocol
(SIP) [RFC3261]. Implementing a logging scheme for SIP is a
considerable challenge. In part, this is due to the fact that the
behavior of a SIP entity is more complex as compared to an HTTP
entity. Additionally, there are shortcomings to the purely text-
based HTTP CLF that need to be addressed in order to allow for real-
time inspection of SIP log files [RFC6872]. Experience with Apache
CLF has shown that dealing with large quantities of log data can be
Show full document text