Skip to content
This repository has been archived by the owner on Oct 12, 2023. It is now read-only.

Telemtery Service

sushilraje edited this page Jan 23, 2019 · 1 revision

Service status

Visibility: internal; Auth: not required

Request:

GET /v1/status

Response:

200 OK
Content-Type: application/json; charset=utf-8
{
    "Name": "DeviceTelemetry",
    "Status": "OK:...msg...|ERROR:...msg...",
    "CurrentTime": "datetime ...",
    "StartTime": "datetime ...",
    "UpTime": "timespan ...",
    "UID": "1be12fa0-7337-49e9-892b-889b9f863ee5",
    "Properties": {
        "Type": "DocumentDB|Cassandra"
    },
    "Dependencies": {
        "Storage": "OK:...msg...|ERROR:...msg..."
    },
    "$metadata": {
        "$type": "Status;v1",
        "$uri": "/v1/status"
    }
}
  • Status: the message is optional
  • UpTime: value specific to the process running, i.e. in case of multiple deployments each instance has a different uptime
  • UID: a unique value in each instance, used mostly for logging correlation
  • Properties: used only for debugging, free form entries
  • Dependencies: health status of the internal dependencies, values used only for debugging