Generating advisor service reports

Red Hat Lightspeed 1-latest

Share reporting from advisor about the conditions affecting your RHEL infrastructure.

Red Hat Customer Content Services

Abstract

The advisor service provides several ways to download and share reporting.

Chapter 1. Overview of Red Hat Lightspeed advisor service reporting

The advisor service enables you to share the status of your Red Hat Enterprise Linux infrastructure. You can download reports, share recommendations, and subscribe to the Weekly Report email.

You can share the status of your RHEL infrastructure in the following ways:

  • Export and download a report in CSV, JSON, or YAML file format to share recommendations for your impacted RHEL systems with stakeholders.
  • Subscribe to the advisor Weekly Report email to receive a brief summary of the health of your RHEL environment.
  • Download an executive report to share a high-level overview of your infrastructure with an executive audience.

These methods provide a quick and easily accessible way for you and your stakeholders to assess the health of your infrastructure and plan accordingly.

Chapter 2. Red Hat Lightspeed advisor service data export

You can export a report in either JSON or CSV format that shows the recommendations that affect each of your registered systems. The report can help you understand your recommendations, solutions, and total risk.

Exported reports include the following information:

  • Hostname
  • Inventory UUID for the host
  • RHEL version
  • The date and time of the last data upload from the host to Red Hat Lightspeed
  • The title of the recommendation that impacts the host
  • A link to the solution for the recommendation
  • The total risk posed by the recommendation on a scale from 1 to 4; 1 means low risk, 4 means high risk
  • The likelihood of the recommendation being active on your registered systems on a scale from 1 to 4; 1 means unlikely and 4 means highly probable
  • The date that the recommendation was published
  • A link to the scan results for the host

2.1. Export reports using the advisor service

You can export a report in either a CSV or JSON file by using the advisor service. You can share the report to update your stakeholders.

Procedure

  1. Navigate to the This content is not included.Operations > Advisor > Recommendations page and log in.
  2. Apply filters as needed to refine the results.
  3. Click Download to the right of the search box in the toolbar.
  4. Select either Export to CSV or Export to JSON.
  5. In the dialog box, select Open with and specify an application, or click Save File and then click OK.

2.2. Export advisor service data using the API

Use the API to export filtered, active advisor recommendations impacting your RHEL systems in CSV or JSON format for automation or integration with external systems.

Procedure

Additional resources

Chapter 3. Red Hat Lightspeed advisor service weekly-report email subscription

The advisor service Weekly Report email provides a quick view of the health of your environment.

3.1. Overview of the advisor service weekly-report email subscription

The advisor service weekly-report email subscription sends an email message every Sunday night (United States Eastern Standard Time, UTC -05:00; Eastern Daylight Time, UTC-4:00) to the email address associated with your individual Red Hat Customer Portal user account. You are automatically subscribed to the weekly-report email the first time that you visit the advisor service.

The email subscription provides the following information about systems registered to your account:

  • Number of critical rule hits in your infrastructure
  • Number of impacted systems in your infrastructure
  • Total number of recommendations impacting your infrastructure

3.2. Unsubscribe and subscribe to the advisor service Weekly Report email

You are automatically subscribed to the Weekly Report email after the first time that you visit the advisor service. The Weekly Report email message is sent every Sunday. You can also unsubscribe to the list on the Notification Preferences page.

Procedure

  1. Navigate to the This content is not included.Notification Preferences page and log in.
  2. Locate the Red Hat Enterprise Linux heading halfway down the page on the left and click Advisor.
  3. Under the Reports heading to the right, select or clear the Weekly Report option based on your preferences.
  4. Click Save.

Result

You will receive the email each Sunday night from the sender, Red Hat Lightspeed noreply@redhat.com, with the subject line, Weekly Red Hat Lightspeed summary report.

Chapter 4. Red Hat Lightspeed advisor service executive report

You can download a high-level report designed for an executive audience that summarizes the status of your infrastructure.

Executive reports are one to two-page PDF files that show the following information:

  • Identified recommendations by severity
  • Recently identified recommendations by category
  • The top three recommendations in your infrastructure based on the greatest total risk and the greatest number of systems exposed

4.1. Download an advisor service executive report

You can download an executive report from the advisor service as a PDF file. This report gives you a high-level overview of your recommendations.

Procedure

  1. In the Hybrid Cloud Console, navigate to This content is not included.Operations > Advisor > Recommendations.
  2. Click the Download executive report link in the upper-right corner of the Recommendations page.
  3. Open or save the file and click OK.
  4. If downloaded, check your download location for the PDF file.

Chapter 5. Enable notifications and integrations

To be notified when the advisor service detects an issue and generates a recommendation, you can enable notifications on Red Hat Hybrid Cloud Console. For example, you can configure the notifications service to automatically send an email message whenever the advisor service generates a recommendation.

5.1. Enable the notifications service

The notifications service enables you to control who gets notifications, how often, and by what delivery method. Your Organization Administrator can enable the notifications service.

Procedure

  1. An Organization Administrator creates a User Access group that includes at least the required role.

    The group must include the Notifications administrator or the RHEL administrator role.

  2. The Organization Administrator adds account members to the group.
  3. Optional: Set up behavior groups for events in the notifications service. Behavior groups specify the delivery method for each notification. For example, a behavior group can specify whether email notifications are sent to all users, or just to Organization Administrators.

  4. Users who receive email notifications from events must set their user preferences to receive individual emails for each event.

    Next steps

    In addition to sending email messages, you can configure the notifications service to send event data in the following other ways:

    • Using an authenticated client to query Red Hat Lightspeed APIs for event data
    • Using webhooks to send events to third-party applications that accept inbound requests
    • Integrating notifications with applications such as Splunk to route advisor recommendations to the application dashboard

Additional resources

Chapter 6. Reference materials

There are resources available to help you learn more about the advisor service.

See the following resources:

Providing feedback on Red Hat documentation

Provide feedback on Red Hat documentation to report issues or request enhancements. Submit detailed feedback through the Red Hat Customer Portal to help improve documentation quality.

Prerequisites

  • You are logged in to the Red Hat Customer Portal.

Procedure

  1. Click the following link: Content from redhat.atlassian.net is not included.Create Issue
  2. Describe the issue or enhancement in the Summary text box.
  3. Provide details about the issue or requested enhancement in the Description text box.
  4. Type your name in the Reporter text box.
  5. Click the Create button.

Results

This action creates a documentation ticket and routes it to the appropriate documentation team. Thank you for taking the time to give feedback.

Legal Notice

Copyright © Red Hat.
Except as otherwise noted below, the text of and illustrations in this documentation are licensed by Red Hat under the Creative Commons Attribution–Share Alike 3.0 Unported license . If you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, the Red Hat logo, JBoss, Hibernate, and RHCE are trademarks or registered trademarks of Red Hat, LLC. or its subsidiaries in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
XFS is a trademark or registered trademark of Hewlett Packard Enterprise Development LP or its subsidiaries in the United States and other countries.
The OpenStack® Word Mark and OpenStack logo are trademarks or registered trademarks of the Linux Foundation, used under license.
All other trademarks are the property of their respective owners.