- Winlogbeat Reference: other versions:
- Winlogbeat Overview
- Quick start: installation and configuration
- Set up and run
- Upgrade
- Configure
- Winlogbeat
- General settings
- Project paths
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- Kibana endpoint
- Kibana dashboards
- Processors
- Define processors
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- append
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_duration
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- move_fields
- rate_limit
- registered_domain
- rename
- replace
- script
- syslog
- timestamp
- translate_ldap_attribute
- translate_sid
- truncate_fields
- urldecode
- Internal queue
- Logging
- HTTP endpoint
- Instrumentation
- winlogbeat.reference.yml
- How to guides
- Modules
- Exported fields
- Monitor
- Secure
- Troubleshoot
- Get Help
- Debug
- Understand logged metrics
- Common problems
- Dashboard in Kibana is breaking up data fields incorrectly
- Bogus computer_name fields are reported in some events
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- Publishing to Logstash fails with "connection reset by peer" message
- @metadata is missing in Logstash
- Not sure whether to use Logstash or Beats
- SSL client fails to connect to Logstash
- Monitoring UI shows fewer Beats than expected
- Dashboard could not locate the index-pattern
- High RSS memory usage due to MADV settings
- Not sure how to read from .evtx files
- Contribute to Beats
Secrets keystore for secure settings
editSecrets keystore for secure settings
editWhen you configure Winlogbeat, you might need to specify sensitive settings, such as passwords. Rather than relying on file system permissions to protect these values, you can use the Winlogbeat keystore to obfuscate stored secret values for use in configuration settings.
After adding a key and its secret value to the keystore, you can use the key in place of the secret value when you configure sensitive settings.
The syntax for referencing keys is identical to the syntax for environment variables:
${KEY}
Where KEY is the name of the key.
For example, imagine that the keystore contains a key called ES_PWD
with the
value yourelasticsearchpassword
:
-
In the configuration file, use
output.elasticsearch.password: "${ES_PWD}"
-
On the command line, use:
-E "output.elasticsearch.password=\${ES_PWD}"
When Winlogbeat unpacks the configuration, it resolves keys before resolving environment variables and other variables.
Notice that the Winlogbeat keystore differs from the Elasticsearch keystore.
Whereas the Elasticsearch keystore lets you store elasticsearch.yml
values by
name, the Winlogbeat keystore lets you specify arbitrary names that you can
reference in the Winlogbeat configuration.
To create and manage keys, use the keystore
command. See the
command reference for the full command syntax, including
optional flags.
The keystore
command must be run by the same user who will run
Winlogbeat.
Create a keystore
editTo create a secrets keystore, use:
winlogbeat keystore create
Winlogbeat creates the keystore in the directory defined by the path.data
configuration setting.
Add keys
editTo store sensitive values, such as authentication credentials for Elasticsearch,
use the keystore add
command:
winlogbeat keystore add ES_PWD
When prompted, enter a value for the key.
To overwrite an existing key’s value, use the --force
flag:
winlogbeat keystore add ES_PWD --force
To pass the value through stdin, use the --stdin
flag. You can also use
--force
:
cat /file/containing/setting/value | winlogbeat keystore add ES_PWD --stdin --force
List keys
editTo list the keys defined in the keystore, use:
winlogbeat keystore list
Remove keys
editTo remove a key from the keystore, use:
winlogbeat keystore remove ES_PWD
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now