HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityLog In

Monitoring mirror services

This topic describes how to monitor mirror services.

📘

Notes

This content applies to CMS versions 10 and 11.

You can install mirroring only on Episerver CMS 7.5 (through the Deployment Center). If you want mirroring with the latest Optimizely version, install a CMS 7.5 site with mirroring, and then upgrade to the latest CMS through NuGet because there is no NuGet package for mirroring functionality; it is installed as a separate service in a virtual directory on the server. An updated DLL is available in the EPiServer.CMS.Core NuGet package (packages/EPiServer.CMS.Core.9.0.0/tools/MirroringService/), which you must manually patch to support CMS 10.

Optimizely CMO and Optimizely Commerce do not support mirroring. Also, content mirroring is not supported in a cloud deployment such as Windows Azure Web Apps and Optimizely Digital Experience Platform (DXP).

Monitoring mirror jobs

The Monitoring Server monitors mirroring jobs. When you start a mirroring job, the Mirroring Source Server sends an event (MirroringStatusEventArgs) for the state changing of the mirroring job to the monitoring server. A subscriber can follow mirroring states from start to end.

Mirroring job states

Mirroring jobState
MirroringJobInitializedSent after a mirroring job is initialized.
MirroringPackageInitializedSent after a mirroring package is initialized (info about the package is also send).
TransferingSent during transferring of a mirroring package.
TransferredSent when the mirroring package is transferred.
MirroringPackageCompletedSent when the package was imported.
MirroringJobCompletedSent when the last package is imported and the entire mirroring job is finished.
ExportingErrorSent if an error occurs during export.
TransferingErrorSent if an error occurs during transfer.
ImportingErrorSent if an error occurs during import.

 MirroringStatusEventArgs

<tr">EventDescription

MirroringStatusEventArgsContains a GUID which is the mirroring job ID and a MirroringTransferData.
MirroringTransferDataContains MirroringInitializeData, MirroringPackageBody, MirroringPackageHeader and MirroringStatus.
MirroringInitializeDataContains Name, DestinationPageGuid, DestinationPath, DestinationRoot, LastExecution, NrOfFilesinPackage, NrOfPagesInPackages and so on.
MirroringPackageHeaderContains FileSize, TargetFilePath, SizeOfSentData, SizeOfReceiveData.
MirroringStatusContains MirroringState and StatusLog (contains information about Processing, Warning and Error).

Monitoring modes

Monitoring modeDescription
Offline MonitoringThe Mirroring Server by default logs states of a mirroring job as an XML file under *C:\MirroringMonitoringData*. The filename starts with a unique ID and timestamp. In the CTP version, this mode is always on; it cannot be configured. The XML file contains a list of MirroringStatusEventArgs.
Online MonitoringThe Monitoring server sends events to subscribers online.

Configuring monitoring

The Monitoring Server is based on Windows Communication Foundation (WCF) Duplex Communication channel and you can configure it in the config file. The Monitoring Server is integrated with the Mirroring Server 2.0 and the installation program configures it to use port 80 by default.

Monitoring server configuration

<service
      name="EPiServer.MirroringService.MirroringMonitoringService.MirroringMonitoringServer"
      behaviorConfiguration="DebugServiceBehaviour">
      <endpoint
        address="~/SitePath/MirroringMonitoringServer.svc"
        name=""
        binding="wsDualHttpBinding"
        bindingConfiguration="wsDualHttpBinding_MirroringMonitoringBinding"
        contract="EPiServer.MirroringService.MirroringMonitoring.IMirroringMonitoringEventSystem" />
    </service>

Monitoring client configuration

<client>
      <endpoint
        name=""
        address="~/SitePath/MirroringMonitoringServer.svc"
        binding="wsDualHttpBinding"
        contract="EPiServer.MirroringService.MirroringMonitoring.IMirroringMonitoringEventSystem" />
    </client>

Using the monitoring utility

A custom subscriber can use the MirroringMonitoringClient helper class and receive events through the MirroringTransferStatusEventHandler. You also can subscribe to a specific mirroring job through the Subscribe (GUID contextId) method, or for all mirroring jobs through the Subscribe() method.

Helper class code example

To subscribe against the monitoring server, create an instance of MirroringMonitoringClient endpointName in app.config.

MirroringMonitoringClient mom = new MirroringMonitoringClient(endPointName); //Client endPointName

To receive Mirroring events or to be notified from the Monitoring Server, the application has to add a handler to the MirroringTransferStatusEventHandler event.

mom.MirroringTransferStatusEventHandler += new MirroringStatusEventHandler(TransferEventCatcher);

Application example

Mirroring 2.0 ships with a simple example of the Monitoring WinForms application which lets you view both online and offline logs.


Did this page help you?