Documentation

Mistake on this page? Email us

Metric

Hierarchy

  • Metric

Index

Constructors

constructor

  • new Metric(init?: Partial<Metric>): Metric
  • Parameters

    • Optional init: Partial<Metric>

    Returns Metric

Properties

bootstraps_failed

bootstraps_failed: number

The number of failed bootstraps the account has performed. Bootstrap is the process of provisioning a Lightweight Machine to Machine Client to a state where it can initiate a management session to a new Lightweight Machine to Machine Server.

bootstraps_pending

bootstraps_pending: number

The number of pending bootstraps the account has performed. Bootstrap is the process of provisioning a Lightweight Machine to Machine Client to a state where it can initiate a management session to a new Lightweight Machine to Machine Server.

bootstraps_successful

bootstraps_successful: number

The number of successful bootstraps the account has performed. Bootstrap is the process of provisioning a Lightweight Machine to Machine Client to a state where it can initiate a management session to a new Lightweight Machine to Machine Server.

connect_rest_api_error

connect_rest_api_error: number

The number of failed Connect API requests the account has performed.The metric do not consider the actual response from the device and it includes only the result of the http request used to subscibe to the device resources.

connect_rest_api_success

connect_rest_api_success: number

The number of successful Connect API requests the account has performed. The metric do not consider the actual response from the device and it includes only the result of the http request used to subscibe to the device resources.

deletedRegistrations

deletedRegistrations: number

The number of deleted registrations (deregistrations) linked to the account. Deregistration is the process of removing the device registration from the Pelion Device Management Connect registry. The deregistration is usually initiated by the device. Pelion Device Management Connect no longer handles requests for a deregistered device.

deleted_registrations

deleted_registrations: number

The number of deleted registrations (deregistrations) linked to the account. Deregistration is the process of removing the device registration from the Mbed Cloud Connect registry. The deregistration is usually initiated by the device. Mbed Cloud Connect no longer handles requests for a deregistered device.

device_observations

device_observations: number

(Beta) The number of observations received by Mbed Cloud Connect from the devices linked to the account. The observations are pushed from the device to Mbed Cloud Connect when you have successfully subscribed to the device resources using Connect API endpoints.

device_proxy_request_error

device_proxy_request_error: number

(Beta) The number of failed proxy requests from Mbed Cloud Connect to devices linked to the account. The proxy requests are made from Mbed Cloud Connect to devices when you try to read or write values to device resources using Connect API endpoints.

device_proxy_request_success

device_proxy_request_success: number

(Beta) The number of successful proxy requests from Mbed Cloud Connect to devices linked to the account. The proxy requests are made from Mbed Cloud Connect to devices when you try to read or write values to device resources using Connect API endpoints.

device_subscription_request_error

device_subscription_request_error: number

(Beta) The number of failed subscription requests from Mbed Cloud Connect to devices linked to the account. The subscription requests are made from Mbed Cloud Connect to devices when you try to subscribe to a resource path using Connect API endpoints.

device_subscription_request_success

device_subscription_request_success: number

(Beta) The number of successful subscription requests from Mbed Cloud Connect to devices linked to the account. The subscription requests are made from Mbed Cloud Connect to devices when you try to subscribe to a resource path using Connect API endpoints.

expiredRegistrations

expiredRegistrations: number

The number of expired registrations linked to the account. Pelion Device Management Connect removes the device registrations when the devices cannot update their registration before the expiry of the lifetime. Pelion Device Management Connect no longer handles requests for a device whose registration has expired already.

expired_registrations

expired_registrations: number

The number of expired registrations linked to the account. Mbed Cloud Connect removes the device registrations when the devices cannot update their registration before the expiry of the lifetime. Mbed Cloud Connect no longer handles requests for a device whose registration has expired already.

failedApiCalls

failedApiCalls: number

The number of failed requests the account has performed.

failedBootstraps

failedBootstraps: number

The number of failed bootstraps the account has performed. Bootstrap is the process of provisioning a Lightweight Machine to Machine Client to a state where it can initiate a management session to a new Lightweight Machine to Machine Server.

failedProxyRequests

failedProxyRequests: number

The number of failed proxy requests from Pelion Device Management Connect to devices linked to the account. The proxy requests are made from Pelion Device Management Connect to devices when you try to read or write values to device resources using Connect API endpoints.

failedSubscriptionRequests

failedSubscriptionRequests: number

The number of failed subscription requests from Pelion Device Management Connect to devices linked to the account. The subscription requests are made from Pelion Device Management Connect to devices when you try to subscribe to a resource path using Connect API endpoints.

fullRegistrations

fullRegistrations: number

The number of full registrations linked to the account. Full registration is the process of registering a device with the Pelion Device Management Connect by providing its lifetime and capabilities such as the resource structure. The registered status of the device does not guarantee that the device is active and accessible from Mebd Cloud Connect at any point of time.

full_registrations

full_registrations: number

The number of full registrations linked to the account. Full registration is the process of registering a device with the Mbed Cloud Connect by providing its lifetime and capabilities such as the resource structure.The registered status of the device does not guarantee that the device is active and accessible from Mebd Cloud Connect at any point of time.

handshakes

handshakes: number

The number of successful TLS handshakes the account has performed. The SSL or TLS handshake enables the SSL or TLS client and server to establish the secret keys with which they communicate. A successful TLS handshake is required for establishing a connection with Pelion Device Management Connect for any operaton such as registration, registration update and deregistration.

handshakes_successful

handshakes_successful: number

The number of successful TLS handshakes the account has performed. The SSL or TLS handshake enables the SSL or TLS client and server to establish the secret keys with which they communicate. A successful TLS handshake is required for establishing a connection with Mbed Cloud Connect for any operaton such as registration, registration update and deregistration.

id

id: string

A unique metric ID. The ID of the metric

observations

observations: number

The number of observations received by Pelion Device Management Connect from the devices linked to the account. The observations are pushed from the device to Pelion Device Management Connect when you have successfully subscribed to the device resources using Connect API endpoints.

pendingBootstraps

pendingBootstraps: number

The number of pending bootstraps the account has performed. Bootstrap is the process of provisioning a Lightweight Machine to Machine Client to a state where it can initiate a management session to a new Lightweight Machine to Machine Server.

registration_updates

registration_updates: number

The number of registration updates linked to the account. Registration update is the process of updating the registration status with the Mbed Cloud Connect to update or extend the lifetime of the device.

successfulApiCalls

successfulApiCalls: number

The number of successful requests the account has performed.

successfulBootstraps

successfulBootstraps: number

The number of successful bootstraps the account has performed. Bootstrap is the process of provisioning a Lightweight Machine to Machine Client to a state where it can initiate a management session to a new Lightweight Machine to Machine Server.

successfulProxyRequests

successfulProxyRequests: number

The number of successful proxy requests from Pelion Device Management Connect to devices linked to the account. The proxy requests are made from Pelion Device Management Connect to devices when you try to read or write values to device resources using Connect API endpoints.

successfulSubscriptionRequests

successfulSubscriptionRequests: number

The number of successful subscription requests from Pelion Device Management Connect to devices linked to the account. The subscription requests are made from Pelion Device Management Connect to devices when you try to subscribe to a resource path using Connect API endpoints.

timestamp

timestamp: Date

UTC time in RFC3339 format. The timestamp is the starting point of the interval for which the data is aggregated. Each interval includes data for the time greater than or equal to the timestamp and less than the next interval's starting point. UTC time in RFC3339 format. The timestamp is the starting point of the interval for which the data is aggregated. Each interval includes data for the time greater than or equal to the timestamp and less than the next interval's starting point.

transactions

transactions: number

The number of transaction events from or to devices linked to the account. A transaction is a 512-byte block of data processed by Mbed Cloud Connect. It can be either sent by the device (device --> Mbed Cloud Connect) or received by the device (Mbed Cloud Connect --> device). A transaction does not include IP, TCP or UDP, TLS or DTLS packet overhead. It only contains the packet payload (full CoAP packet including CoAP headers). The Registration (full registration or registration update) and Deregistration events from device to Mbed Cloud Connect are not counted as a transaction. The observation event (resource change notifications) from device to Mbed Cloud Connect is counted as a transaction. The proxy and subscription request from Mbed Cloud Connect to the device is counted as a transaction and the access to Mbed Cloud Connect cache without contacting the actual device may also add to transaction count. The number of transaction events from or to devices linked to the account. A transaction is a 512-byte block of data processed by Pelion Device Management. It can be either sent by the device (device --> Pelion Device Management) or received by the device (Pelion Device Management --> device). A transaction does not include IP, TCP or UDP, TLS or DTLS packet overhead. It only contains the packet payload (full CoAP packet including CoAP headers).

updatedRegistrations

updatedRegistrations: number

The number of registration updates linked to the account. Registration update is the process of updating the registration status with the Pelion Device Management Connect to update or extend the lifetime of the device.