Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Gathering diagnostic information with diagdata

diagdata is a CLI tool that is used to aid diagnostic testing of Ops Center Protector. It provides the following functions:

  • Stopping and starting of Ops Center Protector services
  • Resetting the Ops Center Protector system state
  • Raising and lowering of trace level for diagnostics
  • Collection of Ops Center Protector state information to aid investigation of issues
Command line options
General options
Abbreviated argumentFull argumentDescription
-h--helpDisplay help.
Service options
Abbreviated argumentFull argumentDescription
-r arg--restart argAuto restart active services yes | no
--start arg

Starts the requested Ops Center Protector service.

Options are all, hub, <filter name> or filters.

--stop arg

Stops the requested Ops Center Protector service.

Options are all, hub, <filter name> or filters.

Protector
Abbreviated argument Full argument Description
-d arg --trace-dir arg Set the trace directory.
-T arg --temp-dir arg Set the temp directory.
--reset

Resets the state of the Ops Center Protector node and flushes cache and logs. Can only be run if Ops Center Protector services are stopped (see --stop).

Dump options
Abbreviated argument Full argument Description
-f --full Produce a full dump of the Ops Center Protector configuration on the system, including all trace files. Results are placed in a ZIP file named:

diag_node name_YYYYMMDDhhmm.zip

in the directory: Data-Instance-Director-install\runtime

This ZIP file can be requested by Hitachi Vantara support when investigating complex end user issues.

Can be combined with --spilt

-m --mini Similar to –f but only saves a recent portion of all trace files.

Can be combined with --spilt

-c arg --collect arg arg specifies which data must be collected. Use all to collect all components. For additional component names use -c help.

Can be combined with --spilt

-o arg --output-dir arg arg specifies an optional output directory. Default is Protector\runtime
-n arg --tracename arg arg specifies a filter mask which uses wildcards to target only specific trace files e.g. diagdata -f --tracename repos*.

Multiple filters can be used seperated by ';' e.g. hub*;node*;repo*. For Linux use "hub*;node*;repo*").

-a arg --traceage arg arg specifies an age, in days, to target only trace files modified in that time frame.
-F --filterlog Collect filter log information.
-z --nosnapshots Prevents diagdata from creating snapshots before a dump (this may result in some files not being added to the diagnostic dump).
-Z --withsnapshots Attempt diagdata snapshots regardless of configuration. The default mode of operation.

For linux , snapshots will only be taken for LVM filesystems

--no-md5Disable MD5 checksum on created zip files.
Trace options
Abbreviated argument Full argument Description
-t arg --trace arg

Sets the trace level of the node. Valid arguments are:

TraceAlways logs only salient events, minimizing trace file size. This is the default level.

The trace output increases in detail with the following levels:

TraceTesting, TraceNormal, TraceVerbose up to TraceDebug logs everything and generates trace files on disk of up to 4GB (configurable).

Trace files are placed in TRA files in the directory:

[Install-Dir]\runtime\trace

-p --deltrace Delete inactive trace files. Any trace files currently in use by the Protector system will not be deleted.

Deletes the contents of [Install-Dir]\runtime\trace

-x --delalltrace Stop Protector services, delete all trace and then restart them.
-i --info Get information about this node and current trace status.
Windows crash dump file options
Abbreviated argument Full argument Description
-l arg--dumplevel argNot available on Linux. Sets Protector crash dump level full | default.
--test-dumpNot available on Linux. Generates a Windows dump file for test purposes.
Archive options
Abbreviated argument Full argument Description
-S arg--split-file argSplit an existing zip file (path specified by arg) into multiple chunks (configurable, 1GB default). Intended to be used if the file is too big to be uploaded to a file service.
-C arg--concatenate argFile name for the concatenated file. That must be followed by the list of the files to be concatenated. Example: --concatenate diag.zip part.000 part.001 part.002
--split Split the zip in multiple chunks (configurable, 1GB default), this is used with the --full, --mini and --collect options. Intended to be used if the file is too big to be uploaded to a file service.
Usage Examples:

Stopping the Ops Center Protector services on any node:

diagdata --stop all

Setting the trace level of the Ops Center Protector services on any node:

diagdata --trace TraceAlways

Collect a mini dianostic log from a node:

diagdata --mini

Collect a full diagnostic log from a node:

diagdata --full

 

  • Was this article helpful?