PATROL Agent configuration variables
The following table provides PATROL for Hadoop variable settings.
PATROL for Hadoop variables
Directory path and variable | Description |
---|---|
/BTQ/HADOOP | |
/EnvList | Each hadoop environment name you add should be on this list, \n is the separator |
/BTQ/HADOOP/<<environment name>> | |
/healthMonitoring | Type of monitoring:
|
/monitoredGroupIdList | The numbers of monitored groups separated by ',' separator, for example if you insert number 1,2 means you want to monitor only HADOOP groups 1 and 2, each group number exist in its own xml file under Patrol3/btq/xml |
/jvmArgs (optional) | JVM arguments for the Java collector |
/disableInstance (optional) | This will disable the creation of the instance on the PATROL tree view Valid values: True or 1, False or 0 |
/BPPMI2D (optional) | When this variable is set to zero, it will disable the creation of the instance on the PATROL tree view Valid values: True or 1, False or 0 |
/diagReport (optional) | This variable will generate diagnostic report for support, value 1 will generate diagnostic report Valid values: True or 1, False or 0 |
/Logging | This variable will enable or disable PSL and Java logging Valid values: Enable = 1, Disable = 0 |
/i18n/lang | This variable sets the locale of Hadoop environment. The locale of Hadoop environment must be declared as <language>_<country> for example en_US. If you do not insert this pconfig variable then the current locale of the Java collector will be used. If you do not succeed in retrieving the current locale from Java then the default locale, en_US, will be used. |
/javaHome | The Java home that will be used to run the java collector. The Java Runtime Environment (JRE) version must be 1.7 and later. |
/isOSCredentialsChanged | This variable indicates the change in the operating system credentials Valid values: 1-indicates that the OS credentials are changed 0-indicates that there is no change to the OS credentials |
/vendor | This variable indicates the Hadoop vendor order. The variable should be set to the number of the vendor. Valid vendor values:
|
/host | This variable indicates the name of the Hadoop host |
/port | This variable indicates the Hadoop port. The port can be NameNode, SecondaryNameNode, ResourceManager, DataNode, JobHistory, NodeManager, JobTracker or TaskTracker port. |
/isHadoopCredentialsChanged | This variable indicates a change in the Hadoop credentials Valid values: 1 - Indicate that the Hadoop credentials are changed 0 - Indicates that there is no change to the Hadoop credentials |
/isSecure | This variable indicates the type of protocol used to connect to the Hadoop environment. Valid values: 0 - Indicates connection to Hadoop with a NON secure mode (HTTP protocol) 1 - Indicates connection to Hadoop with a secure mode (HTTPS protocol) |
/trustStore | This is the SSL trust store file. For example: C:\\sec\\truststore.jks Enter this value only when the isSecure pconfig variable is set to 1 (HTTPS protocol) |
/isTrustStorePasswordChanged | This variable indicates if the change in the SSL trust store password Valid values: 1- Indicates that the SSL trust store password is changed 0- Indicates that there is no change to the SSL trust store password |
/includedDataNodes | This variable will contain a comma-separated list of regular expressions, host names and IP addresses of the data nodes that will be included for monitoring. The regular-expression conforms to the regular expressions defined by Java. |
/excludedDataNodes | This variable will contain a comma-separated list of regular expressions, host names and IP addresses of the data nodes that will not be included for monitoring. The regular-expression conforms to the regular expressions defined by Java. If the /includedDataNodes pconfig variable is defined, the /excludedDataNodes variable will not be available. |
/includedNodeManagers | This variable will contain a comma-separated list of regular expressions, host names and IP addresses of the node managers that will be included for monitoring. The regular-expression conforms to the regular expressions defined by Java. If you have task trackers in your environment, this variable will be used to filter task trackers. |
/excludedNodeManagers | This variable will contain a comma-separated list of regular expressions, host names and IP addresses of the data nodes that will not be included for monitoring. The regular-expression conforms to the regular expressions defined by Java. If the /includedNodeManagers pconfig variable is defined, the /excludedNodeManagers variable will not be available. If you have task trackers in your environment, this variable will be used to filter task trackers. |
/BTQ/HADOOP/<<environment name>>/collectors | |
/<<Collector Name>>/Cycle | Set this collector value in seconds. The Hadoop collector cycle, for each collector exists in $PATROL_HOME/Patrol3/btq/collectors/collectors.xml You can change the collector cycle. Once the pconfig variable cycle is defined, the KM will use the defined cycle instead of the default cycle in the XML. The cache cycle will be equal to the received collector's cycle. |
/isCollectorsCachingEnable | If this variable is set to True or 1, the collectors output will be added to the cache thread. The cache thread will be responsible for sending data to PATROL Agent if the collector fails to collect data. The cache thread will display old values of the parameters for a specific period of time before it stops sending values to PATROL Agent. When this variable is set to False or 0, the collector will send the output directly to PATROL Agent, without any caching. This variable is also defined in the $PATROL_HOME/Patrol3/btq/conf/btq.properties file. Default value: True |
SecureStore/HADOOP_MAIN/HADOOP/<<environment name>> | |
/OSCredentials | HADOOP_SETUP;HADOOP_MAIN;HADOOP_ENVIRONMENT/<<The local username required to run the java collector>>/<<The local user password>> |
/HadoopCredentials | HADOOP_SETUP, HADOOP_MAIN, HADOOP_ENVIRONMENT/<<The hadoop username>>/<<The hadoop user password>> |
/TrustStorePassword | HADOOP_SETUP, HADOOP_MAIN, HADOOP_ENVIRONMENT/<<The SSL trust store password>> |