You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2521 lines
90 KiB

  1. ######################## Filebeat Configuration ############################
  2. # This file is a full configuration example documenting all non-deprecated
  3. # options in comments. For a shorter configuration example, that contains only
  4. # the most common options, please see filebeat.yml in the same directory.
  5. #
  6. # You can find the full configuration reference here:
  7. # https://www.elastic.co/guide/en/beats/filebeat/index.html
  8. #========================== Modules configuration =============================
  9. filebeat.modules:
  10. #-------------------------------- System Module --------------------------------
  11. #- module: system
  12. # Syslog
  13. #syslog:
  14. #enabled: true
  15. # Set custom paths for the log files. If left empty,
  16. # Filebeat will choose the paths depending on your OS.
  17. #var.paths:
  18. # Input configuration (advanced). Any input configuration option
  19. # can be added under this section.
  20. #input:
  21. # Authorization logs
  22. #auth:
  23. #enabled: true
  24. # Set custom paths for the log files. If left empty,
  25. # Filebeat will choose the paths depending on your OS.
  26. #var.paths:
  27. # Input configuration (advanced). Any input configuration option
  28. # can be added under this section.
  29. #input:
  30. #-------------------------------- Apache Module --------------------------------
  31. #- module: apache
  32. # Access logs
  33. #access:
  34. #enabled: true
  35. # Set custom paths for the log files. If left empty,
  36. # Filebeat will choose the paths depending on your OS.
  37. #var.paths:
  38. # Input configuration (advanced). Any input configuration option
  39. # can be added under this section.
  40. #input:
  41. # Error logs
  42. #error:
  43. #enabled: true
  44. # Set custom paths for the log files. If left empty,
  45. # Filebeat will choose the paths depending on your OS.
  46. #var.paths:
  47. # Input configuration (advanced). Any input configuration option
  48. # can be added under this section.
  49. #input:
  50. #-------------------------------- Auditd Module --------------------------------
  51. #- module: auditd
  52. #log:
  53. #enabled: true
  54. # Set custom paths for the log files. If left empty,
  55. # Filebeat will choose the paths depending on your OS.
  56. #var.paths:
  57. # Input configuration (advanced). Any input configuration option
  58. # can be added under this section.
  59. #input:
  60. #---------------------------- Elasticsearch Module ----------------------------
  61. - module: elasticsearch
  62. # Server log
  63. server:
  64. enabled: true
  65. # Set custom paths for the log files. If left empty,
  66. # Filebeat will choose the paths depending on your OS.
  67. #var.paths:
  68. gc:
  69. enabled: true
  70. # Set custom paths for the log files. If left empty,
  71. # Filebeat will choose the paths depending on your OS.
  72. #var.paths:
  73. audit:
  74. enabled: true
  75. # Set custom paths for the log files. If left empty,
  76. # Filebeat will choose the paths depending on your OS.
  77. #var.paths:
  78. slowlog:
  79. enabled: true
  80. # Set custom paths for the log files. If left empty,
  81. # Filebeat will choose the paths depending on your OS.
  82. #var.paths:
  83. deprecation:
  84. enabled: true
  85. # Set custom paths for the log files. If left empty,
  86. # Filebeat will choose the paths depending on your OS.
  87. #var.paths:
  88. #------------------------------- HAProxy Module -------------------------------
  89. - module: haproxy
  90. # All logs
  91. log:
  92. enabled: true
  93. # Set which input to use between syslog (default) or file.
  94. #var.input:
  95. # Set custom paths for the log files. If left empty,
  96. # Filebeat will choose the paths depending on your OS.
  97. #var.paths:
  98. #-------------------------------- Icinga Module --------------------------------
  99. #- module: icinga
  100. # Main logs
  101. #main:
  102. #enabled: true
  103. # Set custom paths for the log files. If left empty,
  104. # Filebeat will choose the paths depending on your OS.
  105. #var.paths:
  106. # Input configuration (advanced). Any input configuration option
  107. # can be added under this section.
  108. #input:
  109. # Debug logs
  110. #debug:
  111. #enabled: true
  112. # Set custom paths for the log files. If left empty,
  113. # Filebeat will choose the paths depending on your OS.
  114. #var.paths:
  115. # Input configuration (advanced). Any input configuration option
  116. # can be added under this section.
  117. #input:
  118. # Startup logs
  119. #startup:
  120. #enabled: true
  121. # Set custom paths for the log files. If left empty,
  122. # Filebeat will choose the paths depending on your OS.
  123. #var.paths:
  124. # Input configuration (advanced). Any input configuration option
  125. # can be added under this section.
  126. #input:
  127. #--------------------------------- IIS Module ---------------------------------
  128. #- module: iis
  129. # Access logs
  130. #access:
  131. #enabled: true
  132. # Set custom paths for the log files. If left empty,
  133. # Filebeat will choose the paths depending on your OS.
  134. #var.paths:
  135. # Input configuration (advanced). Any input configuration option
  136. # can be added under this section.
  137. #input:
  138. # Error logs
  139. #error:
  140. #enabled: true
  141. # Set custom paths for the log files. If left empty,
  142. # Filebeat will choose the paths depending on your OS.
  143. #var.paths:
  144. # Input configuration (advanced). Any input configuration option
  145. # can be added under this section.
  146. #input:
  147. #-------------------------------- Kafka Module --------------------------------
  148. - module: kafka
  149. # All logs
  150. log:
  151. enabled: true
  152. # Set custom paths for Kafka. If left empty,
  153. # Filebeat will look under /opt.
  154. #var.kafka_home:
  155. # Set custom paths for the log files. If left empty,
  156. # Filebeat will choose the paths depending on your OS.
  157. #var.paths:
  158. #-------------------------------- Kibana Module --------------------------------
  159. - module: kibana
  160. # Server logs
  161. log:
  162. enabled: true
  163. # Set custom paths for the log files. If left empty,
  164. # Filebeat will choose the paths depending on your OS.
  165. #var.paths:
  166. # Audit logs
  167. audit:
  168. enabled: true
  169. # Set custom paths for the log files. If left empty,
  170. # Filebeat will choose the paths depending on your OS.
  171. #var.paths:
  172. #------------------------------- Logstash Module -------------------------------
  173. #- module: logstash
  174. # logs
  175. #log:
  176. #enabled: true
  177. # Set custom paths for the log files. If left empty,
  178. # Filebeat will choose the paths depending on your OS.
  179. # var.paths:
  180. # Slow logs
  181. #slowlog:
  182. #enabled: true
  183. # Set custom paths for the log files. If left empty,
  184. # Filebeat will choose the paths depending on your OS.
  185. #var.paths:
  186. #------------------------------- Mongodb Module -------------------------------
  187. #- module: mongodb
  188. # Logs
  189. #log:
  190. #enabled: true
  191. # Set custom paths for the log files. If left empty,
  192. # Filebeat will choose the paths depending on your OS.
  193. #var.paths:
  194. # Input configuration (advanced). Any input configuration option
  195. # can be added under this section.
  196. #input:
  197. #-------------------------------- MySQL Module --------------------------------
  198. #- module: mysql
  199. # Error logs
  200. #error:
  201. #enabled: true
  202. # Set custom paths for the log files. If left empty,
  203. # Filebeat will choose the paths depending on your OS.
  204. #var.paths:
  205. # Input configuration (advanced). Any input configuration option
  206. # can be added under this section.
  207. #input:
  208. # Slow logs
  209. #slowlog:
  210. #enabled: true
  211. # Set custom paths for the log files. If left empty,
  212. # Filebeat will choose the paths depending on your OS.
  213. #var.paths:
  214. # Input configuration (advanced). Any input configuration option
  215. # can be added under this section.
  216. #input:
  217. #--------------------------------- NATS Module ---------------------------------
  218. - module: nats
  219. # All logs
  220. log:
  221. enabled: true
  222. # Set custom paths for the log files. If left empty,
  223. # Filebeat will choose the paths depending on your OS.
  224. #var.paths:
  225. #-------------------------------- Nginx Module --------------------------------
  226. #- module: nginx
  227. # Access logs
  228. #access:
  229. #enabled: true
  230. # Set custom paths for the log files. If left empty,
  231. # Filebeat will choose the paths depending on your OS.
  232. #var.paths:
  233. # Input configuration (advanced). Any input configuration option
  234. # can be added under this section.
  235. #input:
  236. # Error logs
  237. #error:
  238. #enabled: true
  239. # Set custom paths for the log files. If left empty,
  240. # Filebeat will choose the paths depending on your OS.
  241. #var.paths:
  242. # Input configuration (advanced). Any input configuration option
  243. # can be added under this section.
  244. #input:
  245. # Ingress-nginx controller logs. This is disabled by default. It could be used in Kubernetes environments to parse ingress-nginx logs
  246. #ingress_controller:
  247. # enabled: false
  248. #
  249. # # Set custom paths for the log files. If left empty,
  250. # # Filebeat will choose the paths depending on your OS.
  251. # #var.paths:
  252. #------------------------------- Osquery Module -------------------------------
  253. - module: osquery
  254. result:
  255. enabled: true
  256. # Set custom paths for the log files. If left empty,
  257. # Filebeat will choose the paths depending on your OS.
  258. #var.paths:
  259. # If true, all fields created by this module are prefixed with
  260. # `osquery.result`. Set to false to copy the fields in the root
  261. # of the document. The default is true.
  262. #var.use_namespace: true
  263. #------------------------------ PostgreSQL Module ------------------------------
  264. #- module: postgresql
  265. # Logs
  266. #log:
  267. #enabled: true
  268. # Set custom paths for the log files. If left empty,
  269. # Filebeat will choose the paths depending on your OS.
  270. #var.paths:
  271. # Input configuration (advanced). Any input configuration option
  272. # can be added under this section.
  273. #input:
  274. #-------------------------------- Redis Module --------------------------------
  275. #- module: redis
  276. # Main logs
  277. #log:
  278. #enabled: true
  279. # Set custom paths for the log files. If left empty,
  280. # Filebeat will choose the paths depending on your OS.
  281. #var.paths: ["/var/log/redis/redis-server.log*"]
  282. # Slow logs, retrieved via the Redis API (SLOWLOG)
  283. #slowlog:
  284. #enabled: true
  285. # The Redis hosts to connect to.
  286. #var.hosts: ["localhost:6379"]
  287. # Optional, the password to use when connecting to Redis.
  288. #var.password:
  289. #----------------------------- Google Santa Module -----------------------------
  290. - module: santa
  291. log:
  292. enabled: true
  293. # Set custom paths for the log files. If left empty,
  294. # Filebeat will choose the the default path.
  295. #var.paths:
  296. #------------------------------- Traefik Module -------------------------------
  297. #- module: traefik
  298. # Access logs
  299. #access:
  300. #enabled: true
  301. # Set custom paths for the log files. If left empty,
  302. # Filebeat will choose the paths depending on your OS.
  303. #var.paths:
  304. # Input configuration (advanced). Any input configuration option
  305. # can be added under this section.
  306. #input:
  307. #=========================== Filebeat inputs =============================
  308. # List of inputs to fetch data.
  309. filebeat.inputs:
  310. # Each - is an input. Most options can be set at the input level, so
  311. # you can use different inputs for various configurations.
  312. # Below are the input specific configurations.
  313. # Type of the files. Based on this the way the file is read is decided.
  314. # The different types cannot be mixed in one input
  315. #
  316. # Possible options are:
  317. # * log: Reads every line of the log file (default)
  318. # * filestream: Improved version of log input. Experimental.
  319. # * stdin: Reads the standard in
  320. #------------------------------ Log input --------------------------------
  321. - type: log
  322. # Change to true to enable this input configuration.
  323. enabled: false
  324. # Paths that should be crawled and fetched. Glob based paths.
  325. # To fetch all ".log" files from a specific level of subdirectories
  326. # /var/log/*/*.log can be used.
  327. # For each file found under this path, a harvester is started.
  328. # Make sure not file is defined twice as this can lead to unexpected behaviour.
  329. paths:
  330. - /var/log/*.log
  331. #- c:\programdata\elasticsearch\logs\*
  332. # Configure the file encoding for reading files with international characters
  333. # following the W3C recommendation for HTML5 (http://www.w3.org/TR/encoding).
  334. # Some sample encodings:
  335. # plain, utf-8, utf-16be-bom, utf-16be, utf-16le, big5, gb18030, gbk,
  336. # hz-gb-2312, euc-kr, euc-jp, iso-2022-jp, shift-jis, ...
  337. #encoding: plain
  338. # Exclude lines. A list of regular expressions to match. It drops the lines that are
  339. # matching any regular expression from the list. The include_lines is called before
  340. # exclude_lines. By default, no lines are dropped.
  341. #exclude_lines: ['^DBG']
  342. # Include lines. A list of regular expressions to match. It exports the lines that are
  343. # matching any regular expression from the list. The include_lines is called before
  344. # exclude_lines. By default, all the lines are exported.
  345. #include_lines: ['^ERR', '^WARN']
  346. # Exclude files. A list of regular expressions to match. Filebeat drops the files that
  347. # are matching any regular expression from the list. By default, no files are dropped.
  348. #exclude_files: ['.gz$']
  349. # Method to determine if two files are the same or not. By default
  350. # the Beat considers two files the same if their inode and device id are the same.
  351. #file_identity.native: ~
  352. # Optional additional fields. These fields can be freely picked
  353. # to add additional information to the crawled log files for filtering
  354. #fields:
  355. # level: debug
  356. # review: 1
  357. # Set to true to store the additional fields as top level fields instead
  358. # of under the "fields" sub-dictionary. In case of name conflicts with the
  359. # fields added by Filebeat itself, the custom fields overwrite the default
  360. # fields.
  361. #fields_under_root: false
  362. # Set to true to publish fields with null values in events.
  363. #keep_null: false
  364. # By default, all events contain `host.name`. This option can be set to true
  365. # to disable the addition of this field to all events. The default value is
  366. # false.
  367. #publisher_pipeline.disable_host: false
  368. # Ignore files which were modified more then the defined timespan in the past.
  369. # ignore_older is disabled by default, so no files are ignored by setting it to 0.
  370. # Time strings like 2h (2 hours), 5m (5 minutes) can be used.
  371. #ignore_older: 0
  372. # How often the input checks for new files in the paths that are specified
  373. # for harvesting. Specify 1s to scan the directory as frequently as possible
  374. # without causing Filebeat to scan too frequently. Default: 10s.
  375. #scan_frequency: 10s
  376. # Defines the buffer size every harvester uses when fetching the file
  377. #harvester_buffer_size: 16384
  378. # Maximum number of bytes a single log event can have
  379. # All bytes after max_bytes are discarded and not sent. The default is 10MB.
  380. # This is especially useful for multiline log messages which can get large.
  381. #max_bytes: 10485760
  382. # Characters which separate the lines. Valid values: auto, line_feed, vertical_tab, form_feed,
  383. # carriage_return, carriage_return_line_feed, next_line, line_separator, paragraph_separator.
  384. #line_terminator: auto
  385. ### Recursive glob configuration
  386. # Expand "**" patterns into regular glob patterns.
  387. #recursive_glob.enabled: true
  388. ### JSON configuration
  389. # Decode JSON options. Enable this if your logs are structured in JSON.
  390. # JSON key on which to apply the line filtering and multiline settings. This key
  391. # must be top level and its value must be string, otherwise it is ignored. If
  392. # no text key is defined, the line filtering and multiline features cannot be used.
  393. #json.message_key:
  394. # By default, the decoded JSON is placed under a "json" key in the output document.
  395. # If you enable this setting, the keys are copied top level in the output document.
  396. #json.keys_under_root: false
  397. # If keys_under_root and this setting are enabled, then the values from the decoded
  398. # JSON object overwrite the fields that Filebeat normally adds (type, source, offset, etc.)
  399. # in case of conflicts.
  400. #json.overwrite_keys: false
  401. # If this setting is enabled, then keys in the decoded JSON object will be recursively
  402. # de-dotted, and expanded into a hierarchical object structure.
  403. # For example, `{"a.b.c": 123}` would be expanded into `{"a":{"b":{"c":123}}}`.
  404. #json.expand_keys: false
  405. # If this setting is enabled, Filebeat adds a "error.message" and "error.key: json" key in case of JSON
  406. # unmarshaling errors or when a text key is defined in the configuration but cannot
  407. # be used.
  408. #json.add_error_key: false
  409. ### Multiline options
  410. # Multiline can be used for log messages spanning multiple lines. This is common
  411. # for Java Stack Traces or C-Line Continuation
  412. # The regexp Pattern that has to be matched. The example pattern matches all lines starting with [
  413. #multiline.pattern: ^\[
  414. # Defines if the pattern set under pattern should be negated or not. Default is false.
  415. #multiline.negate: false
  416. # Match can be set to "after" or "before". It is used to define if lines should be append to a pattern
  417. # that was (not) matched before or after or as long as a pattern is not matched based on negate.
  418. # Note: After is the equivalent to previous and before is the equivalent to to next in Logstash
  419. #multiline.match: after
  420. # The maximum number of lines that are combined to one event.
  421. # In case there are more the max_lines the additional lines are discarded.
  422. # Default is 500
  423. #multiline.max_lines: 500
  424. # After the defined timeout, an multiline event is sent even if no new pattern was found to start a new event
  425. # Default is 5s.
  426. #multiline.timeout: 5s
  427. # To aggregate constant number of lines into a single event use the count mode of multiline.
  428. #multiline.type: count
  429. # The number of lines to aggregate into a single event.
  430. #multiline.count_lines: 3
  431. # Do not add new line character when concatenating lines.
  432. #multiline.skip_newline: false
  433. # Setting tail_files to true means filebeat starts reading new files at the end
  434. # instead of the beginning. If this is used in combination with log rotation
  435. # this can mean that the first entries of a new file are skipped.
  436. #tail_files: false
  437. # The Ingest Node pipeline ID associated with this input. If this is set, it
  438. # overwrites the pipeline option from the Elasticsearch output.
  439. #pipeline:
  440. # If symlinks is enabled, symlinks are opened and harvested. The harvester is opening the
  441. # original for harvesting but will report the symlink name as source.
  442. #symlinks: false
  443. # Backoff values define how aggressively filebeat crawls new files for updates
  444. # The default values can be used in most cases. Backoff defines how long it is waited
  445. # to check a file again after EOF is reached. Default is 1s which means the file
  446. # is checked every second if new lines were added. This leads to a near real time crawling.
  447. # Every time a new line appears, backoff is reset to the initial value.
  448. #backoff: 1s
  449. # Max backoff defines what the maximum backoff time is. After having backed off multiple times
  450. # from checking the files, the waiting time will never exceed max_backoff independent of the
  451. # backoff factor. Having it set to 10s means in the worst case a new line can be added to a log
  452. # file after having backed off multiple times, it takes a maximum of 10s to read the new line
  453. #max_backoff: 10s
  454. # The backoff factor defines how fast the algorithm backs off. The bigger the backoff factor,
  455. # the faster the max_backoff value is reached. If this value is set to 1, no backoff will happen.
  456. # The backoff value will be multiplied each time with the backoff_factor until max_backoff is reached
  457. #backoff_factor: 2
  458. # Max number of harvesters that are started in parallel.
  459. # Default is 0 which means unlimited
  460. #harvester_limit: 0
  461. ### Harvester closing options
  462. # Close inactive closes the file handler after the predefined period.
  463. # The period starts when the last line of the file was, not the file ModTime.
  464. # Time strings like 2h (2 hours), 5m (5 minutes) can be used.
  465. #close_inactive: 5m
  466. # Close renamed closes a file handler when the file is renamed or rotated.
  467. # Note: Potential data loss. Make sure to read and understand the docs for this option.
  468. #close_renamed: false
  469. # When enabling this option, a file handler is closed immediately in case a file can't be found
  470. # any more. In case the file shows up again later, harvesting will continue at the last known position
  471. # after scan_frequency.
  472. #close_removed: true
  473. # Closes the file handler as soon as the harvesters reaches the end of the file.
  474. # By default this option is disabled.
  475. # Note: Potential data loss. Make sure to read and understand the docs for this option.
  476. #close_eof: false
  477. ### State options
  478. # Files for the modification data is older then clean_inactive the state from the registry is removed
  479. # By default this is disabled.
  480. #clean_inactive: 0
  481. # Removes the state for file which cannot be found on disk anymore immediately
  482. #clean_removed: true
  483. # Close timeout closes the harvester after the predefined time.
  484. # This is independent if the harvester did finish reading the file or not.
  485. # By default this option is disabled.
  486. # Note: Potential data loss. Make sure to read and understand the docs for this option.
  487. #close_timeout: 0
  488. # Defines if inputs is enabled
  489. #enabled: true
  490. #--------------------------- Filestream input ----------------------------
  491. - type: filestream
  492. # Change to true to enable this input configuration.
  493. enabled: false
  494. # Paths that should be crawled and fetched. Glob based paths.
  495. # To fetch all ".log" files from a specific level of subdirectories
  496. # /var/log/*/*.log can be used.
  497. # For each file found under this path, a harvester is started.
  498. # Make sure not file is defined twice as this can lead to unexpected behaviour.
  499. paths:
  500. - /var/log/*.log
  501. #- c:\programdata\elasticsearch\logs\*
  502. # Configure the file encoding for reading files with international characters
  503. # following the W3C recommendation for HTML5 (http://www.w3.org/TR/encoding).
  504. # Some sample encodings:
  505. # plain, utf-8, utf-16be-bom, utf-16be, utf-16le, big5, gb18030, gbk,
  506. # hz-gb-2312, euc-kr, euc-jp, iso-2022-jp, shift-jis, ...
  507. #encoding: plain
  508. # Exclude lines. A list of regular expressions to match. It drops the lines that are
  509. # matching any regular expression from the list. The include_lines is called before
  510. # exclude_lines. By default, no lines are dropped.
  511. #exclude_lines: ['^DBG']
  512. # Include lines. A list of regular expressions to match. It exports the lines that are
  513. # matching any regular expression from the list. The include_lines is called before
  514. # exclude_lines. By default, all the lines are exported.
  515. #include_lines: ['^ERR', '^WARN']
  516. ### Prospector options
  517. # How often the input checks for new files in the paths that are specified
  518. # for harvesting. Specify 1s to scan the directory as frequently as possible
  519. # without causing Filebeat to scan too frequently. Default: 10s.
  520. #prospector.scanner.check_interval: 10s
  521. # Exclude files. A list of regular expressions to match. Filebeat drops the files that
  522. # are matching any regular expression from the list. By default, no files are dropped.
  523. #prospector.scanner.exclude_files: ['.gz$']
  524. # Expand "**" patterns into regular glob patterns.
  525. #prospector.scanner.recursive_glob: true
  526. # If symlinks is enabled, symlinks are opened and harvested. The harvester is opening the
  527. # original for harvesting but will report the symlink name as source.
  528. #prospector.scanner.symlinks: false
  529. ### State options
  530. # Files for the modification data is older then clean_inactive the state from the registry is removed
  531. # By default this is disabled.
  532. #clean_inactive: 0
  533. # Removes the state for file which cannot be found on disk anymore immediately
  534. #clean_removed: true
  535. # Method to determine if two files are the same or not. By default
  536. # the Beat considers two files the same if their inode and device id are the same.
  537. #file_identity.native: ~
  538. # Optional additional fields. These fields can be freely picked
  539. # to add additional information to the crawled log files for filtering
  540. #fields:
  541. # level: debug
  542. # review: 1
  543. # Set to true to publish fields with null values in events.
  544. #keep_null: false
  545. # By default, all events contain `host.name`. This option can be set to true
  546. # to disable the addition of this field to all events. The default value is
  547. # false.
  548. #publisher_pipeline.disable_host: false
  549. # Ignore files which were modified more then the defined timespan in the past.
  550. # ignore_older is disabled by default, so no files are ignored by setting it to 0.
  551. # Time strings like 2h (2 hours), 5m (5 minutes) can be used.
  552. #ignore_older: 0
  553. # Defines the buffer size every harvester uses when fetching the file
  554. #harvester_buffer_size: 16384
  555. # Maximum number of bytes a single log event can have
  556. # All bytes after max_bytes are discarded and not sent. The default is 10MB.
  557. # This is especially useful for multiline log messages which can get large.
  558. #message_max_bytes: 10485760
  559. # Characters which separate the lines. Valid values: auto, line_feed, vertical_tab, form_feed,
  560. # carriage_return, carriage_return_line_feed, next_line, line_separator, paragraph_separator.
  561. #line_terminator: auto
  562. # The Ingest Node pipeline ID associated with this input. If this is set, it
  563. # overwrites the pipeline option from the Elasticsearch output.
  564. #pipeline:
  565. # Backoff values define how aggressively filebeat crawls new files for updates
  566. # The default values can be used in most cases. Backoff defines how long it is waited
  567. # to check a file again after EOF is reached. Default is 1s which means the file
  568. # is checked every second if new lines were added. This leads to a near real time crawling.
  569. # Every time a new line appears, backoff is reset to the initial value.
  570. #backoff.init: 1s
  571. # Max backoff defines what the maximum backoff time is. After having backed off multiple times
  572. # from checking the files, the waiting time will never exceed max_backoff independent of the
  573. # backoff factor. Having it set to 10s means in the worst case a new line can be added to a log
  574. # file after having backed off multiple times, it takes a maximum of 10s to read the new line
  575. #backoff.max: 10s
  576. ### Harvester closing options
  577. # Close inactive closes the file handler after the predefined period.
  578. # The period starts when the last line of the file was, not the file ModTime.
  579. # Time strings like 2h (2 hours), 5m (5 minutes) can be used.
  580. #close.on_state_change.inactive: 5m
  581. # Close renamed closes a file handler when the file is renamed or rotated.
  582. # Note: Potential data loss. Make sure to read and understand the docs for this option.
  583. #close.on_state_change.renamed: false
  584. # When enabling this option, a file handler is closed immediately in case a file can't be found
  585. # any more. In case the file shows up again later, harvesting will continue at the last known position
  586. # after scan_frequency.
  587. #close.on_state_change.removed: true
  588. # Closes the file handler as soon as the harvesters reaches the end of the file.
  589. # By default this option is disabled.
  590. # Note: Potential data loss. Make sure to read and understand the docs for this option.
  591. #close.reader.eof: false
  592. # Close timeout closes the harvester after the predefined time.
  593. # This is independent if the harvester did finish reading the file or not.
  594. # By default this option is disabled.
  595. # Note: Potential data loss. Make sure to read and understand the docs for this option.
  596. #close.reader.after_interval: 0
  597. #----------------------------- Stdin input -------------------------------
  598. # Configuration to use stdin input
  599. #- type: stdin
  600. #------------------------- Redis slowlog input ---------------------------
  601. # Experimental: Config options for the redis slow log input
  602. #- type: redis
  603. #enabled: false
  604. # List of hosts to pool to retrieve the slow log information.
  605. #hosts: ["localhost:6379"]
  606. # How often the input checks for redis slow log.
  607. #scan_frequency: 10s
  608. # Timeout after which time the input should return an error
  609. #timeout: 1s
  610. # Network type to be used for redis connection. Default: tcp
  611. #network: tcp
  612. # Max number of concurrent connections. Default: 10
  613. #maxconn: 10
  614. # Redis AUTH password. Empty by default.
  615. #password: foobared
  616. #------------------------------ Udp input --------------------------------
  617. # Experimental: Config options for the udp input
  618. #- type: udp
  619. #enabled: false
  620. # Maximum size of the message received over UDP
  621. #max_message_size: 10KiB
  622. # Size of the UDP read buffer in bytes
  623. #read_buffer: 0
  624. #------------------------------ TCP input --------------------------------
  625. # Experimental: Config options for the TCP input
  626. #- type: tcp
  627. #enabled: false
  628. # The host and port to receive the new event
  629. #host: "localhost:9000"
  630. # Character used to split new message
  631. #line_delimiter: "\n"
  632. # Maximum size in bytes of the message received over TCP
  633. #max_message_size: 20MiB
  634. # Max number of concurrent connections, or 0 for no limit. Default: 0
  635. #max_connections: 0
  636. # The number of seconds of inactivity before a remote connection is closed.
  637. #timeout: 300s
  638. # Use SSL settings for TCP.
  639. #ssl.enabled: true
  640. # List of supported/valid TLS versions. By default all TLS versions 1.0 up to
  641. # 1.2 are enabled.
  642. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
  643. # SSL configuration. By default is off.
  644. # List of root certificates for client verifications
  645. #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
  646. # Certificate for SSL server authentication.
  647. #ssl.certificate: "/etc/pki/client/cert.pem"
  648. # Server Certificate Key,
  649. #ssl.key: "/etc/pki/client/cert.key"
  650. # Optional passphrase for decrypting the Certificate Key.
  651. #ssl.key_passphrase: ''
  652. # Configure cipher suites to be used for SSL connections.
  653. #ssl.cipher_suites: []
  654. # Configure curve types for ECDHE based cipher suites.
  655. #ssl.curve_types: []
  656. # Configure what types of client authentication are supported. Valid options
  657. # are `none`, `optional`, and `required`. When `certificate_authorities` is set it will
  658. # default to `required` otherwise it will be set to `none`.
  659. #ssl.client_authentication: "required"
  660. #------------------------------ Syslog input --------------------------------
  661. # Experimental: Config options for the Syslog input
  662. # Accept RFC3164 formatted syslog event via UDP.
  663. #- type: syslog
  664. #enabled: false
  665. #protocol.udp:
  666. # The host and port to receive the new event
  667. #host: "localhost:9000"
  668. # Maximum size of the message received over UDP
  669. #max_message_size: 10KiB
  670. # Accept RFC3164 formatted syslog event via TCP.
  671. #- type: syslog
  672. #enabled: false
  673. #protocol.tcp:
  674. # The host and port to receive the new event
  675. #host: "localhost:9000"
  676. # Character used to split new message
  677. #line_delimiter: "\n"
  678. # Maximum size in bytes of the message received over TCP
  679. #max_message_size: 20MiB
  680. # The number of seconds of inactivity before a remote connection is closed.
  681. #timeout: 300s
  682. # Use SSL settings for TCP.
  683. #ssl.enabled: true
  684. # List of supported/valid TLS versions. By default all TLS versions 1.0 up to
  685. # 1.2 are enabled.
  686. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
  687. # SSL configuration. By default is off.
  688. # List of root certificates for client verifications
  689. #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
  690. # Certificate for SSL server authentication.
  691. #ssl.certificate: "/etc/pki/client/cert.pem"
  692. # Server Certificate Key,
  693. #ssl.key: "/etc/pki/client/cert.key"
  694. # Optional passphrase for decrypting the Certificate Key.
  695. #ssl.key_passphrase: ''
  696. # Configure cipher suites to be used for SSL connections.
  697. #ssl.cipher_suites: []
  698. # Configure curve types for ECDHE based cipher suites.
  699. #ssl.curve_types: []
  700. # Configure what types of client authentication are supported. Valid options
  701. # are `none`, `optional`, and `required`. When `certificate_authorities` is set it will
  702. # default to `required` otherwise it will be set to `none`.
  703. #ssl.client_authentication: "required"
  704. #------------------------------ Container input --------------------------------
  705. #- type: container
  706. #enabled: false
  707. # Paths for container logs that should be crawled and fetched.
  708. #paths:
  709. # -/var/lib/docker/containers/*/*.log
  710. # Configure stream to filter to a specific stream: stdout, stderr or all (default)
  711. #stream: all
  712. # =========================== Filebeat autodiscover ============================
  713. # Autodiscover allows you to detect changes in the system and spawn new modules
  714. # or inputs as they happen.
  715. #filebeat.autodiscover:
  716. # List of enabled autodiscover providers
  717. # providers:
  718. # - type: docker
  719. # templates:
  720. # - condition:
  721. # equals.docker.container.image: busybox
  722. # config:
  723. # - type: container
  724. # paths:
  725. # - /var/lib/docker/containers/${data.docker.container.id}/*.log
  726. # ========================== Filebeat global options ===========================
  727. # Registry data path. If a relative path is used, it is considered relative to the
  728. # data path.
  729. #filebeat.registry.path: ${path.data}/registry
  730. # The permissions mask to apply on registry data, and meta files. The default
  731. # value is 0600. Must be a valid Unix-style file permissions mask expressed in
  732. # octal notation. This option is not supported on Windows.
  733. #filebeat.registry.file_permissions: 0600
  734. # The timeout value that controls when registry entries are written to disk
  735. # (flushed). When an unwritten update exceeds this value, it triggers a write
  736. # to disk. When flush is set to 0s, the registry is written to disk after each
  737. # batch of events has been published successfully. The default value is 0s.
  738. #filebeat.registry.flush: 0s
  739. # Starting with Filebeat 7.0, the registry uses a new directory format to store
  740. # Filebeat state. After you upgrade, Filebeat will automatically migrate a 6.x
  741. # registry file to use the new directory format. If you changed
  742. # filebeat.registry.path while upgrading, set filebeat.registry.migrate_file to
  743. # point to the old registry file.
  744. #filebeat.registry.migrate_file: ${path.data}/registry
  745. # By default Ingest pipelines are not updated if a pipeline with the same ID
  746. # already exists. If this option is enabled Filebeat overwrites pipelines
  747. # everytime a new Elasticsearch connection is established.
  748. #filebeat.overwrite_pipelines: false
  749. # How long filebeat waits on shutdown for the publisher to finish.
  750. # Default is 0, not waiting.
  751. #filebeat.shutdown_timeout: 0
  752. # Enable filebeat config reloading
  753. #filebeat.config:
  754. #inputs:
  755. #enabled: false
  756. #path: inputs.d/*.yml
  757. #reload.enabled: true
  758. #reload.period: 10s
  759. #modules:
  760. #enabled: false
  761. #path: modules.d/*.yml
  762. #reload.enabled: true
  763. #reload.period: 10s
  764. # ================================== General ===================================
  765. # The name of the shipper that publishes the network data. It can be used to group
  766. # all the transactions sent by a single shipper in the web interface.
  767. # If this options is not defined, the hostname is used.
  768. #name:
  769. # The tags of the shipper are included in their own field with each
  770. # transaction published. Tags make it easy to group servers by different
  771. # logical properties.
  772. #tags: ["service-X", "web-tier"]
  773. # Optional fields that you can specify to add additional information to the
  774. # output. Fields can be scalar values, arrays, dictionaries, or any nested
  775. # combination of these.
  776. #fields:
  777. # env: staging
  778. # If this option is set to true, the custom fields are stored as top-level
  779. # fields in the output document instead of being grouped under a fields
  780. # sub-dictionary. Default is false.
  781. #fields_under_root: false
  782. # Internal queue configuration for buffering events to be published.
  783. #queue:
  784. # Queue type by name (default 'mem')
  785. # The memory queue will present all available events (up to the outputs
  786. # bulk_max_size) to the output, the moment the output is ready to server
  787. # another batch of events.
  788. #mem:
  789. # Max number of events the queue can buffer.
  790. #events: 4096
  791. # Hints the minimum number of events stored in the queue,
  792. # before providing a batch of events to the outputs.
  793. # The default value is set to 2048.
  794. # A value of 0 ensures events are immediately available
  795. # to be sent to the outputs.
  796. #flush.min_events: 2048
  797. # Maximum duration after which events are available to the outputs,
  798. # if the number of events stored in the queue is < `flush.min_events`.
  799. #flush.timeout: 1s
  800. # The disk queue stores incoming events on disk until the output is
  801. # ready for them. This allows a higher event limit than the memory-only
  802. # queue and lets pending events persist through a restart.
  803. #disk:
  804. # The directory path to store the queue's data.
  805. #path: "${path.data}/diskqueue"
  806. # The maximum space the queue should occupy on disk. Depending on
  807. # input settings, events that exceed this limit are delayed or discarded.
  808. #max_size: 10GB
  809. # The maximum size of a single queue data file. Data in the queue is
  810. # stored in smaller segments that are deleted after all their events
  811. # have been processed.
  812. #segment_size: 1GB
  813. # The number of events to read from disk to memory while waiting for
  814. # the output to request them.
  815. #read_ahead: 512
  816. # The number of events to accept from inputs while waiting for them
  817. # to be written to disk. If event data arrives faster than it
  818. # can be written to disk, this setting prevents it from overflowing
  819. # main memory.
  820. #write_ahead: 2048
  821. # The duration to wait before retrying when the queue encounters a disk
  822. # write error.
  823. #retry_interval: 1s
  824. # The maximum length of time to wait before retrying on a disk write
  825. # error. If the queue encounters repeated errors, it will double the
  826. # length of its retry interval each time, up to this maximum.
  827. #max_retry_interval: 30s
  828. # The spool queue will store events in a local spool file, before
  829. # forwarding the events to the outputs.
  830. #
  831. # Beta: spooling to disk is currently a beta feature. Use with care.
  832. #
  833. # The spool file is a circular buffer, which blocks once the file/buffer is full.
  834. # Events are put into a write buffer and flushed once the write buffer
  835. # is full or the flush_timeout is triggered.
  836. # Once ACKed by the output, events are removed immediately from the queue,
  837. # making space for new events to be persisted.
  838. #spool:
  839. # The file namespace configures the file path and the file creation settings.
  840. # Once the file exists, the `size`, `page_size` and `prealloc` settings
  841. # will have no more effect.
  842. #file:
  843. # Location of spool file. The default value is ${path.data}/spool.dat.
  844. #path: "${path.data}/spool.dat"
  845. # Configure file permissions if file is created. The default value is 0600.
  846. #permissions: 0600
  847. # File size hint. The spool blocks, once this limit is reached. The default value is 100 MiB.
  848. #size: 100MiB
  849. # The files page size. A file is split into multiple pages of the same size. The default value is 4KiB.
  850. #page_size: 4KiB
  851. # If prealloc is set, the required space for the file is reserved using
  852. # truncate. The default value is true.
  853. #prealloc: true
  854. # Spool writer settings
  855. # Events are serialized into a write buffer. The write buffer is flushed if:
  856. # - The buffer limit has been reached.
  857. # - The configured limit of buffered events is reached.
  858. # - The flush timeout is triggered.
  859. #write:
  860. # Sets the write buffer size.
  861. #buffer_size: 1MiB
  862. # Maximum duration after which events are flushed if the write buffer
  863. # is not full yet. The default value is 1s.
  864. #flush.timeout: 1s
  865. # Number of maximum buffered events. The write buffer is flushed once the
  866. # limit is reached.
  867. #flush.events: 16384
  868. # Configure the on-disk event encoding. The encoding can be changed
  869. # between restarts.
  870. # Valid encodings are: json, ubjson, and cbor.
  871. #codec: cbor
  872. #read:
  873. # Reader flush timeout, waiting for more events to become available, so
  874. # to fill a complete batch as required by the outputs.
  875. # If flush_timeout is 0, all available events are forwarded to the
  876. # outputs immediately.
  877. # The default value is 0s.
  878. #flush.timeout: 0s
  879. # Sets the maximum number of CPUs that can be executing simultaneously. The
  880. # default is the number of logical CPUs available in the system.
  881. #max_procs:
  882. # ================================= Processors =================================
  883. # Processors are used to reduce the number of fields in the exported event or to
  884. # enhance the event with external metadata. This section defines a list of
  885. # processors that are applied one by one and the first one receives the initial
  886. # event:
  887. #
  888. # event -> filter1 -> event1 -> filter2 ->event2 ...
  889. #
  890. # The supported processors are drop_fields, drop_event, include_fields,
  891. # decode_json_fields, and add_cloud_metadata.
  892. #
  893. # For example, you can use the following processors to keep the fields that
  894. # contain CPU load percentages, but remove the fields that contain CPU ticks
  895. # values:
  896. #
  897. #processors:
  898. # - include_fields:
  899. # fields: ["cpu"]
  900. # - drop_fields:
  901. # fields: ["cpu.user", "cpu.system"]
  902. #
  903. # The following example drops the events that have the HTTP response code 200:
  904. #
  905. #processors:
  906. # - drop_event:
  907. # when:
  908. # equals:
  909. # http.code: 200
  910. #
  911. # The following example renames the field a to b:
  912. #
  913. #processors:
  914. # - rename:
  915. # fields:
  916. # - from: "a"
  917. # to: "b"
  918. #
  919. # The following example tokenizes the string into fields:
  920. #
  921. #processors:
  922. # - dissect:
  923. # tokenizer: "%{key1} - %{key2}"
  924. # field: "message"
  925. # target_prefix: "dissect"
  926. #
  927. # The following example enriches each event with metadata from the cloud
  928. # provider about the host machine. It works on EC2, GCE, DigitalOcean,
  929. # Tencent Cloud, and Alibaba Cloud.
  930. #
  931. #processors:
  932. # - add_cloud_metadata: ~
  933. #
  934. # The following example enriches each event with the machine's local time zone
  935. # offset from UTC.
  936. #
  937. #processors:
  938. # - add_locale:
  939. # format: offset
  940. #
  941. # The following example enriches each event with docker metadata, it matches
  942. # given fields to an existing container id and adds info from that container:
  943. #
  944. #processors:
  945. # - add_docker_metadata:
  946. # host: "unix:///var/run/docker.sock"
  947. # match_fields: ["system.process.cgroup.id"]
  948. # match_pids: ["process.pid", "process.ppid"]
  949. # match_source: true
  950. # match_source_index: 4
  951. # match_short_id: false
  952. # cleanup_timeout: 60
  953. # labels.dedot: false
  954. # # To connect to Docker over TLS you must specify a client and CA certificate.
  955. # #ssl:
  956. # # certificate_authority: "/etc/pki/root/ca.pem"
  957. # # certificate: "/etc/pki/client/cert.pem"
  958. # # key: "/etc/pki/client/cert.key"
  959. #
  960. # The following example enriches each event with docker metadata, it matches
  961. # container id from log path available in `source` field (by default it expects
  962. # it to be /var/lib/docker/containers/*/*.log).
  963. #
  964. #processors:
  965. # - add_docker_metadata: ~
  966. #
  967. # The following example enriches each event with host metadata.
  968. #
  969. #processors:
  970. # - add_host_metadata: ~
  971. #
  972. # The following example enriches each event with process metadata using
  973. # process IDs included in the event.
  974. #
  975. #processors:
  976. # - add_process_metadata:
  977. # match_pids: ["system.process.ppid"]
  978. # target: system.process.parent
  979. #
  980. # The following example decodes fields containing JSON strings
  981. # and replaces the strings with valid JSON objects.
  982. #
  983. #processors:
  984. # - decode_json_fields:
  985. # fields: ["field1", "field2", ...]
  986. # process_array: false
  987. # max_depth: 1
  988. # target: ""
  989. # overwrite_keys: false
  990. #
  991. #processors:
  992. # - decompress_gzip_field:
  993. # from: "field1"
  994. # to: "field2"
  995. # ignore_missing: false
  996. # fail_on_error: true
  997. #
  998. # The following example copies the value of message to message_copied
  999. #
  1000. #processors:
  1001. # - copy_fields:
  1002. # fields:
  1003. # - from: message
  1004. # to: message_copied
  1005. # fail_on_error: true
  1006. # ignore_missing: false
  1007. #
  1008. # The following example truncates the value of message to 1024 bytes
  1009. #
  1010. #processors:
  1011. # - truncate_fields:
  1012. # fields:
  1013. # - message
  1014. # max_bytes: 1024
  1015. # fail_on_error: false
  1016. # ignore_missing: true
  1017. #
  1018. # The following example preserves the raw message under event.original
  1019. #
  1020. #processors:
  1021. # - copy_fields:
  1022. # fields:
  1023. # - from: message
  1024. # to: event.original
  1025. # fail_on_error: false
  1026. # ignore_missing: true
  1027. # - truncate_fields:
  1028. # fields:
  1029. # - event.original
  1030. # max_bytes: 1024
  1031. # fail_on_error: false
  1032. # ignore_missing: true
  1033. #
  1034. # The following example URL-decodes the value of field1 to field2
  1035. #
  1036. #processors:
  1037. # - urldecode:
  1038. # fields:
  1039. # - from: "field1"
  1040. # to: "field2"
  1041. # ignore_missing: false
  1042. # fail_on_error: true
  1043. # =============================== Elastic Cloud ================================
  1044. # These settings simplify using Filebeat with the Elastic Cloud (https://cloud.elastic.co/).
  1045. # The cloud.id setting overwrites the `output.elasticsearch.hosts` and
  1046. # `setup.kibana.host` options.
  1047. # You can find the `cloud.id` in the Elastic Cloud web UI.
  1048. #cloud.id:
  1049. # The cloud.auth setting overwrites the `output.elasticsearch.username` and
  1050. # `output.elasticsearch.password` settings. The format is `<user>:<pass>`.
  1051. #cloud.auth:
  1052. # ================================== Outputs ===================================
  1053. # Configure what output to use when sending the data collected by the beat.
  1054. # ---------------------------- Elasticsearch Output ----------------------------
  1055. output.elasticsearch:
  1056. # Boolean flag to enable or disable the output module.
  1057. #enabled: true
  1058. # Array of hosts to connect to.
  1059. # Scheme and port can be left out and will be set to the default (http and 9200)
  1060. # In case you specify and additional path, the scheme is required: http://localhost:9200/path
  1061. # IPv6 addresses should always be defined as: https://[2001:db8::1]:9200
  1062. hosts: ["localhost:9200"]
  1063. # Set gzip compression level.
  1064. #compression_level: 0
  1065. # Configure escaping HTML symbols in strings.
  1066. #escape_html: false
  1067. # Protocol - either `http` (default) or `https`.
  1068. #protocol: "https"
  1069. # Authentication credentials - either API key or username/password.
  1070. #api_key: "id:api_key"
  1071. #username: "elastic"
  1072. #password: "changeme"
  1073. # Dictionary of HTTP parameters to pass within the URL with index operations.
  1074. #parameters:
  1075. #param1: value1
  1076. #param2: value2
  1077. # Number of workers per Elasticsearch host.
  1078. #worker: 1
  1079. # Optional index name. The default is "filebeat" plus date
  1080. # and generates [filebeat-]YYYY.MM.DD keys.
  1081. # In case you modify this pattern you must update setup.template.name and setup.template.pattern accordingly.
  1082. #index: "filebeat-%{[agent.version]}-%{+yyyy.MM.dd}"
  1083. # Optional ingest node pipeline. By default no pipeline will be used.
  1084. #pipeline: ""
  1085. # Optional HTTP path
  1086. #path: "/elasticsearch"
  1087. # Custom HTTP headers to add to each request
  1088. #headers:
  1089. # X-My-Header: Contents of the header
  1090. # Proxy server URL
  1091. #proxy_url: http://proxy:3128
  1092. # Whether to disable proxy settings for outgoing connections. If true, this
  1093. # takes precedence over both the proxy_url field and any environment settings
  1094. # (HTTP_PROXY, HTTPS_PROXY). The default is false.
  1095. #proxy_disable: false
  1096. # The number of times a particular Elasticsearch index operation is attempted. If
  1097. # the indexing operation doesn't succeed after this many retries, the events are
  1098. # dropped. The default is 3.
  1099. #max_retries: 3
  1100. # The maximum number of events to bulk in a single Elasticsearch bulk API index request.
  1101. # The default is 50.
  1102. #bulk_max_size: 50
  1103. # The number of seconds to wait before trying to reconnect to Elasticsearch
  1104. # after a network error. After waiting backoff.init seconds, the Beat
  1105. # tries to reconnect. If the attempt fails, the backoff timer is increased
  1106. # exponentially up to backoff.max. After a successful connection, the backoff
  1107. # timer is reset. The default is 1s.
  1108. #backoff.init: 1s
  1109. # The maximum number of seconds to wait before attempting to connect to
  1110. # Elasticsearch after a network error. The default is 60s.
  1111. #backoff.max: 60s
  1112. # Configure HTTP request timeout before failing a request to Elasticsearch.
  1113. #timeout: 90
  1114. # Use SSL settings for HTTPS.
  1115. #ssl.enabled: true
  1116. # Controls the verification of certificates. Valid values are:
  1117. # * full, which verifies that the provided certificate is signed by a trusted
  1118. # authority (CA) and also verifies that the server's hostname (or IP address)
  1119. # matches the names identified within the certificate.
  1120. # * certificate, which verifies that the provided certificate is signed by a
  1121. # trusted authority (CA), but does not perform any hostname verification.
  1122. # * none, which performs no verification of the server's certificate. This
  1123. # mode disables many of the security benefits of SSL/TLS and should only be used
  1124. # after very careful consideration. It is primarily intended as a temporary
  1125. # diagnostic mechanism when attempting to resolve TLS errors; its use in
  1126. # production environments is strongly discouraged.
  1127. # The default value is full.
  1128. #ssl.verification_mode: full
  1129. # List of supported/valid TLS versions. By default all TLS versions from 1.1
  1130. # up to 1.3 are enabled.
  1131. #ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
  1132. # List of root certificates for HTTPS server verifications
  1133. #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
  1134. # Certificate for SSL client authentication
  1135. #ssl.certificate: "/etc/pki/client/cert.pem"
  1136. # Client certificate key
  1137. #ssl.key: "/etc/pki/client/cert.key"
  1138. # Optional passphrase for decrypting the certificate key.
  1139. #ssl.key_passphrase: ''
  1140. # Configure cipher suites to be used for SSL connections
  1141. #ssl.cipher_suites: []
  1142. # Configure curve types for ECDHE-based cipher suites
  1143. #ssl.curve_types: []
  1144. # Configure what types of renegotiation are supported. Valid options are
  1145. # never, once, and freely. Default is never.
  1146. #ssl.renegotiation: never
  1147. # Configure a pin that can be used to do extra validation of the verified certificate chain,
  1148. # this allow you to ensure that a specific certificate is used to validate the chain of trust.
  1149. #
  1150. # The pin is a base64 encoded string of the SHA-256 fingerprint.
  1151. #ssl.ca_sha256: ""
  1152. # Enable Kerberos support. Kerberos is automatically enabled if any Kerberos setting is set.
  1153. #kerberos.enabled: true
  1154. # Authentication type to use with Kerberos. Available options: keytab, password.
  1155. #kerberos.auth_type: password
  1156. # Path to the keytab file. It is used when auth_type is set to keytab.
  1157. #kerberos.keytab: /etc/elastic.keytab
  1158. # Path to the Kerberos configuration.
  1159. #kerberos.config_path: /etc/krb5.conf
  1160. # Name of the Kerberos user.
  1161. #kerberos.username: elastic
  1162. # Password of the Kerberos user. It is used when auth_type is set to password.
  1163. #kerberos.password: changeme
  1164. # Kerberos realm.
  1165. #kerberos.realm: ELASTIC
  1166. # ------------------------------ Logstash Output -------------------------------
  1167. #output.logstash:
  1168. # Boolean flag to enable or disable the output module.
  1169. #enabled: true
  1170. # The Logstash hosts
  1171. #hosts: ["localhost:5044"]
  1172. # Number of workers per Logstash host.
  1173. #worker: 1
  1174. # Set gzip compression level.
  1175. #compression_level: 3
  1176. # Configure escaping HTML symbols in strings.
  1177. #escape_html: false
  1178. # Optional maximum time to live for a connection to Logstash, after which the
  1179. # connection will be re-established. A value of `0s` (the default) will
  1180. # disable this feature.
  1181. #
  1182. # Not yet supported for async connections (i.e. with the "pipelining" option set)
  1183. #ttl: 30s
  1184. # Optionally load-balance events between Logstash hosts. Default is false.
  1185. #loadbalance: false
  1186. # Number of batches to be sent asynchronously to Logstash while processing
  1187. # new batches.
  1188. #pipelining: 2
  1189. # If enabled only a subset of events in a batch of events is transferred per
  1190. # transaction. The number of events to be sent increases up to `bulk_max_size`
  1191. # if no error is encountered.
  1192. #slow_start: false
  1193. # The number of seconds to wait before trying to reconnect to Logstash
  1194. # after a network error. After waiting backoff.init seconds, the Beat
  1195. # tries to reconnect. If the attempt fails, the backoff timer is increased
  1196. # exponentially up to backoff.max. After a successful connection, the backoff
  1197. # timer is reset. The default is 1s.
  1198. #backoff.init: 1s
  1199. # The maximum number of seconds to wait before attempting to connect to
  1200. # Logstash after a network error. The default is 60s.
  1201. #backoff.max: 60s
  1202. # Optional index name. The default index name is set to filebeat
  1203. # in all lowercase.
  1204. #index: 'filebeat'
  1205. # SOCKS5 proxy server URL
  1206. #proxy_url: socks5://user:password@socks5-server:2233
  1207. # Resolve names locally when using a proxy server. Defaults to false.
  1208. #proxy_use_local_resolver: false
  1209. # Use SSL settings for HTTPS.
  1210. #ssl.enabled: true
  1211. # Controls the verification of certificates. Valid values are:
  1212. # * full, which verifies that the provided certificate is signed by a trusted
  1213. # authority (CA) and also verifies that the server's hostname (or IP address)
  1214. # matches the names identified within the certificate.
  1215. # * certificate, which verifies that the provided certificate is signed by a
  1216. # trusted authority (CA), but does not perform any hostname verification.
  1217. # * none, which performs no verification of the server's certificate. This
  1218. # mode disables many of the security benefits of SSL/TLS and should only be used
  1219. # after very careful consideration. It is primarily intended as a temporary
  1220. # diagnostic mechanism when attempting to resolve TLS errors; its use in
  1221. # production environments is strongly discouraged.
  1222. # The default value is full.
  1223. #ssl.verification_mode: full
  1224. # List of supported/valid TLS versions. By default all TLS versions from 1.1
  1225. # up to 1.3 are enabled.
  1226. #ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
  1227. # List of root certificates for HTTPS server verifications
  1228. #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
  1229. # Certificate for SSL client authentication
  1230. #ssl.certificate: "/etc/pki/client/cert.pem"
  1231. # Client certificate key
  1232. #ssl.key: "/etc/pki/client/cert.key"
  1233. # Optional passphrase for decrypting the certificate key.
  1234. #ssl.key_passphrase: ''
  1235. # Configure cipher suites to be used for SSL connections
  1236. #ssl.cipher_suites: []
  1237. # Configure curve types for ECDHE-based cipher suites
  1238. #ssl.curve_types: []
  1239. # Configure what types of renegotiation are supported. Valid options are
  1240. # never, once, and freely. Default is never.
  1241. #ssl.renegotiation: never
  1242. # Configure a pin that can be used to do extra validation of the verified certificate chain,
  1243. # this allow you to ensure that a specific certificate is used to validate the chain of trust.
  1244. #
  1245. # The pin is a base64 encoded string of the SHA-256 fingerprint.
  1246. #ssl.ca_sha256: ""
  1247. # The number of times to retry publishing an event after a publishing failure.
  1248. # After the specified number of retries, the events are typically dropped.
  1249. # Some Beats, such as Filebeat and Winlogbeat, ignore the max_retries setting
  1250. # and retry until all events are published. Set max_retries to a value less
  1251. # than 0 to retry until all events are published. The default is 3.
  1252. #max_retries: 3
  1253. # The maximum number of events to bulk in a single Logstash request. The
  1254. # default is 2048.
  1255. #bulk_max_size: 2048
  1256. # The number of seconds to wait for responses from the Logstash server before
  1257. # timing out. The default is 30s.
  1258. #timeout: 30s
  1259. # -------------------------------- Kafka Output --------------------------------
  1260. #output.kafka:
  1261. # Boolean flag to enable or disable the output module.
  1262. #enabled: true
  1263. # The list of Kafka broker addresses from which to fetch the cluster metadata.
  1264. # The cluster metadata contain the actual Kafka brokers events are published
  1265. # to.
  1266. #hosts: ["localhost:9092"]
  1267. # The Kafka topic used for produced events. The setting can be a format string
  1268. # using any event field. To set the topic from document type use `%{[type]}`.
  1269. #topic: beats
  1270. # The Kafka event key setting. Use format string to create a unique event key.
  1271. # By default no event key will be generated.
  1272. #key: ''
  1273. # The Kafka event partitioning strategy. Default hashing strategy is `hash`
  1274. # using the `output.kafka.key` setting or randomly distributes events if
  1275. # `output.kafka.key` is not configured.
  1276. #partition.hash:
  1277. # If enabled, events will only be published to partitions with reachable
  1278. # leaders. Default is false.
  1279. #reachable_only: false
  1280. # Configure alternative event field names used to compute the hash value.
  1281. # If empty `output.kafka.key` setting will be used.
  1282. # Default value is empty list.
  1283. #hash: []
  1284. # Authentication details. Password is required if username is set.
  1285. #username: ''
  1286. #password: ''
  1287. # SASL authentication mechanism used. Can be one of PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512.
  1288. # Defaults to PLAIN when `username` and `password` are configured.
  1289. #sasl.mechanism: ''
  1290. # Kafka version Filebeat is assumed to run against. Defaults to the "1.0.0".
  1291. #version: '1.0.0'
  1292. # Configure JSON encoding
  1293. #codec.json:
  1294. # Pretty-print JSON event
  1295. #pretty: false
  1296. # Configure escaping HTML symbols in strings.
  1297. #escape_html: false
  1298. # Metadata update configuration. Metadata contains leader information
  1299. # used to decide which broker to use when publishing.
  1300. #metadata:
  1301. # Max metadata request retry attempts when cluster is in middle of leader
  1302. # election. Defaults to 3 retries.
  1303. #retry.max: 3
  1304. # Wait time between retries during leader elections. Default is 250ms.
  1305. #retry.backoff: 250ms
  1306. # Refresh metadata interval. Defaults to every 10 minutes.
  1307. #refresh_frequency: 10m
  1308. # Strategy for fetching the topics metadata from the broker. Default is false.
  1309. #full: false
  1310. # The number of concurrent load-balanced Kafka output workers.
  1311. #worker: 1
  1312. # The number of times to retry publishing an event after a publishing failure.
  1313. # After the specified number of retries, events are typically dropped.
  1314. # Some Beats, such as Filebeat, ignore the max_retries setting and retry until
  1315. # all events are published. Set max_retries to a value less than 0 to retry
  1316. # until all events are published. The default is 3.
  1317. #max_retries: 3
  1318. # The number of seconds to wait before trying to republish to Kafka
  1319. # after a network error. After waiting backoff.init seconds, the Beat
  1320. # tries to republish. If the attempt fails, the backoff timer is increased
  1321. # exponentially up to backoff.max. After a successful publish, the backoff
  1322. # timer is reset. The default is 1s.
  1323. #backoff.init: 1s
  1324. # The maximum number of seconds to wait before attempting to republish to
  1325. # Kafka after a network error. The default is 60s.
  1326. #backoff.max: 60s
  1327. # The maximum number of events to bulk in a single Kafka request. The default
  1328. # is 2048.
  1329. #bulk_max_size: 2048
  1330. # Duration to wait before sending bulk Kafka request. 0 is no delay. The default
  1331. # is 0.
  1332. #bulk_flush_frequency: 0s
  1333. # The number of seconds to wait for responses from the Kafka brokers before
  1334. # timing out. The default is 30s.
  1335. #timeout: 30s
  1336. # The maximum duration a broker will wait for number of required ACKs. The
  1337. # default is 10s.
  1338. #broker_timeout: 10s
  1339. # The number of messages buffered for each Kafka broker. The default is 256.
  1340. #channel_buffer_size: 256
  1341. # The keep-alive period for an active network connection. If 0s, keep-alives
  1342. # are disabled. The default is 0 seconds.
  1343. #keep_alive: 0
  1344. # Sets the output compression codec. Must be one of none, snappy and gzip. The
  1345. # default is gzip.
  1346. #compression: gzip
  1347. # Set the compression level. Currently only gzip provides a compression level
  1348. # between 0 and 9. The default value is chosen by the compression algorithm.
  1349. #compression_level: 4
  1350. # The maximum permitted size of JSON-encoded messages. Bigger messages will be
  1351. # dropped. The default value is 1000000 (bytes). This value should be equal to
  1352. # or less than the broker's message.max.bytes.
  1353. #max_message_bytes: 1000000
  1354. # The ACK reliability level required from broker. 0=no response, 1=wait for
  1355. # local commit, -1=wait for all replicas to commit. The default is 1. Note:
  1356. # If set to 0, no ACKs are returned by Kafka. Messages might be lost silently
  1357. # on error.
  1358. #required_acks: 1
  1359. # The configurable ClientID used for logging, debugging, and auditing
  1360. # purposes. The default is "beats".
  1361. #client_id: beats
  1362. # Use SSL settings for HTTPS.
  1363. #ssl.enabled: true
  1364. # Controls the verification of certificates. Valid values are:
  1365. # * full, which verifies that the provided certificate is signed by a trusted
  1366. # authority (CA) and also verifies that the server's hostname (or IP address)
  1367. # matches the names identified within the certificate.
  1368. # * certificate, which verifies that the provided certificate is signed by a
  1369. # trusted authority (CA), but does not perform any hostname verification.
  1370. # * none, which performs no verification of the server's certificate. This
  1371. # mode disables many of the security benefits of SSL/TLS and should only be used
  1372. # after very careful consideration. It is primarily intended as a temporary
  1373. # diagnostic mechanism when attempting to resolve TLS errors; its use in
  1374. # production environments is strongly discouraged.
  1375. # The default value is full.
  1376. #ssl.verification_mode: full
  1377. # List of supported/valid TLS versions. By default all TLS versions from 1.1
  1378. # up to 1.3 are enabled.
  1379. #ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
  1380. # List of root certificates for HTTPS server verifications
  1381. #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
  1382. # Certificate for SSL client authentication
  1383. #ssl.certificate: "/etc/pki/client/cert.pem"
  1384. # Client certificate key
  1385. #ssl.key: "/etc/pki/client/cert.key"
  1386. # Optional passphrase for decrypting the certificate key.
  1387. #ssl.key_passphrase: ''
  1388. # Configure cipher suites to be used for SSL connections
  1389. #ssl.cipher_suites: []
  1390. # Configure curve types for ECDHE-based cipher suites
  1391. #ssl.curve_types: []
  1392. # Configure what types of renegotiation are supported. Valid options are
  1393. # never, once, and freely. Default is never.
  1394. #ssl.renegotiation: never
  1395. # Configure a pin that can be used to do extra validation of the verified certificate chain,
  1396. # this allow you to ensure that a specific certificate is used to validate the chain of trust.
  1397. #
  1398. # The pin is a base64 encoded string of the SHA-256 fingerprint.
  1399. #ssl.ca_sha256: ""
  1400. # Enable Kerberos support. Kerberos is automatically enabled if any Kerberos setting is set.
  1401. #kerberos.enabled: true
  1402. # Authentication type to use with Kerberos. Available options: keytab, password.
  1403. #kerberos.auth_type: password
  1404. # Path to the keytab file. It is used when auth_type is set to keytab.
  1405. #kerberos.keytab: /etc/security/keytabs/kafka.keytab
  1406. # Path to the Kerberos configuration.
  1407. #kerberos.config_path: /etc/krb5.conf
  1408. # The service name. Service principal name is contructed from
  1409. # service_name/hostname@realm.
  1410. #kerberos.service_name: kafka
  1411. # Name of the Kerberos user.
  1412. #kerberos.username: elastic
  1413. # Password of the Kerberos user. It is used when auth_type is set to password.
  1414. #kerberos.password: changeme
  1415. # Kerberos realm.
  1416. #kerberos.realm: ELASTIC
  1417. # -------------------------------- Redis Output --------------------------------
  1418. #output.redis:
  1419. # Boolean flag to enable or disable the output module.
  1420. #enabled: true
  1421. # Configure JSON encoding
  1422. #codec.json:
  1423. # Pretty print json event
  1424. #pretty: false
  1425. # Configure escaping HTML symbols in strings.
  1426. #escape_html: false
  1427. # The list of Redis servers to connect to. If load-balancing is enabled, the
  1428. # events are distributed to the servers in the list. If one server becomes
  1429. # unreachable, the events are distributed to the reachable servers only.
  1430. # The hosts setting supports redis and rediss urls with custom password like
  1431. # redis://:password@localhost:6379.
  1432. #hosts: ["localhost:6379"]
  1433. # The name of the Redis list or channel the events are published to. The
  1434. # default is filebeat.
  1435. #key: filebeat
  1436. # The password to authenticate to Redis with. The default is no authentication.
  1437. #password:
  1438. # The Redis database number where the events are published. The default is 0.
  1439. #db: 0
  1440. # The Redis data type to use for publishing events. If the data type is list,
  1441. # the Redis RPUSH command is used. If the data type is channel, the Redis
  1442. # PUBLISH command is used. The default value is list.
  1443. #datatype: list
  1444. # The number of workers to use for each host configured to publish events to
  1445. # Redis. Use this setting along with the loadbalance option. For example, if
  1446. # you have 2 hosts and 3 workers, in total 6 workers are started (3 for each
  1447. # host).
  1448. #worker: 1
  1449. # If set to true and multiple hosts or workers are configured, the output
  1450. # plugin load balances published events onto all Redis hosts. If set to false,
  1451. # the output plugin sends all events to only one host (determined at random)
  1452. # and will switch to another host if the currently selected one becomes
  1453. # unreachable. The default value is true.
  1454. #loadbalance: true
  1455. # The Redis connection timeout in seconds. The default is 5 seconds.
  1456. #timeout: 5s
  1457. # The number of times to retry publishing an event after a publishing failure.
  1458. # After the specified number of retries, the events are typically dropped.
  1459. # Some Beats, such as Filebeat, ignore the max_retries setting and retry until
  1460. # all events are published. Set max_retries to a value less than 0 to retry
  1461. # until all events are published. The default is 3.
  1462. #max_retries: 3
  1463. # The number of seconds to wait before trying to reconnect to Redis
  1464. # after a network error. After waiting backoff.init seconds, the Beat
  1465. # tries to reconnect. If the attempt fails, the backoff timer is increased
  1466. # exponentially up to backoff.max. After a successful connection, the backoff
  1467. # timer is reset. The default is 1s.
  1468. #backoff.init: 1s
  1469. # The maximum number of seconds to wait before attempting to connect to
  1470. # Redis after a network error. The default is 60s.
  1471. #backoff.max: 60s
  1472. # The maximum number of events to bulk in a single Redis request or pipeline.
  1473. # The default is 2048.
  1474. #bulk_max_size: 2048
  1475. # The URL of the SOCKS5 proxy to use when connecting to the Redis servers. The
  1476. # value must be a URL with a scheme of socks5://.
  1477. #proxy_url:
  1478. # This option determines whether Redis hostnames are resolved locally when
  1479. # using a proxy. The default value is false, which means that name resolution
  1480. # occurs on the proxy server.
  1481. #proxy_use_local_resolver: false
  1482. # Use SSL settings for HTTPS.
  1483. #ssl.enabled: true
  1484. # Controls the verification of certificates. Valid values are:
  1485. # * full, which verifies that the provided certificate is signed by a trusted
  1486. # authority (CA) and also verifies that the server's hostname (or IP address)
  1487. # matches the names identified within the certificate.
  1488. # * certificate, which verifies that the provided certificate is signed by a
  1489. # trusted authority (CA), but does not perform any hostname verification.
  1490. # * none, which performs no verification of the server's certificate. This
  1491. # mode disables many of the security benefits of SSL/TLS and should only be used
  1492. # after very careful consideration. It is primarily intended as a temporary
  1493. # diagnostic mechanism when attempting to resolve TLS errors; its use in
  1494. # production environments is strongly discouraged.
  1495. # The default value is full.
  1496. #ssl.verification_mode: full
  1497. # List of supported/valid TLS versions. By default all TLS versions from 1.1
  1498. # up to 1.3 are enabled.
  1499. #ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
  1500. # List of root certificates for HTTPS server verifications
  1501. #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
  1502. # Certificate for SSL client authentication
  1503. #ssl.certificate: "/etc/pki/client/cert.pem"
  1504. # Client certificate key
  1505. #ssl.key: "/etc/pki/client/cert.key"
  1506. # Optional passphrase for decrypting the certificate key.
  1507. #ssl.key_passphrase: ''
  1508. # Configure cipher suites to be used for SSL connections
  1509. #ssl.cipher_suites: []
  1510. # Configure curve types for ECDHE-based cipher suites
  1511. #ssl.curve_types: []
  1512. # Configure what types of renegotiation are supported. Valid options are
  1513. # never, once, and freely. Default is never.
  1514. #ssl.renegotiation: never
  1515. # Configure a pin that can be used to do extra validation of the verified certificate chain,
  1516. # this allow you to ensure that a specific certificate is used to validate the chain of trust.
  1517. #
  1518. # The pin is a base64 encoded string of the SHA-256 fingerprint.
  1519. #ssl.ca_sha256: ""
  1520. # -------------------------------- File Output ---------------------------------
  1521. #output.file:
  1522. # Boolean flag to enable or disable the output module.
  1523. #enabled: true
  1524. # Configure JSON encoding
  1525. #codec.json:
  1526. # Pretty-print JSON event
  1527. #pretty: false
  1528. # Configure escaping HTML symbols in strings.
  1529. #escape_html: false
  1530. # Path to the directory where to save the generated files. The option is
  1531. # mandatory.
  1532. #path: "/tmp/filebeat"
  1533. # Name of the generated files. The default is `filebeat` and it generates
  1534. # files: `filebeat`, `filebeat.1`, `filebeat.2`, etc.
  1535. #filename: filebeat
  1536. # Maximum size in kilobytes of each file. When this size is reached, and on
  1537. # every Filebeat restart, the files are rotated. The default value is 10240
  1538. # kB.
  1539. #rotate_every_kb: 10000
  1540. # Maximum number of files under path. When this number of files is reached,
  1541. # the oldest file is deleted and the rest are shifted from last to first. The
  1542. # default is 7 files.
  1543. #number_of_files: 7
  1544. # Permissions to use for file creation. The default is 0600.
  1545. #permissions: 0600
  1546. # ------------------------------- Console Output -------------------------------
  1547. #output.console:
  1548. # Boolean flag to enable or disable the output module.
  1549. #enabled: true
  1550. # Configure JSON encoding
  1551. #codec.json:
  1552. # Pretty-print JSON event
  1553. #pretty: false
  1554. # Configure escaping HTML symbols in strings.
  1555. #escape_html: false
  1556. # =================================== Paths ====================================
  1557. # The home path for the Filebeat installation. This is the default base path
  1558. # for all other path settings and for miscellaneous files that come with the
  1559. # distribution (for example, the sample dashboards).
  1560. # If not set by a CLI flag or in the configuration file, the default for the
  1561. # home path is the location of the binary.
  1562. #path.home:
  1563. # The configuration path for the Filebeat installation. This is the default
  1564. # base path for configuration files, including the main YAML configuration file
  1565. # and the Elasticsearch template file. If not set by a CLI flag or in the
  1566. # configuration file, the default for the configuration path is the home path.
  1567. #path.config: ${path.home}
  1568. # The data path for the Filebeat installation. This is the default base path
  1569. # for all the files in which Filebeat needs to store its data. If not set by a
  1570. # CLI flag or in the configuration file, the default for the data path is a data
  1571. # subdirectory inside the home path.
  1572. #path.data: ${path.home}/data
  1573. # The logs path for a Filebeat installation. This is the default location for
  1574. # the Beat's log files. If not set by a CLI flag or in the configuration file,
  1575. # the default for the logs path is a logs subdirectory inside the home path.
  1576. #path.logs: ${path.home}/logs
  1577. # ================================== Keystore ==================================
  1578. # Location of the Keystore containing the keys and their sensitive values.
  1579. #keystore.path: "${path.config}/beats.keystore"
  1580. # ================================= Dashboards =================================
  1581. # These settings control loading the sample dashboards to the Kibana index. Loading
  1582. # the dashboards are disabled by default and can be enabled either by setting the
  1583. # options here, or by using the `-setup` CLI flag or the `setup` command.
  1584. #setup.dashboards.enabled: false
  1585. # The directory from where to read the dashboards. The default is the `kibana`
  1586. # folder in the home path.
  1587. #setup.dashboards.directory: ${path.home}/kibana
  1588. # The URL from where to download the dashboards archive. It is used instead of
  1589. # the directory if it has a value.
  1590. #setup.dashboards.url:
  1591. # The file archive (zip file) from where to read the dashboards. It is used instead
  1592. # of the directory when it has a value.
  1593. #setup.dashboards.file:
  1594. # In case the archive contains the dashboards from multiple Beats, this lets you
  1595. # select which one to load. You can load all the dashboards in the archive by
  1596. # setting this to the empty string.
  1597. #setup.dashboards.beat: filebeat
  1598. # The name of the Kibana index to use for setting the configuration. Default is ".kibana"
  1599. #setup.dashboards.kibana_index: .kibana
  1600. # The Elasticsearch index name. This overwrites the index name defined in the
  1601. # dashboards and index pattern. Example: testbeat-*
  1602. #setup.dashboards.index:
  1603. # Always use the Kibana API for loading the dashboards instead of autodetecting
  1604. # how to install the dashboards by first querying Elasticsearch.
  1605. #setup.dashboards.always_kibana: false
  1606. # If true and Kibana is not reachable at the time when dashboards are loaded,
  1607. # it will retry to reconnect to Kibana instead of exiting with an error.
  1608. #setup.dashboards.retry.enabled: false
  1609. # Duration interval between Kibana connection retries.
  1610. #setup.dashboards.retry.interval: 1s
  1611. # Maximum number of retries before exiting with an error, 0 for unlimited retrying.
  1612. #setup.dashboards.retry.maximum: 0
  1613. # ================================== Template ==================================
  1614. # A template is used to set the mapping in Elasticsearch
  1615. # By default template loading is enabled and the template is loaded.
  1616. # These settings can be adjusted to load your own template or overwrite existing ones.
  1617. # Set to false to disable template loading.
  1618. #setup.template.enabled: true
  1619. # Select the kind of index template. From Elasticsearch 7.8, it is possible to
  1620. # use component templates. Available options: legacy, component, index.
  1621. # By default filebeat uses the legacy index templates.
  1622. #setup.template.type: legacy
  1623. # Template name. By default the template name is "filebeat-%{[agent.version]}"
  1624. # The template name and pattern has to be set in case the Elasticsearch index pattern is modified.
  1625. #setup.template.name: "filebeat-%{[agent.version]}"
  1626. # Template pattern. By default the template pattern is "-%{[agent.version]}-*" to apply to the default index settings.
  1627. # The first part is the version of the beat and then -* is used to match all daily indices.
  1628. # The template name and pattern has to be set in case the Elasticsearch index pattern is modified.
  1629. #setup.template.pattern: "filebeat-%{[agent.version]}-*"
  1630. # Path to fields.yml file to generate the template
  1631. #setup.template.fields: "${path.config}/fields.yml"
  1632. # A list of fields to be added to the template and Kibana index pattern. Also
  1633. # specify setup.template.overwrite: true to overwrite the existing template.
  1634. #setup.template.append_fields:
  1635. #- name: field_name
  1636. # type: field_type
  1637. # Enable JSON template loading. If this is enabled, the fields.yml is ignored.
  1638. #setup.template.json.enabled: false
  1639. # Path to the JSON template file
  1640. #setup.template.json.path: "${path.config}/template.json"
  1641. # Name under which the template is stored in Elasticsearch
  1642. #setup.template.json.name: ""
  1643. # Overwrite existing template
  1644. # Do not enable this option for more than one instance of filebeat as it might
  1645. # overload your Elasticsearch with too many update requests.
  1646. #setup.template.overwrite: false
  1647. # Elasticsearch template settings
  1648. setup.template.settings:
  1649. # A dictionary of settings to place into the settings.index dictionary
  1650. # of the Elasticsearch template. For more details, please check
  1651. # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html
  1652. #index:
  1653. #number_of_shards: 1
  1654. #codec: best_compression
  1655. # A dictionary of settings for the _source field. For more details, please check
  1656. # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html
  1657. #_source:
  1658. #enabled: false
  1659. # ====================== Index Lifecycle Management (ILM) ======================
  1660. # Configure index lifecycle management (ILM). These settings create a write
  1661. # alias and add additional settings to the index template. When ILM is enabled,
  1662. # output.elasticsearch.index is ignored, and the write alias is used to set the
  1663. # index name.
  1664. # Enable ILM support. Valid values are true, false, and auto. When set to auto
  1665. # (the default), the Beat uses index lifecycle management when it connects to a
  1666. # cluster that supports ILM; otherwise, it creates daily indices.
  1667. #setup.ilm.enabled: auto
  1668. # Set the prefix used in the index lifecycle write alias name. The default alias
  1669. # name is 'filebeat-%{[agent.version]}'.
  1670. #setup.ilm.rollover_alias: 'filebeat'
  1671. # Set the rollover index pattern. The default is "%{now/d}-000001".
  1672. #setup.ilm.pattern: "{now/d}-000001"
  1673. # Set the lifecycle policy name. The default policy name is
  1674. # 'beatname'.
  1675. #setup.ilm.policy_name: "mypolicy"
  1676. # The path to a JSON file that contains a lifecycle policy configuration. Used
  1677. # to load your own lifecycle policy.
  1678. #setup.ilm.policy_file:
  1679. # Disable the check for an existing lifecycle policy. The default is true. If
  1680. # you disable this check, set setup.ilm.overwrite: true so the lifecycle policy
  1681. # can be installed.
  1682. #setup.ilm.check_exists: true
  1683. # Overwrite the lifecycle policy at startup. The default is false.
  1684. #setup.ilm.overwrite: false
  1685. # =================================== Kibana ===================================
  1686. # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
  1687. # This requires a Kibana endpoint configuration.
  1688. setup.kibana:
  1689. # Kibana Host
  1690. # Scheme and port can be left out and will be set to the default (http and 5601)
  1691. # In case you specify and additional path, the scheme is required: http://localhost:5601/path
  1692. # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
  1693. #host: "localhost:5601"
  1694. # Optional protocol and basic auth credentials.
  1695. #protocol: "https"
  1696. #username: "elastic"
  1697. #password: "changeme"
  1698. # Optional HTTP path
  1699. #path: ""
  1700. # Optional Kibana space ID.
  1701. #space.id: ""
  1702. # Use SSL settings for HTTPS.
  1703. #ssl.enabled: true
  1704. # Controls the verification of certificates. Valid values are:
  1705. # * full, which verifies that the provided certificate is signed by a trusted
  1706. # authority (CA) and also verifies that the server's hostname (or IP address)
  1707. # matches the names identified within the certificate.
  1708. # * certificate, which verifies that the provided certificate is signed by a
  1709. # trusted authority (CA), but does not perform any hostname verification.
  1710. # * none, which performs no verification of the server's certificate. This
  1711. # mode disables many of the security benefits of SSL/TLS and should only be used
  1712. # after very careful consideration. It is primarily intended as a temporary
  1713. # diagnostic mechanism when attempting to resolve TLS errors; its use in
  1714. # production environments is strongly discouraged.
  1715. # The default value is full.
  1716. #ssl.verification_mode: full
  1717. # List of supported/valid TLS versions. By default all TLS versions from 1.1
  1718. # up to 1.3 are enabled.
  1719. #ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
  1720. # List of root certificates for HTTPS server verifications
  1721. #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
  1722. # Certificate for SSL client authentication
  1723. #ssl.certificate: "/etc/pki/client/cert.pem"
  1724. # Client certificate key
  1725. #ssl.key: "/etc/pki/client/cert.key"
  1726. # Optional passphrase for decrypting the certificate key.
  1727. #ssl.key_passphrase: ''
  1728. # Configure cipher suites to be used for SSL connections
  1729. #ssl.cipher_suites: []
  1730. # Configure curve types for ECDHE-based cipher suites
  1731. #ssl.curve_types: []
  1732. # Configure what types of renegotiation are supported. Valid options are
  1733. # never, once, and freely. Default is never.
  1734. #ssl.renegotiation: never
  1735. # Configure a pin that can be used to do extra validation of the verified certificate chain,
  1736. # this allow you to ensure that a specific certificate is used to validate the chain of trust.
  1737. #
  1738. # The pin is a base64 encoded string of the SHA-256 fingerprint.
  1739. #ssl.ca_sha256: ""
  1740. # ================================== Logging ===================================
  1741. # There are four options for the log output: file, stderr, syslog, eventlog
  1742. # The file output is the default.
  1743. # Sets log level. The default log level is info.
  1744. # Available log levels are: error, warning, info, debug
  1745. #logging.level: info
  1746. # Enable debug output for selected components. To enable all selectors use ["*"]
  1747. # Other available selectors are "beat", "publisher", "service"
  1748. # Multiple selectors can be chained.
  1749. #logging.selectors: [ ]
  1750. # Send all logging output to stderr. The default is false.
  1751. #logging.to_stderr: false
  1752. # Send all logging output to syslog. The default is false.
  1753. #logging.to_syslog: false
  1754. # Send all logging output to Windows Event Logs. The default is false.
  1755. #logging.to_eventlog: false
  1756. # If enabled, Filebeat periodically logs its internal metrics that have changed
  1757. # in the last period. For each metric that changed, the delta from the value at
  1758. # the beginning of the period is logged. Also, the total values for
  1759. # all non-zero internal metrics are logged on shutdown. The default is true.
  1760. #logging.metrics.enabled: true
  1761. # The period after which to log the internal metrics. The default is 30s.
  1762. #logging.metrics.period: 30s
  1763. # Logging to rotating files. Set logging.to_files to false to disable logging to
  1764. # files.
  1765. logging.to_files: true
  1766. logging.files:
  1767. # Configure the path where the logs are written. The default is the logs directory
  1768. # under the home path (the binary location).
  1769. #path: /var/log/filebeat
  1770. # The name of the files where the logs are written to.
  1771. #name: filebeat
  1772. # Configure log file size limit. If limit is reached, log file will be
  1773. # automatically rotated
  1774. #rotateeverybytes: 10485760 # = 10MB
  1775. # Number of rotated log files to keep. Oldest files will be deleted first.
  1776. #keepfiles: 7
  1777. # The permissions mask to apply when rotating log files. The default value is 0600.
  1778. # Must be a valid Unix-style file permissions mask expressed in octal notation.
  1779. #permissions: 0600
  1780. # Enable log file rotation on time intervals in addition to size-based rotation.
  1781. # Intervals must be at least 1s. Values of 1m, 1h, 24h, 7*24h, 30*24h, and 365*24h
  1782. # are boundary-aligned with minutes, hours, days, weeks, months, and years as
  1783. # reported by the local system clock. All other intervals are calculated from the
  1784. # Unix epoch. Defaults to disabled.
  1785. #interval: 0
  1786. # Rotate existing logs on startup rather than appending to the existing
  1787. # file. Defaults to true.
  1788. # rotateonstartup: true
  1789. # Set to true to log messages in JSON format.
  1790. #logging.json: false
  1791. # Set to true, to log messages with minimal required Elastic Common Schema (ECS)
  1792. # information. Recommended to use in combination with `logging.json=true`
  1793. # Defaults to false.
  1794. #logging.ecs: false
  1795. # ============================= X-Pack Monitoring ==============================
  1796. # Filebeat can export internal metrics to a central Elasticsearch monitoring
  1797. # cluster. This requires xpack monitoring to be enabled in Elasticsearch. The
  1798. # reporting is disabled by default.
  1799. # Set to true to enable the monitoring reporter.
  1800. #monitoring.enabled: false
  1801. # Sets the UUID of the Elasticsearch cluster under which monitoring data for this
  1802. # Filebeat instance will appear in the Stack Monitoring UI. If output.elasticsearch
  1803. # is enabled, the UUID is derived from the Elasticsearch cluster referenced by output.elasticsearch.
  1804. #monitoring.cluster_uuid:
  1805. # Uncomment to send the metrics to Elasticsearch. Most settings from the
  1806. # Elasticsearch output are accepted here as well.
  1807. # Note that the settings should point to your Elasticsearch *monitoring* cluster.
  1808. # Any setting that is not set is automatically inherited from the Elasticsearch
  1809. # output configuration, so if you have the Elasticsearch output configured such
  1810. # that it is pointing to your Elasticsearch monitoring cluster, you can simply
  1811. # uncomment the following line.
  1812. #monitoring.elasticsearch:
  1813. # Array of hosts to connect to.
  1814. # Scheme and port can be left out and will be set to the default (http and 9200)
  1815. # In case you specify and additional path, the scheme is required: http://localhost:9200/path
  1816. # IPv6 addresses should always be defined as: https://[2001:db8::1]:9200
  1817. #hosts: ["localhost:9200"]
  1818. # Set gzip compression level.
  1819. #compression_level: 0
  1820. # Protocol - either `http` (default) or `https`.
  1821. #protocol: "https"
  1822. # Authentication credentials - either API key or username/password.
  1823. #api_key: "id:api_key"
  1824. #username: "beats_system"
  1825. #password: "changeme"
  1826. # Dictionary of HTTP parameters to pass within the URL with index operations.
  1827. #parameters:
  1828. #param1: value1
  1829. #param2: value2
  1830. # Custom HTTP headers to add to each request
  1831. #headers:
  1832. # X-My-Header: Contents of the header
  1833. # Proxy server url
  1834. #proxy_url: http://proxy:3128
  1835. # The number of times a particular Elasticsearch index operation is attempted. If
  1836. # the indexing operation doesn't succeed after this many retries, the events are
  1837. # dropped. The default is 3.
  1838. #max_retries: 3
  1839. # The maximum number of events to bulk in a single Elasticsearch bulk API index request.
  1840. # The default is 50.
  1841. #bulk_max_size: 50
  1842. # The number of seconds to wait before trying to reconnect to Elasticsearch
  1843. # after a network error. After waiting backoff.init seconds, the Beat
  1844. # tries to reconnect. If the attempt fails, the backoff timer is increased
  1845. # exponentially up to backoff.max. After a successful connection, the backoff
  1846. # timer is reset. The default is 1s.
  1847. #backoff.init: 1s
  1848. # The maximum number of seconds to wait before attempting to connect to
  1849. # Elasticsearch after a network error. The default is 60s.
  1850. #backoff.max: 60s
  1851. # Configure HTTP request timeout before failing an request to Elasticsearch.
  1852. #timeout: 90
  1853. # Use SSL settings for HTTPS.
  1854. #ssl.enabled: true
  1855. # Controls the verification of certificates. Valid values are:
  1856. # * full, which verifies that the provided certificate is signed by a trusted
  1857. # authority (CA) and also verifies that the server's hostname (or IP address)
  1858. # matches the names identified within the certificate.
  1859. # * certificate, which verifies that the provided certificate is signed by a
  1860. # trusted authority (CA), but does not perform any hostname verification.
  1861. # * none, which performs no verification of the server's certificate. This
  1862. # mode disables many of the security benefits of SSL/TLS and should only be used
  1863. # after very careful consideration. It is primarily intended as a temporary
  1864. # diagnostic mechanism when attempting to resolve TLS errors; its use in
  1865. # production environments is strongly discouraged.
  1866. # The default value is full.
  1867. #ssl.verification_mode: full
  1868. # List of supported/valid TLS versions. By default all TLS versions from 1.1
  1869. # up to 1.3 are enabled.
  1870. #ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
  1871. # List of root certificates for HTTPS server verifications
  1872. #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
  1873. # Certificate for SSL client authentication
  1874. #ssl.certificate: "/etc/pki/client/cert.pem"
  1875. # Client certificate key
  1876. #ssl.key: "/etc/pki/client/cert.key"
  1877. # Optional passphrase for decrypting the certificate key.
  1878. #ssl.key_passphrase: ''
  1879. # Configure cipher suites to be used for SSL connections
  1880. #ssl.cipher_suites: []
  1881. # Configure curve types for ECDHE-based cipher suites
  1882. #ssl.curve_types: []
  1883. # Configure what types of renegotiation are supported. Valid options are
  1884. # never, once, and freely. Default is never.
  1885. #ssl.renegotiation: never
  1886. # Configure a pin that can be used to do extra validation of the verified certificate chain,
  1887. # this allow you to ensure that a specific certificate is used to validate the chain of trust.
  1888. #
  1889. # The pin is a base64 encoded string of the SHA-256 fingerprint.
  1890. #ssl.ca_sha256: ""
  1891. # Enable Kerberos support. Kerberos is automatically enabled if any Kerberos setting is set.
  1892. #kerberos.enabled: true
  1893. # Authentication type to use with Kerberos. Available options: keytab, password.
  1894. #kerberos.auth_type: password
  1895. # Path to the keytab file. It is used when auth_type is set to keytab.
  1896. #kerberos.keytab: /etc/elastic.keytab
  1897. # Path to the Kerberos configuration.
  1898. #kerberos.config_path: /etc/krb5.conf
  1899. # Name of the Kerberos user.
  1900. #kerberos.username: elastic
  1901. # Password of the Kerberos user. It is used when auth_type is set to password.
  1902. #kerberos.password: changeme
  1903. # Kerberos realm.
  1904. #kerberos.realm: ELASTIC
  1905. #metrics.period: 10s
  1906. #state.period: 1m
  1907. # The `monitoring.cloud.id` setting overwrites the `monitoring.elasticsearch.hosts`
  1908. # setting. You can find the value for this setting in the Elastic Cloud web UI.
  1909. #monitoring.cloud.id:
  1910. # The `monitoring.cloud.auth` setting overwrites the `monitoring.elasticsearch.username`
  1911. # and `monitoring.elasticsearch.password` settings. The format is `<user>:<pass>`.
  1912. #monitoring.cloud.auth:
  1913. # =============================== HTTP Endpoint ================================
  1914. # Each beat can expose internal metrics through a HTTP endpoint. For security
  1915. # reasons the endpoint is disabled by default. This feature is currently experimental.
  1916. # Stats can be access through http://localhost:5066/stats . For pretty JSON output
  1917. # append ?pretty to the URL.
  1918. # Defines if the HTTP endpoint is enabled.
  1919. #http.enabled: false
  1920. # The HTTP endpoint will bind to this hostname, IP address, unix socket or named pipe.
  1921. # When using IP addresses, it is recommended to only use localhost.
  1922. #http.host: localhost
  1923. # Port on which the HTTP endpoint will bind. Default is 5066.
  1924. #http.port: 5066
  1925. # Define which user should be owning the named pipe.
  1926. #http.named_pipe.user:
  1927. # Define which the permissions that should be applied to the named pipe, use the Security
  1928. # Descriptor Definition Language (SDDL) to define the permission. This option cannot be used with
  1929. # `http.user`.
  1930. #http.named_pipe.security_descriptor:
  1931. # ============================== Process Security ==============================
  1932. # Enable or disable seccomp system call filtering on Linux. Default is enabled.
  1933. #seccomp.enabled: true
  1934. # ============================== Instrumentation ===============================
  1935. # Instrumentation support for the filebeat.
  1936. #instrumentation:
  1937. # Set to true to enable instrumentation of filebeat.
  1938. #enabled: false
  1939. # Environment in which filebeat is running on (eg: staging, production, etc.)
  1940. #environment: ""
  1941. # APM Server hosts to report instrumentation results to.
  1942. #hosts:
  1943. # - http://localhost:8200
  1944. # API Key for the APM Server(s).
  1945. # If api_key is set then secret_token will be ignored.
  1946. #api_key:
  1947. # Secret token for the APM Server(s).
  1948. #secret_token:
  1949. # Enable profiling of the server, recording profile samples as events.
  1950. #
  1951. # This feature is experimental.
  1952. #profiling:
  1953. #cpu:
  1954. # Set to true to enable CPU profiling.
  1955. #enabled: false
  1956. #interval: 60s
  1957. #duration: 10s
  1958. #heap:
  1959. # Set to true to enable heap profiling.
  1960. #enabled: false
  1961. #interval: 60s
  1962. # ================================= Migration ==================================
  1963. # This allows to enable 6.7 migration aliases
  1964. #migration.6_to_7.enabled: false