prometheus_exporter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c30ea9a86408e636402bd2d12167b7a2da30970
-  data.tar.gz: 05657f39e1322fdc4f2c3886f16616dd21d0ce3c
+SHA256:
+  metadata.gz: 49c574a415d9c6c164b9e0671c6649928bbee2cb5645e52a43ef37b899d13bc3
+  data.tar.gz: 822b077292371a669291e69944c85d220dfda7c592711e5bc73e252e41b3ee84
 SHA512:
-  metadata.gz: 2b8c45beaac491fbc6673b3e9897ff0b91490ce34fdb68e4d393068056605696c300d757adc5869bd277e2d1facd0657156460cc09e9bbcbe5f3e8ac6ebdbdf0
-  data.tar.gz: efb69fc5380f233fb3564f782cfc8e2f978b4ca4fc78cba3d66ff96738b9c8804d213e980a8e9db63e833437353debddeab3251ecc515657c403ab013d82b6c9
+  metadata.gz: 14eb93a948c46817e889f95c0f9899c0046c667408710eac60a9f96b2693da35d8a0724b9d426e5b5f0882b31f498acfefe5944dce9895629c04dc32af0a3466
+  data.tar.gz: 4ed4f50b3ee95e527d0820cfbbf24f90a44bb51f0ecd652d7159a9a53d7731e1490f8bbd46e0090ca39d723cadbded57f0c2567afc93e7f9700839274e3ce6cd

data/README.md

@@ -116,7 +116,7 @@ gem 'prometheus_exporter'
 ```
 
 
-```
+```ruby
 # in an initializer
 
 unless Rails.env == "test"
@@ -129,7 +129,7 @@ end
 
 You may also be interested in per-process stats, this collects memory and GC stats
 
-```
+```ruby
 # in an initializer
 unless Rails.env == "test"
   require 'prometheus_exporter/instrumentation'
@@ -148,7 +148,7 @@ end
 
 Including Sidekiq metrics (how many jobs ran? how many failed? how long did they take?)
 
-```
+```ruby
 Sidekiq.configure_server do |config|
    config.server_middleware do |chain|
       require 'prometheus_exporter/instrumentation'
@@ -159,7 +159,7 @@ end
 
 It also comes with a DelayedJob plugin.
 
-```
+```ruby
 # in an initializer
 unless Rails.env == "test"
   require 'prometheus_exporter/instrumentation'
@@ -233,7 +233,7 @@ Custom type collectors are the ideal place to collect global metrics, such as us
 
 Out-of-the-box we try to keep the prometheus exporter as lean as possible, we do not load all the Rails dependencies so you will not have access to your models. You can always ensure it is loaded in your custom type collector with:
 
-```
+```ruby
 unless defined? Rails
   require File.expand_path("../../config/environment", __FILE__)
 end
@@ -241,7 +241,7 @@ end
 
 Then you can collect the metrics you need on demand:
 
-```
+```ruby
 def metrics
   user_count_gague = PrometheusExporter::Metric::Gauge.new('user_count', 'number of users in the app')
   user_count_gague.observe User.count
@@ -322,6 +322,31 @@ thing1 122
 thing2 12
 ```
 
+### Metrics default prefix / labels
+
+You can specify default prefix or labels for metrics, for example:
+
+```ruby
+# Specify prefix for metric names
+PrometheusExporter::Metric.base.default_prefix = "ruby"
+
+# Specify default labels for metrics
+PrometheusExporter::Metric.base.default_labels = { "hostname" => "app-server-01" }
+
+counter = PrometheusExporter::Metric::Counter.new("web_requests", "number of web requests")
+
+counter.observe(1, route: 'test/route')
+counter.observe
+```
+
+Will result in:
+
+```
+# HELP web_requests number of web requests
+# TYPE web_requests counter
+ruby_web_requests{hostname="app-server-01",route="test/route"} 1
+ruby_web_requests{hostname="app-server-01"} 1
+```
 
 ## Transport concerns
 

data/lib/prometheus_exporter/metric/base.rb

@@ -11,6 +11,14 @@ module PrometheusExporter::Metric
       @default_prefix.to_s
     end
 
+    def self.default_labels=(labels)
+      @default_labels = labels
+    end
+
+    def self.default_labels
+      @default_labels || {}
+    end
+
     attr_accessor :help, :name, :data
 
     def initialize(name, help)
@@ -46,6 +54,7 @@ module PrometheusExporter::Metric
     end
 
     def labels_text(labels)
+      labels = (labels || {}).merge(Base.default_labels)
       if labels && labels.length > 0
         s = labels.map do |key, value|
           "#{key}=\"#{value}\""

data/lib/prometheus_exporter/version.rb

@@ -1,3 +1,3 @@
 module PrometheusExporter
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Prometheus Exporter