Class: Hitimes::Metric

Inherits:
Object
  • Object
show all
Defined in:
lib/hitimes/metric.rb

Overview

Metric hold the common meta information for all derived metric classes

All metrics hold the meta information of:

  • The name of the metric

  • The time of day the first measurement is taken

  • The time of day the last measurement is taken

  • additional data

Each derived class is assumed to set the sampling_start_time and sampling_stop_time appropriately.

Metric itself should generally not be used. Only use the derived classes.

Direct Known Subclasses

TimedMetric, TimedValueMetric, ValueMetric

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Metric) initialize(name, additional_data = {})

:call-seq:

Metric.new( 'my_metric' ) -> Metric
Metric.new( 'my_metric', 'foo' => 'bar', 'this' => 42 ) -> Metric

Create a new ValueMetric giving it a name and additional data.

additional_data may be anything that follows the to_hash protocol. name may be anything that follows the to_s protocol.



44
45
46
47
48
49
50
51
# File 'lib/hitimes/metric.rb', line 44

def initialize( name, additional_data = {} )
  @sampling_start_time     = nil
  @sampling_start_interval = nil
  @sampling_delta          = 0

  @name                = name.to_s
  @additional_data     = additional_data.to_hash
end

Instance Attribute Details

- (Object) additional_data (readonly)

An additional hash of data to associate with the metric



29
30
31
# File 'lib/hitimes/metric.rb', line 29

def additional_data
  @additional_data
end

- (Object) name (readonly)

The 'name' to associate with the metric



32
33
34
# File 'lib/hitimes/metric.rb', line 32

def name
  @name
end

- (Object) sampling_delta (readonly)

the number of seconds as a float since the sampling_start_time



26
27
28
# File 'lib/hitimes/metric.rb', line 26

def sampling_delta
  @sampling_delta
end

Instance Method Details

- (Object) sampling_start_time

:call-seq:

metric.sampling_start_time -> Float or nil

The time at which the first sample was taken. This is the number of microseconds since UNIX epoch UTC as a Float

If the metric has not started measuring then the start time is nil.



62
63
64
65
66
67
68
# File 'lib/hitimes/metric.rb', line 62

def sampling_start_time
  if @sampling_start_interval then
    @sampling_start_time ||= self.utc_microseconds()
  else
    nil
  end
end

- (Object) sampling_stop_time

:call-seq:

metric.sampling_stop_time -> Float or nil

The time at which the last sample was taken This is the number of microseconds since UNIX epoch UTC as a Float

If the metric has not completely measured at least one thing then stop time is nil.

Because accessing the actual 'time of day' is an expesive operation, we only get the time of day at the beginning of the first measurement and we keep track of the offset from that point in @sampling_delta.

When sampling_stop_time is called, the actual time of day is caculated.



86
87
88
89
90
91
92
# File 'lib/hitimes/metric.rb', line 86

def sampling_stop_time
  if @sampling_delta > 0 then
    (self.sampling_start_time + (@sampling_delta * 1_000_000))
  else 
    nil
  end
end

- (Object) to_hash

:call-seq:

metric.to_hash -> Hash
metric.to_hash

Convert the metric to a Hash.



101
102
103
104
105
106
# File 'lib/hitimes/metric.rb', line 101

def to_hash
  { 'sampling_start_time' => self.sampling_start_time,
    'sampling_stop_time'  => self.sampling_stop_time,
    'additional_data'     => self.additional_data,
    'name'                => self.name }
end

- (Object) utc_microseconds

:call-seq:

metric.utc_microseconds -> Float

The current time in microseconds from the UNIX Epoch in the UTC



114
115
116
# File 'lib/hitimes/metric.rb', line 114

def utc_microseconds
  Time.now.gmtime.to_f * 1_000_000
end