Allow :prefix option on metrics creation #148
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
karanthukral
approved these changes
Nov 27, 2018
| @@ -2,7 +2,7 @@ require 'bundler/gem_tasks' | |||
| require 'rake/testtask' | |||
|
|
|||
| Rake::TestTask.new('test') do |t| | |||
| t.ruby_opts << '-rubygems' | |||
| t.ruby_opts << '-r rubygems' | |||
There was a problem hiding this comment.
CI was complaining about this (and was in fact preventing me from testing locally)
dturn
reviewed
Nov 27, 2018
lib/statsd/instrument/metric.rb
Outdated
| @@ -47,7 +49,11 @@ def initialize(options = {}) | |||
| @type = options[:type] or raise ArgumentError, "Metric :type is required." | |||
| @name = options[:name] or raise ArgumentError, "Metric :name is required." | |||
| @name = normalize_name(@name) | |||
| @name = StatsD.prefix ? "#{StatsD.prefix}.#{@name}" : @name unless options[:no_prefix] | |||
| @name = if options[:prefix] | |||
There was a problem hiding this comment.
what happens if prefix & no_prefix are set?
There was a problem hiding this comment.
prefix will override (which I should document).
I could be persuaded to have :no_prefix have greater precedence but it's 6 of 1, half-dozen of the other.
There was a problem hiding this comment.
Hm. no_prefix having precedence sounds less surprising to me.
fw42
reviewed
Nov 27, 2018
lib/statsd/instrument/metric.rb
Outdated
| @@ -47,7 +49,11 @@ def initialize(options = {}) | |||
| @type = options[:type] or raise ArgumentError, "Metric :type is required." | |||
| @name = options[:name] or raise ArgumentError, "Metric :name is required." | |||
| @name = normalize_name(@name) | |||
| @name = StatsD.prefix ? "#{StatsD.prefix}.#{@name}" : @name unless options[:no_prefix] | |||
| @name = if options[:prefix] | |||
There was a problem hiding this comment.
Hm. no_prefix having precedence sounds less surprising to me.
fw42
approved these changes
Nov 27, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #69
Allows clients to pass in
:prefixas an option to a metric. This allows classes that extend StatsD to avoid polluting the global namespace. The motivation for this is KubernetesDeploy #384, though it seems it's not the first app to feel the need for this.The change is backwards compatible and purely opt-in