watchfor 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30416669c4f7bb2b6361e750e035cd588c36911d9a1dea6d4805dd82c90edc0d
-  data.tar.gz: fbca77d7ef766ebf9b8579a3247935919bc877e966f1fed665d09d79f5437124
+  metadata.gz: b3d7fc66146ff02aa81bb3517188f14d8ce8c04b9b643b869aba9793610560b6
+  data.tar.gz: 19c2c8f08062072d54a90fe7d848b30ae24b5997a6179ba3aac6ddd5e31008be
 SHA512:
-  metadata.gz: c9a3425976be45501efba88d5d777552ad53230ce6db50b30f6e91c26da3d06003b1e6ba3ef0b518350782dc9b0e55a82e17b6368a6fe23d13cdafe3377df53b
-  data.tar.gz: 87e6389322c82c4cbb9b79ec25a808a9db0c0c4c9e8c4cccd26bd9ad58dc812d2ade6210a3ecd705c418b3d4b9d0c9dc4142198f7608f2b047f2817530ae8347
+  metadata.gz: c53ae17ddbc628f745c8099df3d1425627c1da778e616fd2a4cfc8bfca0680b56ff188881383d8f1f6cc10b68f42f53264b1cbc3ebf5f33cc4f8fb069045a703
+  data.tar.gz: b2214618bce3e48a10c5c8bbac5c4ee60f79281445472bde3fe225e82606297b21c7e087d12da41f68a0e20c15d8e6863846608165064add64511a8562940dd2

data/README.md

@@ -90,6 +90,14 @@ Namespaces: `wf.monitors`, `wf.alert_rules`, `wf.incidents`,
 `wf.incident_stats(period)`, `wf.notifications`, `wf.activity`. Errors raise
 `Watchfor::Error` with `#status`, `#code`, `#message`.
 
+## Prometheus metrics (Pro plan and above)
+
+```ruby
+text = wf.metrics(tag: "production") # Prometheus text format
+```
+
+Usually you point Prometheus at `https://watchfor.io/api/v1/metrics` directly; this is for scripts and one-off checks. See https://watchfor.io/docs/api/prometheus.
+
 ## CLI
 
 ```bash

data/exe/watchfor

@@ -36,8 +36,13 @@ begin
       cursor = args.include?("--cursor") ? args[args.index("--cursor") + 1] : nil
       wf.monitors.checks(monitor_id, cursor: cursor)
     when "report" then wf.report(period: args.include?("--period") ? args[args.index("--period") + 1] : nil)
+    when "metrics"
+      tag = args.include?("--tag") ? args[args.index("--tag") + 1] : nil
+      type = args.include?("--type") ? args[args.index("--type") + 1] : nil
+      print wf.metrics(tag: tag, type: type)
+      exit 0
     else
-      warn "Usage: watchfor [summary|plan|monitors|locations|monitor-types|incidents|checks <monitor_id> [--cursor c]|report [--period 7d|30d]]"
+      warn "Usage: watchfor [summary|plan|monitors|locations|monitor-types|incidents|checks <monitor_id> [--cursor c]|report [--period 7d|30d]|metrics [--tag t] [--type t]]"
       exit 2
     end
   puts JSON.pretty_generate(result)

data/lib/watchfor/client.rb

@@ -51,7 +51,7 @@ module Watchfor
     end
 
     # Core request. +query+ and +body+ are optional hashes.
-    def request(method, path, query: nil, body: nil, idempotency_key: nil)
+    def request(method, path, query: nil, body: nil, idempotency_key: nil, text: false)
       uri = URI("#{@base_url}#{path}")
       unless query.nil? || query.empty?
         cleaned = query.reject { |_, v| v.nil? || v == "" }
@@ -65,7 +65,7 @@ module Watchfor
       }.fetch(method)
       req = klass.new(uri)
       req["Authorization"] = "Bearer #{@api_key}"
-      req["Accept"] = "application/json"
+      req["Accept"] = text ? "text/plain, application/json" : "application/json"
       req["User-Agent"] = "watchfor-ruby/#{Watchfor::VERSION}"
       req["Idempotency-Key"] = idempotency_key if idempotency_key
       unless body.nil?
@@ -80,6 +80,8 @@ module Watchfor
       end
 
       raw = res.body.to_s
+      return raw if text && res.code.to_i.between?(200, 299)
+
       parsed = raw.empty? ? nil : (JSON.parse(raw) rescue nil)
       unless res.code.to_i.between?(200, 299)
         err = parsed.is_a?(Hash) ? (parsed["error"] || {}) : {}
@@ -92,6 +94,14 @@ module Watchfor
     # Top-level reads
     def me = request("GET", "/me")
     def summary = request("GET", "/summary")
+
+    # The organization in Prometheus text format (Pro plan and above):
+    # status, uptime, response times, expiry, heartbeats, hosts. Cached 60 s.
+    def metrics(tag: nil, type: nil, monitor_id: nil, include_hosts: nil)
+      query = { tag: tag, type: type, monitor_id: monitor_id,
+                include_hosts: include_hosts.nil? ? nil : include_hosts.to_s }
+      request("GET", "/metrics", query: query, text: true)
+    end
     def plan = request("GET", "/plan")
     def incident_stats(period = nil) = request("GET", "/incidents/stats", query: { period: period })
 

data/lib/watchfor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Watchfor
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watchfor
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - WatchFor