Jira (BOLT-996) Prettify (or support prettifying) JSON output when using --verbose

[Reid Vandewiele (JIRA)]

Title: Message Title

Reid Vandewiele created an issue   Puppet Task Runner / BOLT-996 Prettify (or support prettifying) JSON output when using --verbose Issue Type: Improvement Assignee: Unassigned Created: 2018/11/27 3:43 PM Priority: Normal Reporter: Reid Vandewiele Right now, when you add --verbose to an invocation of Bolt it will print detailed information about what it's doing, often in the form of JSON objects. Oftentimes, it can be very difficult to make sense of this though since the JSON is printed without line breaks or indentation. That is, not prettified. [reidmv@halcyon:~/src/puppet/] % bolt apply --nodes winrm://10.234.1.11 --user Administrator --password --no-ssl-verify -e 'notify { "hello": }' --verbose Please enter your password: Loading modules from /opt/puppetlabs/bolt/lib/ruby/gems/2.5.0/gems/bolt-1.3.0/bolt-modules:/Users/reidmv/.puppetlabs/bolt/modules:/Users/reidmv/.puppetlabs/bolt/site:/opt/puppetlabs/bolt/lib/ruby/gems/2.5.0/gems/bolt-1.3.0/modules Starting: install puppet and gather facts on winrm://10.234.1.11 Starting: task puppet_agent::version on winrm://10.234.1.11 Running task puppet_agent::version with '{"_task"=>"puppet_agent::version"}' on ["winrm://10.234.1.11"] {"node":"winrm://10.234.1.11","status":"success","result":{"version":"6.0.2","source":"C:/Program Files/Puppet Labs/Puppet/VERSION"}} Finished: task puppet_agent::version with 0 failures in 2.47 sec Puppet Agent 6.0.2 installed on winrm://10.234.1.11 Starting: task apply_helpers::custom_facts on winrm://10.234.1.11 Running task apply_helpers::custom_facts with '{"plugins"=>#<Sensitive [value redacted]>, "_task"=>"apply_helpers::custom_facts"}' on ["winrm://10.234.1.11"] {"node":"winrm://10.234.1.11","status":"success","result":{"aio_agent_version":"6.0.2","architecture":"x64","dhcp_servers":{"Ethernet":"192.168.0.3","system":"192.168.0.3"},"dmi":{"manufacturer":"Seabios","product":{"name":"OpenStack Nova","serial_number":"3c2513f4-b791-4ce7-9b2f-558c71093ec7"}},"domain":"platform9.puppet.net","facterversion":"3.12.0","fqdn":"win-2012-0.platform9.puppet.net","hardwareisa":"x64","hardwaremodel":"x86_64","hostname":"win-2012-0","hypervisors":{"kvm":{"openstack":true}},"id":"WIN-2012-0\\Administrator","identity":{"privileged":true,"user":"WIN-2012-0\\Administrator"},"interfaces":"Ethernet","ipaddress":"192.168.0.5","ipaddress6":"fe80::402f:43bf:4d05:dc56%12","ipaddress6_Ethernet":"fe80::402f:43bf:4d05:dc56%12","ipaddress_Ethernet":"192.168.0.5","is_virtual":true,"kernel":"windows","kernelmajversion":"6.3","kernelrelease":"6.3.9600","kernelversion":"6.3.9600","macaddress":"FA:16:3E:3E:87:ED","macaddress_Ethernet":"FA:16:3E:3E:87:ED","manufacturer":"Seabios","memory":{"system":{"available":"2.56 GiB","available_bytes":2753695744,"capacity":"35.88%","total":"4.00 GiB","total_bytes":4294537216,"used":"1.44 GiB","used_bytes":1540841472}},"memoryfree":"2.56 GiB","memoryfree_mb":2626.12890625,"memorysize":"4.00 GiB","memorysize_mb":4095.58984375,"mtu_Ethernet":1500,"netmask":"255.255.255.0","netmask6":"ffff:ffff:ffff:ffff::","netmask6_Ethernet":"ffff:ffff:ffff:ffff::","netmask_Ethernet":"255.255.255.0","network":"192.168.0.0","network6":"fe80::%12","network6_Ethernet":"fe80::%12","network_Ethernet":"192.168.0.0","networking":{"dhcp":"192.168.0.3","domain":"platform9.puppet.net","fqdn":"win-2012-0.platform9.puppet.net","hostname":"win-2012-0","interfaces":{"Ethernet":{"bindings":[{"address":"192.168.0.5","netmask":"255.255.255.0","network":"192.168.0.0"}],"bindings6":[{"address":"fe80::402f:43bf:4d05:dc56%12","netmask":"ffff:ffff:ffff:ffff::","network":"fe80::%12"}],"dhcp":"192.168.0.3","ip":"192.168.0.5","ip6":"fe80::402f:43bf:4d05:dc56%12","mac":"FA:16:3E:3E:87:ED","mtu":1500,"netmask":"255.255.255.0","netmask6":"ffff:ffff:ffff:ffff::","network":"192.168.0.0","network6":"fe80::%12"}},"ip":"192.168.0.5","ip6":"fe80::402f:43bf:4d05:dc56%12","mac":"FA:16:3E:3E:87:ED","mtu":1500,"netmask":"255.255.255.0","netmask6":"ffff:ffff:ffff:ffff::","network":"192.168.0.0","network6":"fe80::%12","primary":"Ethernet"},"operatingsystem":"windows","operatingsystemmajrelease":"2012 R2","operatingsystemrelease":"2012 R2","os":{"architecture":"x64","family":"windows","hardware":"x86_64","name":"windows","release":{"full":"2012 R2","major":"2012 R2"},"windows":{"system32":"C:\\windows\\system32"}},"osfamily":"windows","path":"C:/Program Files/Puppet Labs/Puppet/puppet/lib/ruby/vendor_ruby/../../../bin;C:/Program Files/Puppet Labs/Puppet/puppet/lib/ruby/vendor_ruby/../../../../puppet/bin;C:\\windows\\system32;C:\\windows;C:\\windows\\System32\\Wbem;C:\\windows\\System32\\WindowsPowerShell\\v1.0\\;C:\\Program Files\\Puppet Labs\\Puppet\\bin;C:\\Program Files\\Puppet Labs\\Puppet\\bin\\;C:\\Program Files\\Puppet Labs\\Puppet\\puppet\\bin;C:\\Program Files\\Puppet Labs\\Puppet\\sys\\ruby\\bin\\","physicalprocessorcount":2,"processor0":"Intel Core Processor (Haswell)","processor1":"Intel Core Processor (Haswell)","processorcount":2,"processors":{"count":2,"isa":"x64","models":["Intel Core Processor (Haswell)","Intel Core Processor (Haswell)"],"physicalcount":2},"productname":"OpenStack Nova","puppetversion":"6.0.2","ruby":{"platform":"x64-mingw32","sitedir":"C:/Program Files/Puppet Labs/Puppet/puppet/lib/ruby/site_ruby/2.5.0","version":"2.5.1"},"rubyplatform":"x64-mingw32","rubysitedir":"C:/Program Files/Puppet Labs/Puppet/puppet/lib/ruby/site_ruby/2.5.0","rubyversion":"2.5.1","serialnumber":"3c2513f4-b791-4ce7-9b2f-558c71093ec7","system32":"C:\\windows\\system32","system_uptime":{"days":22,"hours":536,"seconds":1930394,"uptime":"22 days"},"timezone":"Coordinated Universal Time","uptime":"22 days","uptime_days":22,"uptime_hours":536,"uptime_seconds":1930394,"virtual":"openstack","clientcert":"win-2012-0.platform9.puppet.net","clientversion":"6.0.2","clientnoop":false}} Finished: task apply_helpers::custom_facts with 0 failures in 4.44 sec Finished: install puppet and gather facts with 0 failures in 6.92 sec Starting: apply catalog on winrm://10.234.1.11 Compiling manifest block on ["winrm://10.234.1.11"] Applying manifest block on ["winrm://10.234.1.11"] {"tags":["settings"],"name":"10.234.1.11","version":1543359121,"code_id":null,"catalog_uuid":"d8a653d6-e11f-40f7-8d6f-41bbd3335521","catalog_format":1,"environment":"bolt_catalog","resources":[{"type":"Stage","title":"main","tags":["stage","class"],"exported":false,"parameters":{"name":"main"}},{"type":"Class","title":"Settings","tags":["class","settings"],"exported":false},{"type":"Class","title":"main","tags":["class"],"exported":false,"parameters":{"name":"main"}},{"type":"Notify","title":"hello","tags":["notify","hello","class"],"line":1,"exported":false}],"edges":[{"source":"Stage[main]","target":"Class[Settings]"},{"source":"Stage[main]","target":"Class[main]"},{"source":"Class[main]","target":"Notify[hello]"}],"classes":["settings"]} [{"node":"winrm://10.234.1.11","status":"success","result":{"report":{"host":"win-2012-0.platform9.puppet.net","time":"2018-11-27T22:52:06.647865000+00:00","configuration_version":1543359121,"transaction_uuid":null,"report_format":10,"puppet_version":"6.0.2","status":"changed","transaction_completed":true,"noop":false,"noop_pending":false,"environment":null,"logs":[{"level":"notice","message":"hello","source":"Puppet","tags":["notice"],"time":"2018-11-27T22:52:06.747192000+00:00","file":null,"line":null},{"level":"notice","message":"defined 'message' as 'hello'","source":"/Stage[main]/Main/Notify[hello]/message","tags":["notice","notify","hello","class"],"time":"2018-11-27T22:52:06.747980000+00:00","file":null,"line":1},{"level":"notice","message":"Applied catalog in 0.02 seconds","source":"Puppet","tags":["notice"],"time":"2018-11-27T22:52:06.762385000+00:00","file":null,"line":null}],"metrics":{"resources":{"name":"resources","label":"Resources","values":[["total","Total",1],["skipped","Skipped",0],["failed","Failed",0],["failed_to_restart","Failed to restart",0],["restarted","Restarted",0],["changed","Changed",1],["out_of_sync","Out of sync",1],["scheduled","Scheduled",0],["corrective_change","Corrective change",0]]},"time":{"name":"time","label":"Time","values":[["notify","Notify",0.001107],["config_retrieval","Config retrieval",0],["transaction_evaluation","Transaction evaluation",0.004387150052934885],["catalog_application","Catalog application",0.01828193198889494],["total","Total",0.041707]]},"changes":{"name":"changes","label":"Changes","values":[["total","Total",1]]},"events":{"name":"events","label":"Events","values":[["total","Total",1],["failure","Failure",0],["success","Success",1]]}},"resource_statuses":{"Notify[hello]":{"title":"hello","file":null,"line":1,"resource":"Notify[hello]","resource_type":"Notify","provider_used":null,"containment_path":["Stage[main]","Main","Notify[hello]"],"evaluation_time":0.001107,"tags":["notify","hello","class"],"time":"2018-11-27T22:52:06.746955000+00:00","failed":false,"failed_to_restart":false,"changed":true,"out_of_sync":true,"skipped":false,"change_count":1,"out_of_sync_count":1,"events":[{"audited":false,"property":"message","previous_value":"absent","desired_value":"hello","historical_value":null,"message":"defined 'message' as 'hello'","name":"message_changed","status":"success","time":"2018-11-27T22:52:06.747130000+00:00","redacted":null,"corrective_change":false}],"corrective_change":false}},"corrective_change":false,"catalog_uuid":"d8a653d6-e11f-40f7-8d6f-41bbd3335521","cached_catalog_status":"not_used"},"_output":"changed: 1, failed: 0, unchanged: 0 skipped: 0, noop: 0"}}] Finished: apply catalog with 0 failures in 10.78 sec Finished on 10.234.1.11: changed: 1, failed: 0, unchanged: 0 skipped: 0, noop: 0 Successful on 1 node: winrm://10.234.1.11 Ran on 1 node [reidmv@halcyon:~/src/puppet/] % The -verbose output should ideally be more useful and consumable. A very easy step in that direction would be to prettify the JSON output, either by default when using -format=human, or optionally somehow. Add Comment   This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.