twingly-metrics 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 645a000c596946e7ec3ac3ace454267fc2d55784eb757f4357a26beaaf165fef
-  data.tar.gz: edf608261027d9dee342a10cd473c2e04d621b1d189db93c24c27bac1159ae9f
+  metadata.gz: db46b25f0b710bb60e8b504902a79718e2828b067badaeb9690f90516f4e6324
+  data.tar.gz: 99b630dbcbb6da1830cd2b7605f89dcaef1fcf0d95108370bad2c651aa9249bc
 SHA512:
-  metadata.gz: 979af04631cb1cc9e2697db8471119b4dcef5bb3d769aa96c4ce6aa9e35f08e7a9bcda6913b41aca8841751c0cb650df0e985aa2931ea136f0309c077d58006c
-  data.tar.gz: da7fd09eff4fee2554bbeb2d78016f8bec47ac01833d834f6a2c6f97cf2a72d89668b23d776f1d44535ab96e1b666a2961f2257377beb022f078d2e01f1669d6
+  metadata.gz: 31463227adeae2852358eea87082bc69cdc7692cece9935c13bccb68f6ce19f87470f0d75bd330e2d4b7eecc2e9f86b3138d9e10e3fb1b9fdafd173ce45af8ff
+  data.tar.gz: 2d557c902b80cb79a78b1a64c35191eb4261919e66d9f5f4faef84cf24b9a684b9e3becbde33cc7f00d8894d97c4265e9a4cd11b2799f8d0e52a05a000462cc8

data/README.md

@@ -4,7 +4,7 @@
 
 A gem for collecting and reporting metrics from our Ruby applications.
 
-This gem currently relies on the [`metriks` gem][metriks] for collecting metrics. The reason for this is that we're already using that gem in our projects. What the `twingly-metrics` gem currently adds in functionality, is the ability to report metrics to [Grafana cloud][grafana-cloud], using their [Graphite HTTP API][grafana-cloud-graphite-api].
+This gem currently relies on the [`metriks` gem][metriks] for collecting metrics. The reason for this is that we're already using that gem in our projects. What the `twingly-metrics` gem currently adds in functionality, is the ability to report metrics to [Grafana cloud][grafana-cloud], using their [Graphite HTTP API][grafana-cloud-graphite-api], along with some convenience methods for working with metrics.
 
 The code here was inspired by the reporter in the [`metriks-librato_metrics` gem][metriks-librato_metrics].
 
@@ -50,7 +50,7 @@ reporter = Twingly::Metrics::GrafanaCloudReporter.new(
 reporter.start # Starts the reporter thread in the background
 
 # Create some metrics for the reporter to have something to report
-Metriks.meter("test.meter").mark(1)
+Twingly::Metrics.meter("test.meter").mark(1)
 
 at_exit do
   reporter.flush # Ensure all unreported metrics are sent before exiting
@@ -71,10 +71,20 @@ GRAFANA_METRICS_TOKEN=
 
 The reporter currently supports the following metric types from the `metriks` gem:
 
-* [`Metriks.counter`](https://github.com/eric/metriks?tab=readme-ov-file#counters)
-* [`Metriks.gauge`](https://github.com/eric/metriks?tab=readme-ov-file#gauges)
-* [`Metriks.meter`](https://github.com/eric/metriks?tab=readme-ov-file#meters)
-* [`Metriks.timer`](https://github.com/eric/metriks?tab=readme-ov-file#timers)
+* `Twingly::Metrics.counter` - See [`Metriks.counter`](https://github.com/eric/metriks?tab=readme-ov-file#counters)
+* `Twingly::Metrics.gauge` - See [`Metriks.gauge`](https://github.com/eric/metriks?tab=readme-ov-file#gauges)
+* `Twingly::Metrics.meter` - See [`Metriks.meter`](https://github.com/eric/metriks?tab=readme-ov-file#meters)
+* `Twingly::Metrics.timer` - See [`Metriks.timer`](https://github.com/eric/metriks?tab=readme-ov-file#timers)
+
+Helper methods are also provided for some common use cases:
+
+```ruby
+# Equivalent to Twingly::Metrics.meter("my_meter").mark(1)
+Twingly::Metrics.mark("my_meter", 1)
+
+# Equivalent to Twingly::Metrics.timer("my_timer").time { ... }
+Twingly::Metrics.time("my_timer") { ... }
+```
 
 [metriks]: https://github.com/eric/metriks
 [grafana-cloud]: https://grafana.com/products/cloud/

data/lib/twingly/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module Twingly
   module Metrics
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/twingly/metrics.rb

@@ -1,4 +1,36 @@
 # frozen_string_literal: true
 
+require "metriks"
+
 require_relative "metrics/version"
 require_relative "metrics/grafana_cloud_reporter"
+
+module Twingly
+  module Metrics
+    def self.counter(name)
+      Metriks.counter(name)
+    end
+
+    def self.gauge(name, callable = nil, &block)
+      Metriks.gauge(name, callable, &block)
+    end
+
+    def self.timer(name)
+      Metriks.timer(name)
+    end
+
+    def self.meter(name)
+      Metriks.meter(name)
+    end
+
+    def self.mark(name, val = 1)
+      meter(name).mark(val)
+    end
+
+    def self.time(name, duration = nil, &block)
+      return timer(name).update(duration) if duration
+
+      timer(name).time(&block)
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: twingly-metrics
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Twingly AB
 bindir: bin
 cert_chain: []
-date: 2025-07-28 00:00:00.000000000 Z
+date: 2025-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks