Do not build internal metrics without CGO #6501

kvch · 2018-03-06T02:41:47Z

Gosigar only requires CGO for Darwin, FreeBSD and OpenBSD. If someone compiles Beats on these platforms without CGO, metrics are not supported.

Add ephemeral ID to Beats which don't report internal memory usage, etc. So it can still show up in Monitoring UI.

ruflin · 2018-03-06T04:42:44Z

libbeat/cmd/instance/metrics_other.go

+	"github.com/elastic/beats/libbeat/logp"
+)
+
+var (


Could we move the ephemeralID part to a third file which gets compile on all platforms? Like this we can make sure we only have to change it in one place.

andrewkroh · 2018-03-08T05:29:59Z

Metrics reporting should work for the Windows binaries where cgo isn't used. The build tags in metrics.go are

// +build darwin linux windows
// +build cgo

which is (darwin OR linux OR windows) AND cgo. But we need to have (darwin AND cgo) OR (freebsd AND cgo) OR linux OR windows. And as a build tag this would become

// +build darwin,cgo freebsd,cgo linux windows

Then over in metrics_other.go you want the build tag to be the exact logical opposite such that the stub is used for all other platforms.

andrewkroh · 2018-03-08T05:30:06Z

I think we must have a test case to verify that xpack monitoring metrics are working correctly in the released binaries. I don't get a strong confidence from evaluating the build tags in my head against how I think they are set during the builds.

A good place to add this would be beats-tester. As you can see on Jenkins we have the log output from each Beat on each platform. The log contains a message like "Total non-zero metrics" that has all the monitoring metrics. We can parse this JSON log message and assert that it contains all of the correct fields as well as the ephemeral_id.

The assertions need to be written twice, once for posix and once for Windows. The two places where it needs added are:

As an example you can use this which collects the line of interest into a variable, parse the data as JSON, then asserts that the object contains particular fields.

kvch · 2018-03-12T12:22:52Z

I updated the branch with build tags I believe to be correct. :) I am still working on adding the assertions to Beats tester. @andrewkroh thanks for the pointers

ruflin · 2018-03-12T12:44:07Z

I'm wondering if we should merge it as is and then run beats-tester to verify the change or have the beats-tester changes first? I'm good with both options.

ruflin · 2018-03-12T12:44:36Z

@kvch I added the backport label as I assume the change is also needed for 6.2?

kvch · 2018-03-12T13:29:02Z

Thanks for adding the tag. It's definitely needed in 6.2.

I would wait for beats-tester. I am running it locally right now to validate changes. I would be more comfortable with merging this after it is validated.

andrewkroh

I'm happy to help with the beats-tester changes if you want to pair up over Zoom.

andrewkroh · 2018-03-12T13:50:45Z

libbeat/cmd/instance/metrics.go

@@ -1,5 +1,4 @@
-// +build darwin linux windows
-// +build cgo
+// +build darwin,cgo freebsd,cgo openbsd,cgo linux windows


I would leave openbsd off the list because ProcTime and ProcMem are not supported in gosigar.

andrewkroh · 2018-03-12T14:30:13Z

libbeat/cmd/instance/metrics_other.go

@@ -1,8 +1,11 @@
-// +build !darwin,!linux,!windows darwin,!cgo linux,!cgo windows,!cgo
+// +build darwin,!cgo freebsd,!cgo openbsd,!cgo


Definitely double check my work, but I think we have a different set of built tags.

From metrics.go (without openbsd):
(darwin AND cgo) OR (freebsd AND cgo) OR linux OR windows

Negating this and simplifying it:

!((darwin AND cgo) OR (freebsd AND cgo) OR linux OR windows) !(darwin AND cgo) AND !(freebsd AND !cgo) AND !linux AND !windows (!darwin OR !cgo) AND (!freebsd OR !cgo) AND !linux AND !windows

Conversion to build tags:

// +build !darwin !cgo // +build !freebsd !cgo // +build !linux,!windows

kvch · 2018-03-12T14:46:49Z

I opened a PR for Beats tester: elastic/beats-tester#74

andrewkroh · 2018-03-12T16:22:39Z

I kicked off a beats-tester job with the updated test cases. https://beats-ci.elastic.co/job/elastic+beats-tester+master/172/

We should see it fail until this PR gets merged. 👀

andrewkroh · 2018-03-12T21:13:16Z

We found a secondary problem with the new tests we added. See elastic/beats-tester#74 (comment).

ruflin · 2018-03-13T07:32:02Z

Looking at the errors there also seem to be an error related to this change:

17:08:22 TASK [test-beat : Check winlogbeat has monitoring metrics (win)] ***************
17:08:22 fatal: [tester-win12-64]: FAILED! => {"msg": "The conditional check 'log_metrics_event.monitoring.metrics.beat.cpu.system.ticks >= 0' failed. The error was: error while evaluating conditional (log_metrics_event.monitoring.metrics.beat.cpu.system.ticks >= 0): 'dict object' has no attribute 'beat'"}

kvch · 2018-03-13T08:35:43Z

@ruflin The error you pasted here is expected. Right now on master the registry named "beat" is not added in case of winlogbeat or anything crosscompiled. This PR fixes that problem, because it adds the registry even if system and beat metrics are not supported on a platform.

I would merge this PR now. The other test failures are orthogonal to this PR as @andrewkroh pointed it out. So it should not be blocked.

ruflin · 2018-03-13T08:43:53Z

libbeat/cmd/instance/metrics.go

 )

 func init() {
-	beatMetrics := monitoring.Default.NewRegistry("beat")
+	systemMetrics = monitoring.Default.NewRegistry("system")
+	ephemeralID = uuid.NewV4()


The ephmeralID init is not needed here anymore I think.

ruflin · 2018-03-13T08:44:14Z

Ok, left a minor comment. Could you also add a CHANGELOG entry?

kvch · 2018-03-13T09:42:31Z

Nice catch! Thanks for the review @ruflin
I added a CHANGELOG entry.

ruflin

WFG

andrewkroh · 2018-03-22T15:48:55Z

This should be back-ported in case we release a 6.2.4.

kvch · 2018-03-22T15:49:43Z

I am doing that now. :D

* libbeat: build internal metrics on windows and linux without cgo * libbeat: add ephemeral id even if no internal memory metrics is reported * fix incorrect build tags && create common file for all platforms

kvch added review libbeat labels Mar 6, 2018

ruflin reviewed Mar 6, 2018

View reviewed changes

andrewkroh self-requested a review March 7, 2018 05:38

kvch force-pushed the fix/libbeat/monitoring-build-tags branch from 95af99a to 4d7c8b8 Compare March 12, 2018 12:21

ruflin added the needs_backport PR is waiting to be backported to other branches. label Mar 12, 2018

andrewkroh reviewed Mar 12, 2018

View reviewed changes

kvch mentioned this pull request Mar 12, 2018

Check ephemeral ID of every Beat elastic/beats-tester#74

Merged

kvch force-pushed the fix/libbeat/monitoring-build-tags branch from 8a12185 to 5aea756 Compare March 12, 2018 18:20

ruflin reviewed Mar 13, 2018

View reviewed changes

kvch force-pushed the fix/libbeat/monitoring-build-tags branch from 5aea756 to 2e4e18b Compare March 13, 2018 09:39

kvch added 3 commits March 13, 2018 10:40

libbeat: build internal metrics on windows and linux without cgo

39a1d64

libbeat: add ephemeral id even if no internal memory metrics is reported

75474c7

fix incorrect build tags && create common file for all platforms

e18db5d

kvch force-pushed the fix/libbeat/monitoring-build-tags branch from 2e4e18b to e18db5d Compare March 13, 2018 09:40

ruflin approved these changes Mar 13, 2018

View reviewed changes

andrewkroh merged commit 11be2ad into elastic:master Mar 13, 2018

kvch mentioned this pull request Mar 22, 2018

Do not build internal metrics without CGO (#6501) #6633

Merged

kvch removed the needs_backport PR is waiting to be backported to other branches. label Mar 22, 2018

andrewkroh added the v6.3.0 label Mar 29, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not build internal metrics without CGO #6501

Do not build internal metrics without CGO #6501

kvch commented Mar 6, 2018

ruflin Mar 6, 2018

andrewkroh commented Mar 8, 2018

andrewkroh commented Mar 8, 2018 •

edited

Loading

kvch commented Mar 12, 2018

ruflin commented Mar 12, 2018

ruflin commented Mar 12, 2018

kvch commented Mar 12, 2018 •

edited

Loading

andrewkroh left a comment

andrewkroh Mar 12, 2018

andrewkroh Mar 12, 2018

kvch commented Mar 12, 2018

andrewkroh commented Mar 12, 2018

andrewkroh commented Mar 12, 2018

ruflin commented Mar 13, 2018

kvch commented Mar 13, 2018

ruflin Mar 13, 2018

ruflin commented Mar 13, 2018

kvch commented Mar 13, 2018 •

edited

Loading

ruflin left a comment

andrewkroh commented Mar 22, 2018 •

edited

Loading

kvch commented Mar 22, 2018

		@@ -1,8 +1,11 @@
		// +build !darwin,!linux,!windows darwin,!cgo linux,!cgo windows,!cgo
		// +build darwin,!cgo freebsd,!cgo openbsd,!cgo

Do not build internal metrics without CGO #6501

Do not build internal metrics without CGO #6501

Conversation

kvch commented Mar 6, 2018

ruflin Mar 6, 2018

Choose a reason for hiding this comment

andrewkroh commented Mar 8, 2018

andrewkroh commented Mar 8, 2018 • edited Loading

kvch commented Mar 12, 2018

ruflin commented Mar 12, 2018

ruflin commented Mar 12, 2018

kvch commented Mar 12, 2018 • edited Loading

andrewkroh left a comment

Choose a reason for hiding this comment

andrewkroh Mar 12, 2018

Choose a reason for hiding this comment

andrewkroh Mar 12, 2018

Choose a reason for hiding this comment

kvch commented Mar 12, 2018

andrewkroh commented Mar 12, 2018

andrewkroh commented Mar 12, 2018

ruflin commented Mar 13, 2018

kvch commented Mar 13, 2018

ruflin Mar 13, 2018

Choose a reason for hiding this comment

ruflin commented Mar 13, 2018

kvch commented Mar 13, 2018 • edited Loading

ruflin left a comment

Choose a reason for hiding this comment

andrewkroh commented Mar 22, 2018 • edited Loading

kvch commented Mar 22, 2018

andrewkroh commented Mar 8, 2018 •

edited

Loading

kvch commented Mar 12, 2018 •

edited

Loading

kvch commented Mar 13, 2018 •

edited

Loading

andrewkroh commented Mar 22, 2018 •

edited

Loading