signalfx-agent.1.man

% signalfx-agent(1) Version 3 | SignalFx Agent Documentation

# NAME

**signalfx-agent** -- The SignalFx metric collection agent

# SYNOPSIS

| **signalfx-agent** \[**-config** path] \[**-debug**] \[**-version**]

| **signalfx-agent** **status** \[all | config | monitors | endpoints]

# DESCRIPTION

Runs the SignalFx metric collection agent that optionally discovers services
running in the local environment and monitors them, sending metrics to the
SignalFx backend for processing.

The agent does not fork to the background and has no such option to do so.

If the **status** subcommand is invoked it connects to the configured diagnostic
server and dumps diagnostic information about the agent to stdout.  An optional
section can be provided that provides extended output about a certain aspect of
the agent.  If no section is specified, a short summary of the agent is output.

See https://github.com/signalfx/signalfx-agent for more information and
configuration documentation, as well as to file bug reports or ask questions.

# OPTIONS

-config <path>

:	Uses the given configuration file instead of the default
	**/etc/signalfx/agent.yaml**

-debug

:	Sets the log level to debug, overriding whatever level is set in the 
	config file.

-version

:	Prints the agent version information and quits

# FILES

*/etc/signalfx/agent.yaml*

:	The default config file path, can be overriden by the **-config** option.
	See https://github.com/signalfx/signalfx-agent/blob/main/docs/config-schema.md
	for a full schema of the config file.

*/etc/signalfx/token*

:	The default location where the SignalFx access token should be put

*/var/run/signalfx-agent*

:	The default directory where the agent puts temporary files and sockets for
	internal use

# AUTHOR

Splunk, Inc. <signalfx-support@splunk.com>

# SOURCE

Source code for the agent is at https://github.com/signalfx/signalfx-agent.