Skip to content

Commit

Permalink
Log any FQDN lookup errors and fallback to OS-reported hostname (#34946)
Browse files Browse the repository at this point in the history 
* Log any FQDN lookup errors, fallback to OS hostname, and move on.

* Implement fallback logic

* Bumping up go-sysinfo dependency version

* Update call to host.ReportInfo

* Better log message

* Bumping up version on elastic-agent-system-metrics dependency

* Updating NOTICE.txt

* Log FQDN lookup failure as warning

* Move FQDN initialization to after logging has been configured

* Better log message

* Add metric + test

* Update NOTICE.txt

* Use a single namespace for all add_host_metadata processor instances' monitoring

* Fixing imports

* Create monitoring registry only once

* Check errors

(cherry picked from commit 895505c)

# Conflicts:
#	NOTICE.txt
#	go.mod
#	go.sum
#	libbeat/cmd/instance/beat.go
#	libbeat/processors/add_host_metadata/add_host_metadata.go
#	libbeat/processors/add_host_metadata/add_host_metadata_test.go
  • Loading branch information
@ycombinator @mergify
ycombinator authored and mergify[bot] committed Mar 30, 2023
1 parent fcdd3f9 commit 0e5689c
Show file tree
Hide file tree
Showing 6 changed files with 266 additions and 6 deletions.
47 changes: 47 additions & 0 deletions NOTICE.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10414,11 +10414,19 @@ these terms.

--------------------------------------------------------------------------------
Dependency : github.com/elastic/elastic-agent-system-metrics
<<<<<<< HEAD
Version: v0.4.6
Licence type (autodetected): Apache-2.0
--------------------------------------------------------------------------------

Contents of probable licence file $GOMODCACHE/github.com/elastic/elastic-agent-system-metrics@v0.4.6/LICENSE.txt:
=======
Version: v0.5.1-0.20230328163318-a87a0b315c42
Licence type (autodetected): Apache-2.0
--------------------------------------------------------------------------------

Contents of probable licence file $GOMODCACHE/github.com/elastic/elastic-agent-system-metrics@v0.5.1-0.20230328163318-a87a0b315c42/LICENSE.txt:
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))

Apache License
Version 2.0, January 2004
Expand Down Expand Up @@ -12354,11 +12362,19 @@ Contents of probable licence file $GOMODCACHE/github.com/elastic/go-structform@v

--------------------------------------------------------------------------------
Dependency : github.com/elastic/go-sysinfo
<<<<<<< HEAD
Version: v1.9.0
Licence type (autodetected): Apache-2.0
--------------------------------------------------------------------------------

Contents of probable licence file $GOMODCACHE/github.com/elastic/go-sysinfo@v1.9.0/LICENSE.txt:
=======
Version: v1.9.1-0.20230328042007-6dcfe88b8359
Licence type (autodetected): Apache-2.0
--------------------------------------------------------------------------------

Contents of probable licence file $GOMODCACHE/github.com/elastic/go-sysinfo@v1.9.1-0.20230328042007-6dcfe88b8359/LICENSE.txt:
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))


Apache License
Expand Down Expand Up @@ -13472,6 +13488,37 @@ Contents of probable licence file $GOMODCACHE/github.com/fearful-symmetry/gorapl
limitations under the License.


--------------------------------------------------------------------------------
Dependency : github.com/foxcpp/go-mockdns
Version: v0.0.0-20201212160233-ede2f9158d15
Licence type (autodetected): MIT
--------------------------------------------------------------------------------

Contents of probable licence file $GOMODCACHE/github.com/foxcpp/go-mockdns@v0.0.0-20201212160233-ede2f9158d15/LICENSE:

MIT License

Copyright © 2019 Max Mazurov <fox.cpp@disroot.org>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


--------------------------------------------------------------------------------
Dependency : github.com/elastic/fsevents
Version: v0.0.0-20181029231046-e1d381a4d270
Expand Down
11 changes: 11 additions & 0 deletions go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,11 @@ require (
github.com/elastic/go-perf v0.0.0-20191212140718-9c656876f595
github.com/elastic/go-seccomp-bpf v1.3.0
github.com/elastic/go-structform v0.0.10
<<<<<<< HEAD
github.com/elastic/go-sysinfo v1.9.0
=======
github.com/elastic/go-sysinfo v1.9.1-0.20230328042007-6dcfe88b8359
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))
github.com/elastic/go-ucfg v0.8.6
github.com/elastic/gosigar v0.14.2
github.com/fatih/color v1.13.0
Expand Down Expand Up @@ -193,12 +197,19 @@ require (
github.com/awslabs/kinesis-aggregation/go/v2 v2.0.0-20220623125934-28468a6701b5
github.com/elastic/bayeux v1.0.5
github.com/elastic/elastic-agent-autodiscover v0.5.0
<<<<<<< HEAD
github.com/elastic/elastic-agent-libs v0.2.16
github.com/elastic/elastic-agent-shipper-client v0.4.0
github.com/elastic/elastic-agent-system-metrics v0.4.6
=======
github.com/elastic/elastic-agent-libs v0.3.3
github.com/elastic/elastic-agent-shipper-client v0.5.1-0.20230228231646-f04347b666f3
github.com/elastic/elastic-agent-system-metrics v0.5.1-0.20230328163318-a87a0b315c42
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))
github.com/elastic/go-elasticsearch/v8 v8.2.0
github.com/elastic/mito v0.0.0-20230302005114-1dda06e81678
github.com/elastic/toutoumomoma v0.0.0-20221026030040-594ef30cb640
github.com/foxcpp/go-mockdns v0.0.0-20201212160233-ede2f9158d15
github.com/google/cel-go v0.13.0
github.com/googleapis/gax-go/v2 v2.6.0
github.com/gorilla/handlers v1.5.1
Expand Down
15 changes: 15 additions & 0 deletions go.sum
View file
Original file line number Diff line number Diff line change
Expand Up @@ -614,12 +614,21 @@ github.com/elastic/elastic-agent-autodiscover v0.5.0/go.mod h1:p3MSf9813JEnolCTD
github.com/elastic/elastic-agent-client/v7 v7.0.3 h1:YqZPnO7Z9rlj25sFZEUaxGGK3mZR4v0uSOcfO8GRv7s=
github.com/elastic/elastic-agent-client/v7 v7.0.3/go.mod h1:cHviLpA5fAwMbfBIHBVNl16qp90bO7pKHMAQaG+9raU=
github.com/elastic/elastic-agent-libs v0.2.11/go.mod h1:chO3rtcLyGlKi9S0iGVZhYCzDfdDsAQYBc+ui588AFE=
<<<<<<< HEAD
github.com/elastic/elastic-agent-libs v0.2.16 h1:31/VlnRp2ko0CMg+sm7b/u3vOPIlFXgMkJn/8uS6EbU=
github.com/elastic/elastic-agent-libs v0.2.16/go.mod h1:0J9lzJh+BjttIiVjYDLncKYCEWUUHiiqnuI64y6C6ss=
github.com/elastic/elastic-agent-shipper-client v0.4.0 h1:nsTJF9oo4RHLl+zxFUZqNHaE86C6Ba5aImfegcEf6Sk=
github.com/elastic/elastic-agent-shipper-client v0.4.0/go.mod h1:OyI2W+Mv3JxlkEF3OeT7K0dbuxvwew8ke2Cf4HpLa9Q=
github.com/elastic/elastic-agent-system-metrics v0.4.6 h1:SDiI62M68eNcpnihHkHfQ/Aqxh4eSf5zuoD9yBv2MPc=
github.com/elastic/elastic-agent-system-metrics v0.4.6/go.mod h1:vTqfhtj83LlPKbusEwrEywZv13nhPExwINB3PkeRQeo=
=======
github.com/elastic/elastic-agent-libs v0.3.3 h1:iE8XhqQ0zRBLba+eu6ScZED0DYcVP/r2JvjcVoOkxic=
github.com/elastic/elastic-agent-libs v0.3.3/go.mod h1:nRkcK96PSJfK232cJRx17n9+/MVAIOzs5ghZdzXJAMo=
github.com/elastic/elastic-agent-shipper-client v0.5.1-0.20230228231646-f04347b666f3 h1:sb+25XJn/JcC9/VL8HX4r4QXSUq4uTNzGS2kxOE7u1U=
github.com/elastic/elastic-agent-shipper-client v0.5.1-0.20230228231646-f04347b666f3/go.mod h1:rWarFM7qYxJKsi9WcV6ONcFjH/NA3niDNpTxO+8/GVI=
github.com/elastic/elastic-agent-system-metrics v0.5.1-0.20230328163318-a87a0b315c42 h1:oJQbTUpFlD/CXKw6N5gWNOjfofwStp+nR49m1wKv6zc=
github.com/elastic/elastic-agent-system-metrics v0.5.1-0.20230328163318-a87a0b315c42/go.mod h1:jBVJTZFtoxQkGmqutGGRSulkRhjgIO2PY059m+HLG4k=
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))
github.com/elastic/elastic-transport-go/v8 v8.1.0 h1:NeqEz1ty4RQz+TVbUrpSU7pZ48XkzGWQj02k5koahIE=
github.com/elastic/elastic-transport-go/v8 v8.1.0/go.mod h1:87Tcz8IVNe6rVSLdBux1o/PEItLtyabHU3naC7IoqKI=
github.com/elastic/fsevents v0.0.0-20181029231046-e1d381a4d270 h1:cWPqxlPtir4RoQVCpGSRXmLqjEHpJKbR60rxh1nQZY4=
Expand Down Expand Up @@ -647,8 +656,13 @@ github.com/elastic/go-structform v0.0.9/go.mod h1:CZWf9aIRYY5SuKSmOhtXScE5uQiLZN
github.com/elastic/go-structform v0.0.10 h1:oy08o/Ih2hHTkNcRY/1HhaYvIp5z6t8si8gnCJPDo1w=
github.com/elastic/go-structform v0.0.10/go.mod h1:CZWf9aIRYY5SuKSmOhtXScE5uQiLZNqAFnwKR4OrIM4=
github.com/elastic/go-sysinfo v1.7.1/go.mod h1:i1ZYdU10oLNfRzq4vq62BEwD2fH8KaWh6eh0ikPT9F0=
<<<<<<< HEAD
github.com/elastic/go-sysinfo v1.9.0 h1:usICqY/Nw4Mpn9f4LdtpFrKxXroJDe81GaxxUlCckIo=
github.com/elastic/go-sysinfo v1.9.0/go.mod h1:eBD1wEGVaRnRLGecc9iG1z8eOv5HnEdz9+nWd8UAxcE=
=======
github.com/elastic/go-sysinfo v1.9.1-0.20230328042007-6dcfe88b8359 h1:qSCKykLGlUcO/wzq3xH+wtPHM2KCpQnqXOKClSg5K2w=
github.com/elastic/go-sysinfo v1.9.1-0.20230328042007-6dcfe88b8359/go.mod h1:j/gGAinRS+z3loQ/1pO+s9pCyQsna8U13kqhF1Aa0fg=
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))
github.com/elastic/go-ucfg v0.8.5/go.mod h1:4E8mPOLSUV9hQ7sgLEJ4bvt0KhMuDJa8joDT2QGAEKA=
github.com/elastic/go-ucfg v0.8.6 h1:stUeyh2goTgGX+/wb9gzKvTv0YB0231LTpKUgCKj4U0=
github.com/elastic/go-ucfg v0.8.6/go.mod h1:4E8mPOLSUV9hQ7sgLEJ4bvt0KhMuDJa8joDT2QGAEKA=
Expand Down Expand Up @@ -705,6 +719,7 @@ github.com/form3tech-oss/jwt-go v3.2.3+incompatible h1:7ZaBxOI7TMoYBfyA3cQHErNNy
github.com/form3tech-oss/jwt-go v3.2.3+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
github.com/fortytw2/leaktest v1.3.0 h1:u8491cBMTQ8ft8aeV+adlcytMZylmA5nnwwkRZjI8vw=
github.com/fortytw2/leaktest v1.3.0/go.mod h1:jDsjWgpAGjm2CA7WthBh/CdZYEPF31XHquHwclZch5g=
github.com/foxcpp/go-mockdns v0.0.0-20201212160233-ede2f9158d15 h1:nLPjjvpUAODOR6vY/7o0hBIk8iTr19Fvmf8aFx/kC7A=
github.com/foxcpp/go-mockdns v0.0.0-20201212160233-ede2f9158d15/go.mod h1:tPg4cp4nseejPd+UKxtCVQ2hUxNTZ7qQZJa7CLriIeo=
github.com/franela/goblin v0.0.0-20200105215937-c9ffbefa60db/go.mod h1:7dvUGVsVBjqR7JHJk0brhHOZYGmfBYOrK0ZhYMEtBr4=
github.com/franela/goreq v0.0.0-20171204163338-bcd34c9993f8/go.mod h1:ZhphrRTfi2rbfLwlschooIH4+wKKDR4Pdxhh+TRoA20=
Expand Down
21 changes: 21 additions & 0 deletions libbeat/cmd/instance/beat.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,12 @@ func (b *Beat) registerMetrics() {
monitoring.NewString(beatRegistry, "name").Set(b.Info.Name)

// state.host
<<<<<<< HEAD
monitoring.NewFunc(stateRegistry, "host", host.ReportInfo, monitoring.Report)
=======
stateRegistry := monitoring.GetNamespace("state").GetRegistry()
monitoring.NewFunc(stateRegistry, "host", host.ReportInfo(hostname), monitoring.Report)
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))
}

// TestConfig check all settings are ok and the beat can be run
Expand Down Expand Up @@ -731,6 +736,22 @@ func (b *Beat) configure(settings Settings) error {

logp.Info("Beat ID: %v", b.Info.ID)

// Try to get the host's FQDN and set it.
h, err := sysinfo.Host()
if err != nil {
return fmt.Errorf("failed to get host information: %w", err)
}

fqdn, err := h.FQDN()
if err != nil {
// FQDN lookup is "best effort". We log the error, fallback to
// the OS-reported hostname, and move on.
logp.Warn("unable to lookup FQDN: %s, using hostname = %s as FQDN", err.Error(), b.Info.Hostname)
b.Info.FQDN = b.Info.Hostname
} else {
b.Info.FQDN = fqdn
}

// initialize config manager
b.Manager, err = management.Factory(b.Config.Management)(b.Config.Management, reload.RegisterV2, b.Beat.Info.ID)
if err != nil {
Expand Down
51 changes: 45 additions & 6 deletions libbeat/processors/add_host_metadata/add_host_metadata.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ import (
"sync"
"time"

<<<<<<< HEAD
"github.com/pkg/errors"
=======
"github.com/elastic/elastic-agent-libs/monitoring"
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))

"github.com/elastic/beats/v7/libbeat/beat"
"github.com/elastic/beats/v7/libbeat/processors"
Expand All @@ -35,9 +39,22 @@ import (
"github.com/elastic/go-sysinfo"
)

const processorName = "add_host_metadata"
const logName = "processor." + processorName

var (
reg *monitoring.Registry
)

func init() {
processors.RegisterPlugin("add_host_metadata", New)
processors.RegisterPlugin(processorName, New)
jsprocessor.RegisterPlugin("AddHostMetadata", New)

reg = monitoring.Default.NewRegistry(logName, monitoring.DoNotReport)
}

type metrics struct {
FQDNLookupFailed *monitoring.Int
}

type addHostMetadata struct {
Expand All @@ -49,12 +66,9 @@ type addHostMetadata struct {
geoData mapstr.M
config Config
logger *logp.Logger
metrics metrics
}

const (
processorName = "add_host_metadata"
)

// New constructs a new add_host_metadata processor.
func New(cfg *config.C) (processors.Processor, error) {
config := defaultConfig()
Expand All @@ -65,7 +79,10 @@ func New(cfg *config.C) (processors.Processor, error) {
p := &addHostMetadata{
config: config,
data: mapstr.NewPointer(nil),
logger: logp.NewLogger("add_host_metadata"),
logger: logp.NewLogger(logName),
metrics: metrics{
FQDNLookupFailed: monitoring.NewInt(reg, "fqdn_lookup_failed"),
},
}
p.loadData()

Expand Down Expand Up @@ -125,7 +142,29 @@ func (p *addHostMetadata) loadData() error {
return err
}

<<<<<<< HEAD
data := host.MapHostInfo(h.Info())
=======
hostname := h.Info().Hostname
if features.FQDN() {
fqdn, err := h.FQDN()
if err != nil {
// FQDN lookup is "best effort". If it fails, we monitor the failure, fallback to
// the OS-reported hostname, and move on.
p.metrics.FQDNLookupFailed.Inc()
p.logger.Debugf(
"unable to lookup FQDN (failed attempt counter: %d): %s, using hostname = %s as FQDN",
p.metrics.FQDNLookupFailed.Get(),
err.Error(),
hostname,
)
} else {
hostname = fqdn
}
}

data := host.MapHostInfo(h.Info(), hostname)
>>>>>>> 895505cffe (Log any FQDN lookup errors and fallback to OS-reported hostname (#34946))
if p.config.NetInfoEnabled {
// IP-address and MAC-address
var ipList, hwList, err = util.GetNetInfo()
Expand Down
Loading

0 comments on commit 0e5689c

Please sign in to comment.