Class: Fluent::Plugin::Prometheus::Metric

Inherits:
Object
  • Object
show all
Defined in:
lib/fluent/plugin/prometheus.rb

Direct Known Subclasses

Counter, Gauge, Histogram, Summary

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(element, registry, labels) ⇒ Metric

Returns a new instance of Metric.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/fluent/plugin/prometheus.rb', line 155

def initialize(element, registry, labels)
  ['name', 'desc'].each do |key|
    if element[key].nil?
      raise ConfigError, "metric requires '#{key}' option"
    end
  end
  @type = element['type']
  @name = element['name']
  @key = element['key']
  @desc = element['desc']

  @base_labels = Fluent::Plugin::Prometheus.parse_labels_elements(element)
  @base_labels = labels.merge(@base_labels)
end

Instance Attribute Details

#desc ⇒ Object (readonly)

Returns the value of attribute desc.



153
154
155
 
# File 'lib/fluent/plugin/prometheus.rb', line 153

def desc
  @desc
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



152
153
154
 
# File 'lib/fluent/plugin/prometheus.rb', line 152

def key
  @key
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



151
152
153
 
# File 'lib/fluent/plugin/prometheus.rb', line 151

def name
  @name
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



150
151
152
 
# File 'lib/fluent/plugin/prometheus.rb', line 150

def type
  @type
end

Class Method Details

.get(registry, name, type, docstring) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/fluent/plugin/prometheus.rb', line 182

def self.get(registry, name, type, docstring)
  metric = registry.get(name)

  # should have same type, docstring
  if metric.type != type
    raise AlreadyRegisteredError, "#{name} has already been registered as #{type} type"
  end
  if metric.docstring != docstring
    raise AlreadyRegisteredError, "#{name} has already been registered with different docstring"
  end

  metric
end

Instance Method Details

#labels(record, expander) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/fluent/plugin/prometheus.rb', line 170

def labels(record, expander)
  label = {}
  @base_labels.each do |k, v|
    if v.is_a?(String)
      label[k] = expander.expand(v)
    else
      label[k] = v.call(record)
    end
  end
  label
end