Skip to content

How to log from a Java application to the Elastic Stack

License

Notifications You must be signed in to change notification settings

deepsmittal/java-logging

 
 

Repository files navigation

Centralized Application Logs with the Elastic Stack

This repository dives into five different logging patterns:

  • Parse: Take the log files of your applications and extract the relevant pieces of information.
  • Send: Add a log appender to send out your events directly without persisting them to a log file.
  • Structure: Write your events in a structured file, which you can then centralize.
  • Containerize: Keep track of short-lived containers and configure their logging correctly.
  • Orchestrate: Stay on top of your logs even when services are short lived and dynamically allocated on Kubernetes.

The slides for this talk are available on my website.

Dependencies

  • Docker (and Docker Compose) to run all the required components of the Elastic Stack (Filebeat, Logstash, Elasticsearch, and Kibana) and the containerized Java application. The application is built in Docker, so you don't need to have Java or Gradle installed locally.

Usage

  • Bring up the Elastic Stack and the monitored application: $ docker compose up
  • Rerun the Java application to generate more logs: $ docker restart java_app
  • Rebuild the Java application (for example to apply any code changes): $ docker compose up -d --no-deps --build java_app
  • Remove the Elastic Stack and its volumes: $ docker compose down -v

Demo

  1. Start the demo with $ docker compose up or $ docker compose up --build if you want to rebuild the custom images.
  2. Look at the code — which pattern are we building with log statements here?
  3. Look at Management -> Index Management in Kibana.

Parse

  1. How many log events should we have? 40. But we have 42 entries instead. Even though 42 would be the perfect number, here it's not.
  2. See the _grokparsefailure in the tag field. Enable the multiline rules in Filebeat. It should automatically refresh and when you run the application again, it should now only collect 40 events.
  3. Show that this works as expected now and drill down to the errors to see which emoji we are logging.
  4. Copy a log line and parse it with the Grok Debugger in Kibana, for example, with the pattern ^\[%{TIMESTAMP_ISO8601:timestamp}\]%{SPACE}%{LOGLEVEL:level} — show https://github.com/logstash-plugins/logstash-patterns-core/blob/master/patterns/grok-patterns to get started. We can copy the rest of the pattern from logstash.conf.
  5. Point to https://github.com/elastic/ecs for the naming conventions.
  6. Show the Data Visualizer in Machine Learning by uploading the LOG file. The output is actually quite good already, but we are sticking to our manual rules for now.
  7. Find the log statements in Kibana's Discover view for the parse index.
  8. Show the pipeline in Kibana's Monitoring view and the other components in Monitoring.
  9. Create a vertical bar chart visualization on the level field. Further break it down into session.

Send

  1. Show that the logs are missing from the first run, since no connection to Logstash could be established before the Java application shut down in the initial run.
  2. Rerun the application with docker restart java_app and see it works now. And we have already seen the main downside of this approach.
  3. Finally, you would need to rename the fields to match ECS in a Logstash filter.

Structure

  1. Run the application and show the data in the structure index.
  2. Show the Logback configuration for JSON, since it is a little more complicated than the others.

Containerize

  1. Show the metadata we are collecting now.
  2. Point to the ingest pipeline and show how everything is working.
  3. See why we needed the grok failure rule, because of the startup error from sending to Logstash directly.
  4. Filter to down to container.name : "java_app" and point out the hinting that stops the multiline statements from being broken up.
  5. Point out how you could break up the output into two indices — docker-* and docker-java-*.
  6. Show the new Logs UI (adapt the pattern to match the right index).

About

How to log from a Java application to the Elastic Stack

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 53.8%
  • Java 46.2%