Configuring Episerver Live Monitor

This topic describes how to configure the Episerver Live Monitor add-on. You can customize the themes and animations.

Note: Each time you install a new version of Live Monitor to click the Settings button in the Live Monitor user interface settings > Reset Settings button to get the latest setting​s of the new version.​​

Requirements

  • Installation of Episerver CMS 7.5 and higher
  • Installation of Microsoft .NET Framework 4.5.1
  • SignalR 2.0.3 setup for the add-on to work on the website, see Configuring SignalR.
  • Enable WebSocket support for IIS​8 on Windows 8/Windows 2012. SignalR supports long-polling and WebSocket for message transportation. Using WebSocket is more efficient for ​network utilization if you have IIS 8 (and higher) on Windows 8 /Windows 2012 (and higher), see Using WebSocket in .NET 4.5.
  • Ensure that your "master page" (_root.cshtml) has @Html.RequiredClientResources("Header") before the </head> tag, and @Html.RequiredClientResources("Footer") before the </body> tag.

Changing the configuration settings

Configuration is done in LiveMonitor.config.

You can change the following configuration settings:

  • ​​pushInterval. The time interval (in seconds) for collec​​ting visits before sending to the dashboard. When server detects a visit of a visitor to a page, server will start to collect all visits in pushInterval amount of time and then pushes to the dashboard. The default value is set to 0.5 seconds, which is a suitable setting for normal traffic and visits are shown in the dashboard almost immediately. In case the traffic is high and/or there are a lot of visitors visiting t​he site, you can change to a higher value to prevent the dashboard from overloading.
  • visitorActiveEntryTimeout. The time amount in minutes from the last activity of a visitor when the visitor is considered online. Default is 2 minutes.
  • visitorHistoryEntryTimeout . The time amount in minutes from the last activity of a visitor when the visitor are not considered online but still in the history list. This should be set to the Session.Timeout of .NET for correct behavior. Default is 5 minutes.
  • collectingTransferTimeWindow. The time amount in hours for collecting transfers to show statistics data about transfers (From Page/To Page/Global). Default is 24 hours.
  • themes. The collection of implemented themes that can be chosen from the user interface settings. A theme can be selected from the Live Monitor user interface settings.
    • defaultTheme. The name of the default theme for the first time loading the Live Monitor board. Default is FlatLight.
  • realtimeTransport​.​
    • signalRUrl. The default route URL, which visitors will use to connect to your hub. In most cases the default SignalR will work on “wwwroot/signalr”. However, if it already exists a folder wwwroot/signalr used by another app, a conflict will cause the default SignalR not to work. In that case, you can change the base URL by writing your own custom OWINStartup class. In that class, you must call the class app.MapSignalR("/EXAMPLEPATH", new HubConfiguration()). When you have this class, change EXAMPLEPATH to the path you want the custom startup class (the new default path of signalR) to point to in your configuration. The OWINStartup class can be written in any DLL of the website. For more information, refer to the Microsoft article about OWINStartup class.
  • monitoringTarget. The root where you to start monitoring from. Most often Live Monitor is set up with the start page on the website as root, but any page can be used as root.
    • contentId. Where you define the ID of content to start monitoring from. Example: 10 or 123456__CatalogContent. Default is 1.

Last updated: Dec 01, 2014