Skip to content

Commit

Permalink
Move one level up the sections in the configuration file (elastic#1544)
Browse files Browse the repository at this point in the history 
* Reorganize the configuration file to be easier to follow
* Comment filebeat section
* Reorganize topbeat and logging sections
* Use winlogbeat.event_logs
  • Loading branch information
@monicasarbu @tsg
monicasarbu authored and tsg committed May 12, 2016
1 parent 8c49335 commit c49abfe
Show file tree
Hide file tree
Showing 10 changed files with 1,501 additions and 1,525 deletions.
339 changes: 169 additions & 170 deletions filebeat/etc/beat.yml
View file

Large diffs are not rendered by default.

619 changes: 306 additions & 313 deletions filebeat/filebeat.yml
View file

Large diffs are not rendered by default.

280 changes: 137 additions & 143 deletions libbeat/etc/libbeat.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,178 +6,174 @@

# Configure what outputs to use when sending the data collected by the beat.
# Multiple outputs may be used.
output:

### Elasticsearch as output
elasticsearch:
# Array of hosts to connect to.
# Scheme and port can be left out and will be set to the default (http and 9200)
# In case you specify and additional path, the scheme is required: http://localhost:9200/path
# IPv6 addresses should always be defined as: https://[2001:db8::1]:9200
hosts: ["localhost:9200"]
### Elasticsearch as output
output.elasticsearch:
# Array of hosts to connect to.
# Scheme and port can be left out and will be set to the default (http and 9200)
# In case you specify and additional path, the scheme is required: http://localhost:9200/path
# IPv6 addresses should always be defined as: https://[2001:db8::1]:9200
hosts: ["localhost:9200"]

# Optional protocol and basic auth credentials.
#protocol: "https"
#username: "admin"
#password: "s3cr3t"
# Optional protocol and basic auth credentials.
#protocol: "https"
#username: "admin"
#password: "s3cr3t"

# Dictionary of HTTP parameters to pass within the url with index operations.
#parameters:
#param1: value1
#param2: value2
# Dictionary of HTTP parameters to pass within the url with index operations.
#parameters:
#param1: value1
#param2: value2

# Number of workers per Elasticsearch host.
#worker: 1
# Number of workers per Elasticsearch host.
#worker: 1

# Optional index name. The default is "beatname" and generates
# [beatname-]YYYY.MM.DD keys.
#index: "beatname"
# Optional index name. The default is "beatname" and generates
# [beatname-]YYYY.MM.DD keys.
#index: "beatname"

# A template is used to set the mapping in Elasticsearch
# By default template loading is enabled and the template is loaded.
# These settings can be adjusted to load your own template or overwrite existing ones
template:
# Optional HTTP Path
#path: "/elasticsearch"

# Template name. By default the template name is beatname.
name: "beatname"
# Proxy server url
#proxy_url: http://proxy:3128

# Path to template file
path: "beatname.template.json"
# The number of times a particular Elasticsearch index operation is attempted. If
# the indexing operation doesn't succeed after this many retries, the events are
# dropped. The default is 3.
#max_retries: 3

# Overwrite existing template
overwrite: false
# The maximum number of events to bulk in a single Elasticsearch bulk API index request.
# The default is 50.
#bulk_max_size: 50

# Optional HTTP Path
#path: "/elasticsearch"
# Configure http request timeout before failing an request to Elasticsearch.
#timeout: 90

# Proxy server url
#proxy_url: http://proxy:3128
# The number of seconds to wait for new events between two bulk API index requests.
# If `bulk_max_size` is reached before this interval expires, addition bulk index
# requests are made.
#flush_interval: 1

# The number of times a particular Elasticsearch index operation is attempted. If
# the indexing operation doesn't succeed after this many retries, the events are
# dropped. The default is 3.
#max_retries: 3
# Boolean that sets if the topology is kept in Elasticsearch. The default is
# false. This option makes sense only for Packetbeat.
#save_topology: false

# The maximum number of events to bulk in a single Elasticsearch bulk API index request.
# The default is 50.
#bulk_max_size: 50
# The time to live in seconds for the topology information that is stored in
# Elasticsearch. The default is 15 seconds.
#topology_expire: 15

# Configure http request timeout before failing an request to Elasticsearch.
#timeout: 90
# A template is used to set the mapping in Elasticsearch
# By default template loading is enabled and the template is loaded.
# These settings can be adjusted to load your own template or overwrite existing ones

# The number of seconds to wait for new events between two bulk API index requests.
# If `bulk_max_size` is reached before this interval expires, addition bulk index
# requests are made.
#flush_interval: 1
# Template name. By default the template name is beatname.
template.name: "beatname"

# Boolean that sets if the topology is kept in Elasticsearch. The default is
# false. This option makes sense only for Packetbeat.
#save_topology: false
# Path to template file
template.path: "beatname.template.json"

# The time to live in seconds for the topology information that is stored in
# Elasticsearch. The default is 15 seconds.
#topology_expire: 15
# Overwrite existing template
template.overwrite: false

# tls configuration. By default is off.
#tls:
# List of root certificates for HTTPS server verifications
#certificate_authorities: ["/etc/pki/root/ca.pem"]
# TLS configuration. By default is off.
# List of root certificates for HTTPS server verifications
#tls.certificate_authorities: ["/etc/pki/root/ca.pem"]

# Certificate for TLS client authentication
#certificate: "/etc/pki/client/cert.pem"
# Certificate for TLS client authentication
#tls.certificate: "/etc/pki/client/cert.pem"

# Client Certificate Key
#certificate_key: "/etc/pki/client/cert.key"
# Client Certificate Key
#tls.certificate_key: "/etc/pki/client/cert.key"

# Controls whether the client verifies server certificates and host name.
# If insecure is set to true, all server host names and certificates will be
# accepted. In this mode TLS based connections are susceptible to
# man-in-the-middle attacks. Use only for testing.
#insecure: true
# Controls whether the client verifies server certificates and host name.
# If insecure is set to true, all server host names and certificates will be
# accepted. In this mode TLS based connections are susceptible to
# man-in-the-middle attacks. Use only for testing.
#tls.insecure: true

# Configure cipher suites to be used for TLS connections
#cipher_suites: []
# Configure cipher suites to be used for TLS connections
#tls.cipher_suites: []

# Configure curve types for ECDHE based cipher suites
#curve_types: []
# Configure curve types for ECDHE based cipher suites
#tls.curve_types: []

# Configure minimum TLS version allowed for connection to logstash
#min_version: 1.0
# Configure minimum TLS version allowed for connection to logstash
#tls.min_version: 1.0

# Configure maximum TLS version allowed for connection to logstash
#max_version: 1.2
# Configure maximum TLS version allowed for connection to logstash
#tls.max_version: 1.2


### Logstash as output
#logstash:
# The Logstash hosts
#hosts: ["localhost:5044"]
### Logstash as output
#output.logstash:
# The Logstash hosts
#hosts: ["localhost:5044"]

# Number of workers per Logstash host.
#worker: 1
# Number of workers per Logstash host.
#worker: 1

# Set gzip compression level.
#compression_level: 3
# Set gzip compression level.
#compression_level: 3

# Optional load balance the events between the Logstash hosts
#loadbalance: true
# Optional load balance the events between the Logstash hosts
#loadbalance: true

# Optional index name. The default index name is set to name of the beat
# in all lowercase.
#index: beatname
# Optional index name. The default index name is set to name of the beat
# in all lowercase.
#index: beatname

# SOCKS5 proxy server URL
#proxy_url: socks5://user:password@socks5-server:2233
# SOCKS5 proxy server URL
#proxy_url: socks5://user:password@socks5-server:2233

# Resolve names locally when using a proxy server. Defaults to false.
#proxy_use_local_resolver: false
# Resolve names locally when using a proxy server. Defaults to false.
#proxy_use_local_resolver: false

# Optional TLS. By default is off.
#tls:
# List of root certificates for HTTPS server verifications
#certificate_authorities: ["/etc/pki/root/ca.pem"]
# Optional TLS. By default is off.
# List of root certificates for HTTPS server verifications
#tls.certificate_authorities: ["/etc/pki/root/ca.pem"]

# Certificate for TLS client authentication
#certificate: "/etc/pki/client/cert.pem"
# Certificate for TLS client authentication
#tls.certificate: "/etc/pki/client/cert.pem"

# Client Certificate Key
#certificate_key: "/etc/pki/client/cert.key"
# Client Certificate Key
#tls.certificate_key: "/etc/pki/client/cert.key"

# Controls whether the client verifies server certificates and host name.
# If insecure is set to true, all server host names and certificates will be
# accepted. In this mode TLS based connections are susceptible to
# man-in-the-middle attacks. Use only for testing.
#insecure: true
# Controls whether the client verifies server certificates and host name.
# If insecure is set to true, all server host names and certificates will be
# accepted. In this mode TLS based connections are susceptible to
# man-in-the-middle attacks. Use only for testing.
#tls.insecure: true

# Configure cipher suites to be used for TLS connections
#cipher_suites: []
# Configure cipher suites to be used for TLS connections
#tls.cipher_suites: []

# Configure curve types for ECDHE based cipher suites
#curve_types: []
# Configure curve types for ECDHE based cipher suites
#tls.curve_types: []


### File as output
#file:
# Path to the directory where to save the generated files. The option is mandatory.
#path: "/tmp/beatname"
### File as output
#output.file:
# Path to the directory where to save the generated files. The option is mandatory.
#path: "/tmp/beatname"

# Name of the generated files. The default is `beatname` and it generates files: `beatname`, `beatname.1`, `beatname.2`, etc.
#filename: beatname
# Name of the generated files. The default is `beatname` and it generates files: `beatname`, `beatname.1`, `beatname.2`, etc.
#filename: beatname

# Maximum size in kilobytes of each file. When this size is reached, the files are
# rotated. The default value is 10240 kB.
#rotate_every_kb: 10000
# Maximum size in kilobytes of each file. When this size is reached, the files are
# rotated. The default value is 10240 kB.
#rotate_every_kb: 10000

# Maximum number of files under path. When this number of files is reached, the
# oldest file is deleted and the rest are shifted from last to first. The default
# is 7 files.
#number_of_files: 7
# Maximum number of files under path. When this number of files is reached, the
# oldest file is deleted and the rest are shifted from last to first. The default
# is 7 files.
#number_of_files: 7


### Console output
# console:
# Pretty print json event
#pretty: false
### Console output
#output.console:
# Pretty print json event
#pretty: false


############################# General #########################################
Expand Down Expand Up @@ -224,13 +220,12 @@ output:
# default is the number of logical CPUs available in the system.
#max_procs:


############################# Logging #########################################

# There are three options for the log output: syslog, file, stderr.
# Under Windows systems, the log files are per default sent to the file output,
# under all other system per default to syslog.
logging:
#logging:

# Send all logging output to syslog. On Windows default is false, otherwise
# default is true.
Expand All @@ -240,21 +235,6 @@ logging:
# limit is reached.
#to_files: false

# To enable logging to files, to_files option has to be set to true
files:
# The directory where the log files will written to.
#path: /var/log/mybeat

# The name of the files where the logs are written to.
#name: mybeat

# Configure log file size limit. If limit is reached, log file will be
# automatically rotated
rotateeverybytes: 10485760 # = 10MB

# Number of rotated log files to keep. Oldest files will be deleted first.
#keepfiles: 7

# Enable debug output for selected components. To enable all selectors use ["*"]
# Other available selectors are beat, publish, service
# Multiple selectors can be chained.
Expand All @@ -265,3 +245,17 @@ logging:
#level: error


# To enable logging to files, to_files option has to be set to true
# The directory where the log files will written to.
logging.files:
#path: /var/log/mybeat

# The name of the files where the logs are written to.
#name: mybeat

# Configure log file size limit. If limit is reached, log file will be
# automatically rotated
rotateeverybytes: 10485760 # = 10MB

# Number of rotated log files to keep. Oldest files will be deleted first.
#keepfiles: 7
Loading

0 comments on commit c49abfe

Please sign in to comment.