Functionbeat command reference

edit

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

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

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

Some of the features described here require an Elastic license. For more information, see https://www.elastic.co/subscriptions and License Management.

Commands

deploy

Deploys the specified function to your serverless environment.

export

Exports the configuration, index template, or AWS CloudFormation template to stdout.

help

Shows help for any command.

package

Packages the configuration and executable into a zip file.

remove

Removes the specified function from your serverless environment.

setup

Sets up the initial environment, including the ES index template, and ILM policy and write alias.

test

Tests the configuration.

update

Updates the specified function.

version

Shows information about the current version.

Also see Global flags.

deploy command

edit

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 command

edit

Exports the configuration, index template, or AWS CloudFormation template to stdout. You can use this command to quickly view your configuration, see the contents of the index template and the ILM policy, or export an CloudFormation template.

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.
template
Exports the index template to stdout. You can specify the --es.version and --index flags to further define what gets exported. Furthermore you can export the template to a file instead of stdout by defining a directory via --dir.
ilm-policy
Exports the index lifecycle management policy to stdout. You can specify the --es.version and a --dir to which the policy should be exported as a file rather than exporting to stdout.
function FUNCTION_NAME
Exports an AWS CloudFormation template to stdout.

FLAGS

--es.version VERSION
When used with template, exports an index template that is compatible with the specified version. When used with ilm-policy, exports the ILM policy if the specified ES version is enabled for ILM.
-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.
--dir DIRNAME
Define a directory to which the template and ILM policy should be exported to as files instead of printing them to stdout.

Also see Global flags.

EXAMPLES

functionbeat export config
functionbeat export template --es.version 7.6.2 --index myindexname
functionbeat export function cloudwatch

help command

edit

Shows help for any 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

package command

edit

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 pattern to use when creating the packages.

Also see Global flags.

EXAMPLES

functionbeat package --output /path/to/folder/package-{{.Provider}}.zip

remove command

edit

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

setup command

edit

Sets up the initial environment, including the ES index template, and ILM policy and write alias

  • The index template ensures that fields are mapped correctly in Elasticsearch. If index lifecycle management is enabled it also ensures that the defined ILM policy and write alias are connected to the indices matching the index template. The ILM policy takes care of the lifecycle of an index, when to do a rollover, when to move an index from the hot phase to the next phase, etc.
  • The machine learning jobs contain the configuration information and metadata necessary to analyze data for anomalies.

This command sets up the environment without actually running Functionbeat and ingesting data.

SYNOPSIS

functionbeat setup [FLAGS]

FLAGS

-h, --help
Shows help for the setup command.
--machine-learning
Sets up machine learning job configurations only.
--index-management
Sets up components related to Elasticsearch index management including template, ILM policy, and write alias (if supported and configured).
--template
[7.2] Deprecated in 7.2. Sets up the index template only. It is recommended to use --index-management instead.
--ilm-policy
[7.2] Deprecated in 7.2. Sets up the index lifecycle management policy. It is recommended to use --index-management instead.

Also see Global flags.

EXAMPLES

functionbeat setup --machine-learning
functionbeat setup --index-management

test command

edit

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 command

edit

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 command

edit

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 flags

edit

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.