OS Manuals

/usr/bin/filebeat

From filebeat-8.17 8.17.10-r33 (enterprise-packages), captured 2026-11-08 by running filebeat --help (exit 0). permalink

Usage:
  filebeat [flags]
  filebeat [command]

Available Commands:
  export      Export current config or index template
  generate    Generate Filebeat modules, filesets and fields.yml
  help        Help about any command
  keystore    Manage secrets keystore
  modules     Manage configured modules
  run         Run filebeat
  setup       Setup index template, dashboards and ML jobs
  test        Test config
  version     Show current version info

Flags:
  -E, --E setting=value              Configuration overwrite
  -M, --M setting=value              Module configuration overwrite
  -N, --N                            Disable actual publishing for testing
  -c, --c string                     Configuration file, relative to path.config (default "filebeat.yml")
      --cpuprofile string            Write cpu profile to file
  -d, --d string                     Enable certain debug selectors
  -e, --e                            Log to stderr and disable syslog/file output
      --environment environmentVar   set environment being ran in (default default)
  -h, --help                         help for filebeat
      --httpprof string              Start pprof http server
      --memprofile string            Write memory profile to this file
      --modules string               List of enabled modules (comma separated)
      --once                         Run filebeat only once until all harvesters reach EOF
      --path.config string           Configuration path
      --path.data string             Data path
      --path.home string             Home path
      --path.logs string             Logs path
      --plugin pluginList            Load additional plugins
      --strict.perms                 Strict permission checking on config files (default true)
  -v, --v                            Log at INFO level

Use "filebeat [command] --help" for more information about a command.
Options (20)
OptionDescriptionSource
-E, --E setting=valueConfiguration overwritehelp
-M, --M setting=valueModule configuration overwritehelp
-N, --NDisable actual publishing for testinghelp
-c, --c stringConfiguration file, relative to path.config (default "filebeat.yml")help
--cpuprofile stringWrite cpu profile to filehelp
-d, --d stringEnable certain debug selectorshelp
-e, --eLog to stderr and disable syslog/file outputhelp
--environment environmentVarset environment being ran in (default default)help
-h, --helphelp for filebeathelp
--httpprof stringStart pprof http serverhelp
--memprofile stringWrite memory profile to this filehelp
--modules stringList of enabled modules (comma separated)help
--onceRun filebeat only once until all harvesters reach EOFhelp
--path.config stringConfiguration pathhelp
--path.data stringData pathhelp
--path.home stringHome pathhelp
--path.logs stringLogs pathhelp
--plugin pluginListLoad additional pluginshelp
--strict.permsStrict permission checking on config files (default true)help
-v, --vLog at INFO levelhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.