-
Notifications
You must be signed in to change notification settings - Fork 161
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.
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
Add support for gauge metric in static-exporter #1328
base: master
Are you sure you want to change the base?
Add support for gauge metric in static-exporter #1328
Conversation
…nter` to avoid any changes for other places
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: for consistency with the other withFUNCTION
methods, perhaps it should be just withType
and not withMetricType
?
static-exporter/main.libsonnet
Outdated
@@ -47,14 +47,17 @@ local k = import 'ksonnet-util/kausal.libsonnet'; | |||
}), | |||
|
|||
metric:: { | |||
new(name, description):: | |||
new(name, description, metricType='counter'):: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could set this value below and require withMetricType
instead of overloading the constructor.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason to prefer that over having all the arguments in the constructor?
I'm not sure I see how metricType
is different from description
or name
except that the library originally only supported counter
types.
In other words, why have:
metric.new('NAME', 'DESCRIPTION') + metric.withMetricType('TYPE')
when you can just have:
metric.new('NAME', 'DESCRIPTION, 'TYPE')
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, to help me understand our patterns better. Why does the constructor do:
self.withName(name)
+ self.withDescription(description)
+ self.withMetricType(metricType)
instead of:
{
name: name,
description: description,
type: metricType,
}
I am thinking it's to use the public API presented by the object so that if withName
ever does validation, the constructor also does the validation without refactor?
In that case, should we have some convention of indicating that the type
, description
, and type
fields shouldn't be modified except through that public API. Perhaps they should be fields within a hidden _internal
field or something?
Add support for gauge metric in static-exporter
Keep default as
counter
to avoid any changes for other places