Consistency in Elastic stack metricsets' code #8308

ycombinator · 2018-09-13T18:59:42Z

This PR makes error messages, reporting, and logging consistent across all metricsets for Elastic stack products, including the xpack monitoring code paths:

andrewkroh · 2018-09-13T20:46:15Z

metricbeat/module/elasticsearch/cluster_stats/cluster_stats.go

@@ -57,25 +56,35 @@ func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
 func (m *MetricSet) Fetch(r mb.ReporterV2) {
 	isMaster, err := elasticsearch.IsMaster(m.HTTP, m.HostData().SanitizedURI+clusterStatsPath)
 	if err != nil {
-		r.Error(fmt.Errorf("Error fetching master info: %s", err))
+		msg := errors.Wrap(err, "error determining if connected Elasticsearch node is master.")


Errors strings should not end with punctuation. https://github.com/golang/go/wiki/CodeReviewComments#error-strings.

andrewkroh · 2018-09-13T20:54:04Z

metricbeat/module/elasticsearch/metricset.go

 	return &MetricSet{
 		base,
 		http,
 		config.XPack,
+		log,


You might as will inline the logp.NewLogger statement.

andrewkroh · 2018-09-13T20:58:54Z

metricbeat/module/elasticsearch/index_recovery/index_recovery.go

@@ -92,11 +92,15 @@ func (m *MetricSet) Fetch(r mb.ReporterV2) {
 	}

 	if m.MetricSet.XPack {
-		eventsMappingXPack(r, m, content)
+		err = eventsMappingXPack(r, m, content)


This error is never reported. Is that intentional?

Yeah, we don't want to report X-Pack errors because they would end up in the metricbeat-* index, not the .monitoring-* index which is where all the "success" documents go.

Obviously this is something we want to change at some point, but for now we're just trying to achieve parity with existing documents in .monitoring-*.

andrewkroh · 2018-09-13T20:59:37Z

metricbeat/module/elasticsearch/index_recovery/index_recovery.go

 	} else {
 		err = eventsMapping(r, content)
 		if err != nil {
 			r.Error(err)
 		}
 	}
+
+	if err != nil {
+		m.Log.Error(err)


Why are the reporting and logging handled separately?

Mainly because we want to log x-pack and non-xpack errors but want to report only non-xpack errors. I agree, it's not very pleasant.

andrewkroh · 2018-09-13T21:01:29Z

metricbeat/module/elasticsearch/index_recovery/data.go

@@ -20,6 +20,11 @@ package index_recovery
 import (
 	"encoding/json"

+	"github.com/elastic/beats/metricbeat/helper/elastic"


This import should be grouped with the other github.com/elastic imports.

andrewkroh · 2018-09-13T21:02:58Z

metricbeat/module/elasticsearch/index/index.go

+	err = eventsMapping(r, *info, content)
+	if err != nil {
+		r.Error(err)
+		m.Log.Error(err)


This seems like a common pattern. I wonder if it would make sense to have the Metricbeat framework log any error that is reported by a metricset.

I was wondering this too but I have a fairly narrow and relatively recent view in Metricbeat. I'll defer to folks who've worked more broadly in it than me for their opinion: @jsoriano @ruflin, your thoughts?

It would definitively nice to make this more generic.

Best in a follow up PR.

andrewkroh · 2018-09-13T21:03:57Z

metricbeat/module/elasticsearch/cluster_stats/cluster_stats.go

 		return
 	}

 	if m.MetricSet.XPack {
-		eventMappingXPack(r, m, content)
+		err = eventMappingXPack(r, m, content)


This error is never reported. Is that intentional?

Yes, xpack data structure cannot make sense of the errors.

andrewkroh · 2018-09-13T21:10:54Z

metricbeat/module/elasticsearch/elasticsearch.go

@@ -32,6 +32,9 @@ import (
 // Global clusterIdCache. Assumption is that the same node id never can belong to a different cluster id
 var clusterIDCache = map[string]string{}

+// ModuleName is the ame of this module


s/ame/name/

And godocs should have proper punctuation. Wouldn't it be nicer if the descriptions here ended in punctuation. 😄

andrewkroh · 2018-09-13T21:20:56Z

metricbeat/module/elasticsearch/index/data.go

@@ -58,16 +59,14 @@ func eventsMapping(r mb.ReporterV2, info elasticsearch.Info, content []byte) err

 	err := json.Unmarshal(content, &indicesStruct)
 	if err != nil {
-		r.Error(err)
-		return err
+		return errors.Wrap(err, "failure parsing Elasticsearch Stats API response")
 	}

 	var errors multierror.Errors
 	for name, index := range indicesStruct.Indices {
 		event := mb.Event{}
 		event.MetricSetFields, err = schema.Apply(index)


The event can also contain an error. I think it would make sense to store/report the error alongside the data that it's associated with.

I think this is now solved with the more resent commits?

ycombinator · 2018-09-13T22:51:29Z

Good stuff, @andrewkroh. Appreciate the early feedback so I don't have to make the same fixes in a number of places later 😄!

ycombinator · 2018-09-19T00:03:10Z

CI is failing because of unrelated flaky test: #8208

ycombinator · 2018-09-29T01:15:29Z

@ruflin @andrewkroh The CI intake job is failing with this error:

18:08:40 ./module/elasticsearch/elasticsearch_integration_test.go
18:08:40 Code differs from goimports' style ^
18:08:40 ../libbeat/scripts/Makefile:115: recipe for target 'check' failed

I checked the imports in elasticsearch_integration_test.go and I'm not seeing anything odd. I didn't even mess with the imports in that file in is PR 😄 Could you help me figure out what I'm missing? Thanks.

ruflin · 2018-10-01T08:54:44Z

Can you try to run make fmt to see if you get a diff?

…#8497) This PR makes the Metricbeat `logstash` module code consistent with other Elastic stack modules by: * using `FetchContent()` instead of `FetchJSON()` to fetch data from LS APIs before passing it to the event mapping function. * adding unit tests. Further consistency around event reporting and error handling will be achieved in #8308.

…elastic#8497) This PR makes the Metricbeat `logstash` module code consistent with other Elastic stack modules by: * using `FetchContent()` instead of `FetchJSON()` to fetch data from LS APIs before passing it to the event mapping function. * adding unit tests. Further consistency around event reporting and error handling will be achieved in elastic#8308. (cherry picked from commit 909d789)

ycombinator · 2018-10-01T19:14:41Z

Can you try to run make fmt to see if you get a diff?

@ruflin I did get a diff but it was in a file completely unrelated to this PR or the error shown by the intake job in CI. Still I tried to commit that diff in da30d94 but it didn't help either.

ruflin · 2018-10-01T19:15:23Z

Which go version do you have locally?

ycombinator · 2018-10-01T19:16:29Z

1.11 😬 Let me try downgrading to 1.10.

ruflin · 2018-10-01T19:17:03Z

Yes, 1.10 will do different indentations I learned today.

ycombinator · 2018-10-23T07:53:06Z

@ruflin Other PR (#8592) is merged into master and this PR has been rebased on master now. Ready for your 👀 again.

ruflin

I like the error logging / reporting model we have now in the Elasticsearch and Kibana Module. We should probably make that our standard when changing other modules.

ruflin · 2018-10-25T14:14:03Z

metricbeat/module/elasticsearch/ccr/data.go

 			event.MetricSetFields, err = schema.Apply(shard)
 			if err != nil {
-				errors = append(errors, err)
+				event.Error = errors.Wrap(err, "failure applying shard schema")


I like that we report partial documents events even on failure. We should probably document this somewhere.

ruflin · 2018-10-25T14:15:37Z

metricbeat/module/elasticsearch/index/data.go

@@ -58,16 +59,14 @@ func eventsMapping(r mb.ReporterV2, info elasticsearch.Info, content []byte) err

 	err := json.Unmarshal(content, &indicesStruct)
 	if err != nil {
-		r.Error(err)
-		return err
+		return errors.Wrap(err, "failure parsing Elasticsearch Stats API response")
 	}

 	var errors multierror.Errors
 	for name, index := range indicesStruct.Indices {
 		event := mb.Event{}
 		event.MetricSetFields, err = schema.Apply(index)


I think this is now solved with the more resent commits?

ruflin · 2018-10-25T14:17:25Z

metricbeat/module/elasticsearch/index/index.go

+	err = eventsMapping(r, *info, content)
+	if err != nil {
+		r.Error(err)
+		m.Log.Error(err)


It would definitively nice to make this more generic.

Best in a follow up PR.

ruflin · 2018-10-25T14:18:18Z

metricbeat/module/elasticsearch/index_recovery/data_xpack.go

@@ -38,23 +41,23 @@ func eventsMappingXPack(r mb.ReporterV2, m *MetricSet, content []byte) error {
 	for indexName, indexData := range data {
 		indexData, ok := indexData.(map[string]interface{})
 		if !ok {
-			continue
+			return fmt.Errorf("%v is not a map", indexName)


Let's move forward with the way it is at the moment and fix it if it breaks.

* Consistent error handling in elasticsearch/cluster_stats metricset * Consistent error handling in elasticsearch/index_recovery metricset * Remove punctuation from error messages * Inline variable * Reordering imports * Adding periods to the ends of godoc comments * More consistency cleanup * More consistency fixes * More consistency fixes * Fixing API path * Consistent code in elasticsearch/pending_tasks metricset * More code consistency * Consistent code in elasticsearch/shard metricset * Consistent code in elasticsearch/ccr metricset * Making code in kibana module metricsets consistent * Making fully-qualified metricset name consistent * Use elasticsearch.ModuleName constant instead of string literal * Making logstash/node metricset code consistent * Making the logstash/node_stats metricset code consistent * Refactoring common reporting and error pattern into helper function * Updating unit tests * Changes from running make fmt * Re-running make fmt after downgrading golang to 10.3 * Fixes due to make update * Updating LS module integration tests * Update kibana/status integration test * Report error with event (for non x-pack path) * Attaching errors to events * Fixing imports in integration tests * Fixing error (cherry picked from commit 3b2399d)

…de (#8755) Cherry-pick of PR #8308 to 6.x branch. Original message: This PR makes error messages, reporting, and logging consistent across all metricsets for Elastic stack products, including the xpack monitoring code paths: * [x] `elasticsearch/ccr` * [x] `elasticsearch/cluster_stats` * [x] `elasticsearch/index` * [x] `elasticsearch/index_recovery` * [x] `elasticsearch/index_summary` * [x] `elasticsearch/ml_job` * [x] `elasticsearch/node` * [x] `elasticsearch/node_stats` * [x] `elasticsearch/pending_tasks` * [x] `elasticsearch/shard` * [x] `kibana/status` * [x] `kibana/stats` * [x] `logstash/node` * [x] `logstash/node_stats`

The cleanup in #8308 introduced a regression which caused the `xpack.enabled` flag in the `kibana` module to stop having any effect. This PR fixes that issue by reverting the troublesome bits from #8308, ensuring that the struct field for the parsed configuration setting is exported.

The cleanup in elastic#8308 introduced a regression which caused the `xpack.enabled` flag in the `kibana` module to stop having any effect. This PR fixes that issue by reverting the troublesome bits from elastic#8308, ensuring that the struct field for the parsed configuration setting is exported. (cherry picked from commit 8f37eec)

Cherry-pick of PR #9642 to 6.x branch. Original message: The cleanup in #8308 introduced a regression which caused the `xpack.enabled` flag in the `kibana` module to stop having any effect. This PR fixes that issue by reverting the troublesome bits from #8308, ensuring that the struct field for the parsed configuration setting is exported.

ycombinator added in progress Pull request is currently in progress. Metricbeat Metricbeat needs_backport PR is waiting to be backported to other branches. v7.0.0-alpha1 v6.5.0 labels Sep 13, 2018

ycombinator force-pushed the metricbeat-xpack-log-errors branch 2 times, most recently from c2bbcae to 5b22496 Compare September 13, 2018 20:31

andrewkroh reviewed Sep 13, 2018

View reviewed changes

ycombinator force-pushed the metricbeat-xpack-log-errors branch from b453a84 to ceed913 Compare September 18, 2018 15:46

ycombinator changed the title ~~Consistency in Elastic stack metricsets' error handling~~ Consistency in Elastic stack metricsets' code Sep 18, 2018

ycombinator force-pushed the metricbeat-xpack-log-errors branch 2 times, most recently from 6a8c780 to a29be7d Compare September 27, 2018 20:26

ycombinator mentioned this pull request Sep 29, 2018

Make logstash module code consistent with other Elastic stack modules #8497

Merged

ycombinator force-pushed the metricbeat-xpack-log-errors branch 3 times, most recently from 61c68c5 to ae9e1e8 Compare September 29, 2018 11:15

ycombinator mentioned this pull request Oct 1, 2018

Cherry-pick #8497 to 6.x: Make logstash module code consistent with other Elastic stack modules #8525

Merged

ycombinator force-pushed the metricbeat-xpack-log-errors branch from ae9e1e8 to 189aefd Compare October 1, 2018 19:02

ycombinator force-pushed the metricbeat-xpack-log-errors branch from b5b85d3 to 9824433 Compare October 2, 2018 03:48

ycombinator added the review label Oct 2, 2018

ycombinator added 10 commits October 23, 2018 00:51

Updating unit tests

acf6930

Changes from running make fmt

db6a2d2

Re-running make fmt after downgrading golang to 10.3

12a4015

Fixes due to make update

0befa82

Updating LS module integration tests

a864b21

Update kibana/status integration test

6b6bb3c

Report error with event (for non x-pack path)

5291885

Attaching errors to events

35447b1

Fixing imports in integration tests

3be2ae3

Fixing error

ab3a9ce

ycombinator force-pushed the metricbeat-xpack-log-errors branch from b38e397 to ab3a9ce Compare October 23, 2018 07:51

ruflin approved these changes Oct 25, 2018

View reviewed changes

ycombinator merged commit 3b2399d into elastic:master Oct 25, 2018

ycombinator deleted the metricbeat-xpack-log-errors branch October 25, 2018 21:23

ycombinator mentioned this pull request Oct 25, 2018

Cherry-pick #8308 to 6.x: Consistency in Elastic stack metricsets' code #8755

Merged

14 tasks

ycombinator removed the needs_backport PR is waiting to be backported to other branches. label Oct 25, 2018

ycombinator added the v6.6.0 label Oct 25, 2018

ycombinator mentioned this pull request Dec 18, 2018

Export field for xpack.enabled setting #9642

Merged

ycombinator mentioned this pull request Dec 19, 2018

Cherry-pick #9642 to 6.x: Export field for xpack.enabled setting #9655

Merged

erik-stephens mentioned this pull request Jan 3, 2019

Unable to metricbeat elasticsearch when xpack.watcher disabled #9875

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consistency in Elastic stack metricsets' code #8308

Consistency in Elastic stack metricsets' code #8308

ycombinator commented Sep 13, 2018 •

edited

andrewkroh Sep 13, 2018

andrewkroh Sep 13, 2018

andrewkroh Sep 13, 2018

ycombinator Sep 13, 2018

ycombinator Sep 13, 2018

andrewkroh Sep 13, 2018

ycombinator Sep 13, 2018

andrewkroh Sep 13, 2018

andrewkroh Sep 13, 2018

ycombinator Sep 13, 2018 •

edited

ruflin Oct 25, 2018

andrewkroh Sep 13, 2018

ruflin Oct 2, 2018

andrewkroh Sep 13, 2018

andrewkroh Sep 13, 2018

ruflin Oct 25, 2018

ycombinator commented Sep 13, 2018

ycombinator commented Sep 19, 2018

ycombinator commented Sep 29, 2018 •

edited

ruflin commented Oct 1, 2018

ycombinator commented Oct 1, 2018

ruflin commented Oct 1, 2018

ycombinator commented Oct 1, 2018

ruflin commented Oct 1, 2018

ycombinator commented Oct 23, 2018

ruflin left a comment

ruflin Oct 25, 2018

ruflin Oct 25, 2018

ruflin Oct 25, 2018

ruflin Oct 25, 2018

Consistency in Elastic stack metricsets' code #8308

Consistency in Elastic stack metricsets' code #8308

Conversation

ycombinator commented Sep 13, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ycombinator Sep 13, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ycombinator commented Sep 13, 2018

ycombinator commented Sep 19, 2018

ycombinator commented Sep 29, 2018 • edited

ruflin commented Oct 1, 2018

ycombinator commented Oct 1, 2018

ruflin commented Oct 1, 2018

ycombinator commented Oct 1, 2018

ruflin commented Oct 1, 2018

ycombinator commented Oct 23, 2018

ruflin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ycombinator commented Sep 13, 2018 •

edited

ycombinator Sep 13, 2018 •

edited

ycombinator commented Sep 29, 2018 •

edited