Format for the Session Initiation Protocol (SIP) Common Log Format (CLF)
draft-ietf-sipclf-format-09

The information below is for an old version of the document
Document Type Active Internet-Draft (sipclf WG)
Last updated 2012-12-20 (latest revision 2012-11-08)
Replaces draft-salgueiro-sipclf-indexed-ascii
Stream IETF
Intended RFC status Proposed Standard
Formats plain text pdf html
Stream WG state WG Document
Consensus Unknown
Document shepherd None
Shepherd write-up Show (last changed 2012-12-03)
IESG IESG state IESG Evaluation::Revised I-D Needed
Telechat date
Needs a YES. Needs 5 more YES or NO OBJECTION positions to pass.
Responsible AD Robert Sparks
IESG note Peter Musgrave (musgravepj@gmail.com) is the document shepherd.
Send notices to sipclf-chairs@tools.ietf.org, draft-ietf-sipclf-format@tools.ietf.org
SIPCLF                                                      G. Salgueiro
Internet-Draft                                             Cisco Systems
Intended status: Standards Track                              V. Gurbani
Expires: May 12, 2013                          Bell Labs, Alcatel-Lucent
                                                             A. B. Roach
                                                                 Tekelec
                                                        November 8, 2012

Format for the Session Initiation Protocol (SIP) Common Log Format (CLF)
                      draft-ietf-sipclf-format-09

Abstract

   The SIPCLF Workgroup has defined a common log format framework for
   Session Initiation Protocol (SIP) servers.  This common log format
   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 Common Log
   Format (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
   data 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 Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on May 12, 2013.

Copyright Notice

   Copyright (c) 2012 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

Salgueiro, et al.         Expires May 12, 2013                  [Page 1]
Internet-Draft             Format for SIP CLF              November 2012

   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 . . . 14
     4.4.  Optional Fields  . . . . . . . . . . . . . . . . . . . . . 15
   5.  Example SIP CLF Record . . . . . . . . . . . . . . . . . . . . 24
   6.  Text Tool Considerations . . . . . . . . . . . . . . . . . . . 26
   7.  Security Considerations  . . . . . . . . . . . . . . . . . . . 26
   8.  Operational Guidance . . . . . . . . . . . . . . . . . . . . . 26
   9.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . . 26
     9.1.  SIP CLF Version  . . . . . . . . . . . . . . . . . . . . . 26
     9.2.  SIP CLF Transport Flag . . . . . . . . . . . . . . . . . . 27
   10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 27
   11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 28
     11.1. Normative References . . . . . . . . . . . . . . . . . . . 28
     11.2. Informative References . . . . . . . . . . . . . . . . . . 28
   Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 29

Salgueiro, et al.         Expires May 12, 2013                  [Page 2]
Internet-Draft             Format for SIP CLF              November 2012

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
Show full document text