JMAP Debug Logging

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.

Conventions Used In This Document The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. The definitions of JSON keys and datatypes in the document follow the conventions described in the core JMAP specification .

Addition to the Capabilities Object The capabilities object is returned as part of the JMAP Session object; see , Section 2. This document defines one additional capability URI.

urn:ietf:params:jmap:debug Represents support for the logs property in the JMAP method response (defined in RFC8620 Section 3.4) and the LogLine data type. The value of this property in the JMAP Session and account's capabilities property is an empty object.

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", ...

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.

IANA Considerations

JMAP Capability registration for "debug" IANA is requested to register the "debug" JMAP Capability as follows: Capability Name: urn:ietf:params:jmap:debug Specification document: this document Intended use: common Change Controller: IETF Security and privacy considerations: this document, .

JMAP Datatype Registration for "LogLine" IANA will register the "LogLine" Data Type as folows: Type Name: "LogLine" Can reference blobs: No Can use for state change: No Capability: "urn:ietf:params:jmap:debug" Reference: this document

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