The metrics available

WCS sends the following stream parameters for aquisition:

The available metrics list can be obtained using REST API query /api/metric/list

https://hostname:8090/api/metric/list
{
  "id": "4"
}

Where:

• id – metric Id.

If metric Id is set, the response will contain information about the metric with this Id only. In other case, response will contain all the metrics list.

The response contains the following fields:

[
    {
        "id": 4,
        "name": "Video rate",
        "note": "",
        "enumName": "VIDEO_RATE"
    }
]

Metrics aquisition principles

Metrics are combined to profiles to collect from specific nodes. Every profile contains specific metrics set and aquisition rate. A couple of metric aquisition rules can be set for certain profile which are applied to stream on node.

A number of profiles can be applied to one node (WCS instance). In this case, metric sets and rules from profiles are summarized, and minimum aquisition rate for same metric is applied. Let's look to the example:

1. The profiles profile1 and profile2 are applied to test1.flasphoner.com node

2. profile1 includes:

• VIDEO_RATE, VIDEO_FPS metrics which are aquired with rate 5
• the rule Stream name == stream1

3. profile2 includes:

• VIDEO_RATE, AUDIO_RATE metrics which are aquired with rate 10
• the rule Stream name == stream1

As a result, for the stream stream1 on test1.flashphoner.com node the following metric sets will be aquired:

• VIDEO_RATE with rate 5
• VIDEO_FPS with rate 5
• AUDIO_RATE with rate 10