JMAP Debug Logging

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 8 October 2023.¶

Copyright Notice

Copyright (c) 2023 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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶

Table of Contents

1. Introduction

Data exchanges between JMAP clients and server typically produces log lines from both the client and the server. Usually, logs are either stored locally on the instances or sent to a dedicated logging server. However, JMAP can also be used to supply log messages along-side the usual data exchange. This also removes the need to operate a separate logging infrastructure or have dedicated channels for log messages.¶

This extension adds a logs property to the JMAP method response (defined in RFC8620 Section 3.4) which contains the log lines of the JMAP server.¶

An example use case would be a JMAP API software running on a third party infrastructure in which log messages from the API cannot be sent to a dedicated logging service. Access to the third party infrastructure is restrictive in the sense that only access to the JMAP API endpoint is provided.¶

2. Response extension

The Response object will be extended via:¶

• logs: LogLine[] (optional) An array of log lines that were created while processing the request.¶

A LogLine object has the following properties:¶

• level: String The log level of the log message. MUST be one of the eight levels defined in RFC5424: debug, info, notice, warning, error, critical, alert or emergency.¶
• message: String The log message¶
• timestamp: UTCDate The date the log message was logged.¶
• class: String|null The name of the class that is currently logging.¶
• file: String|null The file that initiated the log line.¶
• line: String|null The exact line in the file where the log function is being called.¶

An example list of logs sent alongside a response to Core/echo would look like:¶

{
  "logs" : [
    {
      "file" : "Logger.php",
      "level" : "info",
      "line" : 32,
      "message" : "Array Logger has been successfully initialized",
      "timestamp" : "2022-01-18T10:26:56+01:00"
    },
    {
      "file" : "ErrorHandler.php",
      "level" : "warning",
      "line" : 52,
      "message" : "fopen(bridge.php):
        failed to open stream: No such file or directory",
      "timestamp" : "2022-01-18T10:26:56+01:00"
    },
    ...
  ],
  "methodResponses" : [
    [
      "Core/echo",
      ...

3. Security Considerations

Log messages might contain sensitive user data as well as detailed information about the system on which an API server has been installed. Appropriate measures must be taken to restrict access to JMAP Debug to trusted parties only.¶

4. IANA Considerations

5. Acknowledgements

Bron Gondwana, Neil Jenkins, Alexey Melnikov, Ken Murchison, Robert Stepanek and the JMAP working group at the IETF.¶

Authors' Addresses