Class: TingYun::Metrics::MetricSpec

Inherits:
Object
  • Object
show all
Defined in:
lib/ting_yun/metrics/metric_spec.rb

Constant Summary collapse

MAX_LENGTH =

the maximum length of a metric name or metric scope

255
LENGTH_RANGE = 
(0...MAX_LENGTH)
EMPTY_SCOPE = 
''.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metric_name = '', metric_scope = nil) ⇒ MetricSpec

Returns a new instance of MetricSpec.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 18

def initialize(metric_name='', metric_scope=nil)
  @full_name = metric_name.to_s
  if metric_name.to_s.length > MAX_LENGTH
    @name = metric_name.to_s[LENGTH_RANGE]
  else
    @name = metric_name.to_s
  end

  if metric_scope
    if metric_scope.to_s.length > MAX_LENGTH
      @scope = metric_scope.to_s[LENGTH_RANGE]
    else
      @scope = metric_scope.to_s
    end
  else
    @scope = EMPTY_SCOPE
  end
end

Instance Attribute Details

#full_name ⇒ Object

Returns the value of attribute full_name.



11
12
13
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 11

def full_name
  @full_name
end

#name ⇒ Object

Returns the value of attribute name.



11
12
13
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 11

def name
  @name
end

#scope ⇒ Object

Returns the value of attribute scope.



11
12
13
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 11

def scope
  @scope
end

Instance Method Details

#<=>(o) ⇒ Object 



80
81
82
83
84
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 80

def <=>(o)
  namecmp = self.name <=> o.name
  return namecmp if namecmp != 0
  return (self.scope || '') <=> (o.scope || '')
end

#==(o) ⇒ Object 



37
38
39
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 37

def ==(o)
  self.eql?(o)
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 41

def eql? o
  @name == o.name && @scope == o.scope
end

#hash ⇒ Object 



45
46
47
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 45

def hash
  @name.hash ^ @scope.hash
end

#inspect ⇒ Object 



71
72
73
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 71

def inspect
  "#<TingYun::Metrics::MetricSpec '#{name}':'#{scope}'>"
end

#sub(pattern, replacement, apply_to_scope = true) ⇒ Object

return a new metric spec if the given regex matches the name or scope.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 51

def sub(pattern, replacement, apply_to_scope = true)
  ::TingYun::Agent.logger.warn("The sub method on metric specs is deprecated") rescue nil
  return nil if name !~ pattern &&
      (!apply_to_scope || scope.nil? || scope !~ pattern)
  new_name = name.sub(pattern, replacement)[LENGTH_RANGE]

  if apply_to_scope
    new_scope = (scope && scope.sub(pattern, replacement)[LENGTH_RANGE])
  else
    new_scope = scope
  end

  self.class.new new_name, new_scope
end

#to_hash ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 86

def to_hash
  hash =  { 'name' => name }
  unless scope.empty?
    hash['parent'] = scope
  end

  return hash
end

#to_json(*a) ⇒ Object 



75
76
77
78
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 75

def to_json(*a)
  {'name' => name,
   'scope' => scope}.to_json(*a)
end

#to_s ⇒ Object 



66
67
68
69
 
# File 'lib/ting_yun/metrics/metric_spec.rb', line 66

def to_s
  return name if scope.empty?
  "#{name}:#{scope}"
end