Uploaded image for project: 'Puppet'
  1. Puppet
  2. PUP-8586

Feature related debug messages are confusing and generate too much spam

    Details

    • Type: Task
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 6.4.0
    • Component/s: None
    • Labels:
      None
    • Template:
    • Team:
      Coremunity
    • Sprint:
      Platform Core KANBAN
    • Release Notes:
      Enhancement
    • Release Notes Summary:
      Debug messages related to loading Ruby libraries that support optional features, along with debug messages around resolution of the server setting, are now logged once per puppet invocation.
    • QA Risk Assessment:
      Needs Assessment

      Description

      During an agent run, if a feature is not available, notably msgpack, we print a scary looking message:

      Debug: Dynamically-bound server lookup failed, falling back to server setting
      Debug: Dynamically-bound port lookup failed; falling back to masterport setting
      Debug: Failed to load library 'msgpack' for feature 'msgpack': cannot load such file -- msgpack
      Debug: Puppet::Network::Format[msgpack]: feature msgpack is missing
      Debug: file_metadata supports formats: json pson yaml
      

      The "Failed to load library" sounds bad, but it isn't. It just means an optional feature isn't enabled, which is the normal/default case.

      We should make the message less scary. We should only emit the message once, not everytime we make a file_metadata request.

      Similarly, the "Dynamically-bound server" and "port" messages are repeated for every file_metadata request.

      Similarly, if a type's property/parameter depends on a provider feature, and that provider feature isn't available, we repeat the same set of messages for every instance of that resource type. I think we should only emit the message once per resource type (and possibly once if the feature becomes true later in the run if the command, feature, etc becomes available):

      Debug: /Firewall[a]: Provider iptables does not support features hop_limiting; not managing attribute hop_limit
      Debug: /Firewall[a]: Provider iptables does not support features ishasmorefrags; not managing attribute ishasmorefrags
      Debug: /Firewall[a]: Provider iptables does not support features islastfrag; not managing attribute islastfrag
      Debug: /Firewall[a]: Provider iptables does not support features isfirstfrag; not managing attribute isfirstfrag
      ...
      Debug: /Firewall[b]: Provider iptables does not support features hop_limiting; not managing attribute hop_limit
      Debug: /Firewall[b]: Provider iptables does not support features ishasmorefrags; not managing attribute ishasmorefrags
      Debug: /Firewall[b]: Provider iptables does not support features islastfrag; not managing attribute islastfrag
      Debug: /Firewall[b]: Provider iptables does not support features isfirstfrag; not managing attribute isfirstfrag
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                chuck Charlie Sharpsteen
                Reporter:
                josh Josh Cooper
              • Votes:
                1 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Zendesk Support