[BAPL-1259] Add logging for rule performance analysis #2748

tkobayas · 2020-07-31T03:21:21Z

Document for drools-metric introduced by https://issues.redhat.com/browse/BAPL-1259

I'm sorry about being late to send a PR in the last minutes of 7.41.0.Final release. If it doesn't meet the time (especially, in case that this doc requires revision/update by review), it may be okay to miss in 7.41.0.Final docs... (or probably already too late)

tkobayas · 2020-07-31T03:23:56Z

...easeNotes/ReleaseNotesWorkbench.7.41.0.Final/ReleaseNotesWorkbench.7.41.0.Final-section.adoc

-include::DROOLS-4461-date-picker-for-locadate.adoc[leveloffset=+1]
+include::DROOLS-4461-date-picker-for-localdate.adoc[leveloffset=+1]


Not related to this JIRA but I just found the typo. This typo caused a broken link in release note section.

sterobin · 2020-07-31T14:17:08Z

Thanks @tkobayas , adding @hmanwani-rh who owns this for non-Kogito content.

@hmanwani-rh Can you work through this content? Needs some work to conform to module templates, style, etc. You can likely just make edits directly to the files in the PR and commit in GitHub. Toshiya usually doesn't mind that. Or however you want to do it.

sterobin · 2020-07-31T14:20:52Z

doc-content/drools-docs/src/main/asciidoc/AuthoringAssets/performance-tuning-drl-ref.adoc

@@ -80,3 +80,5 @@ ifdef::DROOLS,JBPM,OP[]
 xref:engine-event-listeners-con_decision-engine[].
 endif::[]
 --
+
+include::identify-bottleneck.adoc[leveloffset=+1]


@hmanwani-rh This include needs to either be elsewhere in an assembly or converted to a segment that instead looks like the other performance tuning sections in this file. See the others above this in the file to see what I mean. In the latter case, might need to be consolidated and not made into a procedure somehow. This approach would be optimal imo, but if it needs to stay a bona fide proc, then should be an include elsewhere I suppose.

@hmanwani-rh FYI, identify-bottleneck is linked from drools-metric.adoc. I'm not sure if we can link to a segment (if we convert identify-bottleneck.adoc to a segment).

tkobayas · 2020-08-03T02:42:28Z

@hmanwani-rh @sterobin

You can likely just make edits directly to the files in the PR and commit in GitHub. Toshiya usually doesn't mind that. Or however you want to do it.

Yes, please edit directly and also it's fine to ask me to edit. Thanks!

…pull/2748

sterobin · 2020-08-05T12:22:24Z

@hmanwani-rh Just a reminder about this PR. Thanks.

hmanwani-rh · 2020-08-10T11:24:29Z

@hmanwani-rh Just a reminder about this PR. Thanks.

@sterobin @tkobayas, apologies for responding late, since I was on PTO. I would like to make edits in the file to be consistent with other performance tuning sections, but I see I do not have the right to edit the file in Github. @sterobin is there any way that I make the changes to the file in the same branch and commit? If yes, please share the procedure and I will make the edits.

hmanwani-rh

Added drools-metric as a section similar to others in performance tuning along with style and formating changes.
Doc previews are as follows:

Designing a Decision Service Using DRL Rules RHPAM
Designing a Decision Service Using DRL Rules RHDM

tkobayas · 2020-08-11T07:51:11Z

LGTM. Thank you, @hmanwani-rh !

sterobin

@hmanwani-rh Thanks! Some minor comments after reviewing the output.

sterobin · 2020-08-11T16:36:01Z

doc-content/drools-docs/src/main/asciidoc/AuthoringAssets/performance-tuning-drl-ref.adoc

@@ -80,3 +80,69 @@ ifdef::DROOLS,JBPM,OP[]
 xref:engine-event-listeners-con_decision-engine[].
 endif::[]
 --
+
+Use `drools-metric` to identify the obstruction in your rules::
+You can use `drools-metric` to identify slow rules especially when you have many rules processing. `drools-metric` can also assist in analyzing the {DECISION_ENGINE} performance. Note that `drools-metric` is not for a production environment use. However, you can perform the analysis in your test environment.


Suggestions/corrections:

"Use the drools-metric module to ..."
"can use the drools-metric module to"
"rules, especially when you process many rules."
"The drools-metric module" [advised to avoid starting sentence with a name like that, per IBM]
"that the drools-metric module is not for production environment use"

sterobin · 2020-08-11T16:39:56Z

doc-content/drools-docs/src/main/asciidoc/AuthoringAssets/performance-tuning-drl-ref.adoc

+You can use `drools-metric` to identify slow rules especially when you have many rules processing. `drools-metric` can also assist in analyzing the {DECISION_ENGINE} performance. Note that `drools-metric` is not for a production environment use. However, you can perform the analysis in your test environment.
+
+
+To analyze the {DECISION_ENGINE} performance using `drools-metric`, add `drools-metric` to your project dependency and enable trace logging for `org.drools.metric.util.MetricLogUtils` as follows:


"to your project dependencies ..."
" , as shown in the following example:" [per IBM, don't use "as follows", "the following", etc. before colon, use complete sentence]

sterobin · 2020-08-11T16:40:45Z

doc-content/drools-docs/src/main/asciidoc/AuthoringAssets/performance-tuning-drl-ref.adoc

+
+To analyze the {DECISION_ENGINE} performance using `drools-metric`, add `drools-metric` to your project dependency and enable trace logging for `org.drools.metric.util.MetricLogUtils` as follows:
+
+


Add the following label to the code snippet, for consistency:

"Example project dependency for drools-metric"

sterobin · 2020-08-11T16:42:20Z

doc-content/drools-docs/src/main/asciidoc/AuthoringAssets/performance-tuning-drl-ref.adoc

+NOTE: Only node executions exceeding the threshold are logged. The default value is `500`.
+
+
+Once the configuration is completed, rule execution produces logs as follows:


"After you complete the configuration, rule execution produces logs as shown in the following example:" [Opt for active voice when possible, avoid the "as follows"]

sterobin · 2020-08-11T16:45:01Z

doc-content/drools-docs/src/main/asciidoc/AuthoringAssets/performance-tuning-drl-ref.adoc

+TRACE [EvalConditionNode(9)]: cond=com.sample.Rule_Collect_expensive_orders_combination930932360Eval1Invoker@ee2a6922], evalCount:49500, elapsedMicro:18787
+----
+
+


Suggest leading the bullets with something like, "In this example, the following key parameters are displayed:"

Thanks, @sterobin.
Changing it to "The example above includes the following key parameters:"

@hmanwani-rh I changed to "This example includes" because per IBM, we should above "above", "below", etc.

sterobin · 2020-08-11T16:45:32Z

doc-content/drools-docs/src/main/asciidoc/AuthoringAssets/performance-tuning-drl-ref.adoc

+* `evalCount` is the number of constraint evaluations against inserted facts during the node execution.
+* `elapsedMicro` is the elapsed time of the node execution in microseconds.
+
+


I think you need to nix this + sign to correct the formatting. Note how the indentation is off from here to the end in the output. Have a look and adjust to fix.

sterobin · 2020-08-11T16:46:20Z

...rools-docs/src/main/asciidoc/ReleaseNotes/ReleaseNotesDrools.7.41.0.Final/drools-metric.adoc

@@ -0,0 +1,5 @@
+[id='drools-metric']
+
+= drools-metric module for {DECISION_ENGINE} performance analysis


"= New drools-metric module for ..." [To avoid starting with a formatted proper name]

hmanwani-rh · 2020-08-12T07:29:37Z

@hmanwani-rh Thanks! Some minor comments after reviewing the output.

Thanks, @sterobin for providing the suggestions. I have incorporated the suggested changes in the content.

Update nearby distance to new VRP implementation Updated the code Added an explanation

[BAPL-1259] Add logging for rule performance analysis

ac71078

tkobayas commented Jul 31, 2020

View reviewed changes

tkobayas requested review from sterobin and mariofusco July 31, 2020 03:29

mariofusco approved these changes Jul 31, 2020

View reviewed changes

sterobin requested a review from hmanwani-rh July 31, 2020 14:14

sterobin reviewed Jul 31, 2020

View reviewed changes

Ginxo referenced this pull request in Ginxo/kie-docs Aug 4, 2020

[TEST] BXMSPROD-907 testing for https://github.com/kiegroup/kie-docs/…

bff3e63

…pull/2748

Ginxo mentioned this pull request Aug 4, 2020

[TEST] BXMSPROD-907 testing for https://github.com/kiegroup/kie-docs/pull/2748 #2751

Closed

Heena Manwani added 2 commits August 10, 2020 21:26

BAPL-1259: Made style changes to drools-metric content

1a7bc62

BAPL-1259: Deleted the idnetify-bottleneck.adoc file

bc2988f

hmanwani-rh reviewed Aug 11, 2020

View reviewed changes

sterobin reviewed Aug 11, 2020

View reviewed changes

sterobin added the under review Label for PRs pending SME or peer review label Aug 11, 2020

BAPL-1259: Incoorporated peer review comments

822d631

Small tweak to wording

555525b

sterobin approved these changes Aug 12, 2020

View reviewed changes

sterobin merged commit 3c703a2 into apache:master Aug 12, 2020

Rikkola pushed a commit to Rikkola/kie-docs that referenced this pull request May 28, 2025

Doc Update nearby distance to new VRP implementation (apache#2748)

be46153

Update nearby distance to new VRP implementation Updated the code Added an explanation

		include::DROOLS-4461-date-picker-for-locadate.adoc[leveloffset=+1]
		include::DROOLS-4461-date-picker-for-localdate.adoc[leveloffset=+1]

		@@ -0,0 +1,5 @@
		[id='drools-metric']

		= drools-metric module for {DECISION_ENGINE} performance analysis

[BAPL-1259] Add logging for rule performance analysis #2748

[BAPL-1259] Add logging for rule performance analysis #2748

Uh oh!

Conversation

tkobayas commented Jul 31, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sterobin commented Jul 31, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tkobayas commented Aug 3, 2020

Uh oh!

sterobin commented Aug 5, 2020

Uh oh!

hmanwani-rh commented Aug 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hmanwani-rh left a comment

Choose a reason for hiding this comment

Uh oh!

tkobayas commented Aug 11, 2020

Uh oh!

sterobin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hmanwani-rh commented Aug 12, 2020

Uh oh!

Uh oh!

tkobayas commented Jul 31, 2020 •

edited

Loading

hmanwani-rh commented Aug 10, 2020 •

edited

Loading

sterobin left a comment •

edited

Loading