A OCLUMON Command Reference
Use the command-line tool to query the Cluster Health Monitor repository to display node-specific metrics for a specific time period.
Use OCLUMON to perform miscellaneous administrative tasks, such as changing the debug levels, querying the version of Cluster Health Monitor, and changing the metrics database size.
- oclumon analyze
Use theoclumon analyze
command to analyze CHM metrics. - oclumon dumpnodeview
Use theoclumon dumpnodeview
command to view log information from the system monitor service in the form of a node view. - oclumon chmdiag
Use theoclumon chmdiag
to get a detailed description of all the supported events and actions, query CHMDiag events/actions sent by various components and generate an HTML or a text report, and to collect all events/actions data generated by CHMDiag into the specified output directory location. - oclumon localrepo getconfig
Use theoclumon localrepo getconfig
to get the configuration of repositories for all the nodes. - oclumon version
Use theoclumon version
command to obtain the version of Cluster Health Monitor that you are using. - oclumon debug
Use theoclumon debug
command to set the log level for the Cluster Health Monitor services.
Parent topic: Appendixes
A.1 oclumon analyze
Use the oclumon analyze
command to analyze CHM metrics.
Syntax
oclumon analyze [-h] [-i CHM_METRICS_DIR] -o OUT_DIR [-l LOG_DIR] [--log_level {DEBUG,INFO,WARNING,ERROR}] [-s START_TIME] [-e END_TIME] [-f FORMAT] [--version]
Parameters
Table A-1 oclumon analyze Command Parameters
Parameter | Description |
---|---|
|
Specify the directory containing CHM metrics. |
|
Specify the output directory for the results. |
|
Specify the log directory. |
|
Specify the log level. |
|
Specify the start time for analysis in |
|
Specify the end time for analysis in |
|
Specify a comma-delimited report format ( |
|
Displays the program's version number and exits. |
Example A-1 oclumon analyze Examples
oclumon analyze -o /<outpur-dir>
oclumon analyze -o /<output-dir> -s 2024-03-14T05:00:00 -e 2024-03-14T05:15:00
oclumon analyze -o /<output-dir> -f html
oclumon analyze -i /<chm-data-dir> -o /<output-dir>
Example A-2 Sample CHM Analysis Report
CHM analysis report contains following sections:
- Header section: Contains info about the node, analysis time period, system configuration and system resource stats.
Figure A-1 System Configuration and System resource stats
- Observed findings and findings summary timeline section: Contains the list of observed problems, along with a summary timeline of the problems.
Figure A-2 Problematic findings and summary timeline
- Findings details section: Contains detailed contextual information for each of the problems observed above.
Figure A-3 Problematic findings - details
Parent topic: OCLUMON Command Reference
A.2 oclumon dumpnodeview
Use the oclumon dumpnodeview
command to view log information from the system monitor service in the form of a node view.
Syntax
oclumon dumpnodeview [[([(-system | -protocols | -v)] |
[(-cpu | -process | -procagg | -device | -nic | -filesystem | -thread | -nfs)
[-detail] [-all] [-pinned_only] [-sort <metric_name>] [-filter <string>] [-head <rows_count>] [-i <seconds>]])
[([-s <start_time> -e <end_time>] | -last <duration>)]] |
[-inputDataDir <absolute_path> -logDir <absolute_path>]
[-h]]
Parameters
Table A-2 oclumon dumpnodeview Command Parameters
Parameter | Description |
---|---|
|
Dumps system metrics. For example:
. |
|
Dumps CPU metrics. For example:
. |
|
Dumps process metrics. For example: .
|
|
Dumps process aggregate metrics. For example:
. |
|
Dumps disk metrics. For example:
. |
|
Dumps network interface metrics. For example:
. |
|
Dumps filesystem metrics. For example:
. |
|
Dumps thread metrics for pinned processes. For example:
|
|
Dumps NFS metrics. For example:
. |
|
Dumps network protocol metrics, cumulative values from system start. For example:
. |
|
Displays verbose node view output. For example:
. |
|
Displays the command-line help and exits. |
Table A-3 oclumon dumpnodeview Command Flags
Flag | Description |
---|---|
|
Use this option to dump detailed metrics. Applicable to the
For example:
. |
|
Use this option to dump the node views of all entries. Applicable to
the For example:
. |
|
Use this option to dump the node views of all pinned processes. Applicable to the For example:
|
|
Use this option to dump the node view of the specified number of
metrics rows in the result. Applicable to the For example:
. |
|
Use this option to sort based on the specified metric name, supported
with the For example:
. |
|
Display data separated by the specified interval in seconds. Must be a multiple of 5. Applicable to continuous mode query. For example:
|
|
Use this option to search for a filter string in the Name column of the respective metric. For example, Supported with the For example:
. |
|
All samples where filter doesn't matches will also show in the output. Can be used only with the For example:
|
Table A-4 oclumon dumpnodeview Command Log File Directories
Directory | Description |
---|---|
|
Specifies absolute path of the directory that contains JSON logs files. For example:
|
|
Specifies absolute path of the directory, which will contain the script run logs. For example:
|
Table A-5 oclumon dumpnodeview Command Historical Query Options
Flag | Description |
---|---|
|
Use the Specify time in the Specify these two options together to obtain a range. For example:
|
|
Use this option to specify a time, given in
Specifying " For example:
. |
Parent topic: OCLUMON Command Reference
A.3 oclumon chmdiag
Use the oclumon chmdiag
to get a detailed description of all the supported events and actions, query CHMDiag events/actions sent by various components and generate an HTML or a text report, and to collect all events/actions data generated by CHMDiag into the specified output directory location.
Parent topic: OCLUMON Command Reference
A.4 oclumon localrepo getconfig
Use the oclumon localrepo getconfig
to get the configuration of repositories for all the nodes.
Syntax
oclumon localrepo getconfig [-reposize] [-repopath] [-retentiontime] [-local | -n <node1> ...]
Parameters
Parameter | Description |
---|---|
|
Gets the repository size in MB. |
|
Gets the repository path. |
|
Gets an estimation of local repository retention in time units based on the historical data of the currently configured repository size. |
|
Gets the configuration only for the local node. |
|
Gets the configuration for a desired list of nodes. |
Example A-3 To view full configuration of repositories for all nodes
oclumon localrepo getconfig
Node: <node-name1>
Repository size: 500 MB
Repository path: $ORACLE_HOME/crsdata/<node-name1>/crf/db/json
Repository retention time: 246 Hours
Node: <node-name2>
Repository size: 500 MB
Repository path: $ORACLE_HOME/crsdata/<node-name2>/crf/db/json
Repository retention time: 240 Hours
Example A-4 To view only the repository path and size of repositories in all nodes
oclumon localrepo getconfig -reposize -repopath
Node: <node-name1>
Repository size: 500 MB
Repository path: $ORACLE_HOME/crsdata/<node-name1>/crf/db/json
Node: <node-name2>
Repository size: 500 MB
Repository path: $ORACLE_HOME/crsdata/<node-name2>/crf/db/json
Example A-5 To view full configuration of the repository for the local node
oclumon localrepo getconfig -local
Node: <node-name>
Repository size: 500 MB
Repository path: $ORACLE_HOME/crsdata/<node-name>/crf/db/json
Repository retention time: 246 Hours
Example A-6 To view full configuration for the repositories on specific nodes <node-name1> and <node-name2>
oclumon localrepo getconfig -n <node-name1> <node-name2>
Node: <node-name1>
Repository size: 500 MB
Repository path: $ORACLE_HOME/crsdata/<node-name1>/crf/db/json
Repository retention time: 246 Hours
Node: <node-name2>
Repository size: 500 MB
Repository path: $ORACLE_HOME/crsdata/<node-name2>/crf/db/json
Repository retention time: 240 Hours
Parent topic: OCLUMON Command Reference
A.5 oclumon version
Use the oclumon version
command to obtain the version of Cluster Health Monitor that you are using.
Syntax
oclumon version
Example A-7 oclumon version
Cluster Health Monitor (OS), Release 20.0.0.0.0
Version : 20.3.0.0.0
Parent topic: OCLUMON Command Reference
A.6 oclumon debug
Use the oclumon debug
command to set the log level for the Cluster Health Monitor services.
Syntax
oclumon debug [log daemon module:log_level] [version]
Parameters
Table A-6 oclumon debug Command Parameters
Parameter | Description |
---|---|
|
Use this option change the log level of daemons and daemon modules. Supported daemons are:
Supported daemon modules are:
Supported Where level 0 is lowest default level with minimal logging and level 3 is highest level with maximum logging. |
|
Use this option to display the versions of the daemons. |
Example A-8 oclumon debug
osysmond
):$ oclumon debug log osysmond CRFMOND:3
$ oclumon debug version
Cluster Health Monitor (OS), Release 20.0.0.0.0
Version : 20.3.0.0.0
NODEVIEW Version : 19.03
Label Date : 200116
Parent topic: OCLUMON Command Reference