postfix-exporter 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4b3403736d6ac37fd2733f6db98f566a36e426de634fe971b96a332dd13527dc
-  data.tar.gz: b20157262dd52237db592744c80713c260ea6eb224e2feb5eac7a60d5665ca40
+SHA1:
+  metadata.gz: c3d12e780c74fb42d02f4760e59b04b92d2697f5
+  data.tar.gz: 01f82ea6eacc6058db15b568e04494ad6bbdbf96
 SHA512:
-  metadata.gz: 8d99493844dfb43b7b15a3742430f50db2c70ec3506b0c1bd93557a4ca4aca45d22c4eca5a95010571eac486519740858e415f9bae2329ff2a630962056bd10d
-  data.tar.gz: a10120c7f4b0b7a31f36b4fd215bb44ea14868e8281491c473e26812e8b2cfbad0352c87666437087875fb3e095c4036e8b0316461ae82b0077567e938040846
+  metadata.gz: 0be25eb7453abc769958db68daddddc64997cfd5d8a0ce5dd46f94b58f48b1c9bccf3c22a4e91c53f6e35f3b34e5f0f2f9cc2969073e43f7fd342b8647bb756b
+  data.tar.gz: 7178052ca7f931d8194a26d187e7d24541712e07f9f085f6d5e8d82ac642087f6009adf6786bb35bf6fad0d20fdf3a077dc149152954d55709700e2c76ef2a6f

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.3-alpine
+
+RUN apk update \
+	&& apk add build-base \
+	&& gem install postfix-exporter \
+	&& apk del build-base \
+	&& rm -f /var/cache/apk/*
+
+ENTRYPOINT ["/usr/local/bundle/bin/postgres-exporter"]

data/README.md

@@ -7,18 +7,8 @@ server.
 * Examines mail queue periodically and exports `postfix_mail_queue_size`;
 
 * Reads syslog entries as they happen, and exports disposition status
-  counters (`postfix_delivery_delays_count`) per DSN, as well as delay summaries per
-  DSN (`postfix_delivery_delays{quantile="..."}`);
-
-* Total number of SMTP connections (`postfix_smtpd_connections_total`) and
-  currently-active connections (`postfix_smtpd_active_connections`);
-
-* Count how many delivery attempts were received
-  (`postfix_incoming_delivery_attempts_total`), split out by whether we
-  accepted or rejected the message (`status`) and the exact DSN provided to
-  the client (`dsn`);
-
-* Whether or not the Postfix `master` process is running (`postfix_up`);
+  counters (`postfix_disposition`) per DSN, as well as delay summaries per
+  DSN;
 
 * Drinks from the syslog stream directly.
 
@@ -31,11 +21,6 @@ available in the container as `/var/spool/postfix`), and some env
 vars.  You can also run it directly (via the gem), with the same env vars,
 and with the expectation that `/var/spool/postfix` is in the usual place.
 
-If you configure the postfix-exporter to run in the same PID namespace as
-whatever it is that's running Postfix itself (either `--pid=host` or in the
-same NS namespace, a la k8s pods), then the `postfix_up` metric will be
-valid, otherwise it'll be random (but unlikely to be correct).
-
 
 ## Environment Variables
 

data/bin/postfix-exporter

@@ -1,19 +1,15 @@
 #!/usr/bin/env ruby
 
-require 'rack'
-require 'prometheus/middleware/exporter'
+require 'prometheus/client/rack/exporter'
 require 'socket'
+require 'docker'
+require 'rack'
 require 'rack/handler/webrick'
 require 'logger'
 
 prometheus = Prometheus::Client.registry
 
-prometheus.gauge(:postfix_exporter_start_time_seconds, "When this process started up").set({}, Time.now.to_f)
-
-oldest = prometheus.gauge(:postfix_oldest_message_timestamp_seconds, "Queue time of the oldest message")
-mailq  = prometheus.gauge(:postfix_queue_size, "Number of messages in the mail queue")
-q_err  = prometheus.counter(:postfix_queue_processing_error_total, "Exceptions raised whilst scanning the Postfix queue")
-up     = prometheus.gauge(:postfix_up, "Whether the master process is running or not")
+mailq = prometheus.gauge(:postfix_queue_size, "Number of messages in the mail queue")
 
 Thread.abort_on_exception = true
 
@@ -27,84 +23,19 @@ Thread.new do
 			# deferred is special, because it's often hueg it gets sharded into
 			# multiple subdirectories
 			mailq.set({ queue: 'deferred' }, Dir["/var/spool/postfix/deferred/*/*"].size)
-		rescue StandardError => ex
-			$stderr.puts "Error while monitoring queue sizes: #{ex.message} (#{ex.class})"
-			$stderr.puts ex.backtrace.map { |l| "  #{l}" }.join("\n")
-			q_err.increment(class: ex.class.to_s, phase: "scan")
-		end
-
-		begin
-			master_pid = File.read("/var/spool/postfix/pid/master.pid").to_i
 
-			if master_pid > 1
-				Process.kill(0, master_pid)
-				# If we get here, then the process exists, and
-				# that'll do for our purposes
-				up.set({}, 1)
-			else
-				up.set({}, 0)
-			end
-		rescue Errno::ENOENT, Errno::ESRCH, Errno::EACCES
-			up.set({}, 0)
-		rescue Errno::EPERM
-			# Ironically, we don't need to be able to *actually*
-			# signal the process; EPERM means it exists and is running
-			# as someone more privileged than us, which is enough
-			# for our purposes
-			up.set({}, 1)
+			sleep 5
 		rescue StandardError => ex
-			$stderr.puts "Error while checking master process: #{ex.message} (#{ex.class})"
-			$stderr.puts ex.backtrace.map { |l| "  #{l}" }.join("\n")
-			q_err.increment(class: ex.class.to_s, phase: "up")
-		end
-
-		sleep 5
-
-	end
-end
-
-Thread.new do
-	earliest_ctime = ->(glob) do
-		# There is seemingly no way to unset or remove a gauge metric in the Ruby
-		# implementation of the prom exporter.  As a hack, we return the current
-		# time in cases where there is nothing to sample.
-		now = Time.now.to_i
-
-		Dir[glob].lazy.map do |n|
-			begin
-				File.stat(n).ctime.to_i
-			rescue Errno::ENOENT
-				now
-			end
-		end.min || now
-	end
-
-	loop do
-		begin
-			%w{incoming active corrupt hold}.each do |q|
-				oldest.set({ queue: q }, earliest_ctime["/var/spool/postfix/#{q}/*"])
-			end
-			oldest.set({ queue: 'deferred' }, earliest_ctime["/var/spool/postfix/deferred/*/*"])
-		rescue StandardError => ex
-			$stderr.puts "Error while sampling message ages: #{ex.message} (#{ex.class})"
+			$stderr.puts "Error while monitoring queue sizes: #{ex.message} (#{ex.class})"
 			$stderr.puts ex.backtrace.map { |l| "  #{l}" }.join("\n")
-			q_err.increment(class: ex.class.to_s, phase: "stat")
+			sleep 1
 		end
-
-		# stat()ing all the files in a large queue could potentially be quite
-		# expensive, so we sample this data less frequently.
-		sleep 60
-
 	end
 end
 
 if ENV["SYSLOG_SOCKET"]
-	delays     = prometheus.summary(:postfix_delivery_delays, "Distribution of time taken to deliver (or bounce) messages")
-	connects   = prometheus.counter(:postfix_smtpd_connections_total, "Connections to smtpd")
-	active     = prometheus.gauge(:postfix_smtpd_active_connections, "Current connections to smtpd")
-	incoming   = prometheus.counter(:postfix_incoming_delivery_attempts_total, "Delivery attempts, labelled by dsn and status")
-	messages   = prometheus.counter(:postfix_log_messages_total, "Syslog messages received, labelled by how it was handled")
-	log_errors = prometheus.counter(:postfix_log_processing_error_total, "Exceptions raised whilst processing log messages")
+	delays   = prometheus.summary(:postfix_delivery_delays, "Distribution of time taken to deliver (or bounce) messages")
+	statuses = prometheus.counter(:postfix_deliveries, "How many messages have been delivered (or bounced)")
 
 	Thread.new do
 		begin
@@ -118,44 +49,19 @@ if ENV["SYSLOG_SOCKET"]
 		loop do
 			begin
 				msg = s.recvmsg.first
-				if msg =~ %r{postfix/.* delay=(\d+(\.\d+)?), .* dsn=(\d+\.\d+\.\d+), status=(\w+)}
+				if msg =~ %r{postfix/smtp.* delay=(\d+(\.\d+)?), .* dsn=(\d+\.\d+\.\d+), status=(\w+)}
 					delay  = $1.to_f
 					dsn    = $3
 					status = $4
 
 					if status == "bounced" or status == "sent"
-						delays.observe({dsn: dsn, status: status}, delay)
-					end
-
-					messages.increment(type: "delay")
-				elsif msg =~ %r{postfix/smtpd\[\d+\]: connect from }
-					connects.increment({})
-					active.send(:synchronize) { active.set({}, active.get({}) || 0 + 1) }
-					messages.increment(type: "connect")
-				elsif msg =~ %r{postfix/smtpd\[\d+\]: disconnect from }
-					active.send(:synchronize) do
-					  new = (active.get({}) || 0) - 1
-					  # If we start running mid-stream,
-					  # we might end up seeing more
-					  # disconnects than connections,
-					  # which would be confusing
-					  new = 0 if new < 0
-					  active.set({}, new)
+						statuses.increment(dsn: dsn, status: status)
+						delays.add({dsn: dsn, status: status}, delay)
 					end
-					messages.increment(type: "disconnect")
-				elsif msg =~ %r{postfix/smtpd\[\d+\]: [A-F0-9]+: client=}
-					incoming.increment(dsn: "2.0.0", status: "queued")
-					messages.increment(type: "queued")
-				elsif msg =~ %r{postfix/smtpd\[\d+\]: NOQUEUE: reject: RCPT from \S+: \d{3} (\d+\.\d+\.\d+) }
-					incoming.increment(dsn: $1, status: "rejected")
-					messages.increment(type: "noqueue")
-				else
-					messages.increment(type: "ignored")
 				end
 			rescue StandardError => ex
 				$stderr.puts "Error while receiving postfix logs: #{ex.message} (#{ex.class})"
 				$stderr.puts ex.backtrace.map { |l| "  #{l}" }.join("\n")
-				log_errors.increment(class: ex.class.to_s)
 				sleep 1
 			end
 		end
@@ -163,21 +69,11 @@ if ENV["SYSLOG_SOCKET"]
 end
 
 app = Rack::Builder.new
-app.use Rack::Deflater, if: ->(_, _, _, body) { body.any? && body[0].length > 512 }
-app.use Prometheus::Middleware::Exporter
+app.use Prometheus::Client::Rack::Exporter
 app.run ->(env) { [404, {'Content-Type' => 'text/plain'}, ['NOPE NOPE NOPE NOPE']] }
 
 logger = Logger.new($stderr)
 logger.level = Logger::INFO
 logger.formatter = proc { |s, t, p, m| "WEBrick: #{m}\n" }
 
-# This is the only way to get the Rack-mediated webrick to listen on both
-# INADDR_ANY and IN6ADDR_ANY on libcs that don't support getaddrinfo("*")
-# (ie musl-libc).  Setting `Host: '*'` barfs on the above-mentioned buggy(?)
-# libcs, `Host: '::'` fails on newer rubies (because they use
-# setsockopt(V6ONLY) by default), and with RACK_ENV at its default of
-# "development", it only listens on localhost.  And even *this* only works
-# on Rack 2, because before that the non-development default listen address
-# was "0.0.0.0"!
-ENV['RACK_ENV'] = "none"
-Rack::Handler::WEBrick.run app, Port: 9154, Logger: logger, AccessLog: []
+Rack::Handler::WEBrick.run app, Host: '::', Port: 9154, Logger: logger, AccessLog: []

data/postfix-exporter.gemspec

@@ -18,15 +18,15 @@ Gem::Specification.new do |s|
 	s.email    = ["matt.palmer@discourse.org"]
 	s.homepage = "https://github.com/discourse/postfix-exporter"
 
-	s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Dockerfile|Rakefile)/ }
+	s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }
 	s.executables = ["postfix-exporter"]
 
 	s.required_ruby_version = ">= 2.1.0"
 
-	s.add_runtime_dependency 'prometheus-client', '~> 0.7', '< 0.10'
-	s.add_runtime_dependency 'rack', '~> 2.0'
+	s.add_runtime_dependency 'prometheus-client'
+	s.add_runtime_dependency 'rack'
 
 	s.add_development_dependency 'bundler'
 	s.add_development_dependency 'github-release'
-	s.add_development_dependency 'rake'
+	s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
 end

metadata

@@ -1,49 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: postfix-exporter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Matt Palmer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -76,17 +70,23 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description:
+        version: 10.4.2
+description: 
 email:
 - matt.palmer@discourse.org
 executables:
@@ -95,13 +95,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Dockerfile
 - README.md
 - bin/postfix-exporter
 - postfix-exporter.gemspec
 homepage: https://github.com/discourse/postfix-exporter
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +117,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
 specification_version: 4
 summary: Export Prometheus statistics for a Postfix server
 test_files: []