Affected by GO-2022-0305 and 1 other vulnerabilities

GO-2022-0305: Instance config inline secret exposure in Grafana in github.com/grafana/agent

GO-2024-3170: Grafana Agent (Flow mode) on Windows has Unquoted Search Path or Element vulnerability in github.com/grafana/agent

config

package

v0.20.1 Latest Latest Go to latest Published: Dec 8, 2021 License: Apache-2.0 Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grafana/agent

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CheckSecret(t *testing.T, rawCfg string, originalValue string)
func LoadBytes(buf []byte, expandEnvVars bool, c *Config) error
func LoadFile(filename string, expandEnvVars bool, c *Config) error
type Config
- func Load(fs *flag.FlagSet, args []string) (*Config, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultConfig = Config{

	Metrics:        metrics.DefaultConfig,
	Integrations:   integrations.DefaultManagerConfig,
	EnableEndpoint: false,
}

DefaultConfig holds default settings for all the subsystems.

Functions ¶

func CheckSecret ¶ added in v0.20.1

func CheckSecret(t *testing.T, rawCfg string, originalValue string)

CheckSecret is a helper function to ensure the original value is overwritten with <secret>

func LoadBytes ¶ added in v0.4.0

func LoadBytes(buf []byte, expandEnvVars bool, c *Config) error

LoadBytes unmarshals a config from a buffer. Defaults are not applied to the file and must be done manually if LoadBytes is called directly.

func LoadFile ¶

func LoadFile(filename string, expandEnvVars bool, c *Config) error

LoadFile reads a file and passes the contents to Load

Types ¶

type Config ¶

type Config struct {
	Server       server.Config              `yaml:"server,omitempty"`
	Metrics      metrics.Config             `yaml:"metrics,omitempty"`
	Integrations integrations.ManagerConfig `yaml:"integrations,omitempty"`
	Traces       traces.Config              `yaml:"traces,omitempty"`
	Logs         *logs.Config               `yaml:"logs,omitempty"`

	// We support a secondary server just for the /-/reload endpoint, since
	// invoking /-/reload against the primary server can cause the server
	// to restart.
	ReloadAddress string `yaml:"-"`
	ReloadPort    int    `yaml:"-"`

	// Deprecated fields user has used. Generated during UnmarshalYAML.
	Deprecations []string `yaml:"-"`

	// Toggle for config endpoint(s)
	EnableEndpoint bool `yaml:"-"`
}

Config contains underlying configurations for the agent

func Load ¶

func Load(fs *flag.FlagSet, args []string) (*Config, error)

Load loads a config file from a flagset. Flags will be registered to the flagset before parsing them with the values specified by args.

func (*Config) ApplyDefaults ¶

func (c *Config) ApplyDefaults() error

ApplyDefaults sets default values in the config

func (*Config) LogDeprecations ¶ added in v0.19.0

func (c *Config) LogDeprecations(l log.Logger)

LogDeprecations will log use of any deprecated fields to l as warn-level messages.

func (Config) MarshalYAML ¶ added in v0.20.1

func (c Config) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (*Config) RegisterFlags ¶

func (c *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers flags in underlying configs

func (*Config) UnmarshalYAML ¶ added in v0.14.0

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

Source Files ¶

View all Source files

config.go

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