beats: github.com/elastic/beats/libbeat/management Index | Files

package management

import "github.com/elastic/beats/libbeat/management"

Index

Package Files

management.go

Variables

var DebugK = "centralmgmt"

DebugK used as key for all things central management

var Namespace = "libbeat.management"

Namespace is the feature namespace for queue definition.

func Register Uses

func Register(name string, fn PluginFunc, stability feature.Stability)

Register a config manager

type FactoryFunc Uses

type FactoryFunc func(*common.Config, *reload.Registry, uuid.UUID) (Manager, error)

FactoryFunc for creating a config manager

func Factory Uses

func Factory(cfg *common.Config) FactoryFunc

Factory retrieves config manager constructor. If no one is registered it will create a nil manager

type Manager Uses

type Manager interface {
    StatusReporter

    // Enabled returns true if manager is enabled.
    Enabled() bool

    // Start the config manager giving it a stopFunc callback
    // so the beat can be told when to stop.
    Start(stopFunc func())

    // Stop the config manager.
    Stop()

    // CheckRawConfig check settings are correct before launching the beat.
    CheckRawConfig(cfg *common.Config) error
}

Manager interacts with the beat to provide status updates and to receive configurations.

type PluginFunc Uses

type PluginFunc func(*common.Config) FactoryFunc

PluginFunc for creating FactoryFunc if it matches a config

type Status Uses

type Status int

Status describes the current status of the beat.

const (
    // Unknown is initial status when none has been reported.
    Unknown Status = iota
    // Starting is status describing application is starting.
    Starting
    // Configuring is status describing application is configuring.
    Configuring
    // Running is status describing application is running.
    Running
    // Degraded is status describing application is degraded.
    Degraded
    // Failed is status describing application is failed. This status should
    // only be used in the case the beat should stop running as the failure
    // cannot be recovered.
    Failed
    // Stopping is status describing application is stopping.
    Stopping
)

type StatusReporter Uses

type StatusReporter interface {
    // UpdateStatus called when the status of the beat has changed.
    UpdateStatus(status Status, msg string)
}

StatusReporter provides a method to update current status of the beat.

Package management imports 6 packages (graph) and is imported by 61 packages. Updated 2020-07-06. Refresh now. Tools for package owners.