Class: PrometheusExporter::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/prometheus_exporter/client.rb

Direct Known Subclasses

LocalClient

Defined Under Namespace

Classes: RemoteMetric

Constant Summary collapse

MAX_SOCKET_AGE = 
25
MAX_QUEUE_SIZE = 
10_000

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host: ENV.fetch("PROMETHEUS_EXPORTER_HOST", "localhost"), port: ENV.fetch( "PROMETHEUS_EXPORTER_PORT", PrometheusExporter::DEFAULT_PORT ), max_queue_size: nil, thread_sleep: 0.5, json_serializer: nil, custom_labels: nil, logger: Logger.new(STDERR), log_level: Logger::WARN) ⇒ Client

Returns a new instance of Client.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/prometheus_exporter/client.rb', line 60

def initialize(
  host: ENV.fetch("PROMETHEUS_EXPORTER_HOST", "localhost"),
  port: ENV.fetch(
    "PROMETHEUS_EXPORTER_PORT",
    PrometheusExporter::DEFAULT_PORT
  ),
  max_queue_size: nil,
  thread_sleep: 0.5,
  json_serializer: nil,
  custom_labels: nil,
  logger: Logger.new(STDERR),
  log_level: Logger::WARN
)
  @logger = logger
  @logger.level = log_level
  @metrics = []

  @queue = Queue.new

  @socket = nil
  @socket_started = nil
  @socket_pid = nil

  max_queue_size ||= MAX_QUEUE_SIZE
  max_queue_size = max_queue_size.to_i

  if max_queue_size <= 0
    raise ArgumentError, "max_queue_size must be larger than 0"
  end

  @max_queue_size = max_queue_size
  @host = host
  @port = port
  @worker_thread = nil
  @mutex = Mutex.new
  @thread_sleep = thread_sleep

  @json_serializer =
    json_serializer == :oj ? PrometheusExporter::OjCompat : JSON

  @custom_labels = custom_labels
end

Instance Attribute Details

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



58
59
60
 
# File 'lib/prometheus_exporter/client.rb', line 58

def logger
  @logger
end

Class Method Details

.default ⇒ Object 



47
48
49
 
# File 'lib/prometheus_exporter/client.rb', line 47

def self.default
  @default ||= new
end

.default=(client) ⇒ Object 



51
52
53
 
# File 'lib/prometheus_exporter/client.rb', line 51

def self.default=(client)
  @default = client
end

Instance Method Details

#custom_labels=(custom_labels) ⇒ Object 



103
104
105
 
# File 'lib/prometheus_exporter/client.rb', line 103

def custom_labels=(custom_labels)
  @custom_labels = custom_labels
end

#find_registered_metric(name, type: nil, help: nil) ⇒ Object 



120
121
122
123
124
125
126
127
128
 
# File 'lib/prometheus_exporter/client.rb', line 120

def find_registered_metric(name, type: nil, help: nil)
  @metrics.find do |metric|
    type_match = type ? metric.type == type : true
    help_match = help ? metric.help == help : true
    name_match = metric.name == name

    type_match && help_match && name_match
  end
end

#process_queue ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/prometheus_exporter/client.rb', line 154

def process_queue
  while @queue.length > 0
    ensure_socket!

    begin
      message = @queue.pop
      @socket.write(message.bytesize.to_s(16).upcase)
      @socket.write("\r\n")
      @socket.write(message)
      @socket.write("\r\n")
    rescue => e
      logger.warn "Prometheus Exporter is dropping a message: #{e}"
      @socket = nil
      raise
    end
  end
end

#register(type, name, help, opts = nil) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/prometheus_exporter/client.rb', line 107

def register(type, name, help, opts = nil)
  metric =
    RemoteMetric.new(
      type: type,
      name: name,
      help: help,
      client: self,
      opts: opts
    )
  @metrics << metric
  metric
end

#send(str) ⇒ Object 



144
145
146
147
148
149
150
151
152
 
# File 'lib/prometheus_exporter/client.rb', line 144

def send(str)
  @queue << str
  if @queue.length > @max_queue_size
    logger.warn "Prometheus Exporter client is dropping message cause queue is full"
    @queue.pop
  end

  ensure_worker_thread!
end

#send_json(obj) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/prometheus_exporter/client.rb', line 130

def send_json(obj)
  payload =
    if @custom_labels
      if obj[:custom_labels]
        obj.merge(custom_labels: @custom_labels.merge(obj[:custom_labels]))
      else
        obj.merge(custom_labels: @custom_labels)
      end
    else
      obj
    end
  send(@json_serializer.dump(payload))
end

#stop(wait_timeout_seconds: 0) ⇒ Object 



172
173
174
175
176
177
178
179
180
 
# File 'lib/prometheus_exporter/client.rb', line 172

def stop(wait_timeout_seconds: 0)
  @mutex.synchronize do
    wait_for_empty_queue_with_timeout(wait_timeout_seconds)
    @worker_thread&.kill
    sleep 0.001 while @worker_thread&.alive?
    @worker_thread = nil
    close_socket!
  end
end