reports

Documentation

Overview

Package reports provides functions for generating one-line summary (Service Output) and detailed overview (Long Service Output) "reports" of plugin service check results.

Index

• func SyncPlansOverviewReport(orgs rsat.Organizations, _ *config.Config, _ zerolog.Logger) string
• func SyncPlansPrettyTableReport(orgs rsat.Organizations, cfg *config.Config, _ zerolog.Logger) string
• func SyncPlansSimpleTableReport(orgs rsat.Organizations, cfg *config.Config, logger zerolog.Logger) string
• func SyncPlansVerboseReport(orgs rsat.Organizations, cfg *config.Config, _ zerolog.Logger) string

Functions

func SyncPlansOverviewReport

func SyncPlansOverviewReport(orgs rsat.Organizations, _ *config.Config, _ zerolog.Logger) string

SyncPlansOverviewReport provides a listing of Red Hat Satellite organizations and the overall (high-level) state of sync plans in each organization. This report is intentionally light on specifics.

func SyncPlansPrettyTableReport

func SyncPlansPrettyTableReport(orgs rsat.Organizations, cfg *config.Config, _ zerolog.Logger) string

SyncPlansPrettyTableReport provides a report of Red Hat Satellite organizations in "pretty" table format. This table format uses more visual "polish" while attempting to remain compatible with modern terminals.

Each sync plan is listed along with relevant status information.

func SyncPlansSimpleTableReport

func SyncPlansSimpleTableReport(orgs rsat.Organizations, cfg *config.Config, logger zerolog.Logger) string

SyncPlansSimpleTableReport provides a report of Red Hat Satellite organizations in "simple" table format. This table format is intentionally simple in an effort for the broadest compatible output.

Each sync plan is listed along with relevant status information.

func SyncPlansVerboseReport

func SyncPlansVerboseReport(orgs rsat.Organizations, cfg *config.Config, _ zerolog.Logger) string

SyncPlansVerboseReport provides a verbose listing of Red Hat Satellite organizations and sync plans. This is useful for providing a detailed (while still manageable) report of the status of all sync plans in each organization.

NOTE: If no problems are detected the output