MonitoringConfiguration

Article
05/10/2022

This topic gives an overview of the Azure Media Services telemetry/monitoring REST types: MonitoringConfiguration and ComponentMonitoringSettings. These types were added in Media Services version 2.13.

Media Services telemetry/monitoring allows Media Services customers to access metrics data for its services. The current version supports telemetry data for "Channel" and "StreamingEndpoint" entities. You can configure telemetry on a component level granularity. There are two detail levels "Normal" and "Verbose". The current version only supports "Normal".

Telemetry is written to a storage table in an Azure Storage account provided by the customer (the storage account must be attached to the Media Services account). Telemetry system will create a separate table for each new day based at 00:00 UTC. As an example "TelemetryMetrics20160321" where "20160321" is date of table created. For each day there will be a separate table.

Note that the telemetry system does not manage data retention. You can remove the old telemetry data by deleting the storage tables.

To enable telemetry for the specified AMS account you have to do the following:

Get the credentials of the storage account attached to the Media Services account.
Create a Notification Endpoint with EndPointType set to AzureTable (2) and endPontAddress pointing to the storage table (for example, https://telemetryvalidationstore.table.core.windows.net/). For information about how to create notification endpoint see NotificationEndPoint topic.
Create a monitoring configuration settings for the services you want to monitor. No more than one monitoring configuration settings is allowed. For details, see Monitoring configuration operations section.

Important

When accessing entities in Media Services, you must set specific header fields and values in your HTTP requests.
For more information, see Setup for Media Services REST API Development and Connecting to Media Services with the Media Services REST API.

MonitoringConfiguration Entity Properties

Property	Type	Description
Id Read-only. Set by Media Services at creation time.	Edm.String	Unique identifier. Format: "nb:mcid:UUID:<GUID>.
NotificationEndPointId	Edm.String	The notification endpoint ID of the endpoint that you want to associate with this monitoring configuration.
Created Read-only. Set by Media Services at creation time.	Edm.DateTime	This value is set by Media Services at creation time.
LastModified	Edm.Int32	The last modified time of the item.
Settings	ComponentMonitoringSettings	The component monitoring settings.

ComponentMonitoringSettings

Property	Type	Description
Component	Edm.String	The monitoring component. Valid values are: - Channel (0) - specify to monitor a channel. - StreamingEndpoint (1) - specify to monitor a streaming endpoint.
Level	Edm.String	The monitoring level. Valid values are: - Disabled (0) - output will contain no Monitoring messages. - Normal (1) - output will contain informational Monitoring messages. - Verbose(2) - output will contain detailed Monitoring messages.

Monitoring configuration operations

To get the latest x-ms-version:, see Media Services REST.

Get monitoring configurations

Request

GET https://wamsbnp1clus001rest-hs.cloudapp.net/api/MonitoringConfigurations HTTP/1.1  
x-ms-version: 2.19 
DataServiceVersion: 3.0  
MaxDataServiceVersion: 3.0  
Accept: application/json; odata=verbose  
Authorization: (redacted)  
Host: wamsbnp1clus001rest-hs.cloudapp.net

Response

HTTP/1.1 200 OK  
Cache-Control: no-cache  
Content-Length: 20  
Content-Type: application/json;odata=verbose;charset=utf-8  
Server: Microsoft-IIS/8.5  
request-id: 00a3ee37-bb19-4fca-b5c7-a92b629d4416  
x-ms-request-id: 00a3ee37-bb19-4fca-b5c7-a92b629d4416  
X-Content-Type-Options: nosniff  
DataServiceVersion: 3.0;  
access-control-expose-headers: request-id, x-ms-request-id  
X-Powered-By: ASP.NET  
Strict-Transport-Security: max-age=31536000; includeSubDomains  
Date: Wed, 02 Dec 2015 05:10:42 GMT  
{"d":{"results":[]}}

Add a monitoring configuration