package
8.15.2+incompatible
Repository: https://github.com/elastic/elastic-agent.git
Documentation: pkg.go.dev
# Functions
AgentActionStoreFile is the file that contains the action that can be replayed after restart.
AgentCapabilitiesPath is a name of file used to store agent capabilities.
AgentConfigFile is a name of file used to store agent information.
AgentConfigFileLock is a locker for agent config file updates.
AgentConfigYmlFile is a name of file used to store agent information.
AgentConfigYmlFileLock is a locker for agent config file updates.
AgentEnrollFile is a name of file used to enroll agent on first-start.
AgentInputsDPath is directory that contains the fragment of inputs yaml for K8s deployment.
AgentKeychainName is the default name for the keychain based vault.
AgentStateStoreFile is the file that contains the persisted state of the agent including the action that can be replayed after restart encrypted.
AgentStateStoreYmlFile is the file that contains the persisted state of the agent including the action that can be replayed after restart.
AgentVaultPath is the default path for file-based vault.
ArePathsEqual determines whether paths are equal taking case sensitivity of os into account.
BinaryPath returns the application binary path that is concatenation of the directory and the agentName.
Components returns the component directory for Agent.
Config returns a directory where configuration file lives.
ConfigFile returns the path to the configuration file.
ControlSocket returns the control socket directory for Agent.
ControlSocketFromPath returns the control socket path for an Elastic Agent running on the defined platform, and its executing directory.
ControlSocketRunSymlink returns the shell wrapper path accounting for any namespace.
Data returns the data directory for Agent.
DataFrom returns the data directory for Agent using the passed directory as top path.
Downloads returns the downloads directory for Agent.
ExecDir returns the "executable" directory which is: 1.
ExternalInputs returns the path to load external inputs from.
HasPrefix tests if the path starts with the prefix.
Home returns a directory where binary lives.
No description provided by the author
InInstallNamespace returns true if the agent is being installed in an installation namespace.
Install returns the install directory for Agent.
InstallDirNameForNamespace returns the installation directory name for a given namespace.
InstallNamespace returns the name of the current installation namespace.
InstallPath returns the top level directory Agent will be installed into, accounting for any namespace.
IsVersionHome returns true if the Home path is versioned based on build.
Logs returns the log directory for Agent.
OtelConfigFile returns the path to the otel configuration file.
ResolveControlSocket does nothing on non-Windows hosts.
Run returns the run directory for Agent.
RunningInstalled returns true when executing Agent is the installed Agent.
ServiceDisplayName returns the service display name accounting for any namespace.
ServiceName returns the service name accounting for any namespace.
SetConfig overrides the Config path.
SetControlSocket overrides the ControlSocket path.
SetDownloads updates the path for the downloads.
SetInstall updates the path for the install.
SetInstallNamespace sets whether the agent is currently in or is being installed in an installation namespace.
SetLogs updates the path for the logs.
SetTop overrides the Top path.
SetVersionHome sets if the Home path is versioned based on build.
ShellWrapperPath returns the shell wrapper path accounting for any namespace.
shellWrapperPathForNamespace is a helper to work around not being able to use fmt.Sprintf unconditionally since shellWrapperPathNamespaceFmt is empty on Windows.
TempDir returns agent temp dir located within data dir.
Top returns the top directory for Elastic Agent, all the versioned home directories live under this top-level/data/elastic-agent-${hash}.
TopBinaryPath returns the path to the Elastic Agent binary that is inside the Top directory.
VersionedHome returns a versioned path based on a TopPath and used commit.
# Constants
AgentLockFileName is the name of the overall Elastic Agent file lock.
BinaryName is the name of the installed binary.
ControlSocketName is the control socket name.
DefaultBasePath is the base path used by the install command for installing Elastic Agent's files.
DefaultConfigName is the default name of the configuration file.
DefaultOtelConfigName is the default name of the otel configuration file.
DevelopmentNamespace defines the "well known" development namespace.
MarkerFileName is the name of the file that's created by `elastic-agent install` in the Agent's topPath folder to indicate that the Agent executing from the binary under the same topPath folder is an installed Agent.
ShellWrapper is the wrapper that is installed.
WindowsControlSocketInstalledPath is the control socket path used when installed on Windows.
# Variables
ExternalInputsPattern is a glob that matches the paths of external configuration files.