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 2020/12/30 11:45:11 UTC

[GitHub] [ignite] nizhikov opened a new pull request #8630: Docs for metric, system view, system properties commands

nizhikov opened a new pull request #8630:
URL: https://github.com/apache/ignite/pull/8630


   * control.sh metric command.
   * control.sh system view command.
   * ignite.sh system properties command
   
   ### The Contribution Checklist
   - [ ] There is a single JIRA ticket related to the pull request. 
   - [ ] The web-link to the pull request is attached to the JIRA ticket.
   - [ ] The JIRA ticket has the _Patch Available_ state.
   - [ ] The pull request body describes changes that have been made. 
   The description explains _WHAT_ and _WHY_ was made instead of _HOW_.
   - [ ] The pull request title is treated as the final commit message. 
   The following pattern must be used: `IGNITE-XXXX Change summary` where `XXXX` - number of JIRA issue.
   - [ ] A reviewer has been mentioned through the JIRA comments 
   (see [the Maintainers list](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute#HowtoContribute-ReviewProcessandMaintainers)) 
   - [ ] The pull request has been checked by the Teamcity Bot and 
   the `green visa` attached to the JIRA ticket (see [TC.Bot: Check PR](https://mtcga.gridgain.com/prs.html))
   
   ### Notes
   - [How to Contribute](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute)
   - [Coding abbreviation rules](https://cwiki.apache.org/confluence/display/IGNITE/Abbreviation+Rules)
   - [Coding Guidelines](https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines)
   - [Apache Ignite Teamcity Bot](https://cwiki.apache.org/confluence/display/IGNITE/Apache+Ignite+Teamcity+Bot)
   
   If you need any help, please email dev@ignite.apache.org or ask anу advice on http://asf.slack.com _#ignite_ channel.
   


----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov merged pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov merged pull request #8630:
URL: https://github.com/apache/ignite/pull/8630


   


----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r554922453



##########
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:
       Done.




----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#issuecomment-753881169


   Helo, @dmagda 
   
   Can you, please, take a look at my changes?


----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r554924199



##########
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:
       Fixed. Thanks!




----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r555285218



##########
File path: docs/_docs/setup.adoc
##########
@@ -278,6 +278,49 @@ 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:
+
+[source, shell]
+----
+./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false

Review comment:
       done

##########
File path: docs/_docs/setup.adoc
##########
@@ -278,6 +278,49 @@ 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:
+
+[source, shell]
+----
+./ignite.sh -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:
+
+[source, shell]
+----
+./ignite.sh -systemProps

Review comment:
       done.




----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r554921457



##########
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:
       Fixed. Thanks!




----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r554921052



##########
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:
       But this is just an example of console output.
   There is no formatting in the console.




----------------------------------------------------------------
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



[GitHub] [ignite] dmagda commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
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



[GitHub] [ignite] nizhikov commented on pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#issuecomment-752461035


   Hello, @Mmuzaf 
   
   Can you, please, take a look at my changes?


----------------------------------------------------------------
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



[GitHub] [ignite] Mmuzaf commented on pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
Mmuzaf commented on pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#issuecomment-759646873


   @nizhikov 
   
   Thank you. I've cherry-picked this commit to the ignite-2.10 branch.


----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r554926379



##########
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:
       Done.




----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r554926990



##########
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:
       Fixed. Thanks!




----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#issuecomment-758171737


   Merged to the master.
   
   @dmagda Thanks for the review!
   


----------------------------------------------------------------
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



[GitHub] [ignite] dmagda commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
dmagda commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r555213699



##########
File path: docs/_docs/setup.adoc
##########
@@ -278,6 +278,49 @@ 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:
+
+[source, shell]
+----
+./ignite.sh -J-Xmx6G -J-DIGNITE_TO_STRING_INCLUDE_SENSITIVE=false

Review comment:
       Could you add two tabs here for Unix and Windows respectively? The latter will run the same command but using "ignite.bat"

##########
File path: docs/_docs/setup.adoc
##########
@@ -278,6 +278,49 @@ 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:
+
+[source, shell]
+----
+./ignite.sh -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:
+
+[source, shell]
+----
+./ignite.sh -systemProps

Review comment:
       Could you add two tabs here for Unix and Windows respectively? The latter will run the same command but using "ignite.bat"




----------------------------------------------------------------
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



[GitHub] [ignite] nizhikov commented on a change in pull request #8630: Docs for metric, system view, system properties commands

Posted by GitBox <gi...@apache.org>.
nizhikov commented on a change in pull request #8630:
URL: https://github.com/apache/ignite/pull/8630#discussion_r554932000



##########
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:
       We don't have windows examples for other commands on this page.
   I think we should keep it as is.




----------------------------------------------------------------
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