Question: adding custom Metric into configuration

I’m playing around with custom metrics and read the bits about Extending custom metrics. I’ve done the following and it works fine (Groovy):

talaiot {
    metrics {
        customBuildMetrics([myMetric: "Hello world"])
    }
    publishers {
        customPublisher(new CustomPublisher())
    }
}

But it would be interesting to have a method that takes a Metric and adds it into the MetricsConfiguration.metrics list.

talaiot {
    metrics {
        customMetrics(new MyCustomMetric())
    }
    publishers {
        customPublisher(new CustomPublisher())
    }
}

This would allow us to:

1. Have only custom metrics reported.
2. Override any existing metrics. e.g. add an extension of GitMetrics with more data.
3. Have our metrics organized in a package and in their own file(s).

Does it make sense to have such a feature added to the API?

P.S.: the docs seem to be outdated. e.g. gitMetrics = false does not work for me.

[cdsap]

@MyDogTom this is an awesome article, thanks!

@mokkun I’m working in the unification of the metrics provider in #158, later I can address this issue. But if you or @MyDogTom have any suggestion, feel free to reach out

[mokkun]

I’d actually go with something more verbose but also more self explaining. Like: enableStandardMetrics, enablePerformanceMetrics, enableGitMetrics etc.

I’d just avoid using the word enable, making it defaultMetrics, performanceMetrics and so on instead. Reason being, we are not enabling/disabling the metrics, we are adding/removing them. That’s my interpretation of it at least. 🤔