Skip to content

Commit a601867

Browse files
Vibhuti Sodhivibhuti sodhi
authored andcommitted
MTA-3102-app insights section added
1 parent a736b30 commit a601867

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

docs/topics/mta-review-reports.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ The top navigation bar lists the various reports that contain additional details
7777
| Issues
7878
| Provides a concise summary of all issues that require attention.
7979

80+
| Insights
81+
| Provides information about the technologies used in the application and their usage in the code. However, these Insights do not impact the migration.
82+
8083
| Application details
8184
| Provides a detailed overview of all resources found within the application that may need attention during the migration.
8285

@@ -152,6 +155,56 @@ image::3-5-expanded-issue.png[Expanded rule in the issues report]
152155

153156
Issues are sorted into four categories by default. Information on these categories is available at ask Category.
154157

158+
159+
=== Insights
160+
161+
Insights provide helpful information about the technologies used in the application and their usage in the code.
162+
For example, a rule searching for a deprecated API usage in the code that does not impact the current migration but can be tracked and fixed when needed in the future.
163+
164+
Unlike issues, insights do not need to be fixed for a successful migration. They are generated by any tagging or non-tagging rule and do not have an effort and category assigned. They might have a message and tag.
165+
166+
[NOTE]
167+
=====
168+
Insights are generated automatically, if applicable or present. However, you must run the application analysis by using the CLI because MTA 7.1 does not support their generation through the UI.
169+
=====
170+
171+
You can view Insights in the Static report under the Insights tab and in the analysis output under the Insights section.
172+
173+
.Example: Insights generated by a tagging rule with undefined effort and category
174+
175+
[source,terminal]
176+
----
177+
- customVariables: []
178+
description: Embedded library - Apache Wicket
179+
labels:
180+
- konveyor.io/include=always
181+
links: []
182+
ruleID: mvc-01000
183+
tag:
184+
- Apache Wicket
185+
- Embedded library - Apache Wicket
186+
when:
187+
builtin.file:
188+
pattern: .*wicket.*\.jar
189+
----
190+
191+
.Example: Insights generated by a non-tagging rule with zero effort and no category
192+
193+
[source,terminal]
194+
----
195+
- category: potential
196+
customVariables: []
197+
description: RESTful Web Services @Context annotation has been deprecated
198+
effort: 0
199+
message: Future versions of this API will no longer support `@Context` and related
200+
types such as `ContextResolver`.
201+
ruleID: jakarta-ws-rs-00001
202+
when:
203+
java.referenced:
204+
location: ANNOTATION
205+
pattern: jakarta.ws.rs.core.Context
206+
----
207+
155208
=== Application details report
156209

157210
Access this report from the dashboard by clicking the *Application Details* link.

0 commit comments

Comments
 (0)