Class MonitoringSettings
Used to define all of the settings used for monitoring.
Inheritance
System.Object
MonitoringSettings
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Phobos.Actor.Configuration
Assembly: Phobos.Actor.dll
Syntax
public sealed class MonitoringSettingsConstructors
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(Boolean, Boolean, Boolean, Boolean)
Declaration
public MonitoringSettings(bool monitorAllUserActors, bool monitorAllSystemActors = false, bool monitorMailboxDepth = false, bool monitorEventStream = true)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | monitorAllUserActors | |
| System.Boolean | monitorAllSystemActors | |
| System.Boolean | monitorMailboxDepth | |
| System.Boolean | monitorEventStream |
Properties
MonitorAllSystemActors
When true, all /system actors will be monitored automatically.
Declaration
public bool MonitorAllSystemActors { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
MonitorAllUserActors
When true, all /user actors will be monitored automatically.
Declaration
public bool MonitorAllUserActors { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
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 |
|---|---|
| System.Boolean |
MonitorMailboxDepth
When true, enables monitoring of the mailboxes of all actors who
have monitoring enabled.
Declaration
public bool MonitorMailboxDepth { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
WithMonitorEventStream(Boolean)
Declaration
public MonitoringSettings WithMonitorEventStream(bool monitorEventStream)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | monitorEventStream |
Returns
| Type | Description |
|---|---|
| MonitoringSettings |
WithMonitorMailboxDepth(Boolean)
Declaration
public MonitoringSettings WithMonitorMailboxDepth(bool monitorMailboxDepth)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | monitorMailboxDepth |
Returns
| Type | Description |
|---|---|
| MonitoringSettings |
WithMonitorSystemActors(Boolean)
Declaration
public MonitoringSettings WithMonitorSystemActors(bool monitorSystemActors)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | monitorSystemActors |
Returns
| Type | Description |
|---|---|
| MonitoringSettings |
WithMonitorUserActors(Boolean)
Declaration
public MonitoringSettings WithMonitorUserActors(bool monitorUserActors)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | monitorUserActors |
Returns
| Type | Description |
|---|---|
| MonitoringSettings |