You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ignite.apache.org by GitBox <gi...@apache.org> on 2021/01/07 20:44:17 UTC
[GitHub] [ignite] dmagda commented on a change in pull request #8630: Docs for metric, system view, system properties commands
dmagda commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r553572548
##########
File path: docs/_docs/starting-nodes.adoc
##########
@@ -213,6 +213,28 @@ You can also pass JVM options by using the `-J` prefix:
----
./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
----
+
+== Ignite Internal Settings
+Ignite provide more then hundred internal flags to tweak som apects of the node behavior.
Review comment:
Please use this desctipion:
_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:_
##########
File path: docs/_docs/starting-nodes.adoc
##########
@@ -213,6 +213,28 @@ You can also pass JVM options by using the `-J` prefix:
----
./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
----
+
+== Ignite Internal Settings
Review comment:
Could you please do the following?
- Rename this section to "== Setting Ignite System Properties" and move to the following page (https://ignite.apache.org/docs/latest/setup). Put it after the "Enabling Modules" section.
- Please also move the entire "== Setting JVM Options" section to the same setup page mentioned above.
##########
File path: docs/_docs/starting-nodes.adoc
##########
@@ -213,6 +213,28 @@ You can also pass JVM options by using the `-J` prefix:
----
./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
----
+
+== Ignite Internal Settings
+Ignite provide more then hundred internal flags to tweak som apects of the node behavior.
+You can see all flags, their descriptions and default values with the following command:
+
+[source, shell]
+----
+./ignite.sh -systemProps
Review comment:
Please add a tab for Windows.
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -646,4 +646,136 @@ control.bat --change-tag _<new-tag>_
----
--
+== Metric command
+Metrics command prints value(s) of the metric or metric registry from the parameter.
+
+If you need to get metric from the specific node, please, set the `--node-id` parameter.
+Without `--node-id` random node will be used.
+
+[tabs]
+--
+tab:Linux[]
+[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]
+$ ./bin/control.sh --metric sysCurrentThreadCpuTime
Review comment:
Remove the command row from the output here and similar places below. Let's follow the same format you (we) have already used for other control script commands documented earlier.
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -646,4 +646,136 @@ control.bat --change-tag _<new-tag>_
----
--
+== Metric command
+Metrics command prints value(s) of the metric or metric registry from the parameter.
+
+If you need to get metric from the specific node, please, set the `--node-id` parameter.
+Without `--node-id` random node will be used.
+
+[tabs]
+--
+tab:Linux[]
+[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]
+$ ./bin/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]
+$ ./bin/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
Review comment:
"== System View Command"
All the first letters must be written in the upper-case.
##########
File path: docs/_docs/starting-nodes.adoc
##########
@@ -213,6 +213,28 @@ You can also pass JVM options by using the `-J` prefix:
----
./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
----
+
+== Ignite Internal Settings
+Ignite provide more then hundred internal flags to tweak som apects of the node behavior.
+You can see all flags, their descriptions and default values with the following command:
+
+[source, shell]
+----
+./ignite.sh -systemProps
+----
+
+Example of the output:
+
+[source, text]
+$ ./bin/ignite.sh -systemProps
+IGNITE_AFFINITY_HISTORY_SIZE - [Integer] Maximum size for affinity assignment history. Default is 25.
Review comment:
Please put digits, constant names or bool values into `value` brackets so that it's highlighted with a special style. For instance, in this row you should change 25 to `25`. Do for all similar places.
##########
File path: docs/_docs/starting-nodes.adoc
##########
@@ -213,6 +213,28 @@ You can also pass JVM options by using the `-J` prefix:
----
./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
----
+
+== Ignite Internal Settings
+Ignite provide more then hundred internal flags to tweak som apects of the node behavior.
+You can see all flags, their descriptions and default values with the following command:
+
+[source, shell]
+----
+./ignite.sh -systemProps
+----
+
+Example of the output:
+
+[source, text]
+$ ./bin/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 execute DML operation (MERGE|INSERT|UPDATE|DELETE) within transaction for non MVCC mode. Default is false.
Review comment:
Please update with
When set to `true`, Ignite will allow executing DML operation (`MERGE`|`INSERT`|`UPDATE`|`DELETE`) within transactions for the non-MVCC mode. Default is `false`.
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -646,4 +646,136 @@ control.bat --change-tag _<new-tag>_
----
--
+== Metric command
Review comment:
"Metric**s** Command"
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -646,4 +646,136 @@ control.bat --change-tag _<new-tag>_
----
--
+== Metric command
+Metrics command prints value(s) of the metric or metric registry from the parameter.
+
+If you need to get metric from the specific node, please, set the `--node-id` parameter.
+Without `--node-id` random node will be used.
+
+[tabs]
+--
+tab:Linux[]
Review comment:
Could you do me a favor by replacing "Linux" with "Unix" for all the tabs on this page? That's my oversight. We need to use "Unix" since the commands are relevant for MacOS, Linux and other Unix-distributions.
##########
File path: docs/_docs/starting-nodes.adoc
##########
@@ -213,6 +213,28 @@ You can also pass JVM options by using the `-J` prefix:
----
./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false
----
+
+== Ignite Internal Settings
+Ignite provide more then hundred internal flags to tweak som apects of the node behavior.
+You can see all flags, their descriptions and default values with the following command:
+
+[source, shell]
+----
+./ignite.sh -systemProps
+----
+
+Example of the output:
+
+[source, text]
+$ ./bin/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 execute DML operation (MERGE|INSERT|UPDATE|DELETE) within transaction for non MVCC mode. Default is false.
+IGNITE_ALLOW_START_CACHES_IN_PARALLEL - [Boolean] Enables start caches in parallel. Default is true.
Review comment:
Say "Allows to start multiple caches in parallel. Default is `true`."
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -646,4 +646,136 @@ control.bat --change-tag _<new-tag>_
----
--
+== Metric command
+Metrics command prints value(s) of the metric or metric registry from the parameter.
+
+If you need to get metric from the specific node, please, set the `--node-id` parameter.
+Without `--node-id` random node will be used.
+
+[tabs]
+--
+tab:Linux[]
+[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]
+$ ./bin/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]
+$ ./bin/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
+
+System view command prints content of the system view from the parameter.
Review comment:
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.
##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -646,4 +646,136 @@ control.bat --change-tag _<new-tag>_
----
--
+== Metric command
+Metrics command prints value(s) of the metric or metric registry from the parameter.
Review comment:
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.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org