85 lines
3.2 KiB
Go
85 lines
3.2 KiB
Go
|
// 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 beat
|
||
|
|
|
||
|
|
import (
|
||
|
|
"github.com/elastic/beats/libbeat/common"
|
||
|
|
"github.com/elastic/beats/libbeat/management"
|
||
|
|
)
|
||
|
|
|
||
|
|
// Creator initializes and configures a new Beater instance used to execute
|
||
|
|
// the beat's run-loop.
|
||
|
|
type Creator func(*Beat, *common.Config) (Beater, error)
|
||
|
|
|
||
|
|
// Beater is the interface that must be implemented by every Beat. A Beater
|
||
|
|
// provides the main Run-loop and a Stop method to break the Run-loop.
|
||
|
|
// Instantiation and Configuration is normally provided by a Beat-`Creator`.
|
||
|
|
//
|
||
|
|
// Once the beat is fully configured, the Run() method is invoked. The
|
||
|
|
// Run()-method implements the beat its run-loop. Once the Run()-method returns,
|
||
|
|
// the beat shuts down.
|
||
|
|
//
|
||
|
|
// The Stop() method is invoked the first time (and only the first time) a
|
||
|
|
// shutdown signal is received. The Stop()-method normally will stop the Run()-loop,
|
||
|
|
// such that the beat can gracefully shutdown.
|
||
|
|
type Beater interface {
|
||
|
|
// The main event loop. This method should block until signalled to stop by an
|
||
|
|
// invocation of the Stop() method.
|
||
|
|
Run(b *Beat) error
|
||
|
|
|
||
|
|
// Stop is invoked to signal that the Run method should finish its execution.
|
||
|
|
// It will be invoked at most once.
|
||
|
|
Stop()
|
||
|
|
}
|
||
|
|
|
||
|
|
// Beat contains the basic beat data and the publisher client used to publish
|
||
|
|
// events.
|
||
|
|
type Beat struct {
|
||
|
|
Info Info // beat metadata.
|
||
|
|
Publisher Pipeline // Publisher pipeline
|
||
|
|
|
||
|
|
SetupMLCallback SetupMLCallback // setup callback for ML job configs
|
||
|
|
InSetupCmd bool // this is set to true when the `setup` command is called
|
||
|
|
|
||
|
|
OverwritePipelinesCallback OverwritePipelinesCallback // ingest pipeline loader callback
|
||
|
|
// XXX: remove Config from public interface.
|
||
|
|
// It's currently used by filebeat modules to setup the Ingest Node
|
||
|
|
// pipeline and ML jobs.
|
||
|
|
Config *BeatConfig // Common Beat configuration data.
|
||
|
|
|
||
|
|
BeatConfig *common.Config // The beat's own configuration section
|
||
|
|
|
||
|
|
Fields []byte // Data from fields.yml
|
||
|
|
|
||
|
|
ConfigManager management.ConfigManager // config manager
|
||
|
|
}
|
||
|
|
|
||
|
|
// BeatConfig struct contains the basic configuration of every beat
|
||
|
|
type BeatConfig struct {
|
||
|
|
// output/publishing related configurations
|
||
|
|
Output common.ConfigNamespace `config:"output"`
|
||
|
|
}
|
||
|
|
|
||
|
|
// SetupMLCallback can be used by the Beat to register MachineLearning configurations
|
||
|
|
// for the enabled modules.
|
||
|
|
type SetupMLCallback func(*Beat, *common.Config) error
|
||
|
|
|
||
|
|
// OverwritePipelinesCallback can be used by the Beat to register Ingest pipeline loader
|
||
|
|
// for the enabled modules.
|
||
|
|
type OverwritePipelinesCallback func(*common.Config) error
|