Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Handle / in job name in Prometheus::Client::Push #291

Merged
merged 1 commit into from
Aug 3, 2023
Merged

Handle / in job name in Prometheus::Client::Push #291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions lib/prometheus/client/push.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class HttpClientError < HttpError; end
class HttpServerError < HttpError; end

DEFAULT_GATEWAY = 'http://localhost:9091'.freeze
PATH = '/metrics/job/%s'.freeze
PATH = '/metrics'.freeze
SUPPORTED_SCHEMES = %w(http https).freeze

attr_reader :job, :gateway, :path
Expand Down Expand Up @@ -87,7 +87,14 @@ def parse(url)
end

def build_path(job, grouping_key)
path = format(PATH, ERB::Util::url_encode(job))
# Job can't be empty, but it can contain `/`, so we need to base64
# encode it in that case
if job.include?('/')
encoded_job = Base64.urlsafe_encode64(job)
path = "#{PATH}/job@base64/#{encoded_job}"
else
path = "#{PATH}/job/#{ERB::Util::url_encode(job)}"
end

grouping_key.each do |label, value|
if value.include?('/')
Expand Down
8 changes: 8 additions & 0 deletions spec/prometheus/client/push_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,14 @@
expect(push.path).to eql('/metrics/job/test-job/foo/bar/baz/qux')
end

it 'encodes the job name in url-safe base64 if it contains `/`' do
push = Prometheus::Client::Push.new(
job: 'foo/test-job',
)

expect(push.path).to eql('/metrics/job@base64/Zm9vL3Rlc3Qtam9i')
end

it 'encodes grouping key label values containing `/` in url-safe base64' do
push = Prometheus::Client::Push.new(
job: 'test-job',
Expand Down