Skip to content

HTML report #295

@nirs

Description

@nirs

The current report for all commands use yaml which is great for machines, and ok for humans. The validate report add emoji to the reports to make it better for humans, but his makes it worse for machines. We need a better way to provide good report for humans and leave the yaml report for machines.

Adding html report can solve this. It can be generated from the Report type.

The report can be saved in out/validate-application.html automatically:

$ tree -L1 out
out
├── gather-application.data
├── gather-application.html
├── gather-application.log
└── gather-application.yaml

Advantages of html report:

  • Can be more compat, fitting more info without scrolling
  • Can include emoji and colors to as needed to make it quicker to read
  • Can include links to gathered resources - click to open the full drpc
  • Can include links to docs for more info

Example yaml

applicationStatus:
  hub:
    drpc:
      ...
  primaryCluster:
    name: dr1
    vrg:
      ...
  secondaryCluster:
    name: dr2
    vrg:
       ...

Example html

<html>
<head>
  <title>Validate application</title>
</head>
<body>
  <h1>Validate application</h1>
    <h2> Application status</h2>
      <h3>hub</h3>
         <h4>drpc</h4>
         ...
      <h3>Primary cluster</h3>
         <h4>vrg</h4>
         ...
      <h3>Primary cluster</h3>
         <h4>vrg</h4>
         ...

Requirments

  • Collected data from validate application and validate clusters commands

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions