Add runtime logs filter guide

[hasathcharu]

$subject.

Resolves #139

Summary by CodeRabbit

• Documentation
  • Updated runtime logs docs with a new "Filter runtime logs" subsection describing available filters (Type, Environment, Deployment Track, Time Range, Content Search, Regex Search), how to apply content/regex searches via the search bar (press Enter), a note about Lucene query syntax, and clarified language about who can view logs with applied filters.

[coderabbitai]

Walkthrough

Adds a "Filter runtime logs" subsection to the logs overview documenting available filter parameters (Type, Environment, Deployment Track, Time Range, Content Search, Regex Search) and instructions to apply content/regex searches via the search bar, with a link to Lucene Query Syntax.

Changes

Cohort / File(s)	Change Summary
Runtime logs filtering documentation en/docs/monitoring-and-insights/logs-overview.md	Adds a "Filter runtime logs" subsection describing filter parameters (Type, Environment, Deployment Track, Time Range, Content Search, Regex Search); documents using the search bar and Enter to apply searches; adds a note linking to Lucene Query Syntax documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Single documentation file updated with additive content.
• Review attention suggestions:
  • Verify the Lucene Query Syntax link target and phrasing.
  • Confirm regex guidance is accurate and non-misleading.
  • Ensure the new subsection integrates with existing headings and formatting.

Poem

🐇 I hop through lines of runtime logs,
I sniff for Type, Environment, Track,
With content queries and regex paws,
Lucene lights the hidden tracks,
A little hop — the match pops back!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The pull request description is minimal and lacks required sections from the template such as Purpose, Goals, Approach, and other critical details.	Complete the description template with Purpose, Goals, Approach, Release note, Documentation links, and other applicable sections to provide full context.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title clearly summarizes the main change: adding documentation about runtime logs filtering.
Linked Issues check	✅ Passed	The code changes add comprehensive filter documentation including regex search as requested in issue #139.
Out of Scope Changes check	✅ Passed	All changes are focused on documentation updates related to runtime logs filtering and align with the linked issue objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between acfc31f and 396146e.

📒 Files selected for processing (1)

• en/docs/monitoring-and-insights/logs-overview.md (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-11-14T08:01:01.468Z

Learnt from: hasathcharu
Repo: wso2/docs-devant PR: 140
File: en/docs/monitoring-and-insights/logs-overview.md:70-75
Timestamp: 2025-11-14T08:01:01.468Z
Learning: In the Devant documentation (en/docs/monitoring-and-insights/logs-overview.md), log type values (Error, Warn, Info, Debug) should use title case to match the terms used in the Devant UI.

Applied to files:

• en/docs/monitoring-and-insights/logs-overview.md

🔇 Additional comments (2)

en/docs/monitoring-and-insights/logs-overview.md (2)

16-16: LGTM: Simplification improves flow before filter section.

The modification appropriately removes redundant filter references, creating better flow into the new detailed "Filter runtime logs" section below.

---

67-82: Lucene documentation link verified as accessible.

The new "Filter runtime logs" section is comprehensive and well-structured:

• All filter parameters clearly documented with appropriate descriptions
• Log type values correctly use Title Case (Error, Warn, Info, Debug)
• Search instructions properly formatted with keyboard action emphasis
• External Lucene reference link is functional and accessible (HTTP 200)

This implementation fully addresses issue #139's regex search documentation requirements.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f89839f and 93be1f2.

📒 Files selected for processing (1)

• en/docs/monitoring-and-insights/logs-overview.md (1 hunks)

🔇 Additional comments (2)

en/docs/monitoring-and-insights/logs-overview.md (2)

79-80: Verify the Lucene documentation link targets the appropriate version.

The Lucene Query Parser Syntax may change from release to release, and you should consult the documentation matching the version you are using. The link references version 2.9.4, which is quite old. Please verify that this is the version Devant's regex search implementation actually uses, or update to a more recent stable version's documentation if applicable.

---

67-81: New filtering documentation is well-structured and documented.

The new "Filtering runtime logs" subsection effectively documents the filter parameters with clear explanations. The guidance on applying filters via the search bar is practical, and the note about Lucene query syntax with the external reference is helpful for users needing advanced regex features.