You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by ni...@apache.org on 2021/01/11 19:28:14 UTC
[ignite] branch master updated: ignite docs: metric, system view,
system properties commands (#8630)
This is an automated email from the ASF dual-hosted git repository.
nizhikov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 358e145 ignite docs: metric, system view, system properties commands (#8630)
358e145 is described below
commit 358e1456640c2fe0c0005f18e6068df964ebc2b5
Author: Nikolay <ni...@apache.org>
AuthorDate: Mon Jan 11 22:27:46 2021 +0300
ignite docs: metric, system view, system properties commands (#8630)
---
docs/_docs/setup.adoc | 61 ++++++++
docs/_docs/starting-nodes.adoc | 23 ---
docs/_docs/tools/control-script.adoc | 156 +++++++++++++++++++--
.../org/apache/ignite/IgniteSystemProperties.java | 6 +-
4 files changed, 205 insertions(+), 41 deletions(-)
diff --git a/docs/_docs/setup.adoc b/docs/_docs/setup.adoc
index f6eb990..603934b 100644
--- a/docs/_docs/setup.adoc
+++ b/docs/_docs/setup.adoc
@@ -278,6 +278,67 @@ directory to discover other Ignite nodes.
|=======================================================================
+== Setting JVM Options
+
+There are several ways you can set JVM options when starting a node with the `ignite.sh` script.
+These ways are described in the following sections.
+
+=== JVM_OPTS System Variable
+
+You can set the `JVM_OPTS` environment variable:
+
+[source, shell]
+----
+export JVM_OPTS="$JVM_OPTS -Xmx6G -DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false"; $IGNITE_HOME/bin/ignite.sh
+----
+
+=== Command Line Arguments
+
+You can also pass JVM options by using the `-J` prefix:
+
+[tabs]
+--
+tab:Unix[]
+[source, shell]
+----
+./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
+----
+tab:Windows[]
+[source, shell]
+----
+.\ignite.bat -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
+----
+--
+
+== Setting Ignite System Properties
+
+In addition to public configuration settings, you can adjust specific, usually low-level, Ignite behavior with internal system properties. You can find all the properties with their descriptions and default values by using the command below:
+
+[tabs]
+--
+tab:Unix[]
+[source, shell]
+----
+./ignite.sh -systemProps
+----
+tab:Windows[]
+[source, shell]
+----
+.\ignite.bat -systemProps
+----
+--
+
+Example of the output:
+
+[source, text]
+ignite.sh -systemProps
+IGNITE_AFFINITY_HISTORY_SIZE - [Integer] Maximum size for affinity assignment history. Default is 25.
+IGNITE_ALLOW_ATOMIC_OPS_IN_TX - [Boolean] Allows atomic operations inside transactions. Default is true.
+IGNITE_ALLOW_DML_INSIDE_TRANSACTION - [Boolean] When set to true, Ignite will allow executing DML operation (MERGE|INSERT|UPDATE|DELETE) within transactions for non MVCC mode. Default is false.
+IGNITE_ALLOW_START_CACHES_IN_PARALLEL - [Boolean] Allows to start multiple caches in parallel. Default is true.
+...
+
+
== Configuration Recommendations
Below are some recommended configuration tips aimed at making it easier for
diff --git a/docs/_docs/starting-nodes.adoc b/docs/_docs/starting-nodes.adoc
index 6e78fad..59f8c81 100644
--- a/docs/_docs/starting-nodes.adoc
+++ b/docs/_docs/starting-nodes.adoc
@@ -189,30 +189,7 @@ Alternatively, you can stop all the nodes non-gracefully (by sending `kill -9`).
However, the latter option is not recommended for clusters with persistence.
////
-== Setting JVM Options
-There are several ways you can set JVM options when starting a node with the `ignite.sh` script.
-These ways are described in the following sections.
-
-=== JVM_OPTS System Variable
-
-You can set the `JVM_OPTS` environment variable:
-
-[source, shell]
-----
-export JVM_OPTS="$JVM_OPTS -Xmx6G -DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false"; $IGNITE_HOME/bin/ignite.sh
-----
-
-
-
-=== Command Line Arguments
-
-You can also pass JVM options by using the `-J` prefix:
-
-[source, shell]
-----
-./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
-----
== Node Lifecycle Events
diff --git a/docs/_docs/tools/control-script.adoc b/docs/_docs/tools/control-script.adoc
index 9870577..e956848 100644
--- a/docs/_docs/tools/control-script.adoc
+++ b/docs/_docs/tools/control-script.adoc
@@ -22,7 +22,7 @@ The control script syntax is as follows:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source, shell]
----
control.sh <connection parameters> <command> <arguments>
@@ -76,7 +76,7 @@ To get the state of the cluster, run the following command:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --state
@@ -97,7 +97,7 @@ To activate the cluster, run the following command:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --set-state ACTIVE
@@ -117,7 +117,7 @@ To deactivate the cluster, run the following command:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --set-state INACTIVE [--yes]
@@ -137,7 +137,7 @@ To get the list of nodes registered in the baseline topology, run the following
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --baseline
@@ -183,7 +183,7 @@ After the node is added, the link:data-rebalancing[rebalancing process] starts.
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --baseline add _consistentId1,consistentId2,..._ [--yes]
@@ -203,7 +203,7 @@ This operation starts the rebalancing process, which re-distributes the data acr
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --baseline remove _consistentId1,consistentId2,..._ [--yes]
@@ -223,7 +223,7 @@ To set a list of node as the baseline topology, use the following command:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
@@ -241,7 +241,7 @@ To restore a specific version of the baseline topology, use the following comman
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --baseline version _topologyVersion_ [--yes]
@@ -263,7 +263,7 @@ To enable it, use the following command:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source, shell]
----
@@ -283,7 +283,7 @@ To disable baseline autoadjustment, use the following command:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source, shell]
----
@@ -305,7 +305,7 @@ You can also cancel specific transactions.
The following command returns a list of transactions that satisfy a given filter (or all transactions if no filter is provided):
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --tx _<transaction filter>_ --info
@@ -337,7 +337,7 @@ To cancel transactions, use the following command:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --tx _<transaction filter>_ --kill
@@ -603,7 +603,7 @@ To view the cluster ID, run the `--state` command:
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --state
@@ -634,7 +634,7 @@ To change the tag, use the following command (the tag must contain no more than
[tabs]
--
-tab:Linux[]
+tab:Unix[]
[source,shell,subs="verbatim,quotes"]
----
control.sh --change-tag _<new-tag>_
@@ -646,4 +646,130 @@ control.bat --change-tag _<new-tag>_
----
--
+== Metric Command
+The metrics command prints out the value of a metric or metric registry provided in the parameters list. Use the `--node-id` parameter, If you need to get a metric from a specific node. Ignite selects a random node, if the `--node-id` is not set.
+
+[tabs]
+--
+tab:Unix[]
+[source,shell,subs="verbatim,quotes"]
+----
+control.sh --metric sys
+----
+tab:Windows[]
+[source,shell,subs="verbatim,quotes"]
+----
+control.bat --metric sys
+----
+--
+
+Example of the metric output:
+[source, text]
+control.sh --metric sysCurrentThreadCpuTime
+Command [METRIC] started
+Arguments: --metric sys
+--------------------------------------------------------------------------------
+metric value
+sys.CurrentThreadCpuTime 17270000
+Command [METRIC] finished with code: 0
+
+
+Example of the metric registry output:
+[source, text]
+control.sh --metric io.dataregion.default
+Command [METRIC] started
+Arguments: --metric sys
+--------------------------------------------------------------------------------
+metric value
+io.dataregion.default.TotalAllocatedSize 0
+io.dataregion.default.LargeEntriesPagesCount 0
+io.dataregion.default.PagesReplaced 0
+io.dataregion.default.PhysicalMemorySize 0
+io.dataregion.default.CheckpointBufferSize 0
+io.dataregion.default.PagesReplaceRate 0
+io.dataregion.default.InitialSize 268435456
+io.dataregion.default.PagesRead 0
+io.dataregion.default.AllocationRate 0
+io.dataregion.default.OffHeapSize 0
+io.dataregion.default.UsedCheckpointBufferSize 0
+io.dataregion.default.MaxSize 6871947673
+io.dataregion.default.OffheapUsedSize 0
+io.dataregion.default.EmptyDataPages 0
+io.dataregion.default.PagesFillFactor 0.0
+io.dataregion.default.DirtyPages 0
+io.dataregion.default.TotalThrottlingTime 0
+io.dataregion.default.EvictionRate 0
+io.dataregion.default.PagesWritten 0
+io.dataregion.default.TotalAllocatedPages 0
+io.dataregion.default.PagesReplaceAge 0
+io.dataregion.default.PhysicalMemoryPages 0
+Command [METRIC] finished with code: 0
+
+== System View Command
+
+The system view command prints out the content of a system view provided in the parameters list. Use the `--node-id` parameter, If you need to get a metric from a specific node. Ignite selects a random node, if the `--node-id` is not set.
+
+[tabs]
+--
+tab:Unix[]
+[source,shell,subs="verbatim,quotes"]
+----
+control.sh --system-view views
+----
+tab:Windows[]
+[source,shell,subs="verbatim,quotes"]
+----
+control.bat --system-view views
+----
+
+Examples of the output:
+
+[source, text]
+control.sh --system-view nodes
+Command [SYSTEM-VIEW] started
+Arguments: --system-view nodes
+--------------------------------------------------------------------------------
+nodeId consistentId version isClient isDaemon nodeOrder addresses hostnames isLocal
+a8a28869-cac6-4b17-946a-6f7f547b9f62 0:0:0:0:0:0:0:1%lo0,127.0.0.1,192.168.31.45:47500 2.10.0#20201230-sha1:00000000 false false 1 [0:0:0:0:0:0:0:1%lo0, 127.0.0.1, 192.168.31.45] [192.168.31.45] true
+d580433d-c621-45ff-a558-b4df82d09613 0:0:0:0:0:0:0:1%lo0,127.0.0.1,192.168.31.45:47501 2.10.0#20201230-sha1:00000000 false false 2 [0:0:0:0:0:0:0:1%lo0, 127.0.0.1, 192.168.31.45] [192.168.31.45] false
+Command [SYSTEM-VIEW] finished with code: 0
+
+
+[source, text]
+control.sh --system-view views
+Command [SYSTEM-VIEW] started
+Arguments: --system-view views
+--------------------------------------------------------------------------------
+name schema description
+NODES SYS Cluster nodes
+SQL_QUERIES_HISTORY SYS SQL queries history.
+INDEXES SYS SQL indexes
+BASELINE_NODES SYS Baseline topology nodes
+STRIPED_THREADPOOL_QUEUE SYS Striped thread pool task queue
+LOCAL_CACHE_GROUPS_IO SYS Local node IO statistics for cache groups
+SCAN_QUERIES SYS Scan queries
+CLIENT_CONNECTIONS SYS Client connections
+PARTITION_STATES SYS Distribution of cache group partitions across cluster nodes
+VIEW_COLUMNS SYS SQL view columns
+SQL_QUERIES SYS Running SQL queries.
+CACHE_GROUP_PAGE_LISTS SYS Cache group page lists
+METRICS SYS Ignite metrics
+CONTINUOUS_QUERIES SYS Continuous queries
+TABLE_COLUMNS SYS SQL table columns
+TABLES SYS SQL tables
+DISTRIBUTED_METASTORAGE SYS Distributed metastorage data
+SERVICES SYS Services
+DATASTREAM_THREADPOOL_QUEUE SYS Datastream thread pool task queue
+NODE_METRICS SYS Node metrics
+BINARY_METADATA SYS Binary metadata
+JOBS SYS Running compute jobs, part of compute task started on remote host.
+SCHEMAS SYS SQL schemas
+CACHE_GROUPS SYS Cache groups
+VIEWS SYS SQL views
+DATA_REGION_PAGE_LISTS SYS Data region page lists
+NODE_ATTRIBUTES SYS Node attributes
+TRANSACTIONS SYS Running transactions
+CACHES SYS Caches
+TASKS SYS Running compute tasks
+Command [SYSTEM-VIEW] finished with code: 0
diff --git a/modules/core/src/main/java/org/apache/ignite/IgniteSystemProperties.java b/modules/core/src/main/java/org/apache/ignite/IgniteSystemProperties.java
index 94f1536..19bd2e7 100644
--- a/modules/core/src/main/java/org/apache/ignite/IgniteSystemProperties.java
+++ b/modules/core/src/main/java/org/apache/ignite/IgniteSystemProperties.java
@@ -1526,8 +1526,8 @@ public final class IgniteSystemProperties {
*
* Default is {@code false}.
*/
- @SystemProperty("When set to true, Ignite will allow execute DML operation " +
- "(MERGE|INSERT|UPDATE|DELETE) within transaction for non MVCC mode")
+ @SystemProperty("When set to true, Ignite will allow executing DML operation " +
+ "(MERGE|INSERT|UPDATE|DELETE) within transactions for non MVCC mode")
public static final String IGNITE_ALLOW_DML_INSIDE_TRANSACTION = "IGNITE_ALLOW_DML_INSIDE_TRANSACTION";
/**
@@ -1596,7 +1596,7 @@ public final class IgniteSystemProperties {
*
* Default is {@code true}.
*/
- @SystemProperty(value = "Enables start caches in parallel",
+ @SystemProperty(value = "Allows to start multiple caches in parallel",
defaults = "" + DFLT_ALLOW_START_CACHES_IN_PARALLEL)
public static final String IGNITE_ALLOW_START_CACHES_IN_PARALLEL = "IGNITE_ALLOW_START_CACHES_IN_PARALLEL";