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: 2.15.0

How to Use Log Parser and Doc Generator

Overview​

Log Parser generates detailed log parsing analysis for all Eyeglass products — Ransomware Defender, Easy Auditor, and DR Manager. This is the same technology Superna Support uses to troubleshoot issues, made available so customers can log parse their own appliance to resolve issues directly. It also produces reports and CSV downloads that summarize data about the environment, and retains a history of previous reports so you can go back in time to compare results.

Ransomware Defender customers can use Log Parser to extract historical threat detections into a CSV file.

Doc Generator licensing

Log Parser also includes Doc Generator, a separate professional-services tool that builds a detailed HTML report summarizing the configuration of different products, including DR design documentation. Doc Generator is a licensed feature — it requires the Eyeglass Pro Services Document Generator 1 Year Subscription license key, and is targeted at certified channel partners or customers who want automated documentation for their PowerScale, and Superna product environment. Log Parser itself does not require this license; only Doc Generator's document-generation step does.

Requirements​

  • Release 2.5.8.1 or later
  • The Log Parse tool can parse logs from any appliance, even if the log was created on a different appliance
  • The tool stores the master zip file each time a backup is uploaded; you can delete a report and re-run analysis (or regenerate documents, if licensed) at any time

How to Use Log Parser​

  1. Log in to Eyeglass, add the Log Parse role to the administrator, then log out and log back in.
  2. Open the Log Parse icon on the desktop.
  3. Download a backup zip file from Inventory → Backup (a support backup should be downloaded).
  4. Click the Add button.
  5. Leave the default option to generate a log parse.
  6. Enter your site name or company name.
  7. Click Upload Zip and locate the Eyeglass support backup you downloaded.
  8. Accept the default option and click Submit.
  9. The zip file upload takes time; you can monitor progress from the Running Jobs window. The final results are displayed and stored on the appliance.
  10. Click Open to review the log parse results in a new browser tab.
  11. Use the table of contents to navigate to the section of the report you want to review. "Data exists" means log parse found data to display for that section; "No data" means nothing will be shown for that item.

How to Manage Log Parse Records and Disk Space​

A log parse record is an unzipped Eyeglass backup. This consumes 1–4 GB of space on the appliance's 80 GB disk. The log parse report itself is typically 3–12 MB.

To delete an entire record (log parse report and unzipped analysis data):

  1. Select one or more appliance rows and click Select Delete Type.
  2. Select Delete Whole Record to delete both the unzipped backup data and the log parse reports, or select the option to delete only the log parse report.
tip

If you only delete the log parse report, you can re-run the log parse analysis later using the Run button.

How to Run Parse on an Existing Eyeglass Backup Record​

  1. Select an appliance backup row and click the + Run button.
  2. Click Submit and wait for the log parse job to complete.
  3. Monitor progress from the Running Jobs icon, Running tab, then view the report once complete.

How to Use Doc Generator​

Overview​

Doc Generator generates detailed design documents and installation summaries. It includes details collected from PowerScale clusters and can draw topology diagrams for replication, shares, exports, access zones, SMB shares, quotas, pools, and subnets for DR design documents. It also includes a summary of the design and configuration of Ransomware Defender, Easy Auditor, and Performance Auditor.

This feature is targeted at certified channel partners or customers who want automated documentation tooling for their PowerScale and Superna product environment.

Requirements​

  • A license key for the subscription feature Eyeglass Pro Services Document Generator 1 Year Subscription

How to Generate Documents​

  1. Upload an Eyeglass backup, or select an existing backup in the Log Parse icon, and use the + Run button.

  2. Select the checkboxes for the reports you want to generate.

  3. Enter the cluster names to include in the report.

    note

    For DR reports, 2 clusters must be selected.

See Also​