Class MonitoringSettings

Used to define all of the settings used for monitoring.

Inheritance

object

MonitoringSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Phobos.Actor.Configuration

Assembly: Phobos.Actor.dll

Syntax

public sealed class MonitoringSettings

Constructors

MonitoringSettings(Config)

Creates a new MonitoringSettings instance.

Declaration

public MonitoringSettings(Config config)

Parameters

Type	Name	Description
Config	config	The phobos.monitoring section of a HOCON configuration.

MonitoringSettings(bool, bool, bool, bool)

Declaration

public MonitoringSettings(bool monitorAllUserActors, bool monitorAllSystemActors = false, bool monitorMailboxDepth = false, bool monitorEventStream = true)

Parameters

Type	Name	Description
bool	monitorAllUserActors
bool	monitorAllSystemActors
bool	monitorMailboxDepth
bool	monitorEventStream

Properties

MonitorAllSystemActors

When true, all /system actors will be monitored automatically.

Declaration

public bool MonitorAllSystemActors { get; }

Property Value

Type	Description
bool

MonitorAllUserActors

When true, all /user actors will be monitored automatically.

Declaration

public bool MonitorAllUserActors { get; }

Property Value

Type	Description
bool

MonitorEventStream

When true, allows Phobos to monitor the default messages that are published on the EventStream, such as log events and deadletters.

Declaration

public bool MonitorEventStream { get; }

Property Value

Type	Description
bool

MonitorMailboxDepth

When true, enables monitoring of the mailboxes of all actors who have monitoring enabled.

Declaration

public bool MonitorMailboxDepth { get; }

Property Value

Type	Description
bool

Methods

WithMonitorEventStream(bool)

Declaration

public MonitoringSettings WithMonitorEventStream(bool monitorEventStream)

Parameters

Type	Name	Description
bool	monitorEventStream

Returns

Type	Description
MonitoringSettings

WithMonitorMailboxDepth(bool)

Declaration

public MonitoringSettings WithMonitorMailboxDepth(bool monitorMailboxDepth)

Parameters

Type	Name	Description
bool	monitorMailboxDepth

Returns

Type	Description
MonitoringSettings

WithMonitorSystemActors(bool)

Declaration

public MonitoringSettings WithMonitorSystemActors(bool monitorSystemActors)

Parameters

Type	Name	Description
bool	monitorSystemActors

Returns

Type	Description
MonitoringSettings

WithMonitorUserActors(bool)

Declaration

public MonitoringSettings WithMonitorUserActors(bool monitorUserActors)

Parameters

Type	Name	Description
bool	monitorUserActors

Returns

Type	Description
MonitoringSettings