Add Increasing log level for Insights IoP by Lennonka · Pull Request #4633 · theforeman/foreman-documentation

Lennonka · 2026-02-04T02:09:02Z

DRAFT = Not ready for review!

What changes are you introducing?

Adding a procedure to increase the logging level for Insights IoP services

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

New feature

Documents theforeman/puppet-iop#90

SAT-42054 (public)

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Contributor checklists

I am okay with my commits getting squashed when you merge this PR.
I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

Foreman 3.17/Katello 4.19
Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6)
Foreman 3.15/Katello 4.17
Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
Foreman 3.13/Katello 4.15 (EL9 only)
Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
We do not accept PRs for Foreman older than 3.12.

github-actions · 2026-02-04T02:13:26Z

The PR preview for 00db915 is available at theforeman-foreman-documentation-preview-pr-4633.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

chris1984

Left some comments to help with your PR

chris1984 · 2026-02-04T15:31:23Z

guides/common/modules/proc_increasing-the-logging-level-for-insights-iop.adoc

+[role="_abstract"]
+You can increase the logging level for {insights-iop} to `DEBUG` to get more detailed logs.
+You can find the logs in `/var/log/messages`.
+The default log level is `INFO`. // TODO: are there multiple defaults?


Most are set to INFO We had one set to ERROR by default:

logging: version: 1 disable_existing_loggers: false loggers: insights.core.dr: level: "ERROR" insights_messaging: level: "INFO" insights_kafka_service: level: "INFO" "": level: "INFO"

"": level: "INFO"

What exactly does this ^^ mean?

And what is the generic term for these things: insights.core.dr, insights_messaging, insights_kafka_service? Components? Containers? Just loggers?
I hesitate to call them "services" because we call the functionalities services (advisor, vulnerability).

@dkuc do you have an idea what we should call these in the docs ^

I would hope this remains an internal implementation detail and not documented.

chris1984 · 2026-02-04T15:34:43Z

guides/common/modules/proc_increasing-the-logging-level-for-insights-iop.adoc

+
+[options="nowrap", subs="+quotes,verbatim,attributes"]
+----
+# // TODO: Add the command to check the log level


You can run this:
podman exec iop-core-engine cat /var/config.yml | grep -A15 "logging:" which would return this:

logging: version: 1 disable_existing_loggers: false loggers: insights.core.dr: level: "DEBUG" insights_messaging: level: "DEBUG" insights_kafka_service: level: "DEBUG" "": level: "DEBUG"

You can cat /var/log/messages and you will see this:

Feb 2 12:24:09 ip-10-0-168-10 iop-core-engine[177812]: DEBUG:insights.core.dr:telemetry.rules.plugins.networking.network_vlan_i40e_driver_offloading_issue.check_bond_master_slave_config missing requirements All: ['telemetry.rules.plugins.networking.bonding.check_bond_master_slave_conn']

You can cat /var/log/messages and you will see this:

Feb 2 12:24:09 ip-10-0-168-10 iop-core-engine[177812]: DEBUG:insights.core.dr:telemetry.rules.plugins.networking.network_vlan_i40e_driver_offloading_issue.check_bond_master_slave_config missing requirements All: ['telemetry.rules.plugins.networking.bonding.check_bond_master_slave_conn']

@chris1984 Can you, please, get me more examples with the default logging levels?
And the ip-10-0-168-10 string is a hostname? I'd prefer to anonymize it for the docs.

Here are some logs with the info level set:

Feb 3 10:39:54 ip-xxx.example.com iop-core-engine[213708]: INFO:insights.core.dr:Trying telemetry.rules.plugins.sap.sap_hana_loose_sudo.check_group_members Feb 3 10:39:54 ip-xxx.example.com iop-core-engine[213708]: INFO:insights.core.dr:Trying telemetry.rules.plugins.sap.sap_hana_loose_sudo.report Feb 3 10:39:54 ip-xxx.example.com iop-core-engine[213708]: INFO:insights.core.dr:Trying telemetry.rules.plugins.ros.ros_instance_evaluation.find_solution Feb 3 10:39:54 ip-xxx.example.com iop-core-engine[213708]: INFO:insights.core.dr:Trying telemetry.rules.plugins.ros.ros_instance_evaluation.report Feb 3 10:39:54 xxx.example.com iop-core-engine[213708]: INFO:insights_kafka_service.consumer:Completed processing request id 4be0099772a23aad477e493990247876 Feb 3 10:39:54 xxx.example.com iop-core-engine[213708]: INFO:insights_messaging.consumers.kafka:Completed one payload

chris1984 · 2026-02-04T15:35:16Z

guides/common/modules/proc_increasing-the-logging-level-for-insights-iop.adoc

+
+[options="nowrap", subs="+quotes,verbatim,attributes"]
+----
+# {foreman-installer} // TODO: Add the command to increase the log level


foreman-installer -l info --iop-core-engine-log-level-insights-core-dr DEBUG --iop-core-engine-log-level-insights-kafka-service DEBUG --iop-core-engine-log-level-insights-messaging DEBUG --iop-core-engine-log-level-root DEBUG

Is the -l info argument absolutely necessary in here? Isn't that the default?
We have a section to set the logging level for installer separately.

Yeah that is fine to remove the -l info I just use that so I can see what the installer is doing, so it was from my copy and paste.

Lennonka · 2026-02-05T02:16:07Z

guides/common/modules/proc_increasing-the-logging-level-for-insights-iop.adoc

+.Log entries of {insights-iop}
+====
+----
+// TODO: Examples with default log levels
+----


@chris1984 FYI, this is my intention with the examples of log entries.

Lennonka · 2026-02-05T02:29:21Z

guides/common/modules/proc_increasing-the-logging-level-for-insights-iop.adoc

+----
+ logging:
+    version: 1
+    disable_existing_loggers: false
+    loggers:
+      insights.core.dr:
+        level: "ERROR"
+      insights_messaging:
+        level: "INFO"
+      insights_kafka_service:
+        level: "INFO"
+      "":
+        level: "INFO"
+----


Suggested change

----

logging:

version: 1

disable_existing_loggers: false

loggers:

insights.core.dr:

level: "ERROR"

insights_messaging:

level: "INFO"

insights_kafka_service:

level: "INFO"

"":

level: "INFO"

----

----

loggers:

insights.core.dr:

level: "ERROR"

insights_messaging:

level: "INFO"

insights_kafka_service:

level: "INFO"

"":

level: "INFO"

----

@chris1984 Will it still make sense if I reduce it like this? Or would you advise me against it? Or perhaps I should use a different formatting altogether, such as a list?

That is fine to reduce it like that, line 19 - 27 is what the installer pr changes, so we can focus on that. Let me know if you want me to try and find a better grep command

Lennonka · 2026-02-05T03:51:14Z

@chris1984 Is the same doc update applicable to Sat 6.18?

chris1984 · 2026-02-05T16:20:39Z

@chris1984 Is the same doc update applicable to Sat 6.18?

No it's not, unless we decide to backport it. I guess for now until we are given that direction we just put it in the Sat 6.19 docs. If I hear anything about a backport, I will make a follow up Jira

Add Increasing log level for Insights IoP

5219d79

pr-processor bot added the Not yet reviewed label Feb 4, 2026

github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Feb 4, 2026

Add default

4fdf596

chris1984 reviewed Feb 4, 2026

View reviewed changes

pr-processor bot removed the Not yet reviewed label Feb 4, 2026

Update with specifics

cb29349

Lennonka commented Feb 5, 2026

View reviewed changes

Fix example block

00db915

Lennonka commented Feb 5, 2026

View reviewed changes

Conversation

Lennonka commented Feb 4, 2026

DRAFT = Not ready for review!

What changes are you introducing?

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Contributor checklists

Uh oh!

github-actions bot commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chris1984 left a comment

Choose a reason for hiding this comment

Uh oh!

chris1984 Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Lennonka Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chris1984 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

dkuc Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

chris1984 Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Lennonka Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chris1984 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

chris1984 Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lennonka Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chris1984 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Lennonka Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Lennonka Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chris1984 Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lennonka commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chris1984 commented Feb 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Feb 4, 2026 •

edited

Loading

Lennonka Feb 5, 2026 •

edited

Loading

Lennonka Feb 5, 2026 •

edited

Loading

chris1984 Feb 4, 2026 •

edited

Loading

Lennonka Feb 5, 2026 •

edited

Loading

Lennonka Feb 5, 2026 •

edited

Loading

chris1984 Feb 5, 2026 •

edited

Loading

Lennonka commented Feb 5, 2026 •

edited

Loading