Class ServerLoadInfo

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Information about the workload on an adTempus instance.

[Serializable]
[DoNotPruneType]
public class ServerLoadInfo

Inheritance

object

ServerLoadInfo

Fields

AgentPriority

The priority setting for the Queue. Set to 0 if no priority has been specified.

public int AgentPriority

Field Value

int

AverageActiveJobCount

The number of executing jobs on the server averaged over a reporting period.

public int AverageActiveJobCount

Field Value

int

AverageCPUUsage

The average CPU utilization on the server, rounded to the nearest percent.

public int AverageCPUUsage

Field Value

int

AverageInactiveJobCount

The number of inactive jobs (waiting for conditions, etc.) averaged over a reporting period.

public int AverageInactiveJobCount

Field Value

int

AverageMemoryInUse

The average amount of memory (in bytes) in use over the reporting period.

public long AverageMemoryInUse

Field Value

long

AveragePendingJobCount

The number of jobs queued for execution averaged over a reporting period.

public int AveragePendingJobCount

Field Value

int

CurrentActiveJobCount

The number of executing jobs on the server.

public int CurrentActiveJobCount

Field Value

int

CurrentInactiveJobCount

The number of inactive jobs (waiting for conditions, etc.).

public int CurrentInactiveJobCount

Field Value

int

CurrentPendingJobCount

The number of jobs queued for execution.

public int CurrentPendingJobCount

Field Value

int

QueueInfo

Information about each ExecutionQueue on the server.

public List<QueueLoadInfo> QueueInfo

Field Value

List<QueueLoadInfo>

ReportingPeriodLength

The number of seconds since the last snapshot.

public int ReportingPeriodLength

Field Value

int

ServerID

The MachineID or AgentOID of the source.

public Guid ServerID

Field Value

Guid

Remarks

This value is set to Server.MachineID on creation. When a ServerLoadInfo is received from an Agent, the ServerID is replaced with the AgentOID of the connection.

ServerName

The user-friendly name of the server or agent.

public string ServerName

Field Value

string

SnapshotTimestampUTC

The date/time (in UTC) at which the snapshot was taken.

public DateTime SnapshotTimestampUTC

Field Value

DateTime

TotalMemory

The total amount of memory on the server (in bytes).

public long TotalMemory

Field Value

long

adTempusCPUUsage

The average CPU utilization of the adTempus service, rounded to the nearest percent.

public int adTempusCPUUsage

Field Value

int

Methods

GetQueueInfo(Guid)

Gets QueueLoadInfo for the specified queue.

public QueueLoadInfo GetQueueInfo(Guid queueOID)

Parameters

Name	Type	Description
queueOID	Guid

Returns

QueueLoadInfo

QueueLoadInfo for the queue with the specified OID, or null if no info exists for that queue.

GetStats()

Gets a string showing a shorthand report of current metrics

public string GetStats()

Returns

string

SetQueueInfo(List<QueueLoadInfo>)

Passes in information about the Queues on the server and updates server totals for job counts.

public void SetQueueInfo(List<QueueLoadInfo> source)

Parameters

Name	Type	Description
source	List<QueueLoadInfo>

Remarks

This method sums up the job counts for all the queues into the server-level counts.