Report File Explanation

The Report file (in XML or JSON formats) that is generated after a Enterprise Deployment Health Check is run contains a lot more information than the CLI Output snippets shown in the previous section. Enterprise Deployment Health Check collects a substantial amount of information (depending on the selection of "Options" targets) that can be used to get a complete picture of the TIBCO ActiveMatrix Enterprise. This section provides a high-level overview of some of the important elements found in the Report file.

The Report file may or not contain some of the elements listed below depending on the selection of "Options" targets used while invoking Enterprise Deployment Health Check.

Note: Each element listed below has a common healthCheckStatus attribute that denotes the status of the element in terms of PASSED or FAILED. In the case the overall status of Enterprise Deployment Health Check is "FAILED", you can use the healthCheckStatus attribute to navigate to the element causing the Health Check to fail.
Element Description
healthCheckOutput

This is the root element of report and contains attributes that help in identifying key information such as: total time taken for the Enterprise Deployment Health Check run, the requesting user and the machine from which Enterprise Deployment Health Check was invoked, unique Invocation ID that can be used to correlate this Enterprise Deployment Health Check run with log entries in the logs for participating Nodes and Hosts logs, and so on.

Based on this element, you can conclude whether the Enterprise Deployment Health Check has PASSED or FAILED.

adminMetaData This element contains the configuration data of TIBCO ActiveMatrix Administrator, such as backend database, Notification/Qin Server, LDAP server Connection Configuration, HTTP Connector configuration, TIBCO_HOME, CONFIG_HOME, SHARED_FOLDER location, and so on.

Note: If the TIBCO ActiveMatrix Administrator is replicated, it also contains information about the External and Internal HTTP connector information of the replicated TIBCO ActiveMatrix Administrator.

adminSummary This element contains information regarding that Enterprise Deployment Health Check collected for the "Most"-used Report. It also contains the Name and Environment name of Applications/Nodes, if any, that are Out-of-sync or in Not running state.
adminInfo

This element contains information regarding the current runtime state of TIBCO ActiveMatrix Administrator, such as:

  • Time for which the TIBCO ActiveMatrix Administrator is up and time it took to start the TIBCO ActiveMatrix Administrator.
  • Ping (turnaround) times for Notification/Qin Server and backend database server.
  • Number of notifications processed by TIBCO ActiveMatrix Administrator since last restart.
  • Information about the shared folder of TIBCO ActiveMatrix Administrator.
  • Deployment history with number of deployment tasks finished/pending.
  • Machine information and JVM information of the TIBCO ActiveMatrix Administrator.
  • Count of various TIBCO ActiveMatrix entities (Hosts, Nodes, and Environments) and when each of them was created/last deployed.
  • TIBCO ActiveMatrix Administrator Plug-in information.
  • Information about super users and super user groups.
  • Number of users logged-in from the last startup (with breakdown of logins in terms of CLI versus the browser).
  • Detailed information about Notification/Qin Server.
  • List of all the Messaging Bus Servers used by various TIBCO ActiveMatrix Environments with their connection information and corresponding Test Connection result.
  • Information about shared resource pools (Database, LDAP).
  • Information about Internal and External HTTP Connectors.
<hostInfoAndPingTime>

This element contains information about Host and Nodes. Depending on the options target used, it contains either the "ping" time OR the complete information set about Hosts and Nodes.

The main targets control list of Hosts and Nodes under this element, that is, if you ran Enterprise Deployment Health Check for a selection of Hosts, only those Hosts and the Nodes managed by those Hosts are shown.

Each Host is represented as a sub-element and under that, is a sub-element for each Node managed by that Host.

Information includes:

  • Version of Host/Upgrade history.
  • JVM information:
    • JAVA home/JAVA vendor information.
    • JVM arguments.
    • TIBCO-specific system properties used.
    • JVM uptime/PID.
    • JVM CPU time and load.
    • JVM memory and perm gen usage.
    • Threads information.
    • Number of Classes loaded by JVM.
    • JVM File descriptors (Linux only).
  • Host/Node specific information:
    • Windows Service info (Microsoft Windows only).
    • TIBCO_HOME information (location, size, all TIBCO Products installed in that TIBCO_HOME).
    • CONFIG_HOME information (location, size, number of TIBCO host instances running from the CONFIG_HOME).
    • Logs information (Number of logs, location of each file, number of log lines, number of errors and warnings in logs).
    • Information about Host Plugins folder.
    • Information about Engineering Builds applied, if any.
  • Machine Information:
    • Machine name, user currently logged-in.
    • Machine uptime.
    • Machine type (operating system architecture).
    • Number of CPUs, Current CPU usage, CPU load average.
    • Maximum memory, currently used memory.
    • Network card information.
    • Storage/Disk space information.

<deploymentHealthCheckResult>

This element contains result of Test Deployment. It also includes the time taken to complete the test deployment on a given Node.
<allHealthCheckErrors> This element contains all errors (if any) seen during Enterprise Deployment Health Check.
</healthCheckOutput>