metrics-backend-statsd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f9b7c611b6af050e5a387907f38a4506c53e872b65991d8cb2037910180114a
+  data.tar.gz: ad44b521e73e76726ba68194a986c3f0393c32bd2a6755928b75fc9f90605553
+SHA512:
+  metadata.gz: 267261b06c704edcad1be0a0311ffdd5271173f6061593b897e7c9c12798ced01fea27e7cf70c2e0b38f17a3cd6dda054e0d1e9c60167fc0a8005dc5f4a25d2c
+  data.tar.gz: 2623ba15b063aa175116131b5ae832c9e2e634207702e59d37c23593b0bcd4b02522f5f8cd28df3fad1625124085c6d21f807294cdbd3368816a9f6302bf9edd

data/lib/metrics/backend/statsd/interface.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require "metrics/metric"
+require "metrics/tags"
+
+require "console"
+require "io/endpoint/host_endpoint"
+
+module Metrics
+	module Backend
+		module Statsd
+			::Thread.attr_accessor :metrics_backend_statsd_instance
+			
+			class Client
+				DEFAULT_ENDPOINT = IO::Endpoint.udp("localhost", 8125)
+				
+				def initialize(endpoint = DEFAULT_ENDPOINT)
+					@endpoint = endpoint
+				end
+				
+				def send_metric(name, value, type:, sample_rate: 1.0, tags: nil)
+					return if sample_rate < 1.0 && rand > sample_rate
+					
+					parts = ["#{name}:#{value}|#{type}"]
+					parts << "@#{sample_rate}" if sample_rate < 1.0
+					parts << format_tags(tags) if tags
+					
+					message = parts.compact.join("|")
+					
+					# Basically, we don't want to block the application if the socket is not connected or otherwise unavailable:
+					self.socket.sendmsg_nonblock(message, 0, exception: false)
+				rescue Errno::ECONNREFUSED => error
+					Console.error(self, "Failed to send metric!", error)
+				end
+				
+				private
+				
+				def socket
+					@socket ||= @endpoint.connect
+				end
+				
+				def format_tags(tags)
+					"##{tags.join(',')}" if tags && !tags.empty?
+				end
+			end
+			
+			def self.instance
+				Thread.current.metrics_backend_statsd_instance ||= Client.new
+			end
+			
+			def self.instance=(instance)
+				Thread.current.metrics_backend_statsd_instance = instance
+			end
+			
+			class Metric < Metrics::Metric
+				def emit(value, tags: nil, sample_rate: 1.0)
+					Statsd.instance.send_metric(@name, value, type: "c", sample_rate: sample_rate, tags: Tags.normalize(tags))
+				end
+			end
+			
+			class Gauge < Metric
+				def emit(value, tags: nil, sample_rate: 1.0)
+					Statsd.instance.send_metric(@name, value, type: "g", sample_rate: sample_rate, tags: Tags.normalize(tags))
+				end
+			end
+			
+			class Histogram < Metric
+				def emit(value, tags: nil, sample_rate: 1.0)
+					Statsd.instance.send_metric(@name, value, type: "h", sample_rate: sample_rate, tags: Tags.normalize(tags))
+				end
+			end
+			
+			class Distribution < Metric
+				def emit(value, tags: nil, sample_rate: 1.0)
+					Statsd.instance.send_metric(@name, value, type: "d", sample_rate: sample_rate, tags: Tags.normalize(tags))
+				end
+			end
+			
+			module Interface
+				def metric(name, type, description: nil, unit: nil)
+					klass = Metric
+					
+					case type
+					when :counter
+						# klass = Metric
+					when :guage
+						klass = Gauge
+					when :histogram
+						klass = Histogram
+					when :distribution
+						klass = Distribution
+					end
+					
+					klass.new(name, type, description, unit)
+				end
+			end
+		end
+		
+		Interface = Statsd::Interface
+	end
+end

data/lib/metrics/backend/statsd/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module Metrics
+	module Backend
+		module Statsd
+			VERSION = "0.1.0"
+		end
+	end
+end

data/lib/metrics/backend/statsd.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "statsd/version"
+require_relative "statsd/interface"

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2025, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,54 @@
+# Metrics::Backend::Statsd
+
+A metrics backend for Statsd.
+
+[![Development Status](https://github.com/socketry/metrics-backend-statsd/workflows/Test/badge.svg)](https://github.com/socketry/metrics-backend-statsd/actions?workflow=Test)
+
+## Usage
+
+If you need to specify custom options, you can override the default statsd client instance.
+
+``` ruby
+# config/initializers/metrics/backend/statsd.rb
+
+require 'metrics/backend/statsd'
+
+module Metrics
+	module Backend
+		module Statsd
+			# Override the default instance setup:
+			def self.new
+				instance = ::Statsd::Statsd.new('localhost', 8125, logger: Console.logger)
+				
+				at_exit do
+					self.close
+				end
+				
+				return instance
+			end
+		end
+	end
+end
+```
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.
+
+## See Also
+
+  - [metrics](https://github.com/socketry/metrics) — Capture metrics about code execution in a vendor agnostic way.

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: metrics-backend-statsd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2025-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/metrics/backend/statsd.rb
+- lib/metrics/backend/statsd/interface.rb
+- lib/metrics/backend/statsd/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/metrics-backend-statsd
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/metrics-backend-statsd/
+  source_code_uri: https://github.com/socketry/metrics-backend-statsd.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Application metrics and instrumentation.
+test_files: []