Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Metricbeat] Avoid omitting of errors in Vsphere module and upgrade to use context.Context #12816

Merged
merged 2 commits into from
Jul 18, 2019
Merged

[Metricbeat] Avoid omitting of errors in Vsphere module and upgrade to use context.Context #12816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb3e9fa
Avoid omitting of errors in metricsets
sayden Jul 8, 2019
77bdced
Add Changelog entry
sayden Jul 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- In the elasticsearch/node_stats metricset, if xpack is enabled, make parsing of ES node load average optional as ES on Windows doesn't report load average. {pull}12866[12866]
- Ramdisk is not filtered out when collecting disk performance counters in diskio metricset {issue}12814[12814] {pull}12829[12829]
- Fix wrong uptime reporting by system/uptime metricset under Windows. {pull}12915[12915]
- Print errors that were being omitted in vSphere metricsets {pull}12816[12816]

*Packetbeat*

Expand Down
20 changes: 13 additions & 7 deletions metricbeat/module/vsphere/datastore/datastore.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,17 +76,20 @@ func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
// Fetch methods implements the data gathering and data conversion to the right
// format. It publishes the event which is then forwarded to the output. In case
// of an error set the Error field of mb.Event or simply call report.Error().
func (m *MetricSet) Fetch(reporter mb.ReporterV2) error {

ctx, cancel := context.WithCancel(context.Background())
func (m *MetricSet) Fetch(ctx context.Context, reporter mb.ReporterV2) error {
ctx, cancel := context.WithCancel(ctx)
defer cancel()

client, err := govmomi.NewClient(ctx, m.HostURL, m.Insecure)
if err != nil {
return errors.Wrap(err, "error in NewClient")
}

defer client.Logout(ctx)
defer func() {
if err := client.Logout(ctx); err != nil {
m.Logger().Debug(errors.Wrap(err, "error trying to logout from vshphere"))
}
}()

c := client.Client

Expand All @@ -98,12 +101,15 @@ func (m *MetricSet) Fetch(reporter mb.ReporterV2) error {
return errors.Wrap(err, "error in CreateContainerView")
}

defer v.Destroy(ctx)
defer func() {
if err := v.Destroy(ctx); err != nil {
m.Logger().Debug(errors.Wrap(err, "error trying to destroy view from vshphere"))
}
}()

// Retrieve summary property for all datastores
var dst []mo.Datastore
err = v.Retrieve(ctx, []string{"Datastore"}, []string{"summary"}, &dst)
if err != nil {
if err = v.Retrieve(ctx, []string{"Datastore"}, []string{"summary"}, &dst); err != nil {
return errors.Wrap(err, "error in Retrieve")
}

Expand Down
8 changes: 4 additions & 4 deletions metricbeat/module/vsphere/datastore/datastore_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ func TestFetchEventContents(t *testing.T) {
ts := model.Service.NewServer()
defer ts.Close()

f := mbtest.NewReportingMetricSetV2Error(t, getConfig(ts))
events, errs := mbtest.ReportingFetchV2Error(f)
f := mbtest.NewReportingMetricSetV2WithContext(t, getConfig(ts))
events, errs := mbtest.ReportingFetchV2WithContext(f)
if len(errs) > 0 {
t.Fatalf("Expected 0 error, had %d. %v\n", len(errs), errs)
}
Expand Down Expand Up @@ -85,9 +85,9 @@ func TestData(t *testing.T) {
ts := model.Service.NewServer()
defer ts.Close()

f := mbtest.NewReportingMetricSetV2Error(t, getConfig(ts))
f := mbtest.NewReportingMetricSetV2WithContext(t, getConfig(ts))

if err := mbtest.WriteEventsReporterV2Error(f, t, ""); err != nil {
if err := mbtest.WriteEventsReporterV2WithContext(f, t, ""); err != nil {
t.Fatal("write", err)
}
}
Expand Down
17 changes: 12 additions & 5 deletions metricbeat/module/vsphere/host/host.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,20 @@ func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
// Fetch methods implements the data gathering and data conversion to the right
// format. It publishes the event which is then forwarded to the output. In case
// of an error set the Error field of mb.Event or simply call report.Error().
func (m *MetricSet) Fetch(reporter mb.ReporterV2) error {

ctx, cancel := context.WithCancel(context.Background())
func (m *MetricSet) Fetch(ctx context.Context, reporter mb.ReporterV2) error {
ctx, cancel := context.WithCancel(ctx)
defer cancel()

client, err := govmomi.NewClient(ctx, m.HostURL, m.Insecure)
if err != nil {
return errors.Wrap(err, "error in NewClient")
}

defer client.Logout(ctx)
defer func() {
if err := client.Logout(ctx); err != nil {
m.Logger().Debug(errors.Wrap(err, "error trying to logout from vshphere"))
}
}()

c := client.Client

Expand All @@ -103,7 +106,11 @@ func (m *MetricSet) Fetch(reporter mb.ReporterV2) error {
return errors.Wrap(err, "error in CreateContainerView")
}

defer v.Destroy(ctx)
defer func() {
if err := v.Destroy(ctx); err != nil {
m.Logger().Debug(errors.Wrap(err, "error trying to destroy view from vshphere"))
}
}()

// Retrieve summary property for all hosts.
var hst []mo.HostSystem
Expand Down
8 changes: 4 additions & 4 deletions metricbeat/module/vsphere/host/host_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ func TestFetchEventContents(t *testing.T) {
ts := model.Service.NewServer()
defer ts.Close()

f := mbtest.NewReportingMetricSetV2Error(t, getConfig(ts))
events, errs := mbtest.ReportingFetchV2Error(f)
f := mbtest.NewReportingMetricSetV2WithContext(t, getConfig(ts))
events, errs := mbtest.ReportingFetchV2WithContext(f)
if len(errs) > 0 {
t.Fatalf("Expected 0 error, had %d. %v\n", len(errs), errs)
}
Expand Down Expand Up @@ -82,9 +82,9 @@ func TestData(t *testing.T) {
ts := model.Service.NewServer()
defer ts.Close()

f := mbtest.NewReportingMetricSetV2Error(t, getConfig(ts))
f := mbtest.NewReportingMetricSetV2WithContext(t, getConfig(ts))

if err := mbtest.WriteEventsReporterV2Error(f, t, ""); err != nil {
if err := mbtest.WriteEventsReporterV2WithContext(f, t, ""); err != nil {
t.Fatal("write", err)
}
}
Expand Down
22 changes: 15 additions & 7 deletions metricbeat/module/vsphere/virtualmachine/virtualmachine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,16 +86,20 @@ func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
// Fetch methods implements the data gathering and data conversion to the right
// format. It publishes the event which is then forwarded to the output. In case
// of an error set the Error field of mb.Event or simply call report.Error().
func (m *MetricSet) Fetch(reporter mb.ReporterV2) error {
ctx, cancel := context.WithCancel(context.Background())
func (m *MetricSet) Fetch(ctx context.Context, reporter mb.ReporterV2) error {
ctx, cancel := context.WithCancel(ctx)
defer cancel()

client, err := govmomi.NewClient(ctx, m.HostURL, m.Insecure)
if err != nil {
return errors.Wrap(err, "error in NewClient")
}

defer client.Logout(ctx)
defer func() {
if err := client.Logout(ctx); err != nil {
m.Logger().Debug(errors.Wrap(err, "error trying to logout from vshphere"))
}
}()

c := client.Client

Expand All @@ -117,7 +121,11 @@ func (m *MetricSet) Fetch(reporter mb.ReporterV2) error {
return errors.Wrap(err, "error in CreateContainerView")
}

defer v.Destroy(ctx)
defer func() {
if err := v.Destroy(ctx); err != nil {
m.Logger().Debug(errors.Wrap(err, "error trying to destroy view from vshphere"))
}
}()

// Retrieve summary property for all machines
var vmt []mo.VirtualMachine
Expand Down Expand Up @@ -181,7 +189,7 @@ func (m *MetricSet) Fetch(reporter mb.ReporterV2) error {
}

if vm.Summary.Vm != nil {
networkNames, err := getNetworkNames(c, vm.Summary.Vm.Reference())
networkNames, err := getNetworkNames(ctx, c, vm.Summary.Vm.Reference())
if err != nil {
m.Logger().Debug(err.Error())
} else {
Expand Down Expand Up @@ -214,8 +222,8 @@ func getCustomFields(customFields []types.BaseCustomFieldValue, customFieldsMap
return outputFields
}

func getNetworkNames(c *vim25.Client, ref types.ManagedObjectReference) ([]string, error) {
ctx, cancel := context.WithCancel(context.Background())
func getNetworkNames(ctx context.Context, c *vim25.Client, ref types.ManagedObjectReference) ([]string, error) {
ctx, cancel := context.WithCancel(ctx)
defer cancel()

var outputNetworkNames []string
Expand Down
8 changes: 4 additions & 4 deletions metricbeat/module/vsphere/virtualmachine/virtualmachine_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ func TestFetchEventContents(t *testing.T) {
ts := model.Service.NewServer()
defer ts.Close()

f := mbtest.NewReportingMetricSetV2Error(t, getConfig(ts))
events, errs := mbtest.ReportingFetchV2Error(f)
f := mbtest.NewReportingMetricSetV2WithContext(t, getConfig(ts))
events, errs := mbtest.ReportingFetchV2WithContext(f)
if len(errs) > 0 {
t.Fatalf("Expected 0 error, had %d. %v\n", len(errs), errs)
}
Expand Down Expand Up @@ -82,9 +82,9 @@ func TestData(t *testing.T) {
ts := model.Service.NewServer()
defer ts.Close()

f := mbtest.NewReportingMetricSetV2Error(t, getConfig(ts))
f := mbtest.NewReportingMetricSetV2WithContext(t, getConfig(ts))

if err := mbtest.WriteEventsReporterV2Error(f, t, ""); err != nil {
if err := mbtest.WriteEventsReporterV2WithContext(f, t, ""); err != nil {
t.Fatal("write", err)
}
}
Expand Down