fluentbitconfig

README

go-fluentbit-config

Library to parse Fluent Bit config files. With support for both the classic/legacy mode (INI), and the new YAML config.

go get github.com/calyptia/go-fluentbit-config

Documentation

Index

• Constants
• Variables
• func Name(props property.Properties) string
• func ValidateSection(kind SectionKind, props property.Properties) error
• func ValidateSectionWithSchema(kind SectionKind, props property.Properties, schema Schema) error
• type ByName
• type Config
  • func ParseAs(raw string, format Format) (Config, error)
  • func (c *Config) AddSection(kind SectionKind, props property.Properties)
  • func (c Config) DumpAs(format Format) (string, error)
  • func (c Config) DumpAsClassic() (string, error)
  • func (c Config) DumpAsJSON() (string, error)
  • func (c Config) DumpAsYAML() (string, error)
  • func (c Config) Equal(target Config) bool
  • func (c *Config) Include(path string)
  • func (c Config) MarshalClassic() ([]byte, error)
  • func (c *Config) SetEnv(key string, value any)
  • func (c *Config) UnmarshalClassic(text []byte) error
  • func (c Config) Validate() error
  • func (c Config) ValidateWithSchema(schema Schema) error
• type Format
• type LinedError
  • func NewLinedError(msg string, line uint) *LinedError
  • func WrapLinedError(err error, line uint) *LinedError
  • func (e *LinedError) Error() string
• type Pipeline
• type Schema
  • func (s *Schema) InjectLTSPlugins()
• type SchemaFluentBit
• type SchemaOptions
• type SchemaProperties
• type SchemaSection
• type SectionKind
  • func (k SectionKind) String() string

Constants

const (
	FormatClassic = "classic"
	FormatYAML    = "yaml"
	FormatJSON    = "json"
)

Variables

var DefaultSchema = func() Schema {
	var s Schema
	err := json.Unmarshal(rawSchema, &s)
	if err != nil {
		fmt.Fprintf(os.Stderr, "could not parse fluent-bit schema: %v\n", err)
		os.Exit(1)
	}

	s.InjectLTSPlugins()

	return s
}()

var ErrFormatUnknown = errors.New("format unknown")

var ErrMissingName = errors.New("missing name property")

Functions

func Name

func Name(props property.Properties) string

Name from properties.

func ValidateSection

func ValidateSection(kind SectionKind, props property.Properties) error

func ValidateSectionWithSchema

func ValidateSectionWithSchema(kind SectionKind, props property.Properties, schema Schema) error

Types

type ByName

type ByName map[string]property.Properties

type Config

type Config struct {
	Env      property.Properties `json:"env,omitempty" yaml:"env,omitempty"`
	Includes []string            `json:"includes,omitempty" yaml:"includes,omitempty"`
	Service  property.Properties `json:"service,omitempty" yaml:"service,omitempty"`
	Customs  []ByName            `json:"customs,omitempty" yaml:"customs,omitempty"`
	Pipeline Pipeline            `json:"pipeline,omitempty" yaml:"pipeline,omitempty"`
}

func ParseAs

func ParseAs(raw string, format Format) (Config, error)

func (*Config) AddSection

func (c *Config) AddSection(kind SectionKind, props property.Properties)

func (Config) DumpAs

func (c Config) DumpAs(format Format) (string, error)

func (Config) DumpAsClassic

func (c Config) DumpAsClassic() (string, error)

func (Config) DumpAsJSON

func (c Config) DumpAsJSON() (string, error)

func (Config) DumpAsYAML

func (c Config) DumpAsYAML() (string, error)

func (Config) Equal

func (c Config) Equal(target Config) bool

func (*Config) Include

func (c *Config) Include(path string)

func (Config) MarshalClassic

func (c Config) MarshalClassic() ([]byte, error)

func (*Config) SetEnv

func (c *Config) SetEnv(key string, value any)

func (*Config) UnmarshalClassic

func (c *Config) UnmarshalClassic(text []byte) error

func (Config) Validate

func (c Config) Validate() error

Validate with the default schema.

func (Config) ValidateWithSchema

func (c Config) ValidateWithSchema(schema Schema) error

ValidateWithSchema validates that the config satisfies all properties defined on the schema. That is if the schema says the the input plugin "cpu" has a property named "pid" that is of integer type, it must be a valid integer.

type Format

type Format string

type LinedError

type LinedError struct {
	Msg  string
	Line uint
}

LinedError with information about the line number where the error was found while parsing.

func NewLinedError

func NewLinedError(msg string, line uint) *LinedError

func WrapLinedError

func WrapLinedError(err error, line uint) *LinedError

func (*LinedError) Error

func (e *LinedError) Error() string

type Pipeline

type Pipeline struct {
	Inputs  []ByName `json:"inputs,omitempty" yaml:"inputs,omitempty"`
	Parsers []ByName `json:"parsers,omitempty" yaml:"parsers,omitempty"`
	Filters []ByName `json:"filters,omitempty" yaml:"filters,omitempty"`
	Outputs []ByName `json:"outputs,omitempty" yaml:"outputs,omitempty"`
}

type Schema

type Schema struct {
	FluentBit SchemaFluentBit `json:"fluent-bit"`
	Customs   []SchemaSection `json:"customs"`
	Inputs    []SchemaSection `json:"inputs"`
	Filters   []SchemaSection `json:"filters"`
	Outputs   []SchemaSection `json:"outputs"`
}

func (*Schema) InjectLTSPlugins

func (s *Schema) InjectLTSPlugins()

type SchemaFluentBit

type SchemaFluentBit struct {
	Version       string `json:"version"`
	SchemaVersion string `json:"schema_version"`
	OS            string `json:"os"`
}

type SchemaOptions

type SchemaOptions struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Default     any    `json:"default,omitempty"`
	Type        string `json:"type"`
}

type SchemaProperties

type SchemaProperties struct {
	Options []SchemaOptions `json:"options"`

	// Networking is only present in outputs.
	Networking []SchemaOptions `json:"networking"`
	// NetworkTLS is only present in outputs.
	NetworkTLS []SchemaOptions `json:"network_tls"`
}

type SchemaSection

type SchemaSection struct {
	Type        string           `json:"type"`
	Name        string           `json:"name"`
	Description string           `json:"description"`
	Properties  SchemaProperties `json:"properties"`
}

type SectionKind

type SectionKind string

const (
	SectionKindService SectionKind = "service"
	SectionKindCustom  SectionKind = "custom"
	SectionKindInput   SectionKind = "input"
	SectionKindParser  SectionKind = "parser"
	SectionKindFilter  SectionKind = "filter"
	SectionKindOutput  SectionKind = "output"
)

func (SectionKind) String

func (k SectionKind) String() string