Metric

Metric

Stores a collected server metric data point.

Fields

Metric is a multi-variant object: each instance has an @type discriminator selecting one of the variants below, and each variant carries its own set of fields.

@type: "Counter"

Counter metric

count

Type: UnsignedInt · default: 0

Count associated with the metric

metric

Type: MetricType · required

Metric event type

timestamp

Type: UTCDateTime · required

Timestamp of the metric entry

@type: "Gauge"

Gauge metric

count

Type: UnsignedInt · default: 0

Count associated with the metric

metric

Type: MetricType · required

Metric event type

timestamp

Type: UTCDateTime · required

Timestamp of the metric entry

@type: "Histogram"

Histogram metric

count

Type: UnsignedInt · default: 0

Value associated with the metric

sum

Type: UnsignedInt · default: 0

Sum associated with the metric

metric

Type: MetricType · required

Metric event type

timestamp

Type: UTCDateTime · required

Timestamp of the metric entry

JMAP API

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

x:Metric/get

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

This method requires the sysMetricGet permission.

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

x:Metric/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 sysMetricCreate permission.

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

Update

This operation requires the sysMetricUpdate permission.

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

Destroy

This operation requires the sysMetricDestroy permission.

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

x:Metric/query

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

This method requires the sysMetricQuery permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:Metric/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 Metric id1

Create

stalwart-cli create Metric/Counter

Query

stalwart-cli query Metric

Update

stalwart-cli update Metric id1 --field count=0

Delete

stalwart-cli delete Metric --ids id1