fluent-plugin-prometheus 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2697668d79174be33f93db6777808ba2e4b6e856
-  data.tar.gz: 9a842e147273f306bd2b7d18fbf6f2ca35ba3de9
+  metadata.gz: 5dbca01329f7efc77c5fa44288e017857e3c5a3a
+  data.tar.gz: a5e6e68b51cd13af4ba048f070b69b92e831bf89
 SHA512:
-  metadata.gz: f25473b6467b07dcc4e25ca95696abb22aa2c1bafaf44707ba07bae3ae5d0f3bf89c6cbe62dc57858630bfcab9e2bf85b13d3d7f0423e9ed8dbd504bca33ed1e
-  data.tar.gz: 90a812f445c0b53189119ffe6e62d7eba8541528ace398c1caaebcf991c961ffa063ae440d338614559f436a0a619a9e1ac994f5270bcea0cfed74b3069398ed
+  metadata.gz: cb2b9a310bdb2f74a8bfd3f6fdde9379f75cefcb98a36c32083ddf97019a6bf0efccb7592d9c62af7fd4bdf55261407573e984775ee432f393d83612f25a8464
+  data.tar.gz: 6033c960888b9989fbebced596a949c9333595a9df6376a24fee8c91723c898dbe365693d62c9b179e86e08a04551a722b3c6c08626560aa3197656f34f144c8

data/README.md

@@ -217,6 +217,30 @@ If key is empty, the metric values is treated as 1, so the counter increments by
 - `key`: key name of record for instrumentation (required)
 - `<labels>`: additional labels for this metric (optional). See [Labels](#Labels)
 
+### histogram type
+
+```
+<metric>
+  name message_foo
+  type histogram
+  desc The histogram of foo in message.
+  key foo
+  buckets 0.1, 1, 5, 10
+  <labels>
+    tag ${tag}
+    host ${hostname}
+    foo bar
+  </labels>
+</metric>
+```
+
+- `name`: metric name (required)
+- `type`: metric type (required)
+- `desc`: description of metric (required)
+- `key`: key name of record for instrumentation (required)
+- `buckets`: buckets of record for instrumentation (optional)
+- `<labels>`: additional labels for this metric (optional). See [Labels](#Labels)
+
 ## Labels
 
 See [Prometheus Data Model](http://prometheus.io/docs/concepts/data_model/) first.
@@ -280,7 +304,7 @@ In this case, `message_foo_counter` has `tag`, `hostname`, `key` and `data_type`
 
 ## Try plugin with nginx
 
-Checkout respotiroy and setup it.
+Checkout repository and setup.
 
 ```
 $ git clone git://github.com/kazegusuri/fluent-plugin-prometheus
@@ -291,8 +315,8 @@ $ bundle install --path vendor/bundle
 Download pre-compiled prometheus binary and start it. It listens on 9090.
 
 ```
-$ wget https://github.com/prometheus/prometheus/releases/download/0.16.1/prometheus-0.16.1.linux-amd64.tar.gz -O - | tar zxf -
-$ ./prometheus-0.16.1.linux-amd64/prometheus -config.file=./misc/prometheus.yaml -storage.local.path=./prometheus/metrics
+$ wget https://github.com/prometheus/prometheus/releases/download/v1.0.1/prometheus-1.0.1.linux-amd64.tar.gz -O - | tar zxf -
+$ ./prometheus-1.0.1.linux-amd64/prometheus -config.file=./misc/prometheus.yaml -storage.local.path=./prometheus/metrics
 ```
 
 Install Nginx for sample metrics. It listens on 80 and 9999.

data/fluent-plugin-prometheus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-prometheus"
-  spec.version       = "0.1.3"
+  spec.version       = "0.2.0"
   spec.authors       = ["Masahiro Sano"]
   spec.email         = ["sabottenda@gmail.com"]
   spec.summary       = %q{A fluent plugin that collects metrics and exposes for Prometheus.}

data/lib/fluent/plugin/prometheus.rb

@@ -34,8 +34,10 @@ module Fluent
           metrics << Fluent::Prometheus::Gauge.new(element, registry, labels)
         when 'counter'
           metrics << Fluent::Prometheus::Counter.new(element, registry, labels)
+        when 'histogram'
+          metrics << Fluent::Prometheus::Histogram.new(element, registry, labels)
         else
-          raise ConfigError, "type option must be 'counter', 'gauge' or 'summary'"
+          raise ConfigError, "type option must be 'counter', 'gauge', 'summary' or 'histogram'"
         end
       }
       metrics
@@ -46,7 +48,13 @@ module Fluent
       if defined?(Fluent::Filter) # for v0.12, built-in PlaceholderExpander
         begin
           require 'fluent/plugin/filter_record_transformer'
-          return Fluent::RecordTransformerFilter::PlaceholderExpander.new(log: log)
+          if defined?(Fluent::Plugin::RecordTransformerFilter::PlaceholderExpander)
+            # for v0.14
+            return Fluent::Plugin::RecordTransformerFilter::PlaceholderExpander.new(log: log)
+          else
+            # for v0.12
+            return Fluent::RecordTransformerFilter::PlaceholderExpander.new(log: log)
+          end
         rescue LoadError => e
           raise ConfigError, "cannot find filter_record_transformer plugin: #{e.message}"
         end
@@ -188,7 +196,35 @@ module Fluent
 
       def instrument(record, expander, placeholders)
         if record[@key]
-          @summary.add(labels(record, expander, placeholders), record[@key])
+          @summary.observe(labels(record, expander, placeholders), record[@key])
+        end
+      end
+    end
+
+    class Histogram < Metric
+      def initialize(element, registry, labels)
+        super
+        if @key.nil?
+          raise ConfigError, "histogram metric requires 'key' option"
+        end
+
+        begin
+          if element['buckets']
+            buckets = element['buckets'].split(/,/).map(&:strip).map do |e|
+              e[/\A\d+.\d+\Z/] ? e.to_f : e.to_i
+            end
+            @histogram = registry.histogram(element['name'].to_sym, element['desc'], {}, buckets)
+          else
+            @histogram = registry.histogram(element['name'].to_sym, element['desc'])
+          end
+        rescue ::Prometheus::Client::Registry::AlreadyRegisteredError
+          @histogram = Fluent::Prometheus::Metric.get(registry, element['name'].to_sym, :histogram, element['desc'])
+        end
+      end
+
+      def instrument(record, expander, placeholders)
+        if record[@key]
+          @histogram.observe(labels(record, expander, placeholders), record[@key])
         end
       end
     end

data/misc/prometheus.yaml

@@ -2,7 +2,7 @@
 scrape_configs:
 - job_name: fluentd
   scrape_interval: 5s
-  target_groups:
+  static_configs:
     - targets:
         - 'localhost:24231'
   metrics_path: /metrics

data/spec/fluent/plugin/filter_prometheus_spec.rb

@@ -12,7 +12,7 @@ describe Fluent::PrometheusFilter do
   end
 
   describe '#run' do
-    let(:message) { {"foo" => 100, "bar" => 100, "baz" => 100} }
+    let(:message) { {"foo" => 100, "bar" => 100, "baz" => 100, "qux" => 10} }
     let(:es) { driver.run { driver.emit(message, Time.now) }.filtered }
 
     context 'simple config' do

data/spec/fluent/plugin/out_prometheus_spec.rb

@@ -12,7 +12,7 @@ describe Fluent::PrometheusOutput do
   end
 
   describe '#run' do
-    let(:message) { {"foo" => 100, "bar" => 100, "baz" => 100} }
+    let(:message) { {"foo" => 100, "bar" => 100, "baz" => 100, "qux" => 10} }
     let(:es) { driver.run { driver.emit(message, Time.now) } }
 
     context 'simple config' do

data/spec/fluent/plugin/shared.rb

@@ -42,6 +42,16 @@ FULL_CONFIG = BASE_CONFIG + %[
       key foo3
     </labels>
   </metric>
+  <metric>
+    name full_qux
+    type histogram
+    desc Something qux.
+    key qux
+    buckets 0.1, 1, 5, 10
+    <labels>
+      key foo4
+    </labels>
+  </metric>
   <labels>
     test_key test_value
   </labels>
@@ -83,6 +93,7 @@ shared_context 'full_config' do
   let(:counter) { registry.get(:full_foo) }
   let(:gauge) { registry.get(:full_bar) }
   let(:summary) { registry.get(:full_baz) }
+  let(:histogram) { registry.get(:full_qux) }
 end
 
 shared_context 'placeholder_config' do
@@ -139,12 +150,14 @@ shared_examples_for 'output configuration' do
   end
 end
 
+emit_count = 0
 shared_examples_for 'instruments record' do
   context 'full config' do
     include_context 'full_config'
 
     before :each do
       es
+      emit_count += 1
     end
 
     it 'adds all metrics' do
@@ -154,6 +167,7 @@ shared_examples_for 'instruments record' do
       expect(counter).to be_kind_of(::Prometheus::Client::Metric)
       expect(gauge).to be_kind_of(::Prometheus::Client::Metric)
       expect(summary).to be_kind_of(::Prometheus::Client::Metric)
+      expect(histogram).to be_kind_of(::Prometheus::Client::Metric)
     end
 
     it 'instruments counter metric' do
@@ -171,6 +185,12 @@ shared_examples_for 'instruments record' do
       expect(summary.get({test_key: 'test_value', key: 'foo3'})).to be_kind_of(Hash)
       expect(summary.get({test_key: 'test_value', key: 'foo3'})[0.99]).to eq(100)
     end
+
+    it 'instruments histogram metric' do
+      expect(histogram.type).to eq(:histogram)
+      expect(histogram.get({test_key: 'test_value', key: 'foo4'})).to be_kind_of(Hash)
+      expect(histogram.get({test_key: 'test_value', key: 'foo4'})[10]).to eq(emit_count)
+    end
   end
 
   context 'placeholder config' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-prometheus
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Masahiro Sano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-04 00:00:00.000000000 Z
+date: 2016-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -118,7 +118,6 @@ files:
 - lib/fluent/plugin/prometheus.rb
 - misc/fluentd_sample.conf
 - misc/nginx_proxy.conf
-- misc/prometheus-old-format.conf
 - misc/prometheus.yaml
 - spec/fluent/plugin/filter_prometheus_spec.rb
 - spec/fluent/plugin/out_prometheus_spec.rb

data/misc/prometheus-old-format.conf

@@ -1,10 +0,0 @@
-# A job to scrape an endpoint of Fluentd running on localhost.
-job: {
-  name: "fluentd"
-  scrape_interval: "5s"
-
-  target_group: {
-    target: "http://localhost:24231/metrics"
-  }
-}
-