- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.3
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
Examples
editExamples
editHere are some configuration examples for the most common logging use cases:
Log to a file
editLog the default log format to a file instead of to stdout (the default).
logging: appenders: file: type: file fileName: /var/log/kibana.log layout: type: pattern root: appenders: [file]
Log in JSON format
editLog the default log format to JSON layout instead of pattern (the default).
With json
layout, log messages will be formatted as JSON strings in ECS format that includes a timestamp, log level, logger, message text and any other metadata that may be associated with the log message itself.
logging: appenders: json-layout: type: console layout: type: json root: appenders: [json-layout]
Log with meta to stdout
editInclude %meta
in your pattern layout:
logging: appenders: console-meta: type: console layout: type: pattern pattern: "[%date] [%level] [%logger] [%meta] %message" root: appenders: [console-meta]
Log Elasticsearch queries
editlogging: appenders: console_appender: type: console layout: type: pattern highlight: true root: appenders: [console_appender] level: warn loggers: - name: elasticsearch.query level: debug
Change overall log level
editlogging: root: level: debug
Customize specific log records
editHere is a detailed configuration example that can be used to configure loggers, appenders and layouts:
logging: appenders: console: type: console layout: type: pattern highlight: true file: type: file fileName: /var/log/kibana.log custom: type: console layout: type: pattern pattern: "[%date][%level] %message" json-file-appender: type: file fileName: /var/log/kibana-json.log layout: type: json root: appenders: [console, file] level: error loggers: - name: plugins appenders: [custom] level: warn - name: plugins.myPlugin level: info - name: server level: fatal - name: optimize appenders: [console] - name: telemetry appenders: [json-file-appender] level: all - name: metrics.ops appenders: [console] level: debug
Here is what we get with the config above:
Context name | Appenders | Level |
---|---|---|
root |
console, file |
error |
plugins |
custom |
warn |
plugins.myPlugin |
custom |
info |
server |
console, file |
fatal |
optimize |
console |
error |
telemetry |
json-file-appender |
all |
metrics.ops |
console |
debug |
On this page