Skip to main content
Migration Notice
We're migrating documentation from the old portal into this one. Some things may look a little different or out of place in the meantime — we know, and we're working to get it right. If something's unclear or doesn't look right, let us know.
Version: 4.4.0

Log Parser and Document Generator

Introduction​

The Log Parser tool lets you run the same log analysis Superna Support uses when troubleshooting a case, directly against your own appliance backup — useful for self-service diagnostics, including in environments with limited or delayed internet access to Superna Support. It parses configuration sync, replication timing, and failover job logs, and summarizes errors, alarms, and DR readiness. The tool anonymizes the data it analyzes.

Document Generator is a licensed companion feature that builds an HTML report summarizing the configuration of your deployment — useful for producing design documentation for an existing environment.

Requirements​

Log Parser and Document Generator require the appliance to be running release 2.5.8.1 or later.

How to Use Log Parser​

  1. Log in to Eyeglass and add the Log Parse role to the administrator account, then log out and log back in.
  2. Open the Log Parse icon on the desktop.
  3. Download a support backup zip file from About Eyeglass > Backup.
  4. Select Add to start a new log parse record.
  5. Enter a name to identify this analysis (for example, a site or environment name).
  6. Select Upload Zip and choose the backup file you downloaded.
  7. Accept the default options and submit.
  8. The upload and analysis can take some time — you can monitor progress from the Running Jobs window, or wait for the results to display once complete. Results are also stored on the appliance for later reference.
  9. Select Open to review the report in a new browser tab. Use the report's table of contents to navigate to each section — a section showing data means the parser found relevant entries; a section showing no data means nothing was found for that category.
note

Log Parser can analyze a backup from any appliance, even if the backup was generated on a different appliance than the one running Log Parser.

Managing Log Parse Records and Disk Space​

A log parse record stores the unzipped backup contents, which can use 1-4 GB of disk space; the generated report itself is typically 3-12 MB. To free up space:

  1. Select the appliance's row in the Log Parse list.
  2. Choose Delete, then select either:
    • Delete whole record — removes both the unzipped backup data and the generated report.
    • Delete report only — removes just the report, keeping the unzipped data so you can re-run analysis later without re-uploading.

Re-running Analysis on an Existing Backup Record​

  1. Select the appliance's row in the Log Parse list.
  2. Select Run (the + icon), then submit.
  3. Monitor progress from the Running Jobs icon, then open the updated report once complete.

Document Generator​

Document Generator builds a detailed HTML summary of your deployment's configuration — useful for producing design documentation for an existing environment, or as a professional-services deliverable for channel partners.

Document Generator requires a separate license key (the Document Generator subscription).

  1. From the Log Parse icon, upload a new backup or select an existing backup record.
  2. Select Run, then choose which report sections to include.
  3. Enter the cluster names to include in the report — a DR-focused report requires at least 2 clusters selected (source and target).
  4. Submit and monitor progress from Running Jobs, then open the generated report once complete.

See Also​