helper

Documentation

Overview

Package helper implement interfaces to get some information that can be OS specific

Index

• type Helper
• type Unix
  • func NewUnix() *Unix
  • func (u *Unix) AgentProcesses() []string
  • func (u *Unix) GetBinaryPath() string
  • func (u *Unix) GetConfigFileName() string
  • func (u *Unix) GetConfigFolder() string
  • func (u *Unix) GetInstallFolder() string
  • func (u *Unix) GetServiceName() string
• type UnixDogstatsd
  • func NewUnixDogstatsd() *UnixDogstatsd
  • func (u *UnixDogstatsd) AgentProcesses() []string
  • func (u *UnixDogstatsd) GetBinaryPath() string
  • func (u *UnixDogstatsd) GetConfigFileName() string
  • func (u *UnixDogstatsd) GetConfigFolder() string
  • func (u *UnixDogstatsd) GetInstallFolder() string
  • func (u *UnixDogstatsd) GetServiceName() string
• type Windows
  • func NewWindowsHelper() *Windows
  • func NewWindowsHelperWithCustomPaths(installFolder, configFolder string) *Windows
  • func (w *Windows) AgentProcesses() []string
  • func (w *Windows) GetBinaryPath() string
  • func (w *Windows) GetConfigFileName() string
  • func (w *Windows) GetConfigFolder() string
  • func (w *Windows) GetInstallFolder() string
  • func (w *Windows) GetServiceName() string

Types

type Helper

type Helper interface {
	GetInstallFolder() string
	GetConfigFolder() string
	GetBinaryPath() string
	GetConfigFileName() string
	GetServiceName() string
	AgentProcesses() []string
}

Helper generic interface

type Unix

type Unix struct{}

Unix implement helper function for Unix distributions

func NewUnix

func NewUnix() *Unix

NewUnix create a new instance of Unix helper

func (*Unix) AgentProcesses

func (u *Unix) AgentProcesses() []string

AgentProcesses return the list of agent processes

func (*Unix) GetBinaryPath

func (u *Unix) GetBinaryPath() string

GetBinaryPath return the datadog-agent binary path

func (*Unix) GetConfigFileName

func (u *Unix) GetConfigFileName() string

GetConfigFileName return the config file name

func (*Unix) GetConfigFolder

func (u *Unix) GetConfigFolder() string

GetConfigFolder return the config folder path

func (*Unix) GetInstallFolder

func (u *Unix) GetInstallFolder() string

GetInstallFolder return the install folder path

func (*Unix) GetServiceName

func (u *Unix) GetServiceName() string

GetServiceName return the service name

type UnixDogstatsd

type UnixDogstatsd struct{}

UnixDogstatsd implement helper function for Dogstatsd on Unix distributions

func NewUnixDogstatsd

func NewUnixDogstatsd() *UnixDogstatsd

NewUnixDogstatsd create a new instance of Unix helper for dogstatsd

func (*UnixDogstatsd) AgentProcesses

func (u *UnixDogstatsd) AgentProcesses() []string

AgentProcesses return the list of agent processes

func (*UnixDogstatsd) GetBinaryPath

func (u *UnixDogstatsd) GetBinaryPath() string

GetBinaryPath return the datadog-agent binary path

func (*UnixDogstatsd) GetConfigFileName

func (u *UnixDogstatsd) GetConfigFileName() string

GetConfigFileName return the config file name

func (*UnixDogstatsd) GetConfigFolder

func (u *UnixDogstatsd) GetConfigFolder() string

GetConfigFolder return the config folder path

func (*UnixDogstatsd) GetInstallFolder

func (u *UnixDogstatsd) GetInstallFolder() string

GetInstallFolder return the install folder path

func (*UnixDogstatsd) GetServiceName

func (u *UnixDogstatsd) GetServiceName() string

GetServiceName return the service name

type Windows

type Windows struct {
	// contains filtered or unexported fields
}

Windows implement helper function for Windows distributions

func NewWindowsHelper

func NewWindowsHelper() *Windows

NewWindowsHelper create a new instance of Windows helper

func NewWindowsHelperWithCustomPaths

func NewWindowsHelperWithCustomPaths(installFolder, configFolder string) *Windows

NewWindowsHelperWithCustomPaths create a new instance of Windows helper with custom paths

func (*Windows) AgentProcesses

func (w *Windows) AgentProcesses() []string

AgentProcesses return the list of agent processes

func (*Windows) GetBinaryPath

func (w *Windows) GetBinaryPath() string

GetBinaryPath return the datadog-agent binary path

func (*Windows) GetConfigFileName

func (w *Windows) GetConfigFileName() string

GetConfigFileName return the config file name

func (*Windows) GetConfigFolder

func (w *Windows) GetConfigFolder() string

GetConfigFolder return the config folder path

func (*Windows) GetInstallFolder

func (w *Windows) GetInstallFolder() string

GetInstallFolder return the install folder path

func (*Windows) GetServiceName

func (w *Windows) GetServiceName() string

GetServiceName return the service name