Docs » Integrations Guide » Integrations Reference » Conviva

image0 Conviva

DESCRIPTION

Conviva is a service for monitoring video playing experience on the Internet. The SignalFx Smart Agent monitor called Conviva was developed for Conviva integration. The conviva monitor can be configured to pull Real-Time/Live Convivametrics using the Conviva Experience Insights RESTAPIs. Conviva Developer Community credentials are required to access this Conviva API documentation link. The Live Conviva metrics are converted to SignalFx metrics with dimensions for the name of the Conviva account and the name(s) of the applied filter(s). For MetricLens metrics, the MetricLens dimensions are mapped one-to-one to SignalFx dimensions with the values of these dimensions derived from the values of the associated MetricLens dimension entities.

REQUIREMENTS AND DEPENDENCIES

Only Live Conviva metrics are supported. Conviva MetricLens metrics require MetricLens-enabled filters. MetricLens-enabled filters are listed in the table of filters here with a checkmark in the ML column. Conviva Pulse credentials are required to access the link to the table of filters.

This monitor requires:

Software Version
Conviva Experience Insights API 2.4+

INSTALLATION

Install the latest version of the SignalFx Smart Agent as described here.

CONFIGURATION

Find and edit the SignalFx Smart Agent configuration file agent.yaml to configure the conviva monitor as described here. Use the metric parameters here as values for metricParameter.

USAGE

The Conviva monitor emits Live Conviva metrics which can then be used to create dashboards such as the one below showing an overview of real-time video quality metrics.

image1

Important conditions to watch out for

The Conviva API response may return with filters listed in fields filters_not_exist, filters_warmup and filters_incomplete_data. This means data for these filters may be wholly or partially unavailable. When this happens it is logged in the SignalFx Smart Agent log file.

Configuration validation will fail when a non-MetricLens enabled filter is listed in a MetricLens metric configuration.

The select all filters in combination with select all dimensions options should be used with care because of the potential to generate a large amount of datapoints (i.e. metric time series (MTS)).

METRICS

Below is a list of all metrics.

Metric Name Brief Type
     
gauge.conviva.attempts Real-Time/Live time series of the number of attempts gauge
gauge.conviva.audience_metriclens.concurrent_plays Real-Time/Live audience metriclens of concurrent plays gauge
gauge.conviva.audience_metriclens.ended_plays Real-Time/Live audience metriclens of ended plays gauge
gauge.conviva.audience_metriclens.plays Real-Time/Live audience metriclens of plays gauge
gauge.conviva.avg_bitrate Real-Time/Live time series of the average bitrate gauge
gauge.conviva.concurrent_plays Real-Time/Live time series of concurrent plays gauge
gauge.conviva.connection_induced_rebuffering_ratio Real-Time/Live simple series of connection induced rebuffering ratio gauge
gauge.conviva.connection_induced_rebuffering_ratio_timeseries Real-Time/Live time series of connection induced rebuffering ratio gauge
gauge.conviva.duration_connection_induced_rebuffering_ratio_distribution Real-Time/Live label series of duration vs. connection induced rebuffering ratio distribution gauge
gauge.conviva.ended_plays Real-Time/Live simple series of ended plays gauge
gauge.conviva.ended_plays_timeseries Real-Time/Live time series of ended plays gauge
gauge.conviva.exits_before_video_start Real-Time/Live time series of exits before video start gauge
gauge.conviva.play_bitrate_distribution Real-Time/Live label series of play bitrate distribution gauge
gauge.conviva.play_buffering_ratio_distribution Real-Time/Live label series of play buffering ratio distribution gauge
gauge.conviva.play_connection_induced_rebuffering_ratio_distribution Real-Time/Live label series of play connection induced rebuffering ratio distribution gauge
gauge.conviva.plays Real-Time/Live time series of plays gauge
gauge.conviva.quality_metriclens.average_bitrate_kbps Real-Time/Live quality metriclens metric of average bitrate in kbps gauge
gauge.conviva.quality_metriclens.connection_induced_rebuffering_ratio_percent Real-Time/Live quality metriclens metric of connection induced rebuffering ratio percent gauge
gauge.conviva.quality_metriclens.ended_plays Real-Time/Live quality metriclens metric of ended plays gauge
gauge.conviva.quality_metriclens.exits_before_video_start_percent Real-Time/Live quality metriclens metric of exits before video start percent gauge
gauge.conviva.quality_metriclens.plays_percent Real-Time/Live quality metriclens metric of plays percent gauge
gauge.conviva.quality_metriclens.rebuffering_ratio_percent Real-Time/Live quality metriclens metric of rebuffering ratio percent gauge
gauge.conviva.quality_metriclens.total_attempts Real-Time/Live quality metriclens metric of total attempts gauge
gauge.conviva.quality_metriclens.video_playback_failures_percent Real-Time/Live quality metriclens metric of video playback failures percent gauge
gauge.conviva.quality_metriclens.video_restart_time Real-Time/Live quality metriclens metric of video restart time gauge
gauge.conviva.quality_metriclens.video_start_failures_percent Real-Time/Live quality metriclens metric of video start failures percent gauge
gauge.conviva.quality_metriclens.video_startup_time_sec Real-Time/Live quality metriclens metric of video startup time in sec gauge
gauge.conviva.quality_summary Real-Time/Live label series of quality summary gauge
gauge.conviva.rebuffered_plays Real-Time/Live time series of rebuffered plays gauge
gauge.conviva.rebuffering_ratio Real-Time/Live time series of rebuffering ratio gauge
gauge.conviva.top_assets_summary Real-Time/Live label series of top assets summary gauge
gauge.conviva.video_playback_failures_distribution Real-Time/Live label series of video playback failures distribution gauge
gauge.conviva.video_playback_failures_timeseries Real-Time/Live time series of video playback failures gauge
gauge.conviva.video_restart_time Real-Time/Live simple series of video restart time gauge
gauge.conviva.video_restart_time_distribution Real-Time/Live label series of video restart time distribution gauge
gauge.conviva.video_restart_time_timeseries Real-Time/Live time series of video restart time gauge
gauge.conviva.video_start_failures Real-Time/Live time series of video start failures gauge
gauge.conviva.video_start_failures_errornames Real-Time/Live simple table of video start failures by error names gauge
gauge.conviva.video_startup_time Real-Time/Live label series of video startup time gauge
———-|——|———–|
|attempts|conviva.<br/attempts|Attempts time-series|
|avg_bitrate|conviva.<br/avg_bitrate|Average bitrate time-series|
|concurrent_plays|conviva.<br/concurrent_plays|Concurrent plays time-series|
|connection_induced<br/_rebuffering_ratio|conviva.<br/connection_induced<br/_rebuffering_ratio|Connection induced rebuffering ratio simple-series|
|connection_induced<br/_rebuffering_ratio<br/_timeseries|conviva.<br/connection_induced<br/_rebuffering_ratio<br/_timeseries|Connection induced rebuffering ratio time-series|
|duration_connection<br/_induced_rebuffering<br/_ratio_distribution|conviva.<br/duration_connection<br/_induced_rebuffering<br/_ratio_distribution|Duration vs. connection induced rebuffering ratio distribution label-series|
|exits_before<br/_video_star|conviva.<br/exits_before<br/_video_start|Exits before video start time-series|
|ended_plays|conviva.<br/ended_plays|Ended plays simple-series|
|ended_plays<br/_timeseries|conviva.<br/ended_plays<br/_timeseries|Ended plays time-series|
|plays|conviva.<br/plays|Plays time-series|
|play_bitrate<br/_distribution|conviva.<br/play_bitrate<br/_distribution|Play bitrate distribution label-series|
|play_buffering<br/_ratio_distribution|conviva.<br/play_buffering<br/_ratio_distribution|Play buffering ratio distribution label-series|
|play_connection<br/_induced_rebuffering<br/_ratio_distribution|conviva.<br/play_connection<br/_induced_rebuffering<br/_ratio_distribution|Play connection induced rebuffering ratio distribution label-series|
|quality_summary|conviva.<br/quality_summary|Quality summary label-series|
|rebuffered_plays|conviva.<br/rebuffered_plays|Rebuffered plays time-series|
|rebuffering_ratio|conviva.<br/rebuffering_ratio|Rebuffering ratio time-series|
|top_assets_15_mins|conviva.<br/top_assets_15_mins|Top assets over last 15 minutes simple-table|
|top_assets_summary|conviva.<br/top_assets_summary|Top assets summary label-series|
|video_playback<br/_failures|conviva.<br/video_playback<br/_failures|Video playback failures simple-series|
|video_playback<br/_failures_timeseries|conviva.<br/video_playback<br/_failures_timeseries|Video playback failures time-series|
|video_playback<br/_failures_distribution|conviva.<br/video_playback<br/_failures_distribution|Video playback failures distribution label-series|
|video_restart<br/_time|conviva.<br/video_restart<br/_time|Video restart time simple-series|
|video_restart<br/_time_timeseries|conviva.<br/video_restart<br/_time_timeseries|Video restart time time-series|
|video_restart<br/_time_distribution|conviva.<br/video_restart_time<br/_distribution|Video restart time distribution label-series|
|video_start<br/_failures|conviva.<br/video_start<br/_failures|Video start failures time-series|
|video_start<br/_failures_errornames|conviva.<br/video_start<br/_failures_errornames|Video start failures by error names simple-table|
|video_startup_time|conviva.<br/video_startup_time|Video startup time label-series|
|quality_metriclens|conviva.<br/quality_metriclens.<br/total_attempts|Attempts|
||conviva.<br/quality_metriclens.<br/video_start<br/_failures_percent|Video Start Failures(VSF) (%)|
||conviva.<br/quality_metriclens.<br/exits_before<br/_video_start<br/_percent|Exits Before Video Starts (EBVS) (%)|
||conviva.<br/quality_metriclens.<br/plays_percent|Plays (%)|
||conviva.<br/quality_metriclens.<br/video_startup<br/_time_sec|Video Startup Time (sec)|
||conviva.<br/quality_metriclens.<br/rebuffering_ratio<br/_percent|Rebuffering Ratio (%)|
||conviva.<br/quality_metriclens.<br/average_bitrate<br/_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.<br/quality_metriclens.<br/video_playback<br/_failures_percent|Video Playback Failures (%)|
||conviva.<br/quality_metriclens.<br/ended_plays|Ended Plays|
||conviva.<br/quality_metriclens.<br/connection_induced<br/_rebuffering_ratio<br/_percent|Connection Induced ReBuffering Ratio (%)|
||conviva.<br/quality_metriclens.<br/video_restart_time|Video Restart Time|
|audience_metriclens|conviva.<br/audience_metriclens.<br/concurrent_plays|Concurrent Plays|
||conviva.<br/audience_metriclens.<br/plays|Plays|
||conviva.<br/audience_metriclens.<br/ended_plays|Ended Plays|

gauge.conviva.attempts

gauge

Real-Time/Live time series of the number of attempts

gauge.conviva.audience_metriclens.concurrent_plays

gauge

Real-Time/Live audience metriclens of concurrent plays

gauge.conviva.audience_metriclens.ended_plays

gauge

Real-Time/Live audience metriclens of ended plays

gauge.conviva.audience_metriclens.plays

gauge

Real-Time/Live audience metriclens of plays

gauge.conviva.avg_bitrate

gauge

Real-Time/Live time series of the average bitrate

gauge.conviva.concurrent_plays

gauge

Real-Time/Live time series of concurrent plays

gauge.conviva.connection_induced_rebuffering_ratio

gauge

Real-Time/Live simple series of connection induced rebuffering ratio

gauge.conviva.connection_induced_rebuffering_ratio_timeseries

gauge

Real-Time/Live time series of connection induced rebuffering ratio

gauge.conviva.duration_connection_induced_rebuffering_ratio_distribution

gauge

Real-Time/Live label series of duration vs. connection induced rebuffering ratio distribution

gauge.conviva.ended_plays

gauge

Real-Time/Live simple series of ended plays

gauge.conviva.ended_plays_timeseries

gauge

Real-Time/Live time series of ended plays

gauge.conviva.exits_before_video_start

gauge

Real-Time/Live time series of exits before video start

gauge.conviva.play_bitrate_distribution

gauge

Real-Time/Live label series of play bitrate distribution

gauge.conviva.play_buffering_ratio_distribution

gauge

Real-Time/Live label series of play buffering ratio distribution

gauge.conviva.play_connection_induced_rebuffering_ratio_distribution

gauge

Real-Time/Live label series of play connection induced rebuffering ratio distribution

gauge.conviva.plays

gauge

Real-Time/Live time series of plays

gauge.conviva.quality_metriclens.average_bitrate_kbps

gauge

Real-Time/Live quality metriclens metric of average bitrate in kbps

gauge.conviva.quality_metriclens.connection_induced_rebuffering_ratio_percent

gauge

Real-Time/Live quality metriclens metric of connection induced rebuffering ratio percent

gauge.conviva.quality_metriclens.ended_plays

gauge

Real-Time/Live quality metriclens metric of ended plays

gauge.conviva.quality_metriclens.exits_before_video_start_percent

gauge

Real-Time/Live quality metriclens metric of exits before video start percent

gauge.conviva.quality_metriclens.plays_percent

gauge

Real-Time/Live quality metriclens metric of plays percent

gauge.conviva.quality_metriclens.rebuffering_ratio_percent

gauge

Real-Time/Live quality metriclens metric of rebuffering ratio percent

gauge.conviva.quality_metriclens.total_attempts

gauge

Real-Time/Live quality metriclens metric of total attempts

gauge.conviva.quality_metriclens.video_playback_failures_percent

gauge

Real-Time/Live quality metriclens metric of video playback failures percent

gauge.conviva.quality_metriclens.video_restart_time

gauge

Real-Time/Live quality metriclens metric of video restart time

gauge.conviva.quality_metriclens.video_start_failures_percent

gauge

Real-Time/Live quality metriclens metric of video start failures percent

gauge.conviva.quality_metriclens.video_startup_time_sec

gauge

Real-Time/Live quality metriclens metric of video startup time in sec

gauge.conviva.quality_summary

gauge

Real-Time/Live label series of quality summary

gauge.conviva.rebuffered_plays

gauge

Real-Time/Live time series of rebuffered plays

gauge.conviva.rebuffering_ratio

gauge

Real-Time/Live time series of rebuffering ratio

gauge.conviva.top_assets_summary

gauge

Real-Time/Live label series of top assets summary

gauge.conviva.video_playback_failures_distribution

gauge

Real-Time/Live label series of video playback failures distribution

gauge.conviva.video_playback_failures_timeseries

gauge

Real-Time/Live time series of video playback failures

gauge.conviva.video_restart_time

gauge

Real-Time/Live simple series of video restart time

gauge.conviva.video_restart_time_distribution

gauge

Real-Time/Live label series of video restart time distribution

gauge.conviva.video_restart_time_timeseries

gauge

Real-Time/Live time series of video restart time

gauge.conviva.video_start_failures

gauge

Real-Time/Live time series of video start failures

gauge.conviva.video_start_failures_errornames

gauge

Real-Time/Live simple table of video start failures by error names

gauge.conviva.video_startup_time

gauge

Real-Time/Live label series of video startup time