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

EPMRPP-87643 || Pattern Analysis documentation update #643

Merged
merged 1 commit into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/analysis/PatternAnalysis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,15 @@ Pattern analysis is a feature that helps you to speed up test failure analysis b

<media-view src={require('./img/PatternAnalysis/PatternAnalysisRegex2.png')} alt="Pattern Analysis Regex in the logs for automated bug triage process" />

:::note
It would be better to use STRING rule instead of REGEX rule in all possible cases to speed up the Pattern Analysis processing in the database. As a result, you can get your analysis completed faster using the STRING patterns rather than REGEX and reduce the database workload.
:::

## Use case 1:

**Problem:** A user knows the several common problems why test cases fail. During tests run a lot of test have failed. A user need to check logs a of tests to know by what reason test cases have failed.

**Solution:** Create a pattern rules for all common reasons which contains a problem phrase (for example: *"Expected status code <404> but > was <500>"* or "*Null response"*) or with Regex query. Switch On a pattern analysis.
**Solution:** Create a pattern rules for all common reasons which contains a problem phrase (for example: *"Expected status code <404> but > was <500>"* or "*Null response"*) or with Regex query (for example: java:[0-9]*). Switch On a pattern analysis.
Launch a test run.
So that the ReportPortal systems finds all failed items which have known patterns in error logs and marks them with a label with pattern name.
Find all items failed by the same reason by choosing a filter by Pattern Name on the Step view.
Expand All @@ -41,7 +45,7 @@ Add The most popular pattern widget (TOP-20) and track the TOP-20 the most popul
name.
Find all items failed by the same reason by choosing a filter by Pattern Name on the Step view.

<media-view thumbnail={require('./img/PatternAnalysis/ManualPatternAnalysis.png')} src="https://youtu.be/mN_wSJArZjQ" alt="Pattern Analysis launched Manually" type="video" />
<media-view thumbnail={require('./img/PatternAnalysis/ManualPatternAnalysis.png')} src="https://youtu.be/_BhG0Tu4H_I" alt="Pattern Analysis launched Manually" type="video" />



Expand Down
Binary file modified docs/analysis/img/PatternAnalysis/ManualPatternAnalysis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/analysis/img/PatternAnalysis/PatternAnalysisRegex1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/analysis/img/PatternAnalysis/PatternAnalysisRegex2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.