Installation

Requirements

  • Wowza Streaming Engine 4.9.6 or later

  • Java 21 (included with WSE 4.9.6+)

  • A valid Scout license key

Install steps

1. Copy the Scout JAR to the WSE library directory

Copy wse-raskenlund-scout.jar to the WSE lib directory:

sudo cp wse-raskenlund-scout.jar /usr/local/WowzaStreamingEngine/lib/

Set ownership to the WSE service account if required:

sudo chown wowza:wowza /usr/local/WowzaStreamingEngine/lib/wse-raskenlund-scout.jar

2. Register the module in Application.xml

Open the application’s configuration file at /usr/local/WowzaStreamingEngine/conf/<appName>/Application.xml and add Scout to the <Modules> section:

<Modules>
  <!-- existing modules ... -->
  <Module>
    <Name>ModuleCmsdMqa</Name>
    <Description>Scout CMSD-MQA Telemetry Module</Description>
    <Class>com.raskenlund.wse.scout.ModuleCmsdMqa</Class>
  </Module>
</Modules>

3. Add the license key and configuration properties

In the same Application.xml, add Scout properties to the <Properties> section. At minimum, the license key is required:

<Properties>
  <!-- existing properties ... -->

  <!-- Scout license (required) -->
  <Property>
    <Name>raskenlund.scout.license</Name>
    <Value>YOUR-LICENSE-KEY</Value>
    <Type>String</Type>
  </Property>

</Properties>

See Configuration for the full list of available properties and their defaults.

4. Restart the WSE application

Apply the changes by restarting the application. You can do this from the Wowza Streaming Engine Manager (Applications → select application → Restart), or restart the WSE service:

sudo systemctl restart WowzaStreamingEngine

Verifying the installation

After restart, check the WSE log at /usr/local/WowzaStreamingEngine/logs/wowzastreamingengine_access.log (or the application log) for the following messages:

ModuleCmsdMqa: starting
ModuleCmsdMqa: config loaded — CmsdMqaConfig{enabled=true, ...}
ModuleCmsdMqa: waiting for license validation
ModuleCmsdMqa: license valid, tier = STANDARD
PrometheusExporter: listening on port 9090/metrics

Once the license is validated, start an HLS or DASH stream. HTTP responses for that stream will carry CMSD-Static headers. If MQA scores are available, CMSD-Dynamic headers will appear on the same responses.