configstreamconsumer

package module
v0.83.0-devel Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package configstreamconsumer implements a component that consumes config streams from the core agent.

team: agent-configuration

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Component

type Component interface {
	IsActive() bool
}

Component is the config stream consumer. IsActive is true once the initial snapshot has been applied to the global config builder.

type Option

type Option func(*Params)

Option mutates Params.

func WithReadyTimeout

func WithReadyTimeout(d time.Duration) Option

WithReadyTimeout overrides the default first-snapshot timeout.

type Params

type Params struct {
	// ClientName identifies this remote agent (e.g. "system-probe"). Required.
	ClientName string
	// CLIConfigPath is the binary's resolved -config / --cfgpath (file or dir).
	CLIConfigPath string
	// ReadyTimeout caps NewComponent's wait for the first snapshot. Defaults to 60s.
	ReadyTimeout time.Duration
}

Params for the configstreamconsumer component.

func NewParams

func NewParams(clientName, cliConfigPath string, opts ...Option) Params

NewParams returns Params with the required fields set; apply Options for the rest.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL