Main logging schema for qlog
draft-marx-qlog-main-schema-00

Document Type Active Internet-Draft (individual)
Last updated 2019-07-03
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
QUIC                                                             R. Marx
Internet-Draft                                        Hasselt University
Intended status: Standards Track                           July 03, 2019
Expires: January 4, 2020

                      Main logging schema for qlog
                     draft-marx-qlog-main-schema-00

Abstract

   This document describes a high-level schema for a standardized
   endpoint logging format called qlog.  This format allows easy sharing
   of data and the creation of reusable visualization and debugging
   tools.  The high-level schema in this document is intended to be
   protocol-agnostic.  Separate documents specify how the format should
   be used for specific protocol data.

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 https://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 January 4, 2020.

Copyright Notice

   Copyright (c) 2019 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
   (https://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

Marx                     Expires January 4, 2020                [Page 1]
Internet-Draft        Main logging schema for qlog             July 2019

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Notational Conventions  . . . . . . . . . . . . . . . . .   2
   2.  Design Goals  . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  The High Level Schema . . . . . . . . . . . . . . . . . . . .   3
     3.1.  Top level container . . . . . . . . . . . . . . . . . . .   3
     3.2.  Summary field . . . . . . . . . . . . . . . . . . . . . .   4
     3.3.  Trace container . . . . . . . . . . . . . . . . . . . . .   4
       3.3.1.  vantage_point . . . . . . . . . . . . . . . . . . . .   5
       3.3.2.  Title and Description . . . . . . . . . . . . . . . .   6
       3.3.3.  Configuration . . . . . . . . . . . . . . . . . . . .   6
       3.3.4.  common_fields and event_fields  . . . . . . . . . . .   7
     3.4.  Field name semantics  . . . . . . . . . . . . . . . . . .  10
       3.4.1.  time, delta_time and reference_time + relative_time .  10
       3.4.2.  group_id and group_ids  . . . . . . . . . . . . . . .  11
       3.4.3.  CATEGORY and EVENT_TYPE . . . . . . . . . . . . . . .  15
       3.4.4.  TRIGGER . . . . . . . . . . . . . . . . . . . . . . .  15
       3.4.5.  DATA  . . . . . . . . . . . . . . . . . . . . . . . .  15
       3.4.6.  Event field values  . . . . . . . . . . . . . . . . .  15
   4.  Tooling requirements  . . . . . . . . . . . . . . . . . . . .  15
   5.  Methods of Access . . . . . . . . . . . . . . . . . . . . . .  16
   6.  Notes on Practical Use  . . . . . . . . . . . . . . . . . . .  16
   7.  Security Considerations . . . . . . . . . . . . . . . . . . .  16
   8.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  16
   9.  Normative References  . . . . . . . . . . . . . . . . . . . .  16
   Appendix A.  Change Log . . . . . . . . . . . . . . . . . . . . .  17
     A.1.  Since draft-marx-qlog-main-schema-00: . . . . . . . . . .  17
   Appendix B.  Design Variations  . . . . . . . . . . . . . . . . .  17
   Appendix C.  Acknowledgements . . . . . . . . . . . . . . . . . .  17
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  17

1.  Introduction

   Feedback and discussion welcome at https://github.com/quiclog/
   internet-drafts

1.1.  Notational Conventions

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in [RFC2119].

Marx                     Expires January 4, 2020                [Page 2]
Internet-Draft        Main logging schema for qlog             July 2019

2.  Design Goals

   The main tenets for the schema design are:
Show full document text