wmedvede commented on code in PR #693: URL: https://github.com/apache/incubator-kie-kogito-docs/pull/693#discussion_r1881981209
########## serverlessworkflow/modules/ROOT/pages/_common-content/sonataflow-metrics.adoc: ########## @@ -0,0 +1,134 @@ +== Overview Review Comment: @jianrongzhang89 this common sonataflow_metrics document is great, many thanks. My only observation is that the order of occurrence of each metric in the document, is not the same as the one being shown in the initial paragraph, which somehow corresponds with the workflow "natural" life-cycle. see:  ########## serverlessworkflow/modules/ROOT/pages/_common-content/sonataflow-metrics.adoc: ########## @@ -0,0 +1,134 @@ +== Overview + +In {product_name}, you can check the following metrics: + +* `kogito_process_instance_started_total`: Number of started workflows (a workflow that has started might be running or completed) +* `kogito_process_instance_running_total`: Number of running workflows +* `kogito_process_instance_completed_total`: Number of completed workflows +* `kogito_process_instance_error`: Number of workflows that report an error ( a workflow with an error might be still running or have been completed) +* `kogito_process_instance_duration_seconds`: Duration of a process instance in seconds +* `kogito_node_instance_duration_milliseconds`: Duration of relevant nodes in milliseconds (a workflow is composed by nodes, user might be interested on the time consumed by an specific node type) +* `sonataflow_input_parameters_counter`: Records input parameters, the occurrences of <"param_name","param_value"> per `processId`. + +[NOTE] +==== +Internally, workflows are referred as processes. Therefore, the `processId` and `processName` is workflow ID and name respectively. +==== + +Each of the metrics mentioned previously contains a label for a specific workflow ID. For example, the `kogito_process_instance_completed_total` metric below contains the labels for `callbackstatetimeouts` workflow: + +.Example `kogito_process_instance_completed_total` metric +[source,yaml] +---- +# HELP kogito_process_instance_completed_total Completed Process Instances +# TYPE kogito_process_instance_completed_total counter +kogito_process_instance_completed_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",process_state="Completed",version="1.0.0-SNAPSHOT",} 3.0 +---- + +[NOTE] +==== +Internally, {product_name} uses Quarkus Micrometer extension, which also exposes built-in metrics. You can disable the Micrometer metrics in {product_name}. For more information, see link:https://quarkus.io/guides/micrometer[Quarkus - Micrometer Metrics]. +==== + +== Metrics Description +=== kogito_process_instance_completed_total +Workflow instances that have reached a terminal status, “Aborted” or “Completed”, and thus are considered as completed. + +[NOTE] +==== +These are the only two terminal status. The “Error” state is not terminal. +Additionally, the metric has the process_state="Completed", or could be "Aborted", to register exactly which of the two terminal status were reached. +==== + +[source, yaml] +---- +# HELP kogito_process_instance_completed_total Completed Process Instances +# TYPE kogito_process_instance_completed_total counter +kogito_process_instance_completed_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",process_state="Completed",version="1.0.0-SNAPSHOT",} 3.0 +---- + +=== kogito_process_instance_started_total +Count the number of started workflow instances. + +[source, yaml] +---- +# HELP kogito_process_instance_started_total Started Process Instances +# TYPE kogito_process_instance_started_total counter +kogito_process_instance_started_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",version="1.0.0-SNAPSHOT",} 7.0 +---- + +=== kogito_process_instance_running_total +Records the number of running workflow instances. + +[NOTE] +==== +This includes workflow instances that are in the "Error" state, since the error state is not a terminal state. Review Comment: ```suggestion This includes workflow instances that are in the `Error` state, since the error state is not a terminal state. ``` ########## serverlessworkflow/modules/ROOT/pages/_common-content/sonataflow-metrics.adoc: ########## @@ -0,0 +1,134 @@ +== Overview + +In {product_name}, you can check the following metrics: + +* `kogito_process_instance_started_total`: Number of started workflows (a workflow that has started might be running or completed) +* `kogito_process_instance_running_total`: Number of running workflows +* `kogito_process_instance_completed_total`: Number of completed workflows +* `kogito_process_instance_error`: Number of workflows that report an error ( a workflow with an error might be still running or have been completed) +* `kogito_process_instance_duration_seconds`: Duration of a process instance in seconds +* `kogito_node_instance_duration_milliseconds`: Duration of relevant nodes in milliseconds (a workflow is composed by nodes, user might be interested on the time consumed by an specific node type) +* `sonataflow_input_parameters_counter`: Records input parameters, the occurrences of <"param_name","param_value"> per `processId`. + +[NOTE] +==== +Internally, workflows are referred as processes. Therefore, the `processId` and `processName` is workflow ID and name respectively. +==== + +Each of the metrics mentioned previously contains a label for a specific workflow ID. For example, the `kogito_process_instance_completed_total` metric below contains the labels for `callbackstatetimeouts` workflow: + +.Example `kogito_process_instance_completed_total` metric +[source,yaml] +---- +# HELP kogito_process_instance_completed_total Completed Process Instances +# TYPE kogito_process_instance_completed_total counter +kogito_process_instance_completed_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",process_state="Completed",version="1.0.0-SNAPSHOT",} 3.0 +---- + +[NOTE] +==== +Internally, {product_name} uses Quarkus Micrometer extension, which also exposes built-in metrics. You can disable the Micrometer metrics in {product_name}. For more information, see link:https://quarkus.io/guides/micrometer[Quarkus - Micrometer Metrics]. +==== + +== Metrics Description +=== kogito_process_instance_completed_total +Workflow instances that have reached a terminal status, “Aborted” or “Completed”, and thus are considered as completed. + +[NOTE] +==== +These are the only two terminal status. The “Error” state is not terminal. +Additionally, the metric has the process_state="Completed", or could be "Aborted", to register exactly which of the two terminal status were reached. +==== + +[source, yaml] +---- +# HELP kogito_process_instance_completed_total Completed Process Instances +# TYPE kogito_process_instance_completed_total counter +kogito_process_instance_completed_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",process_state="Completed",version="1.0.0-SNAPSHOT",} 3.0 +---- + +=== kogito_process_instance_started_total +Count the number of started workflow instances. + +[source, yaml] +---- +# HELP kogito_process_instance_started_total Started Process Instances +# TYPE kogito_process_instance_started_total counter +kogito_process_instance_started_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",version="1.0.0-SNAPSHOT",} 7.0 +---- + +=== kogito_process_instance_running_total +Records the number of running workflow instances. + +[NOTE] +==== +This includes workflow instances that are in the "Error" state, since the error state is not a terminal state. +Process instances that have reached a terminal status, i.e. "Completed" or "Aborted", are not present in this metric. Review Comment: ```suggestion Process instances that have reached a terminal status, i.e. `Completed` or `Aborted`, are not present in this metric. ``` ########## serverlessworkflow/modules/ROOT/pages/_common-content/sonataflow-metrics.adoc: ########## @@ -0,0 +1,134 @@ +== Overview + +In {product_name}, you can check the following metrics: + +* `kogito_process_instance_started_total`: Number of started workflows (a workflow that has started might be running or completed) +* `kogito_process_instance_running_total`: Number of running workflows +* `kogito_process_instance_completed_total`: Number of completed workflows +* `kogito_process_instance_error`: Number of workflows that report an error ( a workflow with an error might be still running or have been completed) +* `kogito_process_instance_duration_seconds`: Duration of a process instance in seconds +* `kogito_node_instance_duration_milliseconds`: Duration of relevant nodes in milliseconds (a workflow is composed by nodes, user might be interested on the time consumed by an specific node type) +* `sonataflow_input_parameters_counter`: Records input parameters, the occurrences of <"param_name","param_value"> per `processId`. + +[NOTE] +==== +Internally, workflows are referred as processes. Therefore, the `processId` and `processName` is workflow ID and name respectively. +==== + +Each of the metrics mentioned previously contains a label for a specific workflow ID. For example, the `kogito_process_instance_completed_total` metric below contains the labels for `callbackstatetimeouts` workflow: + +.Example `kogito_process_instance_completed_total` metric +[source,yaml] +---- +# HELP kogito_process_instance_completed_total Completed Process Instances +# TYPE kogito_process_instance_completed_total counter +kogito_process_instance_completed_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",process_state="Completed",version="1.0.0-SNAPSHOT",} 3.0 +---- + +[NOTE] +==== +Internally, {product_name} uses Quarkus Micrometer extension, which also exposes built-in metrics. You can disable the Micrometer metrics in {product_name}. For more information, see link:https://quarkus.io/guides/micrometer[Quarkus - Micrometer Metrics]. +==== + +== Metrics Description +=== kogito_process_instance_completed_total +Workflow instances that have reached a terminal status, “Aborted” or “Completed”, and thus are considered as completed. + +[NOTE] +==== +These are the only two terminal status. The “Error” state is not terminal. +Additionally, the metric has the process_state="Completed", or could be "Aborted", to register exactly which of the two terminal status were reached. +==== + +[source, yaml] +---- +# HELP kogito_process_instance_completed_total Completed Process Instances +# TYPE kogito_process_instance_completed_total counter +kogito_process_instance_completed_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",process_state="Completed",version="1.0.0-SNAPSHOT",} 3.0 +---- + +=== kogito_process_instance_started_total +Count the number of started workflow instances. + +[source, yaml] +---- +# HELP kogito_process_instance_started_total Started Process Instances +# TYPE kogito_process_instance_started_total counter +kogito_process_instance_started_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",version="1.0.0-SNAPSHOT",} 7.0 +---- + +=== kogito_process_instance_running_total +Records the number of running workflow instances. + +[NOTE] +==== +This includes workflow instances that are in the "Error" state, since the error state is not a terminal state. +Process instances that have reached a terminal status, i.e. "Completed" or "Aborted", are not present in this metric. +==== + +[source, yaml] +---- +# HELP kogito_process_instance_running_total Running Process Instances +# TYPE kogito_process_instance_running_total gauge +kogito_process_instance_running_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",version="1.0.0-SNAPSHOT",} 4.0 +---- + +=== kogito_process_instance_duration_seconds +Calculates duration of a workflow instance that has reached a terminal state,, i.e. "Aborted" or "Completed". This metric is registered when the process reaches the terminal state. Review Comment: ```suggestion Calculates duration of a workflow instance that has reached a terminal state, i.e. `Aborted` or `Completed`. This metric is registered when the process reaches the terminal state. ``` ########## serverlessworkflow/modules/ROOT/pages/_common-content/sonataflow-metrics.adoc: ########## @@ -0,0 +1,134 @@ +== Overview + +In {product_name}, you can check the following metrics: + +* `kogito_process_instance_started_total`: Number of started workflows (a workflow that has started might be running or completed) +* `kogito_process_instance_running_total`: Number of running workflows +* `kogito_process_instance_completed_total`: Number of completed workflows +* `kogito_process_instance_error`: Number of workflows that report an error ( a workflow with an error might be still running or have been completed) +* `kogito_process_instance_duration_seconds`: Duration of a process instance in seconds +* `kogito_node_instance_duration_milliseconds`: Duration of relevant nodes in milliseconds (a workflow is composed by nodes, user might be interested on the time consumed by an specific node type) +* `sonataflow_input_parameters_counter`: Records input parameters, the occurrences of <"param_name","param_value"> per `processId`. + +[NOTE] +==== +Internally, workflows are referred as processes. Therefore, the `processId` and `processName` is workflow ID and name respectively. +==== + +Each of the metrics mentioned previously contains a label for a specific workflow ID. For example, the `kogito_process_instance_completed_total` metric below contains the labels for `callbackstatetimeouts` workflow: + +.Example `kogito_process_instance_completed_total` metric +[source,yaml] +---- +# HELP kogito_process_instance_completed_total Completed Process Instances +# TYPE kogito_process_instance_completed_total counter +kogito_process_instance_completed_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",process_state="Completed",version="1.0.0-SNAPSHOT",} 3.0 +---- + +[NOTE] +==== +Internally, {product_name} uses Quarkus Micrometer extension, which also exposes built-in metrics. You can disable the Micrometer metrics in {product_name}. For more information, see link:https://quarkus.io/guides/micrometer[Quarkus - Micrometer Metrics]. +==== + +== Metrics Description +=== kogito_process_instance_completed_total +Workflow instances that have reached a terminal status, “Aborted” or “Completed”, and thus are considered as completed. + +[NOTE] +==== +These are the only two terminal status. The “Error” state is not terminal. Review Comment: ```suggestion These are the only two terminal status. The `Error` state is not terminal. ``` ########## serverlessworkflow/modules/ROOT/pages/cloud/operator/monitoring-workflows.adoc: ########## @@ -0,0 +1,332 @@ += Monitoring Workflows +:compat-mode!: +// Metadata: +:description: Workflows monitoring configuration configuration Review Comment: ```suggestion :description: Workflows monitoring configuration ########## serverlessworkflow/modules/ROOT/pages/_common-content/sonataflow-metrics.adoc: ########## @@ -0,0 +1,134 @@ +== Overview + +In {product_name}, you can check the following metrics: + +* `kogito_process_instance_started_total`: Number of started workflows (a workflow that has started might be running or completed) +* `kogito_process_instance_running_total`: Number of running workflows +* `kogito_process_instance_completed_total`: Number of completed workflows +* `kogito_process_instance_error`: Number of workflows that report an error ( a workflow with an error might be still running or have been completed) +* `kogito_process_instance_duration_seconds`: Duration of a process instance in seconds +* `kogito_node_instance_duration_milliseconds`: Duration of relevant nodes in milliseconds (a workflow is composed by nodes, user might be interested on the time consumed by an specific node type) +* `sonataflow_input_parameters_counter`: Records input parameters, the occurrences of <"param_name","param_value"> per `processId`. + +[NOTE] +==== +Internally, workflows are referred as processes. Therefore, the `processId` and `processName` is workflow ID and name respectively. +==== + +Each of the metrics mentioned previously contains a label for a specific workflow ID. For example, the `kogito_process_instance_completed_total` metric below contains the labels for `callbackstatetimeouts` workflow: + +.Example `kogito_process_instance_completed_total` metric +[source,yaml] +---- +# HELP kogito_process_instance_completed_total Completed Process Instances +# TYPE kogito_process_instance_completed_total counter +kogito_process_instance_completed_total{app_id="sonataflow-process-monitoring-listener",artifactId="serverless-workflow-project",process_id="callbackstatetimeouts",process_state="Completed",version="1.0.0-SNAPSHOT",} 3.0 +---- + +[NOTE] +==== +Internally, {product_name} uses Quarkus Micrometer extension, which also exposes built-in metrics. You can disable the Micrometer metrics in {product_name}. For more information, see link:https://quarkus.io/guides/micrometer[Quarkus - Micrometer Metrics]. +==== + +== Metrics Description +=== kogito_process_instance_completed_total +Workflow instances that have reached a terminal status, “Aborted” or “Completed”, and thus are considered as completed. Review Comment: ```suggestion Workflow instances that have reached a terminal status, `Aborted` or `Completed`, and thus are considered as completed. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
