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.

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

Use common host parser in vsphere module #26904

Merged
merged 5 commits into from
Jul 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Added `statsd.mappings` configuration for Statsd module {pull}26220[26220]
- Added Airflow lightweight module {pull}26220[26220]
- Add state_job metricset to Kubernetes module{pull}26479[26479]
- Recover service.address field in vsphere module {issue}26902[26902] {pull}26904[26904]

*Packetbeat*

Expand Down
10 changes: 5 additions & 5 deletions metricbeat/module/vsphere/datastore/_meta/data.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@
"period": 10000
},
"service": {
"address": "http://127.0.0.1:51027/sdk",
"address": "127.0.0.1:33365",
"type": "vsphere"
},
"vsphere": {
"datastore": {
"capacity": {
"free": {
"bytes": 267958476800
"bytes": 37120094208
},
"total": {
"bytes": 484736266240
"bytes": 74686664704
},
"used": {
"bytes": 216777789440,
"pct": 0.44720769733509097
"bytes": 37566570496,
"pct": 0.502988996026061
}
},
"fstype": "local",
Expand Down
32 changes: 7 additions & 25 deletions metricbeat/module/vsphere/datastore/datastore.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ package datastore

import (
"context"
"net/url"

"github.com/pkg/errors"

"github.com/elastic/beats/v7/libbeat/common"
"github.com/elastic/beats/v7/metricbeat/mb"
"github.com/elastic/beats/v7/metricbeat/module/vsphere"

"github.com/vmware/govmomi"
"github.com/vmware/govmomi/view"
Expand All @@ -33,41 +33,23 @@ import (

func init() {
mb.Registry.MustAddMetricSet("vsphere", "datastore", New,
mb.WithHostParser(vsphere.HostParser),
mb.DefaultMetricSet(),
)
}

// MetricSet type defines all fields of the MetricSet
// MetricSet type defines all fields of the MetricSet.
type MetricSet struct {
mb.BaseMetricSet
HostURL *url.URL
Insecure bool
*vsphere.MetricSet
}

// New create a new instance of the MetricSet
// New creates a new instance of the MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
config := struct {
Username string `config:"username"`
Password string `config:"password"`
Insecure bool `config:"insecure"`
}{}

if err := base.Module().UnpackConfig(&config); err != nil {
return nil, err
}

u, err := url.Parse(base.HostData().URI)
ms, err := vsphere.NewMetricSet(base)
if err != nil {
return nil, err
}

u.User = url.UserPassword(config.Username, config.Password)

return &MetricSet{
BaseMetricSet: base,
HostURL: u,
Insecure: config.Insecure,
}, nil
return &MetricSet{ms}, nil
}

// Fetch methods implements the data gathering and data conversion to the right
Expand Down
15 changes: 9 additions & 6 deletions metricbeat/module/vsphere/host/_meta/data.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
{
"@timestamp": "2017-10-12T08:05:34.853Z",
"beat": {
"hostname": "host.example.com",
"name": "host.example.com"
"event": {
"dataset": "vsphere.host",
"duration": 115000,
"module": "vsphere"
},
"metricset": {
"host": "http://127.0.0.1:43843/sdk",
"module": "vsphere",
"name": "host",
"rtt": 115
"period": 10000
},
"service": {
"address": "127.0.0.1:38517",
"type": "vsphere"
},
"vsphere": {
"host": {
Expand Down
32 changes: 7 additions & 25 deletions metricbeat/module/vsphere/host/host.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ package host
import (
"context"
"fmt"
"net/url"
"strings"

"github.com/pkg/errors"

"github.com/elastic/beats/v7/libbeat/common"
"github.com/elastic/beats/v7/metricbeat/mb"
"github.com/elastic/beats/v7/metricbeat/module/vsphere"

"github.com/vmware/govmomi"
"github.com/vmware/govmomi/property"
Expand All @@ -38,41 +38,23 @@ import (

func init() {
mb.Registry.MustAddMetricSet("vsphere", "host", New,
mb.WithHostParser(vsphere.HostParser),
mb.DefaultMetricSet(),
)
}

// MetricSet type defines all fields of the MetricSet
// MetricSet type defines all fields of the MetricSet.
type MetricSet struct {
mb.BaseMetricSet
HostURL *url.URL
Insecure bool
*vsphere.MetricSet
}

// New create a new instance of the MetricSet
// New creates a new instance of the MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
config := struct {
Username string `config:"username"`
Password string `config:"password"`
Insecure bool `config:"insecure"`
}{}

if err := base.Module().UnpackConfig(&config); err != nil {
return nil, err
}

u, err := url.Parse(base.HostData().URI)
ms, err := vsphere.NewMetricSet(base)
if err != nil {
return nil, err
}

u.User = url.UserPassword(config.Username, config.Password)

return &MetricSet{
BaseMetricSet: base,
HostURL: u,
Insecure: config.Insecure,
}, nil
return &MetricSet{ms}, nil
}

// Fetch methods implements the data gathering and data conversion to the right
Expand Down
59 changes: 59 additions & 0 deletions metricbeat/module/vsphere/metricset.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package vsphere

import (
"net/url"

"github.com/elastic/beats/v7/metricbeat/mb"
"github.com/elastic/beats/v7/metricbeat/mb/parse"
)

var HostParser = parse.URLHostParserBuilder{
DefaultScheme: "https",
DefaultPath: "/sdk",
}.Build()

// MetricSet type defines all fields of the MetricSet.
type MetricSet struct {
mb.BaseMetricSet
Insecure bool
HostURL *url.URL
}

// NewMetricSet creates a new instance of the MetricSet.
func NewMetricSet(base mb.BaseMetricSet) (*MetricSet, error) {
config := struct {
Insecure bool `config:"insecure"`
}{}

if err := base.Module().UnpackConfig(&config); err != nil {
return nil, err
}

u, err := url.Parse(base.HostData().URI)
if err != nil {
return nil, err
}

return &MetricSet{
BaseMetricSet: base,
HostURL: u,
Insecure: config.Insecure,
}, nil
}
6 changes: 6 additions & 0 deletions metricbeat/module/vsphere/test_vsphere.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ def test_datastore(self):

self.assertCountEqual(self.de_dot(VSPHERE_FIELDS), evt.keys(), evt)

self.assertEqual(evt["service"]["address"], self.get_hosts()[0])

self.assert_fields_are_documented(evt)

@unittest.skipUnless(metricbeat.INTEGRATION_TESTS, "integration test")
Expand Down Expand Up @@ -71,6 +73,8 @@ def test_host(self):

self.assertCountEqual(self.de_dot(VSPHERE_FIELDS), evt.keys(), evt)

self.assertEqual(evt["service"]["address"], self.get_hosts()[0])

self.assert_fields_are_documented(evt)

@unittest.skipUnless(metricbeat.INTEGRATION_TESTS, "integration test")
Expand Down Expand Up @@ -100,4 +104,6 @@ def test_virtualmachine(self):

self.assertCountEqual(self.de_dot(VSPHERE_FIELDS), evt.keys(), evt)

self.assertEqual(evt["service"]["address"], self.get_hosts()[0])

self.assert_fields_are_documented(evt)
5 changes: 1 addition & 4 deletions metricbeat/module/vsphere/virtualmachine/_meta/data.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"period": 10000
},
"service": {
"address": "http://127.0.0.1:37231/sdk",
"address": "127.0.0.1:39149",
"type": "vsphere"
},
"vsphere": {
Expand Down Expand Up @@ -43,9 +43,6 @@
}
},
"name": "ha-host_VM0",
"network_names": [
"VM Network"
],
"os": "otherGuest"
}
}
Expand Down
33 changes: 12 additions & 21 deletions metricbeat/module/vsphere/virtualmachine/virtualmachine.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ package virtualmachine
import (
"context"
"fmt"
"net/url"
"strings"

"github.com/elastic/beats/v7/libbeat/common"
"github.com/elastic/beats/v7/metricbeat/mb"
"github.com/elastic/beats/v7/metricbeat/module/vsphere"

"github.com/pkg/errors"
"github.com/vmware/govmomi"
Expand All @@ -38,44 +38,35 @@ import (

func init() {
mb.Registry.MustAddMetricSet("vsphere", "virtualmachine", New,
mb.WithHostParser(vsphere.HostParser),
mb.DefaultMetricSet(),
)
}

// MetricSet type defines all fields of the MetricSet
// MetricSet type defines all fields of the MetricSet.
type MetricSet struct {
mb.BaseMetricSet
HostURL *url.URL
Insecure bool
*vsphere.MetricSet
GetCustomFields bool
}

// New create a new instance of the MetricSet
// New creates a new instance of the MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
ms, err := vsphere.NewMetricSet(base)
if err != nil {
return nil, err
}

config := struct {
Username string `config:"username"`
Password string `config:"password"`
Insecure bool `config:"insecure"`
GetCustomFields bool `config:"get_custom_fields"`
GetCustomFields bool `config:"get_custom_fields"`
}{
GetCustomFields: false,
}

if err := base.Module().UnpackConfig(&config); err != nil {
return nil, err
}

u, err := url.Parse(base.HostData().URI)
if err != nil {
return nil, err
}

u.User = url.UserPassword(config.Username, config.Password)

return &MetricSet{
BaseMetricSet: base,
HostURL: u,
Insecure: config.Insecure,
MetricSet: ms,
GetCustomFields: config.GetCustomFields,
}, nil
}
Expand Down