Register Edge observability metrics.

POST

https://app.unleash-instance.example.com/api/client/metrics/edge

POST

/api/client/metrics/edge

curl -X POST https://app.unleash-instance.example.com/api/client/metrics/edge \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "identifier": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "appName": "unleash-edge-us-east-1",
  "edgeVersion": "19.6.3",
  "started": "2024-01-15T09:30:00Z",
  "traffic": {
    "get": {},
    "post": {},
    "accessDenied": {},
    "cachedResponses": {}
  },
  "latencyUpstream": {
    "features": {
      "avg": 1.1,
      "count": 1.1,
      "p99": 34.5
    },
    "metrics": {
      "avg": 1.1,
      "count": 1.1,
      "p99": 34.5
    },
    "edge": {
      "avg": 1.1,
      "count": 1.1,
      "p99": 34.5
    }
  },
  "connectedStreamingClients": 1.1,
  "connectedEdges": [
    {
      "identifier": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "appName": "unleash-edge-us-east-1",
      "edgeVersion": "19.6.3",
      "started": "2024-01-15T09:30:00Z",
      "traffic": {
        "get": {},
        "post": {},
        "accessDenied": {},
        "cachedResponses": {}
      },
      "latencyUpstream": {
        "features": {
          "avg": 1.1,
          "count": 1.1,
          "p99": 34.5
        },
        "metrics": {
          "avg": 1.1,
          "count": 1.1,
          "p99": 34.5
        },
        "edge": {
          "avg": 1.1,
          "count": 1.1,
          "p99": 34.5
        }
      },
      "connectedStreamingClients": 1.1,
      "connectedEdges": [
        null
      ]
    }
  ]
}'

202Accepted

{}

Enterprise feature

Registers Edge observability metrics from downstream Edge instances to aggregate a comprehensive status view of connected Edges.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Request

edgeInstanceDataSchema

identifierstringRequired

The ID of the Edge process, typically a ULID. Newly generated for each restart of the instance.

appNamestringRequired

The name of the application, configured by the user, typically persistent across restarts of Edge.

edgeVersionstringRequired

Which version (semver) of Edge is the Edge instance running.

startedstringRequiredformat: "date-time"

RFC3339 timestamp for when the Edge instance was started.

trafficobjectRequired

Represents requests to the Edge instance (/api/client/features, /api/frontend, etc.)

latencyUpstreamobjectRequired

Latencies for upstream actions from Edge (downloading/syncing new features, uploading metrics, uploading instance data)

connectedStreamingClientsdoubleRequired>=0

How many streaming clients are connected to the Edge instance.

connectedEdgeslist of objectsRequired

A list of Edge instances connected to the Edge instance.

regionstring or nullOptional

Which region the Edge instance is running in. Set to AWS_REGION by default (if present).

processMetricsobject or nullOptional

Represents Edge instance resource usage data.

enricherMetricsobject or nullOptional

Context enrichment request latency, errors, and timeouts.

requestsSinceLastReportobjectOptional

Requests made to edge's endpoints since last report. Meant to be used for billing purposes.

connectionConsumptionSinceLastReportobjectOptional

Connection consumption data since last report, including features and metrics consumption. Used for long-lived backend SDKs with backend controlled number of instances.

requestConsumptionSinceLastReportlist of objectsOptional

Request consumption data since last report, grouped by metered group. Used for frontend SDKs with unpredictable and potentially large number of user devices running those SDKs.

hostingenumOptional

A marker that tells Unleash whether this Edge instance is self-hosted, enterprise self-hosted, or hosted by Unleash.

Allowed values:

apiKeyRevisionIdslist of objects or nullOptional

List of API keys (represented by their environment and projects) and revision ids to make it easier to track sync state of edge

Response

This response has no body.