Breaking changes and known issues in Wowza Streaming Engine beta releases

This article describes breaking changes and known issues in the latest Wowza Streaming Engine™ media server software beta releases. Breaking changes listed here include information about how to address them. Known issues listed here include whether a fix or workaround is available or when a solution will be available. Check back often as this article is updated frequently as new developments occur.

Note:  See Latest beta releases for the latest beta releases and their release notes.

Breaking changes in beta releases


When updating to the latest Wowza Streaming Engine beta release, the following changes may break functionality if you don't take steps to address them.

Wowza Streaming Engine REST API backward compatibility

With Wowza Streaming Engine 4.8.6b and the upgrade to version 2.4.3 of the Restlet framework library due to security vulnerabilities in version 2.3.12, some REST API XML responses have changed and are not backward compatible. We've identified changes in the XML responses with the following GET requests:

For more detail, see the following lists of changes for each GET request.

http://[address]:8087/v2/servers/[serverName]/vhosts/[vhostName]/applications/[appName]/transcoder
/templates/[templateName]/encodes/[encodeName]

  • Renamed the Name property in the <TranscoderOverlayEncode> container element to OverlayName.
 
Wowza Streaming Engine 4.8.5 Wowza Streaming Engine 4.8.6b and later
<Overlays>
  <TranscoderOverlayEncode>
    <Name>WowzaLogo</Name>
    ...
  </TranscoderOverlayEncode>
</Overlays>
<Overlays>
  <TranscoderOverlayEncode>
    <OverlayName>WowzaLogo</OverlayName>
    ...
  </TranscoderOverlayEncode>
</Overlays>

http://[address]:8087/v2/servers/[serverName]/vhosts/[vhostName]/monitoring/current

  • Removed the vhostName property.
  • Changed the XML structure within the <ConnectionCount> container element to return descriptive properties rather than multiple entry container elements with string and long properties.
 
Wowza Streaming Engine 4.8.5 Wowza Streaming Engine 4.8.6b and later
<CurrentVHostStatistics serverName="_defaultServer_"> 
  <vhostName>_defaultVHost_</vhostName> 
  <Uptime>19</Uptime> 
  <BytesIn>0</BytesIn> 
  <BytesOut>0</BytesOut> 
  <TotalConnections>0</TotalConnections> 
  <ConnectionCount> 
    <entry> 
      <string>WEBM</string> 
      <long>0</long> 
    </entry> 
    <entry> 
      <string>DVRCHUNKS</string> 
      <long>0</long> 
    </entry>
    ...
  </ConnectionCount>
</CurrentVHostStatistics>
<CurrentVHostStatistics serverName="_defaultServer_">
  <Uptime>19</Uptime>
  <BytesIn>0</BytesIn>
  <BytesOut>0</BytesOut>
  <TotalConnections>0</TotalConnections>
  <ConnectionCount>
    <WEBM>0</WEBM>
    <DVRCHUNKS>0</DVRCHUNKS>
    <RTMP>0</RTMP>
    <MPEGDASH>0</MPEGDASH>
    <CUPERTINO>0</CUPERTINO>
    <SANJOSE>0</SANJOSE>
    <SMOOTH>0</SMOOTH>
    <RTP>0</RTP>
  </ConnectionCount>
</CurrentVHostStatistics>

http://[address]:8087/v2/servers/[serverName]/vhosts/[vhostName]/applications/[appName]/monitoring/historic

  • Changed the dateTime property to return the date and time rather than milliseconds.
  • Changed the XML structure of how data is returned.
  • Removed the actual entry data.
  • Removed extra Joda-Time properties, including the i and j properties within the <HistoricApplicationStatistics> container element.
Wowza Streaming Engine 4.8.5 Wowza Streaming Engine 4.8.6b and later
<HistoricApplicationStatistics serverName="_defaultServer_">
  ...
  <Entries>
    <entry>
      <string>actual</string>
      <list/>
    </entry>
    <entry>
      <string>average</string>
      <list>
        <com.wowza.wms.stats.entry.StatsEntryApplication serialization="custom">
          <com.wowza.wms.stats.entry.StatsEntry>
            <default>
              <data>
                <int>0</int>
                ...
              </data>
              <dateTime>
                <iMillis>1601398800000</iMillis>
                <iChronology class="org.joda.time.chrono.ISOChronology" reference="../../../../../com.wowza.wms.stats.entry.StatsEntryApplication/com.wowza.wms.stats.entry.StatsEntry/default/dateTime/iChronology"/>
              </dateTime>
            </default>
          </com.wowza.wms.stats.entry.StatsEntry>
        </com.wowza.wms.stats.entry.StatsEntryApplication>
        ...
      </list>
    </entry>
    ...
  </Entries>
</HistoricApplicationStatistics>
<HistoricApplicationStatistics serverName="_defaultServer_">
  <Entries>
    <average>
      <dateTime>2020-09-29T16:00:00</dateTime>
      <data>
        <data>0</data>
        ...
      </data>
    </average>
    ...
  </Entries>
</HistoricApplicationStatistics>

Logging configuration backward compatibility

With Wowza Streaming Engine 4.8.6b and the upgrade to Apache Log4j 2, the logging configuration has changed to use [install-dir]/conf/log4j2-config.xml. Existing logging configurations need to be moved to log4j2-config.xml. When updating to the latest beta release, properties from existing logging configurations in [install-dir]/conf/log4j.properties are copied to [install-dir]/conf/log4j.properties.bak.

To enable debug logging for all Wowza Streaming Engine log files, complete the following steps:

  1. Navigate to [install-dir]/conf/ and open log4j2-config.xml in a text editor.
  2. In the <Loggers> block, set <Root level> to debug, and set the level attribute for the stdout and serverAccess appenders to debug.
     
    <Loggers>
        <Root level="debug">
            <AppenderRef ref="stdout" level="debug"/>
            <AppenderRef ref="serverAccess" level="debug"/>
            <AppenderRef ref="serverError" level="warn"/>
            <!-- <AppenderRef ref="vhostAccess" level="info"/> -->
            <!-- <AppenderRef ref="vhostError" level="warn"/> -->
            <!-- <AppenderRef ref="applicationAccess" level="info"/> -->
            <!-- <AppenderRef ref="applicationError" level="warn"/> -->
        </Root>
    </Loggers>
    

To develop custom logging, update the run configuration for Eclipse or IntelliJ to point to the new logging configuration XML file:
-Dlog4j.configurationFile="$WMSCONFIG_HOME/conf/log4j2-config.xml"

Access log header information not added every start up

With Wowza Streaming Engine 4.8.6b and the upgrade to Apache Log4j 2, Wowza Streaming Engine no longer writes headers to the Access log file (wowzastreamingengine_access.log) every time the Wowza Streaming Engine server starts up. Wowza Streaming Engine now only adds the following header information to the beginning of new wowzastreamingengine_access.log files:

#Version: ...
#Start-Date: ...
#Software: ...
#Date: ...

Known issues in beta releases


The following issues may affect your deployment, management, and use of Wowza Streaming Engine beta releases. When available, workarounds and fixes for these issues are described.

Creating or editing Media Cache sources and stores does not work in Wowza Streaming Engine Manager

The Wowza Streaming Engine 4.8.6b beta release breaks the Wowza Streaming Engine Manager functionality for creating or editing Media Cache sources and stores.

Solution

There is no fix available at this time.

As a workaround, you can create Media Cache sources and stores using the Wowza Streaming Engine REST API or edit existing Media Cache sources and stores using Wowza Streaming Engine XML or the Wowza Streaming Engine REST API.

Windows installer does not start services after install

The Windows installer for Wowza Streaming Engine 4.8.7b does not start services upon completing the installation. Also, the Wowza Streaming Engine Manager service is incorrectly listed as "Wowza Streaming Engine Manager 4.8.7bb" in Services.

Solution

There is no fix available at this time.

As a workaround, you can start services manually by completing the following steps:

  1. Press WIN key + R, type services.msc in the Run dialog box, and then click OK.
     
  2. In the Services window, right-click Wowza Streaming Engine 4.8.7b and then click Start.
  3. To start Wowza Streaming Engine Manager as a service, in the Services window, right-click Wowza Streaming Engine Manager 4.8.7bb and then click Start.

See Start and stop Wowza Streaming Engine for more information.

Updating from Wowza Streaming Engine 4.8.0 or earlier does not include java.scripting module

With Wowza Streaming Engine 4.8.5, we added the java.scripting module to the custom version of OpenJDK Java SE JRE 9.0.4 installed with Wowza Streaming Engine. This module is not installed with earlier versions of Wowza Streaming Engine but is required for Wowza Streaming Engine 4.8.6b and later. The beta updaters do not add this module.

Solution

If you are updating to Wowza Streaming Engine 4.8.6b or 4.8.7b from Wowza Streaming Engine 4.8.0 or earlier, before you update, you will need to install the custom version of OpenJDK Java SE JRE 9.0.4 available from the the Downloads tab of My Account and then instruct Wowza Streaming Engine to use that version of Java according to the instructions in Manually install and troubleshoot Java on Wowza Streaming Engine.

More resources