paths

Documentation

Overview

Package paths provides a common way to handle paths configuration for all Beats.

Currently the following paths are defined:

path.home - It’s the default folder for everything that doesn't fit in the categories below

path.data - Contains things that are expected to change often during normal operations (“registry” files, UUID file, etc.)

path.config - Configuration files and Elasticsearch template default location

These settings can be set via the configuration file or via command line flags. The CLI flags overwrite the configuration file options.

Use the Resolve function to resolve files to their absolute paths. For example, to look for a file in the config path:

cfgfilePath := paths.Resolve(paths.Config, "beat.yml"

Index

• Variables
• func InitPaths(cfg *Path) error
• func Resolve(fileType FileType, path string) string
• type FileType
• type Path
  • func New() *Path
  • func (paths *Path) InitPaths(cfg *Path) error
  • func (paths *Path) Resolve(fileType FileType, path string) string
  • func (paths *Path) String() string

Variables

var Paths = New()

Paths is the Path singleton on which the top level functions from this package operate.

Functions

func InitPaths

func InitPaths(cfg *Path) error

InitPaths sets the default paths in the configuration based on CLI flags, configuration file and default values. It also tries to create the data path with mode 0750 and returns an error on failure.

func Resolve

func Resolve(fileType FileType, path string) string

Resolve resolves a path to a location in one of the default folders. For example, Resolve(Home, "test") returns an absolute path for "test" in the home path. In case path is already an absolute path, the path itself is returned.

Types

type FileType

type FileType string

FileType is an enumeration type representing the file types. Currently existing file types are: Home, Config, Data

const (
	// Home is the "root" directory for the running beats instance
	Home FileType = "home"
	// Config is the path to the beat config
	Config FileType = "config"
	// Data is the path to the beat data directory
	Data FileType = "data"
	// Logs is the path to the beats logs directory
	Logs FileType = "logs"
)

type Path

type Path struct {
	Home   string
	Config string
	Data   string
	Logs   string
}

Path tracks user-configurable path locations and directories

func New

func New() *Path

New creates a new Paths object with all values set to empty values.

func (*Path) InitPaths

func (paths *Path) InitPaths(cfg *Path) error

InitPaths sets the default paths in the configuration based on CLI flags, configuration file and default values. It also tries to create the data path with mode 0750 and returns an error on failure.

func (*Path) Resolve

func (paths *Path) Resolve(fileType FileType, path string) string

Resolve resolves a path to a location in one of the default folders. For example, Resolve(Home, "test") returns an absolute path for "test" in the home path.

func (*Path) String

func (paths *Path) String() string

String returns a textual representation