Monitoring

Retrieve information about the health of the link between the encoder and the CSL slicer.

Get Link Health

Retrieve information about the health of the link between the encoder and the CSL slicer.

Request

Request syntax:

GET /managed-slicer/slicer/monitor/Slicer ID

Request URL variable:

Define the following variable when submitting the above request:

Response

The response for a successful request contains the following properties:

If an encoder is not currently connected to the specified CSL slicer, then the response will only contain the @id and @type properties.

session Dictionary

The session dictionary contains link health statistics for the current CSL slicer session through the following properties:

recent Dictionary

The recent dictionary describes recent link health statistics through the following properties:

Sample Request/Response

Call the get_link_health module (Python 3) to retrieve health statistics for the link between the encoder and the CSL slicer. This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

class GetLinkHealth:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        """
        Get link health.
        """
        self._get_link_health()

    def _get_link_health(self):
        csl_slicer_id = "bcc4d23b45ba43e8b1e93141a10fee7e" # Replace with your CSL slicer ID.
        url = "{}{}{}".format(self.host, "/api/v4/managed-slicer/slicer/monitor/", csl_slicer_id)

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({})
        )

        if response.status_code == 200:
            print(response.json())
        else:
            print(response.status_code)

GetLinkHealth().run()

Response:

{
    "@id": "/api/v4/managed-slicer/slicer/monitor/bcc4d23b45ba43e8b1e93141a10fee7e",
    "@type": "StreamMonitor",
    "session": {
        "round_trip_time": 14,
        "link_uptime": 25.17,
        "latency_setting": 1000,
        "stream_bitrate": 2248.0,
        "packets_inbound": 20966998,
        "packets_outbound": 0,
        "percent_link_success": 99.97,
        "packets_errored": 5530,
        "percent_errored": 0.03,
        "packets_FEC_corrected": 0,
        "percent_fixed_by_FEC": 0.0,
        "packets_ARQ_corrected": 0,
        "percent_fixed_by_ARQ": 0.0,
        "ARQ_requests": 0,
        "ARQ_fails": 5530,
        "percent_failed_ARQ": 0.03
    },
    "recent": {
        "stream_bitrate": 2557.0,
        "packets_inbound": 2339,
        "packets_outbound": 0,
        "percent_link_success": 100.0,
        "packets_errored": 0,
        "percent_errored": 0.0,
        "packets_FEC_corrected": 0,
        "percent_fixed_by_FEC": 0.0,
        "packets_ARQ_corrected": 0,
        "percent_fixed_by_ARQ": 0.0,
        "ARQ_requests": 0,
        "ARQ_fails": 0,
        "percent_failed_ARQ": 0.0
    },
    "cms_session_fingerprint": "33a77bded4d8d86ab2e4a4c533ac0778821417b4",
    "cms_session_id_fingerprint": "42428ed15c5139277884bfbf9b2946dc0f4d88d6"
}