puma-plugin-statsd 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155fc63d4aeb44adff94d1aecceee4458c4829d68ad0da1a7db10566e9c8d646
-  data.tar.gz: fdea125242151b6abf868cd74f163f84560d10d8825356f8ce718d7d5582967c
+  metadata.gz: 61b91a8a6e85cc308cb83a047ddbf958a2529363433689f3b7a407658982c9aa
+  data.tar.gz: d62ab03d1fe3c20dc13a395ba84fa5fe035183f17dec401a85217a20221a43b5
 SHA512:
-  metadata.gz: c8b63db9c3d6b63fa40c0709712e1cd4c1aa028d662976428089eefee6c48c597a1e84d602dce442e0899c6796cec21e2c179d1eec1331b4b3012b7c4036dbdc
-  data.tar.gz: cab4e1f32c8db8a434beeac2a0e83c66d385ebd2e85d1dde1cdfeb7ee93392d51791d41bc790f9df84c36f041c1879e74607122c0d9d2a1072dfa1cf80596ee3
+  metadata.gz: '09e931680b3c4280e1764fc9738ab69e7b0af6c0705eb02d52edc6ba9df69d227293075d77abbedb8e794337e99ae3d048abe8f76413ec9ed02a7c526494fe3c'
+  data.tar.gz: 6eb107be17c9b457dc0c7bb900867dab42dcd50fd49e27df919e6268e648a6a0c858a422f9545d9280e001f825db0ceb0eae4a333b705adc5ccb5b3c25f4b0e8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.0.0 2020-11-03
+
+* Added option to specify arbitrary datadog tags (PR #[18](https://github.com/yob/puma-plugin-statsd/pull/18))
+
 ## 0.3.0 2020-09-24
 
 * Support puma 5.x

data/README.md

@@ -37,7 +37,7 @@ plugin :statsd
 
 ## Usage
 
-Ensure you have an environment variable set that points to a statsd host, then boot your puma app as usual.  Optionally you may specify a port (default is 8125). 
+Ensure you have an environment variable set that points to a statsd host, then boot your puma app as usual.  Optionally you may specify a port (default is 8125).
 
 ```
 STATSD_HOST=127.0.0.1 bundle exec puma
@@ -53,9 +53,25 @@ metric tags are a non-standard addition to the statsd protocol, supported by
 the datadog "dogstatsd" server.
 
 Should you be reporting the puma metrics to a dogstatsd server, you can set
-tags via the following two environment variables.
+tags via the following three environment variables.
 
-`MY_POD_NAME` adds a `pod_name` tag to the metrics. The `MY_POD_NAME`
+
+#### DD_TAGS
+
+`DD_TAGS`: Set this to a space-separated list of tags, using the
+[datadog agent standard format](https://docs.datadoghq.com/agent/docker/?tab=standard#global-options).
+
+For example, you could set this environment variable to set three datadog tags,
+and then you can filter by in the datadog interface:
+
+```bash
+export DD_TAGS="env:test simple-tag-0 tag-key-1:tag-value-1"
+bundle exec rails server
+```
+
+#### MY_POD_NAME
+
+`MY_POD_NAME`: Set a `pod_name` tag to the metrics. The `MY_POD_NAME`
 environment variable is recommended in the datadog kubernetes setup
 documentation, and for puma apps deployed to kubernetes it's very helpful to
 have the option to report on specific pods.
@@ -70,7 +86,9 @@ env:
         fieldPath: metadata.name
 ```
 
-`STATSD_GROUPING` adds a `grouping` tag to the metrics, with a value equal to
+#### STATSD_GROUPING
+
+`STATSD_GROUPING`: add a `grouping` tag to the metrics, with a value equal to
 the environment variable value. This is particularly helpful in a kubernetes
 deployment where each pod has a unique name but you want the option to group
 metrics across all pods in a deployment. Setting this on the pods in a
@@ -100,7 +118,7 @@ Start puma:
 Throw some traffic at it, either with curl or a tool like ab:
 
     curl http://127.0.0.1:9292/
-    ab -n 10000 -c 20 http://127.0.0.1:9292/ 
+    ab -n 10000 -c 20 http://127.0.0.1:9292/
 
 Watch the output of the UDP server process - you should see statsd data printed to stdout.
 

data/lib/puma/plugin/statsd.rb

@@ -20,12 +20,9 @@ class StatsdConnector
     !!host
   end
 
-  def send(metric_name:, value:, type:, tags: {})
+  def send(metric_name:, value:, type:, tags: nil)
     data = "#{metric_name}:#{value}|#{STATSD_TYPES.fetch(type)}"
-    if tags.any?
-      tag_str = tags.map { |k,v| "#{k}:#{v}" }.join(",")
-      data = "#{data}|##{tag_str}"
-    end
+    data = "#{data}|##{tags}" unless tags.nil?
 
     socket = UDPSocket.new
     socket.send(data, 0, host, port)
@@ -123,15 +120,39 @@ Puma::Plugin.create do
     end
   end
 
-  def tags
-    tags = {}
+  def environment_variable_tags
+    # Tags are separated by spaces, and while they are normally a tag and
+    # value separated by a ':', they can also just be tagged without any
+    # associated value.
+    #
+    # Examples: simple-tag-0 tag-key-1:tag-value-1
+    #
+    tags = []
+
     if ENV.has_key?("MY_POD_NAME")
-      tags[:pod_name] = ENV.fetch("MY_POD_NAME", "no_pod")
+      tags << "pod_name:#{ENV['MY_POD_NAME']}"
     end
+
     if ENV.has_key?("STATSD_GROUPING")
-      tags[:grouping] = ENV.fetch("STATSD_GROUPING", "no-group")
+      tags << "grouping:#{ENV['STATSD_GROUPING']}"
     end
-    tags
+
+    # Standardised datadog tag attributes, so that we can share the metric
+    # tags with the application running
+    #
+    # https://docs.datadoghq.com/agent/docker/?tab=standard#global-options
+    #
+    if ENV.has_key?("DD_TAGS")
+      ENV["DD_TAGS"].split(/\s+/).each do |t|
+        tags << t
+      end
+    end
+
+    # Return nil if we have no environment variable tags. This way we don't
+    # send an unnecessary '|' on the end of each stat
+    return nil if tags.empty?
+
+    tags.join(",")
   end
 
   def prefixed_metric_name(puma_metric)
@@ -140,6 +161,8 @@ Puma::Plugin.create do
 
   # Send data to statsd every few seconds
   def stats_loop
+    tags = environment_variable_tags
+
     sleep 5
     loop do
       @launcher.events.debug "statsd: notify statsd"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-plugin-statsd
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - James Healy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma