Class: PrometheusExporter::Client
- Inherits:
-
Object
- Object
- PrometheusExporter::Client
- Defined in:
- lib/prometheus_exporter/client.rb
Direct Known Subclasses
Defined Under Namespace
Classes: RemoteMetric
Constant Summary collapse
- MAX_SOCKET_AGE =
25
- MAX_QUEUE_SIZE =
10_000
Class Method Summary collapse
Instance Method Summary collapse
- #custom_labels=(custom_labels) ⇒ Object
-
#initialize(host: 'localhost', port: PrometheusExporter::DEFAULT_PORT, max_queue_size: nil, thread_sleep: 0.5, json_serializer: nil, custom_labels: nil) ⇒ Client
constructor
A new instance of Client.
- #process_queue ⇒ Object
- #register(type, name, help) ⇒ Object
- #send(str) ⇒ Object
- #send_json(obj) ⇒ Object
- #stop(wait_timeout_seconds: 0) ⇒ Object
Constructor Details
#initialize(host: 'localhost', port: PrometheusExporter::DEFAULT_PORT, max_queue_size: nil, thread_sleep: 0.5, json_serializer: nil, custom_labels: nil) ⇒ Client
Returns a new instance of Client.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/prometheus_exporter/client.rb', line 54 def initialize(host: 'localhost', port: PrometheusExporter::DEFAULT_PORT, max_queue_size: nil, thread_sleep: 0.5, json_serializer: nil, custom_labels: nil) @metrics = [] @queue = Queue.new @socket = nil @socket_started = nil max_queue_size ||= MAX_QUEUE_SIZE max_queue_size = max_queue_size.to_i if max_queue_size.to_i <= 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 |
Class Method Details
.default ⇒ Object
43 44 45 |
# File 'lib/prometheus_exporter/client.rb', line 43 def self.default @default ||= new end |
.default=(client) ⇒ Object
47 48 49 |
# File 'lib/prometheus_exporter/client.rb', line 47 def self.default=(client) @default = client end |
Instance Method Details
#custom_labels=(custom_labels) ⇒ Object
80 81 82 |
# File 'lib/prometheus_exporter/client.rb', line 80 def custom_labels=(custom_labels) @custom_labels = custom_labels end |
#process_queue ⇒ Object
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/prometheus_exporter/client.rb', line 105 def process_queue while @queue.length > 0 ensure_socket! begin = @queue.pop @socket.write(.bytesize.to_s(16).upcase) @socket.write("\r\n") @socket.write() @socket.write("\r\n") rescue => e STDERR.puts "Prometheus Exporter is dropping a message: #{e}" @socket = nil raise end end end |
#register(type, name, help) ⇒ Object
84 85 86 87 88 |
# File 'lib/prometheus_exporter/client.rb', line 84 def register(type, name, help) metric = RemoteMetric.new(type: type, name: name, help: help, client: self) @metrics << metric metric end |
#send(str) ⇒ Object
95 96 97 98 99 100 101 102 103 |
# File 'lib/prometheus_exporter/client.rb', line 95 def send(str) @queue << str if @queue.length > @max_queue_size STDERR.puts "Prometheus Exporter client is dropping message cause queue is full" @queue.pop end ensure_worker_thread! end |
#send_json(obj) ⇒ Object
90 91 92 93 |
# File 'lib/prometheus_exporter/client.rb', line 90 def send_json(obj) payload = @custom_labels.nil? ? obj : obj.merge(custom_labels: @custom_labels) send(@json_serializer.dump(payload)) end |
#stop(wait_timeout_seconds: 0) ⇒ Object
123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/prometheus_exporter/client.rb', line 123 def stop(wait_timeout_seconds: 0) @mutex.synchronize do wait_for_empty_queue_with_timeout(wait_timeout_seconds) @worker_thread&.kill while @worker_thread&.alive? sleep 0.001 end @worker_thread = nil end close_socket! end |