Chapter 1. Red Hat Insights client configuration overview

This guide provides information about configuring the Red Hat Insights client on your system. With the insights-client command and associated configuration files, you can control how your system interacts with Red Hat Insights.

  • General information and overviews of the Insights client features are covered in the first few chapters.
  • How-to information on using the Insights client commands and configuration files to accomplish specific tasks follows the overview information.
  • Command reference and configuration file reference information is at the end of this guide.

Navigation links help you quickly find what you are looking for.

1.1. Client configuration overview

The Red Hat Insights client collects information about your system and sends it to Red Hat Insights, which is a cloud application. Command options for the CLI and configuration file options modify the information that is collected and shared with Red Hat Insights. These options control the following:

  • Data obfuscation

    • IP address obfuscation

      Note

      IP address obfuscation is supported only for IPv4 addresses.

    • Host name obfuscation
  • Data redaction

    • Specific files
    • Output of specific commands
    • Pattern-match deletions
    • Keyword replacement
  • Insights client scheduling
  • Insights rule updates
  • Insights client authentication method

    • Certificate-based
    • SSO-based, or Basic
  • System tagging

Because the information collected by the Red Hat Insights client is saved in a tar file, that file is referred to as an archive file.

1.2. Insights client CLI and configuration file interactions

The Red Hat Insights client runs according to its scheduler, which by default is every 24 hours. The client also runs when you enter the insights-client command.

When the client runs, its behavior is controlled, in order, by the following:

  1. The values, if any, provided when you enter the insights-client command. Values entered in the CLI override configuration file settings and system environment settings for that execution of the Insights client.
  2. The settings in the configuration files (/etc/insights-client/insights-client.conf and /etc/insights-client/remove.conf) override system environment settings.
  3. The values of any system environment variables (printenv) not affected by the CLI or the client configuration files are used.

Any options you provide in the insights-client command are used only for that execution. Those values can temporarily override values set in the configuration file or the environment variables.

Note

Using the insights-client command to set the display name takes effect immediately but does not run the Insights client.

Note

If you are using RHEL 6.9 or earlier, the client command is redhat-access-insights.

1.3. Insights client distribution

Insights client is available on Red Hat Enterprise Linux (RHEL) as shown in the following table.

RHEL releaseComments

RHEL 8

Distributed with Insights client pre-installed.

RHEL 7

Distributed with the Insights client RPM package loaded but not installed.

RHEL 6.10 and later

You must download the Insights client RPM package and install it.