logstash icon indicating copy to clipboard operation
logstash copied to clipboard

health api: expose `GET /_health_report` with pipelines/*/up probe

Open yaauie opened this issue 1 year ago • 1 comments

Release notes

What does this PR do?

Adds the base framework for a health report API as-described in #16056, including the basic per-pipeline up probe.

Why is it important/What is the impact to the user?

Users are best served with actionable insights into what is going on in the Logstash process, and this bootstrap adds an API endpoint to start providing value to that end.

Checklist

  • [x] My code follows the style guidelines of this project
  • [x] I have commented my code, particularly in hard-to-understand areas
  • [x] I have made corresponding changes to the documentation
  • ~~[ ] I have made corresponding change to the default configuration files (and/or docker env variables)~~
  • [ ] I have added tests that prove my fix is effective or that my feature works

How to test this PR locally

  1. Build Logstash
  2. Start Logstash with a variety of pipelines, some of which exit when complete, others that take significant time to load, etc
  3. Query the health API endpoint curl --silent -XGET http://localhost:9600/_health_report

Related issues

  • Relates #16056

Use cases

Screenshots

Screenshot 2024-08-20 at 5 20 39 PM

Logs

yaauie avatar Aug 21 '24 00:08 yaauie

FYI: I have built docker image and validated the _health_report API.

mashhurs avatar Oct 08 '24 07:10 mashhurs

:green_heart: Build Succeeded

History

  • :yellow_heart: Build #1593 was flaky 05e858f56c2135af8ce98edcbf4f8c881a36e4ed
  • :green_heart: Build #1592 succeeded e7b1f39bf5258a6a603e38fc4784088336e72dd5
  • :yellow_heart: Build #1582 was flaky 34a7d64000128db388135182c2fe610895b8a681
  • :green_heart: Build #1580 succeeded dba08e0594ff5e30671b9a3904da669c4f5948f8
  • :green_heart: Build #1579 succeeded aa6ede46f39e084c5d63a3fcceb5ccef8754d6f3
  • :green_heart: Build #1578 succeeded bcb0563dda77a190fa43eefb55704815a30607d6

elasticmachine avatar Oct 08 '24 19:10 elasticmachine