Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Live debugging front #977

Merged
merged 4 commits into from
Jun 5, 2024
Merged

Live debugging front #977

merged 4 commits into from
Jun 5, 2024

Conversation

wildum
Copy link
Contributor

@wildum wildum commented Jun 3, 2024

THIS PR WILL BE MERGED TO A FEATURE BRANCH WHICH WILL RECEIVE A FEW OTHER PRs BEFORE BEING READY TO BE MERGED ON MAIN

This PR is the second part of the live debugging functionality.

It adds a live debugging page in the front-end:

Screen.Recording.2024-06-03.at.16.09.35.mov

The live debugging uses a 5000 lines buffer to display the feed. Once the buffer is full, old lines are removed.
The user:

  • can filter the buffer
  • use a sample probability to reduce the throughput
  • copy the content of the buffer to the clipboard
  • pause/resume/clear the page
  • enable/disable auto-scrolling

It supports modules.

Fixes #831

@wildum wildum changed the title Xray front Live debugging front Jun 3, 2024
@wildum wildum requested a review from jcreixell June 4, 2024 11:57
Copy link
Contributor

@jcreixell jcreixell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, the changes are consistent with the previous code we wrote for the POC, which we tested thoroughly. I don't love the colors of the buttons on the top right, but they are functional and we can always make cosmetic improvements later. Looking forward to seeing this released!

@wildum wildum merged commit 5736565 into xray Jun 5, 2024
15 checks passed
@wildum wildum deleted the xray-front branch June 5, 2024 08:21
wildum added a commit that referenced this pull request Jun 7, 2024
* add live debugging page in UI

* change button size

* move icon in front of text in buttons

* add warning if the number of incoming lines is greater than the buffer size
@wildum wildum mentioned this pull request Jun 7, 2024
5 tasks
wildum added a commit that referenced this pull request Jun 11, 2024
* Live debugging service with prometheus.relabel (#797)

* create xray service to manage the debug streams

* add xray support to the prometheus.relabel component

* add xray endpoint to the api

* rename handler to manager

* defer cleanup func

* rework to add multi-streams support

* more tests

* additional multi delete test

* add todo comment for buffer size

* add error checks

* improve naming and readability, split interfaces and add a check to avoid expensive string computation

* move register and isregistered to a new debugRegistry interface

* Live debugging front (#977)

* add live debugging page in UI

* change button size

* move icon in front of text in buttons

* add warning if the number of incoming lines is greater than the buffer size

* Live debugging doc (#987)

* add live debugging doc

* Update docs/sources/tasks/debug.md

Co-authored-by: Clayton Cornell <[email protected]>

* Update docs/sources/tasks/debug.md

Co-authored-by: Clayton Cornell <[email protected]>

* Update docs/sources/tasks/debug.md

Co-authored-by: Clayton Cornell <[email protected]>

* improve doc

* Update docs/sources/tasks/debug.md

Co-authored-by: Clayton Cornell <[email protected]>

---------

Co-authored-by: Clayton Cornell <[email protected]>

* changelog

* add list of supported components in debug.md

* switch to pull based registration

* switch stability to GA

* update changelog

* use monospace font for log lines

* copy to clipboard now copies the filtered data

* disable livedebugging by default and add a config block to enable it. The stability is also updated to experimental

* Update docs/sources/reference/config-blocks/livedebugging.md

Co-authored-by: Clayton Cornell <[email protected]>

* Update docs/sources/reference/config-blocks/livedebugging.md

Co-authored-by: Clayton Cornell <[email protected]>

* replace debugging data by live debugging data in the doc

* update screenshots

* Update docs/sources/reference/config-blocks/livedebugging.md

Co-authored-by: Clayton Cornell <[email protected]>

* Update docs/sources/reference/config-blocks/livedebugging.md

Co-authored-by: Clayton Cornell <[email protected]>

* small doc fix

---------

Co-authored-by: Clayton Cornell <[email protected]>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants