EventTracingLevel

EventTracingLevel

Defines a custom logging level override for a specific event type.

This object can be configured from the WebUI under Settings › Telemetry › Event Levels

Fields

event

Type: EventType · read-only

Unique identifier of the event

level

Type: TracingLevelOpt · default: "info"

The logging level for this event

JMAP API

The EventTracingLevel object is available via the urn:stalwart:jmap capability.

x:EventTracingLevel/get

This is a standard Foo/get method as defined in RFC 8620, Section 5.1.

This method requires the sysEventTracingLevelGet permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:EventTracingLevel/get",
          {
            "ids": [
              "id1"
            ]
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

x:EventTracingLevel/set

This is a standard Foo/set method as defined in RFC 8620, Section 5.3.

Supports create, update, and destroy operations in a single call.

Create

This operation requires the sysEventTracingLevelCreate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:EventTracingLevel/set",
          {
            "create": {
              "new1": {}
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

Update

This operation requires the sysEventTracingLevelUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:EventTracingLevel/set",
          {
            "update": {
              "id1": {
                "level": "info"
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

Destroy

This operation requires the sysEventTracingLevelDestroy permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:EventTracingLevel/set",
          {
            "destroy": [
              "id1"
            ]
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

x:EventTracingLevel/query

This is a standard Foo/query method as defined in RFC 8620, Section 5.5.

This method requires the sysEventTracingLevelQuery permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:EventTracingLevel/query",
          {
            "filter": {}
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

CLI

stalwart-cli wraps the same JMAP calls. See the CLI reference for installation, authentication, and general usage.

Fetch

stalwart-cli get EventTracingLevel id1

Create

stalwart-cli create EventTracingLevel

Query

stalwart-cli query EventTracingLevel

Update

stalwart-cli update EventTracingLevel id1 --field level=info

Delete

stalwart-cli delete EventTracingLevel --ids id1

Enums

TracingLevelOpt

Value	Label
disable	Disabled
error	Error - Only errors are logged
warn	Warning - Errors and warnings are logged
info	Info - Errors, warnings and info are logged
debug	Debug - Errors, warnings, info and debug are logged
trace	Trace - Errors, warnings, info, debug and trace are logged