You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kie.apache.org by wm...@apache.org on 2024/11/21 11:00:36 UTC
(incubator-kie-kogito-docs) branch main updated: [Fix #687] Updating metrics doc (#688)
This is an automated email from the ASF dual-hosted git repository.
wmedvedeo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-kie-kogito-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 356e5754a [Fix #687] Updating metrics doc (#688)
356e5754a is described below
commit 356e5754ac8860c824f6f209bee07dca09719a48
Author: Francisco Javier Tirado Sarti <65...@users.noreply.github.com>
AuthorDate: Thu Nov 21 12:00:33 2024 +0100
[Fix #687] Updating metrics doc (#688)
Fix https://github.com/apache/incubator-kie-kogito-docs/issues/687
---
.../integrations/expose-metrics-to-prometheus.adoc | 27 +++++++++++++++++-----
1 file changed, 21 insertions(+), 6 deletions(-)
diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc
index 915dd318e..ee6ce25d5 100644
--- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc
+++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc
@@ -145,14 +145,29 @@ For more information, see <<proc-enable-metrics-sw, Enabling metrics in {product
For more information about configuring Prometheus, see link:{prometheus_operator_getting_started_guide}[Configure Prometheus to monitor the sample targets] in Prometheus Getting Started document.
[[ref-sw-example-metrics]]
-== Example metrics in {product_name}
+== Metrics in {product_name}
-In {product_name}, you can check the following example metrics:
+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)
+
+Optionally, if you include dependency
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.kie</groupId>
+ <artifactId>kie-addons-quarkus-monitoring-sonataflow</artifactId>
+</dependency>
+----
+
+metric `sonataflow_input_parameters_counter`, which tracks input parameter, will be available. This metric is optional because it counts every workflow input parameter key value combination, which might be space consuming.
-* `kogito_process_instance_completed_total`: Completed workflows
-* `kogito_process_instance_started_total`: Started workflows
-* `kogito_process_instance_running_total`: Running workflows
-* `kogito_process_instance_duration_seconds_sum`: Workflows total duration
[NOTE]
====
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org