Add licence usage metrics #3145

charith-elastic · 2020-05-26T12:42:32Z

Exposes licence usage information as Prometheus metrics.

Metrics output:

# HELP elastic_licensing_enterprise_resource_units_total Total enterprise resource units used
# TYPE elastic_licensing_enterprise_resource_units_total gauge
elastic_licensing_enterprise_resource_units_total{license_level="enterprise_trial"} 1
# HELP elastic_licensing_memory_gigabytes_total Total memory used in GB
# TYPE elastic_licensing_memory_gigabytes_total gauge
elastic_licensing_memory_gigabytes_total{license_level="enterprise_trial"} 7.516192768

ConfigMap output:

data:
  eck_license_level: enterprise_trial
  enterprise_resource_units: "1"
  timestamp: "2020-05-26T12:40:10Z"
  total_managed_memory: 7.52GB

Fixes #3140

sebgl

Overall looks good!

sebgl · 2020-05-28T07:51:11Z

pkg/utils/metrics/metrics.go

@@ -0,0 +1,58 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one


I'm wondering if we should keep it close to the license stuff for the time being (pkg/license/metrics.go) instead of using a generic metrics package. And maybe extract the generic metrics stuff once we need it somewhere else?

I was wondering that too, but it also might be my personal twitch I get for anything in a utils directory. But since there's license info in here I'm +1 for that I think

I am planning on adding more metrics soon. Other metrics are a bit harder to integrate because the code is not organised with instrumentation in mind so I'll be doing that incrementally in a series of PRs.

I prefer the all-metrics-in-a-single-place approach as it is easier to audit and helps to implicitly enforce conventions on new metrics -- which is harder to do when they are strewn all over the place.

sebgl · 2020-05-28T07:56:29Z

pkg/license/license.go

@@ -57,16 +59,21 @@ func (r LicensingResolver) ToInfo(totalMemory resource.Quantity) (LicensingInfo,
 	licenseLevel := r.getOperatorLicenseLevel(operatorLicense)


I would not expect ToInfo to also update the in-memory metrics as a side-effect. Should we extract the metrics update to its own function (or rename this function)?

anyasabo · 2020-05-28T23:06:01Z

jenkins test this please

anyasabo · 2020-05-28T23:17:02Z

pkg/license/reporter.go

@@ -62,6 +62,7 @@ func (r ResourceReporter) Report() error {
 		return err
 	}

+	licensingInfo.ReportAsMetrics()


The comment on this func could use an update since it's doing more now

anyasabo · 2020-05-28T23:26:32Z

pkg/license/reporter_test.go

-	assert.NoError(t, err)
-	assert.Equal(t, "21.47GB", licensingInfo.TotalManagedMemory)
-	assert.Equal(t, "1", licensingInfo.EnterpriseResourceUnits)
+func TestGet(t *testing.T) {


I realize both are not directly from this PR, but:

It doesn't look like we have a test exercising the maxERUs branch, correct? It might be worth adding one if possible

Nit: Since they don't share anything, at this point it might be simpler to break each case out into separate tests just to make it easier to run a specific test if you need to

There are tests for maxERUs in the licence tests.

I am not sure I understand your comment about individual tests. You can already run specific tests by invoking something like go test -run='TestGet/elasticsearch_defaults' ./pkg/license/...

You can already run specific tests

You're right, I was being goofy 🤦‍♀️

anyasabo · 2020-05-28T23:35:05Z

LGTM, nice work. Looks like most recent CI failure should be fixed with #3157

sebgl

LGTM

charith-elastic · 2020-06-01T07:20:41Z

Jenkins test this please

Add licence usage metrics

7b50ff6

charith-elastic added >enhancement Enhancement of existing functionality v1.2.0 labels May 26, 2020

sebgl reviewed May 28, 2020

View reviewed changes

Refactor

52ea845

anyasabo reviewed May 28, 2020

View reviewed changes

Update comment

ca5ba31

sebgl approved these changes May 29, 2020

View reviewed changes

Update notice

1a12f99

charith-elastic merged commit fcc109b into elastic:master Jun 1, 2020

charith-elastic deleted the licence-metrics branch June 1, 2020 08:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add licence usage metrics #3145

Add licence usage metrics #3145

charith-elastic commented May 26, 2020

sebgl left a comment

sebgl May 28, 2020

anyasabo May 28, 2020 •

edited

Loading

charith-elastic May 29, 2020

sebgl May 28, 2020

anyasabo commented May 28, 2020

anyasabo May 28, 2020

anyasabo May 28, 2020

charith-elastic May 29, 2020

anyasabo Jun 2, 2020 •

edited

Loading

anyasabo commented May 28, 2020

sebgl left a comment

charith-elastic commented Jun 1, 2020

		@@ -0,0 +1,58 @@
		// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one

		@@ -57,16 +59,21 @@ func (r LicensingResolver) ToInfo(totalMemory resource.Quantity) (LicensingInfo,
		licenseLevel := r.getOperatorLicenseLevel(operatorLicense)

Add licence usage metrics #3145

Add licence usage metrics #3145

Conversation

charith-elastic commented May 26, 2020

sebgl left a comment

Choose a reason for hiding this comment

sebgl May 28, 2020

Choose a reason for hiding this comment

anyasabo May 28, 2020 • edited Loading

Choose a reason for hiding this comment

charith-elastic May 29, 2020

Choose a reason for hiding this comment

sebgl May 28, 2020

Choose a reason for hiding this comment

anyasabo commented May 28, 2020

anyasabo May 28, 2020

Choose a reason for hiding this comment

anyasabo May 28, 2020

Choose a reason for hiding this comment

charith-elastic May 29, 2020

Choose a reason for hiding this comment

anyasabo Jun 2, 2020 • edited Loading

Choose a reason for hiding this comment

anyasabo commented May 28, 2020

sebgl left a comment

Choose a reason for hiding this comment

charith-elastic commented Jun 1, 2020

anyasabo May 28, 2020 •

edited

Loading

anyasabo Jun 2, 2020 •

edited

Loading