Implements: ICounters
Description
The NullCounters class allows you to create dummy performance counters.
Important points
- It can be used in testing or in situations when a counter is required but must be disabled.
Constructors
NewNullCounters
Creates a new instance of the counter.
NewNullCounters() *NullCounters
Methods
BeginTiming
Begins measurement of execution time interval. It returns *CounterTiming object which has to be called at CounterTiming.EndTiming to end the measurement and update the counter.
(c *NullCounters) BeginTiming(ctx context.Context, name string) *CounterTiming
- ctx: context.Context - operation context.
- name: string - counter name of Interval type.
- returns: *CounterTiming - callback object to end timing.
Increment
Increments counter by given value.
(c *NullCounters) Increment(ctx context.Context, name string, value float32)
- ctx: context.Context - operation context.
- name: string - counter name of Increment type.
- value: float32 - value to add to the counter.
IncrementOne
Increments counter by 1.
(c *NullCounters) IncrementOne(ctx context.Context, name string)
- ctx: context.Context - operation context.
- name: string - counter name of Increment type.
Last
Records the last calculated measurement value. Usually this method is used by metrics calculated externally.
(c *NullCounters) Last(ctx context.Context, name string, value float32)
- ctx: context.Context - operation context.
- name: string - counter name of Last type.
- value: float32 - last value to record.
Stats
Calculates min/average/max statistics based on the current and previous values.
(c *NullCounters) Stats(ctx context.Context, name string, value float32)
- ctx: context.Context - operation context.
- name: string - counter name of Statistics type
- value: float32 - value to update statistics
Timestamp
Records the given timestamp.
(c *NullCounters) Timestamp(ctx context.Context, name string, value time.Time)
- ctx: context.Context - operation context.
- name: string - counter name of Timestamp type.
- value: time.Time - timestamp to record.
TimestampNow
Records the current time as a timestamp.
(c *NullCounters) TimestampNow(ctx context.Context, name string)
- ctx: context.Context - operation context.
- name: string - counter name of Timestamp type.