1. interface
  2. Hypervel
  3. \
  4. Horizon
  5. \
  6. Contracts
  7. \
  8. MetricsRepository

MetricsRepository

interface MetricsRepository

Methods

array
measuredJobs()

Get all of the class names that have metrics measurements.

array
measuredQueues()

Get all of the queues that have metrics measurements.

float
jobsProcessedPerMinute()

Get the jobs processed per minute since the last snapshot.

int
throughput()

Get the application's total throughput since the last snapshot.

int
throughputForJob(string $job)

Get the throughput for a given job.

int
throughputForQueue(string $queue)

Get the throughput for a given queue.

float
runtimeForJob(string $job)

Get the average runtime for a given job in milliseconds.

float
runtimeForQueue(string $queue)

Get the average runtime for a given queue in milliseconds.

string|null
queueWithMaximumRuntime()

Get the queue that has the longest runtime.

string|null
queueWithMaximumThroughput()

Get the queue that has the most throughput.

void
incrementJob(string $job, float|null $runtime)

Increment the metrics information for a job.

void
incrementQueue(string $queue, float|null $runtime)

Increment the metrics information for a queue.

array
snapshotsForJob(string $job)

Get all of the snapshots for the given job.

array
snapshotsForQueue(string $queue)

Get all of the snapshots for the given queue.

void
snapshot()

Store a snapshot of the metrics information.

bool
acquireWaitTimeMonitorLock()

Attempt to acquire a lock to monitor the queue wait times.

void
forget(string $key)

Clear the metrics for a key.

void
clear()

Delete all stored metrics information.

Details

at line 12
array measuredJobs()

Get all of the class names that have metrics measurements.

Return Value

array

at line 17
array measuredQueues()

Get all of the queues that have metrics measurements.

Return Value

array

at line 22
float jobsProcessedPerMinute()

Get the jobs processed per minute since the last snapshot.

Return Value

float

at line 27
int throughput()

Get the application's total throughput since the last snapshot.

Return Value

int

at line 32
int throughputForJob(string $job)

Get the throughput for a given job.

Parameters

string $job

Return Value

int

at line 37
int throughputForQueue(string $queue)

Get the throughput for a given queue.

Parameters

string $queue

Return Value

int

at line 42
float runtimeForJob(string $job)

Get the average runtime for a given job in milliseconds.

Parameters

string $job

Return Value

float

at line 47
float runtimeForQueue(string $queue)

Get the average runtime for a given queue in milliseconds.

Parameters

string $queue

Return Value

float

at line 52
string|null queueWithMaximumRuntime()

Get the queue that has the longest runtime.

Return Value

string|null

at line 57
string|null queueWithMaximumThroughput()

Get the queue that has the most throughput.

Return Value

string|null

at line 62
void incrementJob(string $job, float|null $runtime)

Increment the metrics information for a job.

Parameters

string $job
float|null $runtime

Return Value

void

at line 67
void incrementQueue(string $queue, float|null $runtime)

Increment the metrics information for a queue.

Parameters

string $queue
float|null $runtime

Return Value

void

at line 72
array snapshotsForJob(string $job)

Get all of the snapshots for the given job.

Parameters

string $job

Return Value

array

at line 77
array snapshotsForQueue(string $queue)

Get all of the snapshots for the given queue.

Parameters

string $queue

Return Value

array

at line 82
void snapshot()

Store a snapshot of the metrics information.

Return Value

void

at line 87
bool acquireWaitTimeMonitorLock()

Attempt to acquire a lock to monitor the queue wait times.

Return Value

bool

at line 92
void forget(string $key)

Clear the metrics for a key.

Parameters

string $key

Return Value

void

at line 97
void clear()

Delete all stored metrics information.

Return Value

void