opensearch-project / OpenSearch-Dashboards

📊 Open source visualization dashboards for OpenSearch.
https://opensearch.org/docs/latest/dashboards/index/
Apache License 2.0
1.69k stars 893 forks source link

Add grok debugger in the DevTools tab #5421

Open samuambroj opened 1 year ago

samuambroj commented 1 year ago

Hi,

Is there a way of getting the grok debugger in OS-Dashboards? As far as I am concerned, this is available in Kibana. This is really useful when some people are starting to debug the parsing with regular expressions. There are alternatives online, but I think that having it in the DevTools tab would be really helpful.

Cheers, Samuel

ananzh commented 1 year ago

@samuambroj could you provide us more info? for example what is the user story and use cases?

samuambroj commented 1 year ago

Dear @ananzh,

Thank you for your prompt response. I appreciate your interest in understanding the potential value of the grok debugger feature in OS-Dashboards. To provide a more formal explanation, here is a user story and some use cases that demonstrate the significance of this feature:

User Story: As a developer using OS-Dashboards, I want to have access to a grok debugger tool in the DevTools tab to facilitate the debugging of log parsing and regular expressions. This would improve the efficiency of troubleshooting and fine-tuning log parsing configurations, leading to a smoother and more reliable log processing workflow.

Use Cases:

Troubleshooting Parsing Issues: When working with log data, parsing issues are a common challenge. With the grok debugger, users can interactively test and refine their regular expressions. This simplifies the process of identifying and resolving parsing problems, reducing debugging time and effort.

Validation of Parsing Rules: Users can validate their grok patterns directly within OS-Dashboards, ensuring that they accurately capture the necessary fields from log data. This feature would be particularly valuable for those who frequently work with log data from different sources and formats.

Educational Tool: For users who are new to grok patterns and regular expressions, having a built-in grok debugger can serve as an educational resource. It allows them to experiment, learn, and refine their regular expression skills without needing to use external tools or online resources.

Streamlined Workflow: Integrating the grok debugger into OS-Dashboards aligns with a streamlined workflow. Users can perform parsing tests and make adjustments without leaving the dashboard environment, increasing overall productivity.

In summary, the inclusion of a grok debugger in OS-Dashboards would enhance the user experience, expedite troubleshooting, and serve as an educational asset. I believe that this feature can significantly benefit users who work with log data regularly. Your consideration of this request is greatly appreciated.

If you require any further information or have additional questions, please do not hesitate to ask. Looking forward to your response.

Best regards, Samuel

dubloid commented 2 months ago

Hello! Is there any positive reaction to the proposal to add the grok debugger module to dev tools?

Best regards, Dubloid