You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by na...@apache.org on 2021/07/02 09:23:43 UTC
[ignite] branch ignite-2.11 updated: IGNITE-15049 Add documentation
for the performance statistics Control script commands. (#9218)
This is an automated email from the ASF dual-hosted git repository.
namelchev pushed a commit to branch ignite-2.11
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/ignite-2.11 by this push:
new 842ccd8 IGNITE-15049 Add documentation for the performance statistics Control script commands. (#9218)
842ccd8 is described below
commit 842ccd82625380793e81a7c4e624039d55228b25
Author: Sergei Ryzhov <s....@gmail.com>
AuthorDate: Fri Jul 2 12:18:41 2021 +0300
IGNITE-15049 Add documentation for the performance statistics Control script commands. (#9218)
(cherry picked from commit c5ebdc9e30000f742fcaab896df66af26dc8c40b)
---
.../monitoring-metrics/performance-statistics.adoc | 36 ++++++++++++++++++++--
docs/_docs/tools/control-script.adoc | 34 ++++++++++++++++++++
2 files changed, 68 insertions(+), 2 deletions(-)
diff --git a/docs/_docs/monitoring-metrics/performance-statistics.adoc b/docs/_docs/monitoring-metrics/performance-statistics.adoc
index a64696f..eb98ba9 100644
--- a/docs/_docs/monitoring-metrics/performance-statistics.adoc
+++ b/docs/_docs/monitoring-metrics/performance-statistics.adoc
@@ -25,7 +25,7 @@ link:#building-the-report[build] the performance report.
== Collecting Statistics
-link:#jmx[JMX interface] is used to start and stop statistics collecting.
+link:#jmx[JMX interface] and link:#control-script[Control Script] are used to start and stop statistics collecting.
Each node collects performance statistics in a binary file. This file is placed under
the `Ignite_work_directory/perf_stat/` directory. The name mask is `node-{nodeId}-{index}.prf`.
@@ -69,7 +69,7 @@ the report.
== Management
-The following section provides information on JMX interface and system properties.
+The following section provides information on JMX, Control Script and system properties.
=== JMX
@@ -80,9 +80,41 @@ You can manage the performance statistics collection via the `PerformanceStatist
|Method | Description
|start() | Start collecting performance statistics in the cluster.
|stop() | Stop collecting performance statistics in the cluster.
+|rotate() | Rotate collecting performance statistics in the cluster.
|started() | True if performance statistics collection is started.
|===
+
+=== Control Script
+
+You can manage the performance statistics collection via the link:tools/control-script[Control Script].
+
+[tabs]
+--
+tab:Unix[]
+[source,shell]
+----
+control.sh --performance-statistics [start|stop|rotate|status]
+----
+tab:Window[]
+[source,shell]
+----
+control.bat --performance-statistics [start|stop|rotate|status]
+----
+--
+
+Parameters:
+
+[cols="1,3",opts="header"]
+|===
+| Parameter | Description
+| `start`| Start collecting performance statistics in the cluster.
+| `stop`| Stop collecting performance statistics in the cluster.
+| `rotate`| Rotate collecting performance statistics in the cluster.
+| `status`| Get status of collecting performance statistics in the cluster.
+|===
+
+
=== System properties
[cols="2,1,1,3",opts="header"]
diff --git a/docs/_docs/tools/control-script.adoc b/docs/_docs/tools/control-script.adoc
index b8417ee..2e307a9 100644
--- a/docs/_docs/tools/control-script.adoc
+++ b/docs/_docs/tools/control-script.adoc
@@ -862,6 +862,8 @@ tab:Windows[]
----
control.bat --system-view views
----
+--
+
Examples of the output:
@@ -913,3 +915,35 @@ TRANSACTIONS SYS Running transactions
CACHES SYS Caches
TASKS SYS Running compute tasks
Command [SYSTEM-VIEW] finished with code: 0
+
+
+== Performance Statistics
+
+Ignite provides a built-in tool for cluster profiling. Read link:monitoring-metrics/performance-statistics[Performance Statistics] for more information.
+
+
+[tabs]
+--
+tab:Unix[]
+[source,shell]
+----
+control.sh --performance-statistics [start|stop|rotate|status]
+----
+tab:Window[]
+[source,shell]
+----
+control.bat --performance-statistics [start|stop|rotate|status]
+----
+--
+
+Parameters:
+
+[cols="1,3",opts="header"]
+|===
+| Parameter | Description
+| `start`| Start collecting performance statistics in the cluster.
+| `stop`| Stop collecting performance statistics in the cluster.
+| `rotate`| Rotate collecting performance statistics in the cluster.
+| `status`| Get status of collecting performance statistics in the cluster.
+|===
+