Inherited by Org.Apache.REEF.Common.Telemetry.Counters.
◆ GetCounters()
| IEnumerable<ICounter> Org.Apache.REEF.Common.Telemetry.ICounters.GetCounters |
( |
| ) |
|
Returns all the counters
- Returns
◆ Increment()
| void Org.Apache.REEF.Common.Telemetry.ICounters.Increment |
( |
string |
name, |
|
|
int |
number |
|
) |
| |
Increase the counter with the given number
- Parameters
-
| name | Name of the counter |
| number | number to increase |
◆ Serialize()
| string Org.Apache.REEF.Common.Telemetry.ICounters.Serialize |
( |
| ) |
|
Serialize the counter into a string
- Returns
- Returns serialized string of the counters.
◆ TryGetValue()
| bool Org.Apache.REEF.Common.Telemetry.ICounters.TryGetValue |
( |
string |
name, |
|
|
out ICounter |
counter |
|
) |
| |
Get counter value for a given counter name
- Parameters
-
| name | Name of the counter |
| counter | The counter object returned |
- Returns
- Returns a boolean to indicate if the value is found.
◆ TryRegisterCounter()
| bool Org.Apache.REEF.Common.Telemetry.ICounters.TryRegisterCounter |
( |
string |
name, |
|
|
string |
description |
|
) |
| |
Register a new counter with a specified name.
If name does not exist, the counter will be added and true will be returned Otherwise the counter will be not added and false will be returned.
- Parameters
-
| name | Name of the counter to be registered. |
| description | Description of the counter to be registered. |
- Returns
- Returns a boolean to indicate if the counter is added.
The documentation for this interface was generated from the following file:
