package
0.44.2
Repository: https://github.com/grafana/agent.git
Documentation: pkg.go.dev

# Packages

Package all imports all known component packages.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
Get finds a registered component by name.
GetAllComponents enumerates over all of the modules in p and returns the set of all components.
LeastHealthy returns the Health from the provided arguments which is considered to be the least healthy.
ParseID parses an input string of the form "LOCAL_ID" or "MODULE_ID/LOCAL_ID" into an ID.
Register registers a component.

# Constants

HealthTypeExited represents a component which has stopped running.
HealthTypeHealthy represents a component which is working as expected.
HealthTypeUnhealthy represents a component which is not working as expected.
HealthTypeUnknown is the initial health of components, set when they're first created.

# Variables

ErrComponentNotFound is returned by [Provider.GetComponent] when the specified component isn't found.
ErrModuleNotFound is returned by [Provider.ListComponents] when the specified module isn't found.

# Structs

Health is the reported health state of a component.
ID is a globally unique identifier for a component.
Info ia detailed information about a component.
InfoOptions is used by to determine how much information to return with [Info].
Options are provided to a component when it is being constructed.
Registration describes a single component.

# Interfaces

The Arguments contains the input fields for a specific component, which is unmarshaled from River.
Component is the base interface for a Flow component.
DebugComponent is an extension interface for components which can report debugging information upon request.
Exports contains the current set of outputs for a specific component, which is then marshaled to River.
HealthComponent is an optional extension interface for Components which report health information.
Module is a controller for running components within a Module.
ModuleController is a mechanism responsible for allowing components to create other components via modules.
A Provider is a system which exposes a list of running components.

# Type aliases

ExportFunc is used for onExport of the Module.
HealthType holds the health value for a component.