Skip to content

Add support for gauge metric in static-exporter #1328

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

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

gauravgpta93
Copy link

Add support for gauge metric in static-exporter
Keep default as counter to avoid any changes for other places

Copy link
Contributor

@jdbaldry jdbaldry left a 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?

@@ -47,14 +47,17 @@ local k = import 'ksonnet-util/kausal.libsonnet';
}),

metric:: {
new(name, description)::
new(name, description, metricType='counter')::
Copy link
Contributor

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.

Copy link
Contributor

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')

Copy link
Contributor

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?

Copy link
Contributor

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'll answer with a question: At what point do we stop adding things to the constructor?

My rule of thumb is to only add arguments to the constructor that are strictly required to create the object. Then create functions for changing the default values of the returned object.

Why does the constructor do ?

For small objects it doesn't matter that much I guess, for bigger objects these functions may encapsulate larger chunks of code. Opting to ~always use the functions increases consistency. I'm not too nitty-gritty on that, especially for manually written libraries.

There is a benefit on composability. Let's say the user wants to prefix the name for all instances from a library.

In the object approach, they have to override the constructor:

local prefixLib =
  lib + {
    new(name, description):
      lib.new(name, description) 
      + { name: 'prefix-' + name },
  };

With the function approach:

local prefixLib =
  lib + {
    withName(name):
      { name: 'prefix-' + name },
  };

I prefer to do the latter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants