Skip to content

Mos Debugger

The Mos Debugger is the troubleshooting screen for the MOS protocol. It shows, live, whether the MOS connections between Erizos Studio and your newsroom computer system (NCS) are up, and it lets you read every MOS message that passes between them - and send one yourself.

Where to Find It

Navigate to: Studio → Admin → Mos Debugger, or browse directly to http://[serverIP]:5550/admin/mos.

Note

If MOS is switched off, the page shows only MOS is disabled. Enable MOS and configure at least one newsroom under Settings → MOS first.

The connection matrix

At the top of the page is a grid with one column per MOS port type that Studio listens on - Lower and Upper - and one row per connection. The grid refreshes every two seconds.

  • Incoming MOS Ports - Studio's own listeners, one per port type. These accept connections from the NCS.
  • Connection to <NCS> - one row for every enabled newsroom, showing the connections Studio opens to that NCS. The row is named after the NCS ID from the MOS settings.

Each cell shows the state of one connection:

Icon Meaning
The port is listening, or the connection to the NCS is established.
The port is not listening, or the connection to the NCS is down.
The connection is still being attempted; the state is not known yet.
An error was reported for this connection. Hover the icon to read it.

On the Incoming MOS Ports row, a number in brackets after the icon is the number of clients currently connected to that port. Hover it to list their addresses.

Info

Studio only listens on the Lower and Upper ports. The Query port is used for outgoing requests only, so it never appears as an incoming port.

The message console

Below the matrix is the message list. Every MOS message logged while the page is open is added to the top of the list, with three columns:

  1. Time - the timestamp of the message, to the millisecond.
  2. Direction - Recieved or Sent.
  3. Message - the message title, for example Sent heartbeat or Recieved roReqAll.

Use the controls above the list to narrow it down:

  • Filter - type any text to keep only the messages whose title or XML contains it.
  • Received / Sent / All - show one direction, or both.
  • The icon in the Message column header clears the list.

From version 3.7 the Message column header also has a pause control:

  • Pause freezes the list so it stops scrolling. New messages are still collected, and a badge on the icon counts them. Click Resume to show them all.
  • While paused, shows the next waiting messages without resuming. The dropdown beside it sets how many it shows per click: x1, x5, x10, x15 or x50.

Click a message to open it in the viewer on the right. The viewer has two switches:

  • Raw / Pretty - Pretty reformats the XML with indentation; Raw shows the complete log entry as JSON instead.
  • Editor / Text - Editor uses the syntax-highlighting code editor, Text a plain text box.

Note

The console is fed by the live log stream, so it starts empty each time you open the page and only collects messages from that moment on. The message XML is streamed to this page whatever the Log Messages setting is; that setting decides whether the same messages are also written to the server log file. Set it to Raw in Settings → MOS to additionally get a hexadecimal dump of the raw data on the wire - those entries are titled Sending MOS Raw Data and Recieved MOS Raw Data.

Sending a MOS message

The + button next to the direction filter opens the Send a mos message window, where you can compose a message and send it to a newsroom.

  1. The editor is pre-filled with an empty <mos> element. When exactly one newsroom is enabled in the MOS settings, its <ncsID> and <mosID> are filled in for you; otherwise, type them yourself.
  2. Use the Common Requests dropdown in the window title to insert a ready-made body - heartbeat, reqMachInfo, roReqAll or roReq. The dropdown keeps whatever <ncsID>, <mosID>, <messageID> and <port> elements are already in the editor.
  3. Add a <port> element to choose the port the message goes out on: UPPER (the default if you leave it out) or LOWER.
  4. Click Send. Studio reports MOS message sent on success, and the reply is written to the browser console.

The message is rejected before it is sent if the XML does not parse (Invalid XML), if the root element is not <mos>, if there is no message body, or if <port> holds anything other than UPPER or LOWER. The reason is shown at the bottom of the window.

Warning

Messages sent from here are real MOS traffic and are handled by the newsroom system exactly as if Studio had generated them. Use it for diagnostics, not during a live show.