BXMSDOC-5098: Added Managing Log files chapter in process designer doc #12

hmanwani-rh · 2020-03-31T14:47:10Z

See JIRA: https://issues.redhat.com/browse/BXMSDOC-5098

Rendered docs:
Designing business processes in Business Central

MarianMacik

BTW all of this is true also for other containers than JWS like EAP for example. Do we already have that there? If so, then it would be good to share the content.

MarianMacik · 2020-04-01T09:42:32Z

doc-content/enterprise-only/admin-and-config/log-process-instance-con.adoc

+
+You can use the `jbpm-audit` module that provides an event listener and allows you to store the information directly in a database using JPA or Hibernate. The log data is stored as follows:
+
+* Process instance as `processinstancelog`


Please use ProcessInstanceLog as the name.

MarianMacik · 2020-04-01T09:42:59Z

doc-content/enterprise-only/admin-and-config/log-process-instance-con.adoc

+
+|===
+
+* Element instance as `nodeinstancelog`


NodeInstanceLog

MarianMacik · 2020-04-01T09:43:59Z

doc-content/enterprise-only/admin-and-config/log-process-instance-con.adoc

+* Variable instance as `variableinstancelog`
+
+[id='fields_variableinstancelog_{context}']
+.Fields of the variableinstancelog table


VariableInstanceLog

MarianMacik · 2020-04-01T09:46:24Z

doc-content/enterprise-only/admin-and-config/log-process-instance-con.adoc

+|End date of a process instance
+|Yes
+
+|`processid`


I would generally go for lower camel case even for the name of the columns as this is how it appears in the code, so here it would be processId for example.

MarianMacik · 2020-04-01T09:48:01Z

doc-content/enterprise-only/admin-and-config/logging-events-database-proc.adoc

+[id='logging-events-database-proc']
+= Logging events to database
+
+You can log an event to a database that occurs on runtime in a process instance, element instance or variable instance.


element instance -> node instance

MarianMacik · 2020-04-01T10:17:54Z

doc-content/enterprise-only/admin-and-config/logging-events-database-proc.adoc

+	<groupId>org.jbpm</groupId>
+	<artifactId>jbpm-audit</artifactId>
+	<version>6.5.0.Final-redhat-2</version>
+</dependency>


This should be probably moved to the log-process-instance-con.adoc where you speak about You can use the jbpm-audit module that...

And also please as a version just put there either a variable referring to the current version or some kind of placeholder that will just explain that the version a user is currently using should be specified there.

MarianMacik · 2020-04-01T10:20:31Z

doc-content/enterprise-only/admin-and-config/logging-events-database-proc.adoc

+  private EntityManagerFactory emf;
+
+  private AuditLogService auditLogService;
+@PostConstruct


@PostConstruct is not relevant here as we don't have to use CDI/EJB framework. You can omit it.

MarianMacik · 2020-04-01T10:44:45Z

doc-content/enterprise-only/admin-and-config/setup-auto-cleanup-proc.adoc

+org.jbpm.executor.commands.LogCleanupCommand
+----
+
+. Click *Add Parameter* if you wish to use the parameters listed above. In the key section, enter a parameter name. In the value section, enter true or false, depending on the desired outcome.


if you wish to use the parameters listed above
Where are those parameters?

…tent to eap and process designer user stories

hmanwani-rh · 2020-04-02T08:06:18Z

BTW all of this is true also for other containers than JWS like EAP for example. Do we already have that there? If so, then it would be good to share the content.

@MarianMacik thanks for providing the comments. I have made the changes as suggested, can you please review and provide your approval.

MarianMacik

Adding @sutaakar to verify some things.

MarianMacik · 2020-04-02T17:19:35Z

doc-content/enterprise-only/admin-and-config/setup-auto-cleanup-proc.adoc

+org.jbpm.executor.commands.LogCleanupCommand
+----
+
+. Click *Add Parameter* if you wish to use the <<logcleanupcommand_parameters_{context}, parameters>>, enter a parameter in the key section and enter true or false in the value section.


Not all parameters have true/false as their value. So I would just state here enter the parameter value in the value section or similar.

Made this change

MarianMacik · 2020-04-02T17:22:02Z

doc-content/enterprise-only/admin-and-config/log-process-instance-con.adoc

+	<artifactId>jbpm-audit</artifactId>
+	<version>{PRODUCT_VERSION_LONG}-redhat-2</version>
+</dependency>
+----


This kind of information cannot be really set when installing it on EAP or JWS. It can only be set when running a process engine inside a custom application. So I wouldn't add it into EAP or JWS install guides but probably to the guide which is about running engine as a part of a custom app.

Right, this setup is already available in Kie server.

Therefore, I would suggest to move this to another chapter, definitely somewhere where we have configuration of jBPM engine as a part of a custom app.

@MarianMacik and @sutaakar, thanks for providing the inputs, I will be moving this section to process engine doc

MarianMacik · 2020-04-02T17:23:01Z

doc-content/enterprise-only/admin-and-config/logging-configuration-logback-proc.adoc

+   <groupId>ch.qos.logback</groupId>
+   <artifactId>logback-classic</artifactId>
+   <version>1.x</version>
+</dependency>


Same here, this cannot be configured for Business Central or KIE Server.

Moving this section to process engine doc

MarianMacik · 2020-04-02T17:23:33Z

doc-content/enterprise-only/admin-and-config/logging-events-database-proc.adoc

+  RuntimeEngine runtime = singletonManager.getRuntimeEngine(EmptyContext.get());
+  KieSession ksession = runtime.getKieSession();
+  AuditLoggerFactory.newInstance(Type.JPA, ksession, null);
+


This also belongs to an engine section.

Moving to process engine doc

MarianMacik · 2020-04-02T17:24:31Z

doc-content/enterprise-only/admin-and-config/logging-events-database-proc.adoc

+.Procedure
+. Map log classes to the data source that enables the data source to accept the log entries.
+* On {EAP}, edit the data source properties in the `persistence.xml` file.
+[source,code]


The persistence.xml of KIE Server already contains this so I guess it should be present only in an engine section.

Moving to process engine doc

sutaakar · 2020-04-03T11:43:09Z

doc-content/enterprise-only/admin-and-config/logging-events-database-proc.adoc

+      <property name="hibernate.hbm2ddl.auto" value="update"/>
+      <property name="hibernate.show_sql" value="true"/>
+      <property name="hibernate.transaction.manager_lookup_class"
+                value="org.hibernate.transaction.BTMTransactionManagerLookup"/>


@MarianMacik This looks like a deprecated configuration. IMHO the hibernate.transaction.jta.platform should be used here.

sutaakar · 2020-04-03T11:44:17Z

doc-content/enterprise-only/admin-and-config/logging-events-database-proc.adoc

+      <property name="hibernate.dialect" value="org.hibernate.dialect.H2Dialect"/>
+      <property name="hibernate.max_fetch_depth" value="3"/>
+      <property name="hibernate.hbm2ddl.auto" value="update"/>
+      <property name="hibernate.show_sql" value="true"/>


Shouldn't we rather set this to false/skip this property?

sutaakar · 2020-04-03T11:45:28Z

doc-content/enterprise-only/admin-and-config/logging-events-database-proc.adoc

+  xmlns="http://java.sun.com/xml/ns/persistence">
+
+  <persistence-unit name="org.jbpm.persistence.jpa">
+    <provider>org.hibernate.ejb.HibernatePersistence</provider>


We may rather use org.hibernate.jpa.HibernatePersistenceProvider

kaldesai · 2020-04-08T09:33:12Z

doc-content/enterprise-only/admin-and-config/clean-log-proc.adoc

+|No, it is used with other parameters.
+
+|`EmfName`
+|Persistence unit name that is used to perform operation deletion.


I would use .... to perform delete operation.

kaldesai · 2020-04-08T09:35:42Z

doc-content/enterprise-only/admin-and-config/clean-log-proc.adoc

+[id='clean-log-proc']
+= Removing logs from the database
+
+Use `LogCleanupCommand` executor command to clean up the data that is using the database space. The `LogCleanupCommand` consists of logic to automatically clean up all or selected data.


We can use "which" instead of "that".

Use LogCleanupCommand executor command to clean up the data which is using the database space.

kaldesai · 2020-04-08T09:40:47Z

doc-content/enterprise-only/admin-and-config/setup-auto-cleanup-proc.adoc

+.Procedure
+. In {CENTRAL}, go to *Deploy* > *Jobs*.
+. Click *New Job*.
+. Enter a name, due date and time and following into the *Type* text field.


Just a question:

In this Enter a name, due date and time and following into the Type text field, what is the following? Is it a command that we are including in the Type text field?

Suggestion: Enter a name, due date, time and, the following command into the Type text field.

yes, following is the command.
Have made the suggested change

kaldesai · 2020-04-08T09:42:20Z

doc-content/enterprise-only/admin-and-config/setup-auto-cleanup-proc.adoc

+org.jbpm.executor.commands.LogCleanupCommand
+----
+
+. Click *Add Parameter* if you wish to use the <<logcleanupcommand_parameters_{context}, parameters>>, enter a parameter in the key section and enter a parameter value in the value section.


Original: . Click Add Parameter if you wish to use the <<logcleanupcommand_parameters_{context},
Suggestion: . Click Add Parameter if you want to use the <<logcleanupcommand_parameters_{context},

kaldesai · 2020-04-08T09:44:10Z

doc-content/enterprise-only/admin-and-config/manage-log-file-proc.adoc

+* *Per request strategy* allows automatic removal when a request is terminated.
+* *Per process instances* are automatically removed when a process instance is mapped to a session that is completed or aborted.
+
+In order to keep track of process instances, {PRODUCT} provides audit data tables. There are two ways to manage and maintain the audit data tables, including cleaning up the jobs <<setup-auto-cleanup-proc, automatically>> and <<manual-cleanup-con, manually>>.


Add "the".
In order to keep the track of process instances,

kaldesai

Hey @hmanwani-rh, I have added minor suggestions. Otherwise looks good to me. Your content is really clean and clear. :)

MarianMacik

Looks good. I agree with moving some of the parts to process engine doc.

hmanwani-rh · 2020-04-08T10:56:29Z

Hey @hmanwani-rh, I have added minor suggestions. Otherwise looks good to me. Your content is really clean and clear. :)

Thank you @kaldesai

hmanwani-rh · 2020-04-08T10:58:11Z

Looks good. I agree with moving some of the parts to process engine doc.

Thanks Marian, other sections will be tracked for process engine as part of https://issues.redhat.com/browse/BXMSDOC-5704

* BXMSDOC-8060 Migration of standalone Business Central from Thorntail to EAP Bootable Jar (#11) * BXMSDOC-8060 initial commit * Removes internal notes * Replaces dashes with colons * Post QA feedback * BXMSDOC-8312: Add note to enable user and group management (#12) * BXMSDOC-8312 Adds note to enable user and group management * Fixes typo * Update doc-content/enterprise-only/installation/run-dc-standalone-proc.adoc Incorporating peer review suggestion. Co-authored-by: emmurphy1 <30830712+emmurphy1@users.noreply.github.com> Co-authored-by: emmurphy1 <30830712+emmurphy1@users.noreply.github.com> * BXMSDOC-8312: Add note to enable user and group management (#12) * BXMSDOC-8312 Adds note to enable user and group management * Fixes typo * Update doc-content/enterprise-only/installation/run-dc-standalone-proc.adoc Incorporating peer review suggestion. Co-authored-by: emmurphy1 <30830712+emmurphy1@users.noreply.github.com> Co-authored-by: emmurphy1 <30830712+emmurphy1@users.noreply.github.com> Co-authored-by: emmurphy1 <30830712+emmurphy1@users.noreply.github.com>

…che#4043) * BXMSDOC-8312 Adds note to enable user and group management * Fixes typo * Update doc-content/enterprise-only/installation/run-dc-standalone-proc.adoc Incorporating peer review suggestion. Co-authored-by: emmurphy1 <30830712+emmurphy1@users.noreply.github.com> Co-authored-by: emmurphy1 <30830712+emmurphy1@users.noreply.github.com> Co-authored-by: emmurphy1 <30830712+emmurphy1@users.noreply.github.com>

BXMSDOC-5098: Added Logging chapter in Install and config doc

55c208e

MarianMacik reviewed Apr 1, 2020

View reviewed changes

BXMSDOC-5098: Made changes as per SME review comments, also added con…

930afb6

…tent to eap and process designer user stories

MarianMacik reviewed Apr 2, 2020

View reviewed changes

sutaakar reviewed Apr 3, 2020

View reviewed changes

hmanwani-rh changed the title ~~BXMSDOC-5098: Added Logging Process Instance chapter in Install and config doc~~ BXMSDOC-5098: Added Managing Log files chapter in process designer doc Apr 7, 2020

BXMSDOC-5098: Made changes as per peer review comments

431390e

kaldesai reviewed Apr 8, 2020

View reviewed changes

kaldesai approved these changes Apr 8, 2020

View reviewed changes

MarianMacik approved these changes Apr 8, 2020

View reviewed changes

BXMSDOC-5098: Made changes as per peer review comments

d61623c

sutaakar approved these changes Apr 9, 2020

View reviewed changes

hmanwani-rh merged commit 5f063f4 into BXMSDOC-5098-master-final Apr 9, 2020


		You can use the `jbpm-audit` module that provides an event listener and allows you to store the information directly in a database using JPA or Hibernate. The log data is stored as follows:

		* Process instance as `processinstancelog`

BXMSDOC-5098: Added Managing Log files chapter in process designer doc #12

BXMSDOC-5098: Added Managing Log files chapter in process designer doc #12

Conversation

hmanwani-rh commented Mar 31, 2020 • edited

MarianMacik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hmanwani-rh commented Apr 2, 2020

MarianMacik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaldesai left a comment

Choose a reason for hiding this comment

MarianMacik left a comment

Choose a reason for hiding this comment

hmanwani-rh commented Apr 8, 2020

hmanwani-rh commented Apr 8, 2020

hmanwani-rh commented Mar 31, 2020 •

edited