Docs » Configure application receivers » Conviva Real-Time/Live video play

Conviva Real-Time/Live video play 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the conviva monitor via the Smart Agent Receiver.

This monitor uses version 2.4 of the Conviva Experience Insights REST APIs to pull Real-Time/Live video playing experience metrics from Conviva.

Only Live conviva metrics listed on the Conviva Developer Community page are supported. All metrics are gauges. The Conviva metrics are converted to Splunk Observability Cloud metrics with dimensions named account and filter. The account dimension is the name of the Conviva account and the filter dimension is the name of the Conviva filter applied to the metric. In the case of MetricLenses, the constituent MetricLens metrics and MetricLens dimensions are included. The values of the MetricLens dimensions are derived from the values of the associated MetricLens dimension entities.

Installation 🔗

This monitor is available in the SignalFx Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector.

To install this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform.

  2. Configure the monitor, as described in the next section.

Configuration 🔗

The Splunk Distribution of OpenTelemetry Collector allows embedding a Smart Agent monitor configuration in an associated Smart Agent Receiver instance.

Note: Providing a Conviva monitor entry in your Smart Agent or Collector configuration is required for its use. Use the appropriate form for your agent type.

Smart Agent 🔗

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
 - type: conviva
   ...  # Additional config

See Smart Agent example configuration for an autogenerated example of a YAML configuration file, with default values where applicable.

Splunk Distribution of OpenTelemetry Collector 🔗

To activate this monitor in the OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/conviva:
    type: conviva
    ... # Additional config

To complete the monitor activation, you must also include the smartagent/conviva receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file.

See configuration examples for specific use cases that show how the collector can integrate and complement existing environments.

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option Required Type Description
pulseUsername yes string Conviva Pulse username required with each API request.
pulsePassword yes string Conviva Pulse password required with each API request.
timeoutSeconds no integer (default: 10)
metricConfigs no list of objects (see below) Conviva metrics to fetch. The default is quality_metriclens metric with the "All Traffic" filter applied and all quality_metriclens dimensions.

The nested metricConfigs configuration object has the following fields:

Option Required Type Description
account no string Conviva customer account name. The default account is fetched used if not specified.
metricParameter no string (default: quality_metriclens)
filters no list of strings Filter names. The default is All Traffic filter.
metricLensDimensions no list of strings MetricLens dimension names. The default is names of all MetricLens dimensions of the account
excludeMetricLensDimensions no list of strings MetricLens dimension names to exclude.
maxFiltersPerRequest no integer Max number of filters per request. The default is the number of filters. Multiple requests are made if the number of filters is more than maxFiltersPerRequest (default: 0)

Example configurations 🔗

This section provides a basic YAML configuration of the Conviva monitor using only the required fields. For this configuration, the monitor will default to fetching quality MetricLens metrics for all dimensions from the default Conviva account using the All Traffic filter.

monitors:
- type: conviva
 pulseUsername: <username>
 pulsePassword: <password>

Individual metrics are configured as a list of metricConfigs, as shown in the following sample configuration. The metrics are fetched using the specified metricParameter. See the list of metric parameters in the Conviva monitor metric parameters and metrics section.

The Conviva metrics reported to Observability Cloud are prefixed by conviva., conviva.quality_metriclens. and conviva.audience_metriclens. accordingly. The metric names are the titles of the metrics, which correspond to the Conviva metric parameters on the Conviva Developer Community page.

Where an account is not provided, the default account is fetched and used. Where no filters are specified the All Traffic filter is used. Where MetricLens dimensions are not specified, all MetricLens dimensions are fetched and used. The _ALL_ keyword means all. MetricLens dimension configuration applies only to MetricLenses. If specified for a regular metric, they will be ignored. MetricLens dimensions listed in excludeMetricLensDimensions are excluded.

monitors:
- type: conviva
 pulseUsername: <username>
 pulsePassword: <password>
 metricConfigs:
   - account: c3.NBC
     metricParameter: quality_metriclens
     filters:
       - All Traffic
     metricLensDimensions:
       - Cities
   - metricParameter: avg_bitrate
     maxFiltersPerRequest: 99
     filters:
       - _ALL_
   - metricParameter: concurrent_plays
   - metricParameter: audience_metriclens
     filters:
       - All Traffic
     metricLensDimensions:
       - _ALL_
     excludeMetricLensDimensions:
       - CDNs

Add the extra dimension metric_source, as shown in following sample configuration for the convenience of searching for your metrics in SignalFx using the metric_source value you specify. Also, version 2.4 of the Conviva Experience Insights REST APIs limits the number of filters per request to 99. Specify the maximum number of filters per request using maxFiltersPerRequest, as shown in the previous example to limit the number of filters per request.

monitors:
- type: conviva
 pulseUsername: <username>
 pulsePassword: <password>
 extraDimensions:
   metric_source: conviva

Conviva monitor metric parameters and metrics 🔗

Metric parameters are Conviva monitor metricParameter configuration values. Metrics are the metrics that get reported to Observability Cloud.

Metric parameters Metrics Description
attempts conviva.
attempts
Attempts time-series
avg_bitrate conviva.
avg_bitrate
Average bitrate time-series
concurrent_plays conviva.
concurrent_plays
Concurrent plays time-series
connection_induced
_rebuffering_ratio
conviva.
connection_induced
_rebuffering_ratio
Connection induced rebuffering ratio simple-series
connection_induced
_rebuffering_ratio
_timeseries
conviva.
connection_induced
_rebuffering_ratio
_timeseries
Connection induced rebuffering ratio time-series
duration_connection
_induced_rebuffering
_ratio_distribution
conviva.
duration_connection
_induced_rebuffering
_ratio_distribution
Duration vs. connection induced rebuffering ratio distribution label-series
exits_before
_video_star
conviva.
exits_before
_video_start
Exits before video start time-series
ended_plays conviva.
ended_plays
Ended plays simple-series
ended_plays
_timeseries
conviva.
ended_plays
_timeseries
Ended plays time-series
plays conviva.
plays
Plays time-series
play_bitrate
_distribution
conviva.
play_bitrate
_distribution
Play bitrate distribution label-series
play_buffering
_ratio_distribution
conviva.
play_buffering
_ratio_distribution
Play buffering ratio distribution label-series
play_connection
_induced_rebuffering
_ratio_distribution
conviva.
play_connection
_induced_rebuffering
_ratio_distribution
Play connection induced rebuffering ratio distribution label-series
quality_summary conviva.
quality_summary
Quality summary label-series
rebuffered_plays conviva.
rebuffered_plays
Rebuffered plays time-series
rebuffering_ratio conviva.
rebuffering_ratio
Rebuffering ratio time-series
top_assets_15_mins conviva.
top_assets_15_mins
Top assets over last 15 minutes simple-table
top_assets_summary conviva.
top_assets_summary
Top assets summary label-series
video_playback
_failures
conviva.
video_playback
_failures
Video playback failures simple-series
video_playback
_failures_timeseries
conviva.
video_playback
_failures_timeseries
Video playback failures time-series
video_playback
_failures_distribution
conviva.
video_playback
_failures_distribution
Video playback failures distribution label-series
video_restart
_time
conviva.
video_restart
_time
Video restart time simple-series
video_restart
_time_timeseries
conviva.
video_restart
_time_timeseries
Video restart time time-series
video_restart
_time_distribution
conviva.
video_restart_time
_distribution
Video restart time distribution label-series
video_start
_failures
conviva.
video_start
_failures
Video start failures time-series
video_start
_failures_errornames
conviva.
video_start
_failures_errornames
Video start failures by error names simple-table
video_startup_time conviva.
video_startup_time
Video startup time label-series
quality_metriclens conviva.
quality_metriclens.
total_attempts
Attempts
conviva.
quality_metriclens.
video_start
_failures_percent
Video Start Failures(VSF) (%)
conviva.
quality_metriclens.
exits_before
_video_start
_percent
Exits Before Video Starts (EBVS) (%)
conviva.
quality_metriclens.
plays_percent
Plays (%)
conviva.
quality_metriclens.
video_startup
_time_sec
Video Startup Time (sec)
conviva.
quality_metriclens.
rebuffering_ratio
_percent
Rebuffering Ratio (%)
conviva.
quality_metriclens.
average_bitrate
_kbps
Average Bitrate (bps). This metric can be returned in kbps with the ab_units=kbps parameter. Unless this parameter is specified, average bitrate is bps.
conviva.
quality_metriclens.
video_playback
_failures_percent
Video Playback Failures (%)
conviva.
quality_metriclens.
ended_plays
Ended Plays
conviva.
quality_metriclens.
connection_induced
_rebuffering_ratio
_percent
Connection Induced ReBuffering Ratio (%)
conviva.
quality_metriclens.
video_restart_time
Video Restart Time
audience_metriclens conviva.
audience_metriclens.
concurrent_plays
Concurrent Plays
conviva.
audience_metriclens.
plays
Plays
conviva.
audience_metriclens.
ended_plays
Ended Plays

Metrics 🔗

These are the metrics available for this integration.