Functionbeat command referenceedit

Functionbeat provides a command-line interface for starting Functionbeat and performing common tasks, like testing configuration files and loading dashboards.

The command-line also supports global flags for controlling global behaviors.

Tip

Use sudo to run the following commands if:

  • the config file is owned by root, or
  • Functionbeat is configured to capture data that requires root access
Commands  

deploy

Deploys the specified function to your serverless environment.

export

Exports the configuration, index template, or a dashboard to stdout.

help

Shows help for any command.

keystore

Manages the secrets keystore.

package

Packages the configuration and executable into a zip file.

remove

Removes the specified function from your serverless environment.

run

Runs Functionbeat. This command is used by default if you start Functionbeat without specifying a command.

setup

Sets up the initial environment, including the index template, Kibana dashboards (when available), and machine learning jobs (when available).

test

Tests the configuration.

update

Updates the specified function.

version

Shows information about the current version.

Also see Global flags.

deploy commandedit

Deploys the specified function to your serverless environment. Before deploying functions, make sure the user has the credentials required by your cloud service provider.

SYNOPSIS

functionbeat deploy FUNCTION_NAME [FLAGS]
FUNCTION_NAME
Specifies the name of the function to deploy.

FLAGS

-h, --help
Shows help for the deploy command.

Also see Global flags.

EXAMPLES

functionbeat deploy cloudwatch
functionbeat deploy sqs

export commandedit

Exports the configuration, index template, or a dashboard to stdout. You can use this command to quickly view your configuration, see the contents of the index template, or export a dashboard from Kibana.

SYNOPSIS

functionbeat export SUBCOMMAND [FLAGS]

SUBCOMMANDS

config
Exports the current configuration to stdout. If you use the -c flag, this command exports the configuration that’s defined in the specified file.
dashboard

Exports a dashboard. You can use this option to store a dashboard on disk in a module and load it automatically. For example, to export the dashboard to a JSON file, run:

functionbeat export dashboard --id="DASHBOARD_ID" > dashboard.json

To find the DASHBOARD_ID, look at the URL for the dashboard in Kibana. By default, export dashboard writes the dashboard to stdout. The example shows how to write the dashboard to a JSON file so that you can import it later. The JSON file will contain the dashboard with all visualizations and searches. You must load the index pattern separately for Functionbeat.

To load the dashboard, copy the generated dashboard.json file into the kibana/6/dashboard directory of Functionbeat, and run functionbeat setup --dashboards to import the dashboard.

If Kibana is not running on localhost:5061, you must also adjust the Functionbeat configuration under setup.kibana.

template
Exports the index template to stdout. You can specify the --es.version and --index flags to further define what gets exported.

FLAGS

--es.version VERSION
When used with template, exports an index template that is compatible with the specified version.
-h, --help
Shows help for the export command.
--index BASE_NAME
When used with template, sets the base name to use for the index template. If this flag is not specified, the default base name is functionbeat.
--id DASHBOARD_ID
When used with dashboard, specifies the dashboard ID.

Also see Global flags.

EXAMPLES

functionbeat export config
functionbeat export template --es.version 6.5.4 --index myindexname
functionbeat export dashboard --id="a7b35890-8baa-11e8-9676-ef67484126fb" > dashboard.json

help commandedit

Shows help for any command. If no command is specified, shows help for the run command.

SYNOPSIS

functionbeat help COMMAND_NAME [FLAGS]
COMMAND_NAME
Specifies the name of the command to show help for.

FLAGS

-h, --help
Shows help for the help command.

Also see Global flags.

EXAMPLE

functionbeat help export

keystore commandedit

Manages the secrets keystore.

SYNOPSIS

functionbeat keystore SUBCOMMAND [FLAGS]

SUBCOMMANDS

add KEY
Adds the specified key to the keystore. Use the --force flag to overwrite an existing key. Use the --stdin flag to pass the value through stdin.
create
Creates a keystore to hold secrets. Use the --force flag to overwrite the existing keystore.
list
Lists the keys in the keystore.
remove KEY
Removes the specified key from the keystore.

FLAGS

--force
Valid with the add and create subcommands. When used with add, overwrites the specified key. When used with create, overwrites the keystore.
--stdin
When used with add, uses the stdin as the source of the key’s value.
-h, --help
Shows help for the keystore command.

Also see Global flags.

EXAMPLES

functionbeat keystore create
functionbeat keystore add ES_PWD
functionbeat keystore remove ES_PWD
functionbeat keystore list

See Secrets keystore for more examples.

package commandedit

Packages the configuration and executable into a zip file.

SYNOPSIS

functionbeat package [FLAGS]

FLAGS

-h, --help
Shows help for the package command.
-o, --output
Specifies the full path to the zip file that will contain the package.

Also see Global flags.

EXAMPLES

functionbeat package /path/to/file.zip

remove commandedit

Removes the specified function from your serverless environment. Before removing functions, make sure the user has the credentials required by your cloud service provider.

SYNOPSIS

functionbeat remove FUNCTION_NAME [FLAGS]
FUNCTION_NAME
Specifies the name of the function to remove.

FLAGS

-h, --help
Shows help for the remove command.

Also see Global flags.

EXAMPLES

functionbeat remove cloudwatch
functionbeat remove sqs

run commandedit

Runs Functionbeat. This command is used by default if you start Functionbeat without specifying a command.

SYNOPSIS

functionbeat run [FLAGS]

Or:

functionbeat [FLAGS]

FLAGS

-N, --N
Disables publishing for testing purposes.
--cpuprofile FILE
Writes CPU profile data to the specified file. This option is useful for troubleshooting Functionbeat.
-h, --help
Shows help for the run command.
--httpprof [HOST]:PORT
Starts an http server for profiling. This option is useful for troubleshooting and profiling Functionbeat.
--memprofile FILE
Writes memory profile data to the specified output file. This option is useful for troubleshooting Functionbeat.
--setup
Loads the initial setup, including Elasticsearch template, Kibana index pattern, Kibana dashboards (when available), and Machine learning jobs. If you want to use the command without running Functionbeat, use the setup command instead.

Also see Global flags.

EXAMPLE

functionbeat run -e --setup

Or:

functionbeat -e --setup

setup commandedit

Sets up the initial environment, including the index template, Kibana dashboards (when available), and machine learning jobs (when available)

  • The index template ensures that fields are mapped correctly in Elasticsearch.
  • The Kibana dashboards make it easier for you to visualize Functionbeat data in Kibana.
  • The machine learning jobs contain the configuration information and metadata necessary to analyze data for anomalies.

Use this command instead of run --setup when you want to set up the environment without actually running Functionbeat and ingesting data.

SYNOPSIS

functionbeat setup [FLAGS]

FLAGS

--dashboards
Sets up the Kibana dashboards (when available). This option loads the dashboards from the Functionbeat package. For more options, such as loading customized dashboards, see Importing Existing Beat Dashboards in the Beats Developer Guide.
-h, --help
Shows help for the setup command.
--machine-learning
Sets up machine learning job configurations only.
--template
Sets up the index template only.

Also see Global flags.

EXAMPLES

functionbeat setup --dashboards
functionbeat setup --machine-learning
functionbeat setup --template

test commandedit

Tests the configuration.

SYNOPSIS

functionbeat test SUBCOMMAND [FLAGS]

SUBCOMMANDS

config
Tests the configuration settings.
output
Tests that Functionbeat can connect to the output by using the current settings.

FLAGS

-h, --help
Shows help for the test command.

Also see Global flags.

EXAMPLE

functionbeat test config

update commandedit

Updates the specified function. Before updating functions, make sure the user has the credentials required by your cloud service provider.

SYNOPSIS

functionbeat update FUNCTION_NAME [FLAGS]
FUNCTION_NAME
Specifies the name of the function to update.

FLAGS

-h, --help
Shows help for the update command.

Also see Global flags.

EXAMPLES

functionbeat update cloudwatch
functionbeat update sqs

version commandedit

Shows information about the current version.

SYNOPSIS

functionbeat version [FLAGS]

FLAGS

-h, --help
Shows help for the version command.

Also see Global flags.

EXAMPLE

functionbeat version

Global flagsedit

These global flags are available whenever you run Functionbeat.

-E, --E "SETTING_NAME=VALUE"

Overrides a specific configuration setting. You can specify multiple overrides. For example:

functionbeat -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"

This setting is applied to the currently running Functionbeat process. The Functionbeat configuration file is not changed.

-c, --c FILE
Specifies the configuration file to use for Functionbeat. The file you specify here is relative to path.config. If the -c flag is not specified, the default config file, functionbeat.yml, is used.
-d, --d SELECTORS
Enables debugging for the specified selectors. For the selectors, you can specify a comma-separated list of components, or you can use -d "*" to enable debugging for all components. For example, -d "publish" displays all the "publish" related messages.
-e, --e
Logs to stderr and disables syslog/file output.
--path.config
Sets the path for configuration files. See the Directory layout section for details.
--path.data
Sets the path for data files. See the Directory layout section for details.
--path.home
Sets the path for miscellaneous files. See the Directory layout section for details.
--path.logs
Sets the path for log files. See the Directory layout section for details.
--strict.perms
Sets strict permission checking on configuration files. The default is -strict.perms=true. See Config file ownership and permissions in the Beats Platform Reference for more information.
-v, --v
Logs INFO-level messages.