monitors:
- dimensions:
  doc: |
    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
    [here](https://community.conviva.com/site/global/apis_data/experience_insights_api/index.gsp#metrics)
    are supported. All metrics are gauges. The Conviva metrics are converted to SignalFx 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.

    Below is a sample YAML configuration showing the most basic 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 sample configuration below. The
    metrics a fetched using the specified metricParameter. Find the list of metric parameters [below](#conviva-monitor-metric-parameters-and-metrics).
    The Conviva metrics reported to SignalFx 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` [here](https://community.conviva.com/site/global/apis_data/experience_insights_api/index.gsp#metrics).
    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`
    will be 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 sample configuration below 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 example above in order 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 SignalFx

    |Metric Parameters|Metrics|Description|
    |----------------|------|-----------|
    |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|

  metrics:
    conviva.attempts:
      description: Attempts time-series
      default: true
      type: gauge
      group: attempts
    conviva.avg_bitrate:
      description: Average bitrate time-series
      default: true
      type: gauge
      group: avg_bitrate
    conviva.concurrent_plays:
      description: Concurrent plays time-series
      default: true
      type: gauge
      group: concurrent_plays
    conviva.connection_induced_rebuffering_ratio:
      description: Connection induced rebuffering ratio simple-series
      default: true
      type: gauge
      group: connection_induced_rebuffering_ratio
    conviva.connection_induced_rebuffering_ratio_timeseries:
      description: Connection induced rebuffering ratio time-series
      default: true
      type: gauge
      group: connection_induced_rebuffering_ratio_timeseries
    conviva.duration_connection_induced_rebuffering_ratio_distribution:
      description: Duration vs. connection induced rebuffering ratio distribution label-series
      default: true
      type: gauge
      group: duration_connection_induced_rebuffering_ratio_distribution
    conviva.exits_before_video_start:
      description: Exits before video start time-series
      default: true
      type: gauge
      group: exits_before_video_start
    conviva.ended_plays:
      description: Ended plays simple-series
      default: true
      type: gauge
      group: ended_plays
    conviva.ended_plays_timeseries:
      description: Ended plays time-series
      default: true
      type: gauge
      group: ended_plays_timeseries
    conviva.plays:
      description: Plays time-series
      default: true
      type: gauge
      group: plays
    conviva.play_bitrate_distribution:
      description: Play bitrate distribution label-series
      default: true
      type: gauge
      group: play_bitrate_distribution
    conviva.play_buffering_ratio_distribution:
      description: Play buffering ratio distribution label-series
      default: true
      type: gauge
      group: play_buffering_ratio_distribution
    conviva.play_connection_induced_rebuffering_ratio_distribution:
      description: Play connection induced rebuffering ratio distribution label-series
      default: true
      type: gauge
      group: play_connection_induced_rebuffering_ratio_distribution
    conviva.quality_summary:
      description: Quality summary label-series
      default: true
      type: gauge
      group: quality_summary
    conviva.rebuffered_plays:
      description: Rebuffered plays time-series
      default: true
      type: gauge
      group: rebuffered_plays
    conviva.rebuffering_ratio:
      description: Rebuffering ratio time-series
      default: true
      type: gauge
      group: rebuffering_ratio
    conviva.top_assets_15_mins:
      description: Top assets over last 15 minutes simple-table
      default: true
      type: gauge
      group: top_assets_15_mins
    conviva.top_assets_summary:
      description: Top assets summary label-series
      default: true
      type: gauge
      group: top_assets_summary
    conviva.video_playback_failures:
      description: Video playback failures simple-series
      default: true
      type: gauge
      group: video_playback_failures
    conviva.video_playback_failures_timeseries:
      description: Video playback failures time-series
      default: true
      type: gauge
      group: video_playback_failures_timeseries
    conviva.video_playback_failures_distribution:
      description: Video playback failures distribution label-series
      default: true
      type: gauge
      group: video_playback_failures_distribution
    conviva.video_restart_time:
      description: Video restart time simple-series
      default: true
      type: gauge
      group: video_restart_time
    conviva.video_restart_time_timeseries:
      description: Video restart time time-series
      default: true
      type: gauge
      group: video_restart_time_timeseries
    conviva.video_restart_time_distribution:
      description: Video restart time distribution label-series
      default: true
      type: gauge
      group: video_restart_time_distribution
    conviva.video_start_failures:
      description: Video start failures time-series
      default: true
      type: gauge
      group: video_start_failures
    conviva.video_start_failures_errornames:
      description: Video start failures by error names simple-table
      default: true
      type: gauge
      group: video_start_failures_errornames
    conviva.video_startup_time:
      description: Video startup time label-series
      default: true
      type: gauge
    conviva.quality_metriclens.total_attempts:
      description: Attempts
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.video_start_failures_percent:
      description: Video Start Failures(VSF) (%)
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.exits_before_video_start_percent:
      description: Exits Before Video Starts (EBVS) (%)
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.plays_percent:
      description: Plays (%)
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.video_startup_time_sec:
      description: Video Startup Time (sec)
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.rebuffering_ratio_percent:
      description: Rebuffering Ratio (%)
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.average_bitrate_kbps:
      description: 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
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.video_playback_failures_percent:
      description: Video Playback Failures (%)
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.ended_plays:
      description: Ended Plays
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.connection_induced_rebuffering_ratio_percent:
      description: Connection Induced ReBuffering Ratio (%)
      default: true
      type: gauge
      group: quality_metriclens
    conviva.quality_metriclens.video_restart_time:
      description: Video Restart Time
      default: true
      type: gauge
      group: quality_metriclens
    conviva.audience_metriclens.concurrent_plays:
      description: Concurrent Plays
      default: true
      type: gauge
      group: audience_metriclens
    conviva.audience_metriclens.plays:
      description: Plays
      default: true
      type: gauge
      group: audience_metriclens
    conviva.audience_metriclens.ended_plays:
      description: Ended Plays
      default: true
      type: gauge
      group: audience_metriclens
  monitorType: conviva
  properties: