SIPPING Working Group A. Pendleton Internet-Draft Nortel Expires: July 4, 2006 A. Johnston Tello H. Sinnreich Pulver A. Clark Telchemy Incorporated February 2006 Session Initiation Protocol Package for Voice Quality Reporting Event draft-ietf-sipping-rtcp-summary-01 Status of this Memo By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet- Drafts. 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." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire on July 4, 2006. Copyright Notice Copyright (C) The Internet Society (2006). Abstract This document defines a SIP event package that enables the collection and reporting of metrics that measure the quality for Voice over Internet Protocol (VoIP) sessions. Pendleton, et al. Expires July 4, 2006 [Page 1] Internet-Draft SIP Package for Voice Quality Reporting February 2006 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 3. SIP Events Approach . . . . . . . . . . . . . . . . . . . . . 3 4. Use of PUBLISH Method . . . . . . . . . . . . . . . . . . . . 3 5. Event Package Formal Definition . . . . . . . . . . . . . . . 4 5.1. Event Package Name . . . . . . . . . . . . . . . . . . . . 4 5.2. Event Package Parameters . . . . . . . . . . . . . . . . . 4 5.3. SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . 4 5.4. Subscription Duration . . . . . . . . . . . . . . . . . . 4 5.5. NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . 4 5.6. Voice Quality Event Syntax and Semantics . . . . . . . . . 5 5.7. Message Flow and Syntax Examples . . . . . . . . . . . . . 12 5.7.1. End of Session Report using PUBLISH . . . . . . . . . 12 5.7.2. Alert Report using PUBLISH . . . . . . . . . . . . . . 14 5.7.3. End of Session Report using NOTIFY . . . . . . . . . . 16 5.7.4. Mid Session Threshold Violation using NOTIFY . . . . . 18 5.8. IANA Considerations . . . . . . . . . . . . . . . . . . . 21 5.8.1. SIP Event Package Registration . . . . . . . . . . . . 21 5.8.2. application/vq-rtcp-xr MIME Registration . . . . . . . 22 5.9. Security Considerations . . . . . . . . . . . . . . . . . 22 5.10. Contributors . . . . . . . . . . . . . . . . . . . . . . . 23 6. Normative References . . . . . . . . . . . . . . . . . . . . . 23 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 24 Intellectual Property and Copyright Statements . . . . . . . . . . 25 Pendleton, et al. Expires July 4, 2006 [Page 2] Internet-Draft SIP Package for Voice Quality Reporting February 2006 1. Introduction This document defines a new SIP event package, vq-rtcpxr, and a new MIME type, application/vq-rtcpxr, that enable the collection and reporting of metrics that measure quality for RTP [3] sessions. The definitions of the metrics used in the event package are based on RTCP Extended Reports [4] and RTCP [3]. Monitoring of voice quality is believed to be the highest priority for usage of this mechanism and as such, the metrics in the event package are largely tailored for voice quality measurement. However, the event package defined herein is designed to be extensible. The event package explicitly provides parameters for reporting both the local and remote versions of these statistics. Note that in multi-party calls, multiple reports will need to be generated either one for each endpoint or one for each session. Configuration of usage of the event package is not covered in this document. The event package can be used either with the SUBSCRIBE/NOTIFY methods or the PUBLISH method. Message flow examples for both mechanims are provided in this document. 2. Terminology In this document, the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in BCP 14, RFC 2119 [1] and indicate requirement levels for compliant implementations. 3. SIP Events Approach This document defines a new SIP events package [5]. The intended methods to use for this event are PUBLISH and SUBSCRIBE/NOTIFY. A SIP UA can provide voice quality reports using either of these methods to an entity which can make the information available to other applications. 4. Use of PUBLISH Method A SIP UA that supports this specification may send the service quality metric reports using the PUBLISH method. An application wishing to access this performance data maintains a State Agent for the vq-rtcpxr event package. The Request-URI of the PUBLISH method is set to the address of the resource for the VoIP application. The PUBLISH message is sent to the normal default outbound proxy server of the SIP UA or could be sent to other interested parties. Pendleton, et al. Expires July 4, 2006 [Page 3] Internet-Draft SIP Package for Voice Quality Reporting February 2006 The use of PUBLISH by this event is unique in that it does not require a soft or hard state to be maintained by either the Event Publication Agent (EPA) or the Event State Compositor (ESC). Futhermore the information that is presented by the vq-rtcpxr event in a PUBLISH request is not expected to have an expiration, rather, the information is associated with the timestamps in the event itself. The primary intention of using PUBLISH for this event is reduction of transaction processing. A concern over the usage of the PUBLISH method is potential overloading of servers receiving the events, particularly in the threshold reporting model. There are many approaches to solving this type of problem, but clearly the EPA's needs to adhere to some guidelines to reduce the probability of causing this overload condition. Some suggested solutions are: a) limit sending of one threshold report per metric per session b) limit sending of one threshold report per session regardless of the metric c) limit sending a new threshold report to when a metric state has been sustained for a reasonable amount of time such as 20-30 seconds. 5. Event Package Formal Definition 5.1. Event Package Name This document defines a SIP Event Package as defined in RFC 3265 [2]. The event-package token name for this package is: "vq-rtcpxr" 5.2. Event Package Parameters No event package parameters are defined. 5.3. SUBSCRIBE Bodies No SUBSCRIBE bodies are described by this specification. 5.4. Subscription Duration Subscriptions to this event package MAY range from minutes to weeks. Subscriptions in hours or days are more typical and are RECOMMENDED. The default subscription duration for this event package is one hour. 5.5. NOTIFY Bodies There are three notify bodies: a session report, an interval session report, and a alert report. Pendleton, et al. Expires July 4, 2006 [Page 4] Internet-Draft SIP Package for Voice Quality Reporting February 2006 The session report is used for end of session reporting. This can be generated when a voice media session terminates or when a media change occurs, such as a codec change or a session forks. This report is intended to allow cumulative metric reporting. The session reports will populate the metrics with values that are measured over the interval explicitly defined by the "start" and "stop" timestamps. The interval report is used for periodic or interval reporting. This report is intended to capture short duration metric reporting. Interval reports will populate the metrics with values that are measured over the interval explicitly defined by the "start" and "stop" timestamps. The threshold report is used when voice quality degrades during a session. The session report parameters are also included in the alert report to provide all of the necessary diagnostic information. Like the interval report, the metrics in the threshold reports will be populated with values that are measured over the interval explicitly defined by the "start" and "stop" timestamps. This specification defines a new MIME type application/vq-rtcpxr which is a text encoding of the RTCP and RTCP-XR statistics, along with some additional metrics and correlation information. 5.6. Voice Quality Event Syntax and Semantics This section describes the syntax extensions required for event publication in SIP. The formal syntax definitions described in this section are expressed in the Augmented BNF [6] format used in SIP [2], and contains references to elements defined therein. Additionally, the definition of the timestamp format is provided in [7]. Note that most of the parameters are optional. In practice, most implementations will send a subset of the parameters. It is not the intention of this document to define what parameters may or may not be useful for monitoring the quality of a voice session, but to enable reporting of voice quality. As such, the syntax allows the implementer to choose which metrics are most appropriate for their solution. As there are no "invalid", "unknown", or "not applicable" values in the syntax, the intention is to exclude any parameters for which values are not available, not applicable, or unknown. Additionally, the authors recognize that implementers may need to add new parameter lines to the reports and new metrics to the existing parameter lines. The extension tokens are intended to fulfill this need. VQReportEvent = AlertReport / SessionReport / IntervalReport Pendleton, et al. Expires July 4, 2006 [Page 5] Internet-Draft SIP Package for Voice Quality Reporting February 2006 SessionReport = "VQSessionReport" CLRF LocalMetrics [CLRF RemoteMetrics] [DialogID] IntervalReport = "VQIntervalReport" CLRF LocalMetrics [CLRF RemoteMetrics] [DialogID] LocalMetrics = "LocalMetrics" COLON Metrics RemoteMetrics = "RemoteMetrics" COLON Metrics AlertReport = "VQAlertReport" COLON MetricType WSP Severity WSP Direction CLRF "Metrics:" CLRF Metrics [CLRF "OtherDir Metrics:" CLRF Metrics] [DialogID] Metrics = TimeStamps CLRF [SessionDescription CLRF] CallID CLRF LocalAddr CRLF RemoteAddr CRLF [JitterBuffer CRLF] [PacketLoss CRLF] [BurstGapLoss CLRF] [Delay CLRF] [Signal CLRF] [QualityEstimates CLRF] *[Extension CLRF] ; Timestamps are provided in Coordinated Universal Time (UTC) ; using the ABNF format provided in RFC3339, ; "Date and Time on the Internet: Timestamps" ; These timestamps should reflect, as closely as ; possible, the actual time during which the media session ; was running to enable correlation to events occurring ; in the network infrastructure and to accounting or billing ; records TimeStamps = "Timestamps" COLON StartTime WSP StopTime StartTime = "START" EQUAL date-time StopTime = "STOP" EQUAL date-time ; SessionDescription provides a shortened version of the ; session SDP but contains only the relevant parameters for Pendleton, et al. Expires July 4, 2006 [Page 6] Internet-Draft SIP Package for Voice Quality Reporting February 2006 ; session quality reporting purposes SessionDescription = "SessionDesc" COLON [PayloadType WSP] [PayloadDesc WSP] [SampleRate WSP] [FrameDuration WSP] [FrameOctets WSP] [FramesPerPacket WSP] [PacketsPerSecond WSP] [FmtpOptions WSP] [PacketLossConcealment WSP] [SilenceSuppressionState] *[WSP Extension] ; PayloadType provides the PT parameter used in the RTP packets ; i.e. the codec used for decoding received RTP packets ; It is recommended that IANA registered values are used ; where possible. PayloadType = "PT" EQUAL (1*3DIGIT) ; PayloadDesc provides a text description of the codec ; It is recommended that IANA registered names are used ; where possible. PayloadDesc = "PD" EQUAL word ; SampleRate provides the rate at which voice was sampled ; in the case of narrowband codecs, the value will typically be 8000 SampleRate = "SR" EQUAL (1*5DIGIT) ; FrameDuration can be combined with the FramesPerPacket to determine ; the packetization rate; the units for this are milliseconds. FrameDuration = "FD" EQUAL (1*3DIGIT) ; FrameOctets provides the number of octets in each frame ; Used where FrameDuration is not available FrameOctets = "FO" EQUAL (1*4DIGIT) ; FramesPerPacket provides the number of frames in each RTP packet FramesPerPacket = "FPP" EQUAL (1*2DIGIT) ; Packets per second provides the number of packets, including one or ; more frames within each, that are transmitted per second PacketsPerSecond = "PPS" EQUAL (1*5DIGIT) ; FMTP options from SDP. Note that the parameter is deliniated ; by " " to avoid parsing issues in transitioning between SDP and ; SIP parsing FmtpOptions = "FMTP" EQUAL "word-plus" Pendleton, et al. Expires July 4, 2006 [Page 7] Internet-Draft SIP Package for Voice Quality Reporting February 2006 ; PacketLossConcealment indicates whether a PLC algorithm was ; or is being used for the session. The values follow the same ; numbering convention as RFC 3611. For more details, ; please refer to RFC 3611, RTCP XR ; 0 - unspecified ; 1 - disabled ; 2 - enhanced ; 3 - standard PacketLossConcealment = "PLC" EQUAL ("0" / "1" / "2" / "3") ; SilenceSuppressionState indicates whether silence suppression, ; also known as Voice Activity Detection (VAD) is enabled. SilenceSuppressionState = "SSUP" EQUAL ("on" / "off") ; CallId provides the call id from the SIP header CallID = "CID" EQUAL Call-ID-Parm ; LocalAddr provides the IP address, port and ssrc for the ; session from the perspective of the endpoint/UA which is ; sending the report LocalAddr = "LocalAddr" COLON IPAddress WSP Port WSP Ssrc ; RemoteAddr provides the IP address, port and ssrc for the ; session from the perspective of the peer of the endpoint/UA ; that is sending the report RemoteAddr = "RemoteAddr" COLON IPAddress WSP Port WSP Ssrc IPAddress = "IP" EQUAL IPv6address / IPv4address Port = "PORT" EQUAL 1*DIGIT Ssrc = "SSRC" EQUAL 1*8HEX JitterBuffer = "JitterBuffer" COLON [JitterBufferAdaptive WSP] [JitterBufferRate WSP] [JitterBufferNominal WSP] [JitterBufferMax WSP] [JitterBufferAbsMax] *[WSP Extension] ; JitterBufferAdaptive indicates whether the jitter buffer in the ; endpoint is adaptive, static, or unknown. ; The values follow the same numbering convention as RFC 3611. ; For more details, please refer to that document. ; 0 - unknown ; 1 - reserved ; 2 - non-adaptive ; 3 - adaptive Pendleton, et al. Expires July 4, 2006 [Page 8] Internet-Draft SIP Package for Voice Quality Reporting February 2006 JitterBufferAdaptive = "JBA" EQUAL ("0" / "1" / "2" / "3") ; JitterBuffer metric definitions are provided in RTCP XR, RFC 3611 JitterBufferRate = "JBR" EQUAL (1*2DIGIT) ;0-15 JitterBufferNominal = "JBN" EQUAL (1*5DIGIT) ;0-65535 JitterBufferMax = "JBM" EQUAL (1*5DIGIT) ;0-65535 JitterBufferAbsMax = "JBX" EQUAL (1*5DIGIT) ;0-65535 ; PacketLoss metric definitions are provided in RTCP XR, RFC 3611 PacketLoss = "PacketLoss" COLON [NetworkPacketLossRate WSP] [JitterBufferDiscardRate] *[WSP Extension] NetworkPacketLossRate = "NLR" EQUAL (1*3(DIGIT) ["." 1*2(DIGIT)]) ;percentage JitterBufferDiscardRate = "JDR" EQUAL (1*3(DIGIT) ["." 1*2(DIGIT)]) ;percentage ; BurstGapLoss metric definitions are provided in RTCP XR, RFC 3611 BurstGapLoss = "BurstGapLoss" COLON [BurstLossDensity WSP] [BurstDuration WSP] [GapLossDensity WSP] [GapDuration WSP] [MinimumGapThreshold] *[WSP Extension] BurstLossDensity = "BLD" EQUAL (1*3(DIGIT) ["." 1*2(DIGIT)]) ;percentage BurstDuration = "BD" EQUAL (1*8DIGIT) ;0-3,600,000 -- milliseconds GapLossDensity = "GLD" EQUAL (1*3(DIGIT) ["." 1*2(DIGIT)]) ;percentage GapDuration = "GD" EQUAL (1*8DIGIT) ;0-3,600,000 -- milliseconds MinimumGapThreshold = "GMIN" EQUAL (1*3DIGIT) ;1-255 Delay = "Delay" COLON [RoundTripDelay WSP] [EndSystemDelay WSP] [OneWayDelay WSP] [InterarrivalJitter WSP] [MeanAbsoluteJitter] *[WSP Extension] Pendleton, et al. Expires July 4, 2006 [Page 9] Internet-Draft SIP Package for Voice Quality Reporting February 2006 ; RoundTripDelay is recommended to be measured as defined in ; RTCP, RFC 3550. RoundTripDelay = "RTD" EQUAL (1*5DIGIT) ;0-65535 ; EndSystemDelay metric is defined in RTCP XR, RFC 3611 EndSystemDelay = "ESD" EQUAL (1*5DIGIT) ;0-65535 ; OneWayDelay is recommended to be measured according to ; recommendations provided by the IPPM working group but may be ; based on alternative measurement recommendations OneWayDelay = "OWD" EQUAL (1*5DIGIT) ;0-65535 ; Interarrival Jitter is recommended to be measured as defined ; in RTCP, RFC 3550, but may be based on alternatives InterarrivalJitter = "IAJ" EQUAL (1*5DIGIT) ;0-65535 ; Mean Absolute Jitter is recommended to be measured as defined ; by ITU-T G.1020 where it is known as MAPDV MeanAbsoluteJitter = "MAJ" EQUAL (1*5DIGIT) ; Signal metrics definitions are provided in RTCP XR, RFC 3611 Signal = "Signal" COLON [SignalLevel WSP] [NoiseLevel WSP] [ResidualEchoReturnLoss] *[WSP Extension] ; SignalLevel will normally be a positive value ; the absence of the negative sign indicates a positive value ; where the signal level is negative, the sign must be included SignalLevel = "SL" EQUAL (["-"] 1*2DIGIT) ; NoiseLevel will normally be negative but to align with the ; the encoding of SignalLevel, the sign must be explicitly included ; again, the absence of a sign indicates a positive value NoiseLevel = "NL" EQUAL (["-"] 1*2DIGIT) ResidualEchoReturnLoss = "RERL" EQUAL (1*3DIGIT) ; Voice Quality estimation metrics ; The definition of these metrics are provided in RTCP XR and ; the new High Resolution proposal, RTCP HD. ; Each quality estmiate has an optional associated algorithm. ; These fields permit the implementation to use a variety ; of different calculation methods for each type of metric QualityEstimates = "QualityEst" COLON Pendleton, et al. Expires July 4, 2006 [Page 10] Internet-Draft SIP Package for Voice Quality Reporting February 2006 [ListeningQualityR WSP] [RLQEstAlg WSP] [ConversationalQualityR WSP] [RCQEstAlg WSP] [ExternalR-In WSP] [ExtRInEstAlg WSP] [ExternalR-Out WSP] [ExtROutEstAlg WSP] [MOS-LQ WSP] [MOSLQEstAlg WSP] [MOS-CQ WSP] [MOSCQEstAlg WSP] [QoEEstAlg] *[WSP Extension] ListeningQualityR = "RLQ" EQUAL (1*3DIGIT) ; 0 - 120 RLQEstAlg = "RLQEstAlg" EQUAL word ; "PESQ", "G.107", or other ConversationalQualityR = "RCQ" EQUAL *1*3DIGIT) ; 0 - 120 RCQEstAlg = "RCQEstAlg" EQUAL word ; "PESQ", "G.107", or other ; ExternalR-In is measured by the local endpoint for incoming ; connection on "other" side of this endpoint ; e.g. PhoneA <---> Bridge <----> Phone B ; ListeningQualityR = quality for PhoneA ----> Bridge path ; ExternalR-In = quality for Bridge <---- PhoneB path ExternalR-In = "EXTRI" EQUAL (1*3DIGIT) ; 0 - 120 ExtRInEstAlg = "ExtRIEstAlg" EQUAL word ; "PESQ", "G.107", or other ; ExternalR-Out is copied from RTCP XR message received from the ; remote endpoint on "other" side of this endpoint ; e.g. PhoneA <---> Bridge <----> Phone B ; ExternalR-Out = quality for Bridge -----> PhoneB path ExternalR-Out = "EXTRO" EQUAL (1*3DIGIT) ; 0 - 120 ExtRInEstAlg = "ExtROEstAlg" EQUAL word ; "PESQ", "G.107", or other MOS-LQ = "MOSLQ" EQUAL (DIGIT ["." 1*2DIGIT]) ; 0.0 - 4.9 MOSLQEstAlg = "MOSLQEstAlg" EQUAL word ; "PESQ", "G.107", or other MOS-CQ = "MOSCQ" EQUAL (DIGIT ["." 1*2DIGIT] ; 0.0 - 4.9 MOSCQEstAlg = "MOSCQEstAlg" EQUAL word ; "PESQ", "G.107", or other ; alternative to the separate estimation algorithms ; for use when the same algorithm is used for all measurements QoEEstAlg = "QoEEstAlg' Pendleton, et al. Expires July 4, 2006 [Page 11] Internet-Draft SIP Package for Voice Quality Reporting February 2006 DialogID = "DialogID" COLON callid *(SEMI did-parm) did-parm = to-tag / from-tag / generic-param callid = Call-ID-Parm to-tag = "to-tag" EQUAL token from-tag = "from-tag" EQUAL token ; MetricType provides the metric on which a notification of ; threshold violation was based. The more commonly used metrics ; for alerting purposes are included here explicitly and the ; token parameter allows for extension MetricType = "Type" EQUAL "RLQ" / "RCQ" / "EXTR" / "MOSLQ" / "MOSCQ" / "BD" / "NLR" / "JDR" / "RTD" / "ESD" / "IAD" / "RERL" / Extension Direction = "Dir" EQUAL "local" / "remote" Severity = "Severity" EQUAL "Warning" / "Critical" / "Clear" Call-ID-Parm = word [ "@" word ] Extension = word-plus word = 1*(alphanum / "-" / "." / "!" / "%" / "*" / "_" / "+" / "`" / "'" / "~" / "(" / ")" / "<" / ">" / ":" / "\" / DQUOTE / "/" / "[" / "]" / "?" / word-plus = 1*(alphanum / "-" / "." / "!" / "%" / "*" / "_" / "+" / "`" / "'" / "~" / "(" / ")" / "<" / ">" / ":" / "\" / "/" / "[" / "]" / "?" / "{" / "}" / "=" / " ") 5.7. Message Flow and Syntax Examples This section shows a number of message flow examples showing how the event package works. 5.7.1. End of Session Report using PUBLISH Alice Proxy/Registrar Collector Bob | | | | Pendleton, et al. Expires July 4, 2006 [Page 12] Internet-Draft SIP Package for Voice Quality Reporting February 2006 | | | | | REGISTER Allow-Event:vq-rtcpxr F1 | | |------------------->| | | | 200 OK F2 | | | |<-------------------| | | | INVITE F3 | | | |------------------->| | | | | INVITE F4 | | | |---------------------------------------->| | | 200 OK F5 | | | |<----------------------------------------| | 200 OK F6 | | | |<-------------------| | | | ACK F7 | | | |------------------->| | | | | ACK F8 | | | |---------------------------------------->| | RTP | | | |<============================================================>| | RTCP | | | |<============================================================>| | | | | | BYE F9 | | | |------------------->| BYE F10 | | | |---------------------------------------->| | | 200 OK F11 | | | |<----------------------------------------| | 200 OK F12 | | | |<-------------------| | | | PUBLISH Event:vq-rtcpxr F13 | | |------------------->| | | | | PUBLISH Event:vq-rtcpxr F14 | | |------------------->| | | | 200 OK F15 | | | |<-------------------| | | 200 OK F16 | | | |<-------------------| | | Figure 1. End of session report sent after session termination. In the message flow depicted in Figure 1, the following message is sent in F13. PUBLISH sip:collector@example.org SIP/2.0 Via: SIP/2.0/UDP pc22.example.org;branch=z9hG4bK3343d7 Max-Forwards: 70 Pendleton, et al. Expires July 4, 2006 [Page 13] Internet-Draft SIP Package for Voice Quality Reporting February 2006 To: From: Alice ;tag=a3343df32 Call-ID: 1890463548@alice.example.org CSeq: 4331 PUBLISH Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY Event: vq-rtcpxr Accept: application/sdp, message/sipfrag Content-Type: application/vq-rtcpxr Content-Length: ... VQSessionReport LocalMetrics: TimeStamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z SessionDesc:PT=18 PD=G729 SR=8000 FD=20 FO=20 FPP=2 PPS=50 FMTP="annexb=no" PLC=3 SSUP=on CallID:1890463548@alice.example.org LocalAddr:IP=10.10.1.100 PORT=5000 SSRC=2468abcd RemoteAddr:IP=11.1.1.150 PORT=5002 SSRC=1357efff JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120 PacketLoss:NLR=5.0 JDR=2.0 BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16 Delay:RTD=200 ESD=140 IAJ=2 OWD=100 Signal:SL=2 NL=-10 RERL=14 QualityEst:RLQ=90 RCQ=85 EXTRI=90 MOSLQ=3.4 MOSCQ=3.3 QoEEstAlg=AlgX RemoteMetrics: TimeStamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z SessionDesc:PT=18 PD=G729 SR=8000 FD=20 FO=20 FPP=2 PPS=50 FMTP="annexb=no" PLC=3 SSUP=on CallID:1890463548@alice.example.org LocalAddr:IP=11.1.1.150 PORT=5002 SSRC=1357efff RemoteAddr:IP=10.10.1.100 PORT=5000 SSRC=2468abcd JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120 PacketLoss:NLR=5.0 JDR=2.0 BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16 Delay:RTD=200 ESD=140 IAJ=2 OWD=100 Signal:SL=2 NL=-10 RERL=0 QualityEst:RLQ=90 RCQ=85 MOSLQ=3.4 MOSCQ=3.3 QoEEstAlg=AlgX DialogID:1890463548@alice.example.org;to-tag=8472761; from-tag=9123dh311 5.7.2. Alert Report using PUBLISH Alice Proxy/Registrar Collector Bob | | | | | INVITE F1 | | | |------------------->| | | Pendleton, et al. Expires July 4, 2006 [Page 14] Internet-Draft SIP Package for Voice Quality Reporting February 2006 | | INVITE F2 | | | |---------------------------------------->| | | 200 OK F3 | | | |<----------------------------------------| | 200 OK F4 | | | |<-------------------| | | | ACK F5 | | | |------------------->| | | | | ACK F6 | | | |---------------------------------------->| | RTP | | | |<============================================================>| | RTCP | | | |<============================================================>| | PUBLISH Event:vq-rtcpxr F7 | | |------------------->| | | | | PUBLISH Event:vq-rtcpxr F8 | | |------------------->| | | | 200 OK F9 | | | |<-------------------| | | 200 OK F10 | | | |<-------------------| | | | | | | | BYE F12 | | | |------------------->| BYE F13 | | | |---------------------------------------->| | | 200 OK F14 | | | |<----------------------------------------| | 200 OK F15 | | | |<-------------------| | | Figure 2. Alert report message flow This alert indicates that the quality of the call in progress, as measured by the Listening Quality R metric, has degraded to an unacceptable level. For futher troubleshooting of the problem, all metrics are populated, including the remote values obtained via RTCP XR (RFC 3611) in the endpoints. In the message flow depicted in Figure 2, the following message is sent in F7: PUBLISH sip:collector@example.org SIP/2.0 Via: SIP/2.0/UDP pc22.example.org;branch=z9hG4bK3343d7 Max-Forwards: 70 To: From: Alice ;tag=a3343df32 Pendleton, et al. Expires July 4, 2006 [Page 15] Internet-Draft SIP Package for Voice Quality Reporting February 2006 Call-ID: 1890463548@alice.example.org CSeq: 4321 PUBLISH Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY Event: vq-rtcpxr Accept: application/sdp, message/sipfrag Content-Type: application/vq-rtcpxr Content-Length: ... VQAlertReport: Type=RLQ Severity=Warning Dir=local Metrics: TimeStamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50 PLC=3 SSUP=on CallID:1890463548@alice.example.org LocalAddr:IP=10.10.1.100 PORT=5000 SSRC=2a4b6c8d RemoteAddr:IP=11.1.1.150 PORT=5002 SSRC=9f7e5d3c JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120 PacketLoss:NLR=5.0 JDR=2.0 BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16 Delay:RTD=200 ESD=140 IAJ=2 OWD=100 Signal:SL=2 NL=-10 RERL=14 QualityEst:RLQ=90 RCQ=85 EXTR=90 MOSLQ=3.4 MOSCQ=3.3 QoEEstAlg=AlgX OtherDir Metrics: TimeStamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50 PLC=3 SSUP=on CallID:1890463548@alice.example.rog LocalAddr:IP=11.1.1.150 PORT=5002 SSRC=9f7e5d3c RemoteAddr:IP=10.10.1.100 PORT=5000 SSRC=2a4b6c8d JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120 PacketLoss:NLR=5.0 JDR=2.0 BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16 Delay:RTD=200 ESD=140 IAJ=2 OWD=100 Signal:SL=2 NL=-10 RERL=0 QualityEst:RLQ=90 RCQ=85 EXTRI=90 MOSLQ=3.4 MOSCQ=3.3 QoEEstAlg=AlgX DialogID:1890463548@alice.example.org;to-tag=8472761; from-tag=9123dh3111 5.7.3. End of Session Report using NOTIFY Alice Proxy/Registrar Collector Bob | | | | | | | | | REGISTER Allow-Event:vq-rtcpxr F1 | | |------------------->| | | | 200 OK F2 | | | Pendleton, et al. Expires July 4, 2006 [Page 16] Internet-Draft SIP Package for Voice Quality Reporting February 2006 |<-------------------| | | | | SUBSCRIBE Event:vq-rtcpxr F3 | | |<-------------------| | | SUBSCRIBE Event:vq-rtcpxr F4 | | |<-------------------| | | | 200 OK F5 | | | |------------------->| | | | | 200 OK F6 | | | |------------------->| | | INVITE F7 | | | |------------------->| | | | | INVITE F8 | | | |---------------------------------------->| | | 200 OK F9 | | | |<----------------------------------------| | 200 OK F10 | | | |<-------------------| | | | ACK F11 | | | |------------------->| | | | | ACK F12 | | | |---------------------------------------->| | RTP | | | |<============================================================>| | RTCP, RTCP XR | | |<============================================================>| | | | | | BYE F13 | | | |------------------->| BYE F14 | | | |---------------------------------------->| | | 200 OK F15 | | | |<----------------------------------------| | 200 OK F16 | | | |<-------------------| | | | NOTIFY Event:vq-rtcpxr F17 | | |------------------->| | | | | NOTIFY Event:vq-rtcpxr F18 | | |------------------->| | | | 200 OK F19 | | | |<-------------------| | | 200 OK F20 | | | |<-------------------| | | Figure 3. Summary report with NOTIFY sent after session termination. In the call flow depicted in Figure 3, the following message format is sent in F17: NOTIFY sip:collector@example.org SIP/2.0 Pendleton, et al. Expires July 4, 2006 [Page 17] Internet-Draft SIP Package for Voice Quality Reporting February 2006 Via: SIP/2.0/UDP pc22.example.org;branch=z9hG4bK3343d7 Max-Forwards: 70 To: ;tag=43524545 From: Alice ;tag=a3343df32 Call-ID: 1890463548@alice.example.org CSeq: 4321 NOTIFY Contact: Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY Event: vq-rtcpxr Accept: application/sdp, message/sipfrag Subscription-State: active;expires=3600 Content-Type: application/vq-rtcpxr Content-Length: ... VQSessionReport LocalMetrics: TimeStamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50 PLC=3 SSUP=on CallID:1890463548@alice.example.org LocalAddr:IP=10.10.1.100 PORT=5000 SSRC=1a3b5c7d RemoteAddr:IP=11.1.1.150 PORT=5002 SSRC=2468abcd JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120 PacketLoss:NLR=5.0 JDR=2.0 BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16 Delay:RTD=200 ESD=140 IAJ=2 OWD=100 Signal:SL=2 NL=-10 RERL=14 QualityEst:RLQ=90 RCQ=85 EXTRI=90 MOSLQ=3.4 MOSCQ=3.3 QoEEstAlg=AlgX RemoteMetrics: TimeStamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50 PLC=3 SSUP=on CallID:1890463548@alice.example.org LocalAddr:IP=11.1.1.150 PORT=5002 SSRC=2468abcd RemoteAddr:IP=10.10.1.100 PORT=5000 SSRC=1a3b5c7d JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120 PacketLoss:NLR=5.0 JDR=2.0 BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16 Delay:RTD=200 ESD=140 IAJ=2 OWD=100 Signal:SL=2 NL=-10 RERL=0 QualityEst:RLQ=90 RCQ=85 EXTRI=90 MOSLQ=3.4 MOSCQ=3.3 QoEEstAlg=AlgX DialogID:1890463548@alice.example.org;to-tag=8472761; from-tag=9123dh311 5.7.4. Mid Session Threshold Violation using NOTIFY Pendleton, et al. Expires July 4, 2006 [Page 18] Internet-Draft SIP Package for Voice Quality Reporting February 2006 Alice Proxy/Registrar Collector Bob | | | | | | | | | REGISTER Allow-Event:vq-rtcpxr F1 | | |------------------->| | | | 200 OK F2 | | | |<-------------------| | | | | SUBSCRIBE Event:vq-rtcpxr F3 | | |<-------------------| | | SUBSCRIBE Event:vq-rtcpxr F4 | | |<-------------------| | | | 200 OK F5 | | | |------------------->| | | | | 200 OK F6 | | | |------------------->| | | INVITE F7 | | | |------------------->| | | | | INVITE F8 | | | |---------------------------------------->| | | 200 OK F9 | | | |<----------------------------------------| | 200 OK F10 | | | |<-------------------| | | | ACK F11 | | | |------------------->| | | | | ACK F12 | | | |---------------------------------------->| | RTP | | | |<============================================================>| | RTCP, RTCP XR | | |<============================================================>| | NOTIFY Event:vq-rtcpxr F17 | | |------------------->| | | | | NOTIFY Event:vq-rtcpxr F18 | | |------------------->| | | | 200 OK F19 | | | |<-------------------| | | 200 OK F20 | | | |<-------------------| | | | | | | | BYE F13 | | | |------------------->| BYE F14 | | | |---------------------------------------->| | | 200 OK F15 | | | |<----------------------------------------| | 200 OK F16 | | | |<-------------------| | | | NOTIFY Event:vq-rtcpxr F17 | | Pendleton, et al. Expires July 4, 2006 [Page 19] Internet-Draft SIP Package for Voice Quality Reporting February 2006 |------------------->| | | | | NOTIFY Event:vq-rtcpxr F18 | | |------------------->| | | | 200 OK F19 | | | |<-------------------| | | 200 OK F20 | | | |<-------------------| | | Figure 4. Summary report sent during session with threshold report. This alert indicates that the quality of the call in progress, based on Listening Quality transmission rating R , has degraded to an unacceptable level. For futher troubleshooting of the problem, all metrics are populated, including the remote values obtained via RTCP XR [4]. In the call flow depicted in Figure 4, the following message format is sent in F17: NOTIFY sip:collector@example.org SIP/2.0 Via: SIP/2.0/UDP pc22.example.org;branch=z9hG4bK3343d7 Max-Forwards: 70 To: From: Alice ;tag=a3343df32 Call-ID: 1890463548@alice.example.org CSeq: 4321 PUBLISH Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY Event: vq-rtcpxr Accept: application/sdp, message/sipfrag Content-Type: application/vq-rtcpxr Content-Length: ... VQAlertReport: Type=RLQ Severity=Warning Dir=local Metrics: TimeStamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50 PLC=3 SSUP=on CallID:1890463548@alice.example.org LocalAddr:IP=10.10.1.100 PORT=5000 SSRC=1a3b5c7d RemoteAddr:IP=11.1.1.150 PORT=5002 SSRC=2468abcd JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120 PacketLoss:NLR=5.0 JDR=2.0 BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16 Delay:RTD=200 ESD=140 IAJ=2 OWD=100 Signal:SL=2 NL=-10 RERL=14 QualityEst:RLQ=90 RCQ=85 EXTR=90 MOSLQ=3.4 MOSCQ=3.3 QoEEstAlg=AlgX OtherDir Metrics: Pendleton, et al. Expires July 4, 2006 [Page 20] Internet-Draft SIP Package for Voice Quality Reporting February 2006 TimeStamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50 PLC=3 SSUP=on CallID:1890463548@alice.example.org LocalAddr:IP=11.1.1.150 PORT=5002 SSRC=2468abcd RemoteAddr:IP=10.10.1.100 PORT=5000 SSRC=1a3b5c7d JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120 PacketLoss:NLR=5.0 JDR=2.0 BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=10 Delay:RTD=200 ESD=140 IAJ=2 OWD=100 Signal:SL=2 NL=-10 RERL=0 QualityEst:RLQ=90 RCQ=85 EXTRI=90 MOSLQ=3.4 MOSCQ=3.3 QoEEstAlg=AlgX DialogID:1890463548@alice.example.org;to-tag=8472761; from-tag=9123dh31111 5.8. IANA Considerations This document registers a new SIP Event Package and a new MIME type. 5.8.1. SIP Event Package Registration Package name: vq-rtcpxr Type: package Contact: Amy Pendleton Published Specification: This document Pendleton, et al. Expires July 4, 2006 [Page 21] Internet-Draft SIP Package for Voice Quality Reporting February 2006 5.8.2. application/vq-rtcp-xr MIME Registration MIME media type name: application MIME subtype name: vq-rtcpxr Mandatory parameters: none Optional parameters: none Encoding considerations: text Security considerations: See next section. Interoperability considerations: none. Published specification: This document. Applications which use this media type: This document type is being used in notifications of VoIP quality reports. Additional Information: Magic Number: None File Extension: None Macintosh file type code: "TEXT" Personal and email address for further information: Amy Pendleton Intended usage: COMMON Author/Change controller: The IETF. 5.9. Security Considerations RTCP reports can contain sensitive information since they can provide information about the nature and duration of a session established between two or more endpoints. As a result, any third party wishing to obtain this information SHOULD be properly authenticated by the SIP UA using standard SIP mechanisms and according to the recommendations in [5]. Additionally the event content MAY be encrypted to ensure confidentiality; the mechanisms for providing confidentiality are detailed in [2]. Pendleton, et al. Expires July 4, 2006 [Page 22] Internet-Draft SIP Package for Voice Quality Reporting February 2006 5.10. Contributors The authors would like to thank Rajesh Kumar, Dave Oran and Tom Redman for their discussions. 6. Normative References [1] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [2] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., Peterson, J., Sparks, R., Handley, M., and E. Schooler, "SIP: Session Initiation Protocol", RFC 3261, June 2002. [3] Schulzrinne, H., Casner, S., Frederick, R., and V. Jacobson, "RTP: A Transport Protocol for Real-Time Applications", STD 64, RFC 3550, July 2003. [4] Friedman, T., Caceres, R., and A. Clark, "RTP Control Protocol Extended Reports (RTCP XR)", RFC 3611, November 2003. [5] Huitema, C., "Real Time Control Protocol (RTCP) attribute in Session Description Protocol (SDP)", RFC 3605, October 2003. [5] Roach, A., "Session Initiation Protocol (SIP)-Specific Event Notification", RFC 3265, June 2002. [6] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", RFC 2234, November 1997. [7] Klyne, G. and C. Newman, "Date and Time on the Internet: Timestamps", RFC 3339, July 2002. Pendleton, et al. Expires July 4, 2006 [Page 23] Internet-Draft SIP Package for Voice Quality Reporting February 2006 Authors' Addresses Amy Pendleton Nortel 2380 Performance Drive Richardson, TX 75081 Email: aspen@nortel.com Alan Johnston Tello 100 South 4th Street St. Louis, MO 63104 Email: alan.johnston@sipstation.com Henry Sinnreich Pulver 115 Broadhollow Drive, Suite 250 Melville, NY 11747, NY 11747 Email: henry@pulver.com Alan Clark Telchemy Incorporated 3360 Martins Farm Road, Suite 200 Suwanee, GA 30024 Email: alan@telchemy.com Pendleton, et al. Expires July 4, 2006 [Page 24] Internet-Draft SIP Package for Voice Quality Reporting February 2006 Intellectual Property Statement The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. Disclaimer of Validity This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Copyright Statement Copyright (C) The Internet Society (2006). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society. Pendleton, et al. Expires July 4, 2006 [Page 25]