insights-core Documentation Release 3.0.7 Author Mar 27, 2018 Contents 1 Red Hat Insights 3 1.1 Introduction...............................................3 1.1.1 Insights Client - Collection...................................4 1.1.2 Red Hat Insights Core - Data Analysis Engine.........................4 1.1.3 Plugin Components - Parsing and Fact Analysis........................5 1.1.3.1 Parser Plugins.....................................5 1.1.3.2 Combiner Plugins...................................5 1.1.3.3 Rule Plugins......................................5 1.1.4 Customer Interface - Analysis Results.............................5 2 Quickstart Insights Development7 2.1 Prerequisites...............................................8 2.2 Rule Development Setup.........................................8 2.3 Contributor Setup............................................8 2.4 Contributor Submissions.........................................9 2.5 Style Conventions............................................9 2.5.1 Code Style...........................................9 2.5.2 Commit Message Style..................................... 10 2.5.3 Documentation......................................... 10 2.6 Review Checklist............................................. 10 2.6.1 General (all submissions).................................... 10 2.6.2 Parsers.............................................. 11 3 Insights API 13 3.1 Input Data Formats............................................ 13 3.1.1 SoSReports........................................... 13 3.1.2 Insights Archives........................................ 13 3.2 Execution Model............................................. 14 3.3 Parsers.................................................. 14 3.3.1 Choosing a Module....................................... 14 3.3.2 Defining Parsers......................................... 14 3.3.3 Registration and Symbolic Names............................... 14 3.3.4 Parser Contexts......................................... 15 3.3.5 Parser Outputs......................................... 15 3.4 Rule Plugins............................................... 16 3.4.1 Rule Context.......................................... 16 3.4.2 Rule Output........................................... 16 i 3.5 Testing.................................................. 17 3.6 Feature Deprecation........................................... 17 3.6.1 Functions............................................ 18 3.6.2 Class methods.......................................... 18 3.6.3 Class.............................................. 18 4 Components and Exceptions 19 4.1 Case 1 all Data is Parsed as Expected.................................. 19 4.2 Case 2 Data is Unparsable........................................ 19 4.3 Case 3 Unparsable Data Provides Useful Information.......................... 20 4.3.1 Case 3a Parsable Data having Some Errors........................... 20 4.3.2 Case 3b Parsing Data to Find Errors (“Dirty Parser”)..................... 20 4.4 Other Exceptions from Parsers...................................... 20 4.5 SkipComponent and SkipException................................... 20 4.6 Exception Recognition by the Insights Engine............................. 21 5 API Documentation 23 5.1 insights.core............................................... 23 5.2 insights.core.context........................................... 35 5.3 insights.core.plugins........................................... 37 5.4 insights.parsers.............................................. 38 5.5 insights.tests............................................... 44 5.6 insights.util................................................ 46 6 Shared Parsers Catalog 53 6.1 Alternatives - command /usr/bin/alternatives output.................... 53 6.2 audit_log - File /var/log/audit/audit.log .......................... 55 6.3 AuditdConf - file /etc/audit/auditd.conf ........................... 56 6.4 AutoFSConf - file /etc/autofs.conf ............................... 56 6.5 BlockIDInfo - command blkid ..................................... 57 6.6 Bond - file /proc/net/bonding .................................. 58 6.7 BrctlShow - command brctl show .................................. 60 6.8 catalina_log - Log files for Tomcat.................................... 61 6.9 Cciss - Files /proc/driver/cciss/cciss* ........................... 63 6.10 CeilometerConf - file /etc/ceilometer/ceilometer.conf ................. 64 6.11 Ceilometer logs.............................................. 65 6.11.1 CeilometerCentralLog - file /var/log/ceilometer/central.log ......... 65 6.11.2 CeilometerCollectorLog - file /var/log/ceilometer/collector.log ....... 65 6.12 Ceph status commands.......................................... 67 6.12.1 CephOsdDump - command ceph osd dump -f json-pretty ............ 67 6.12.2 CephOsdDf - command ceph osd df -f json-pretty ............... 67 6.12.3 CephS - command ceph -s -f json-pretty ...................... 67 6.12.4 CephDfDetail - command ceph osd erasure-code-profile get default -f json-pretty ...................................... 67 6.12.5 CephHealthDetail - command ceph daemon {ceph_socket_files} config show .............................................. 67 6.12.6 CephECProfileGet - command ceph health detail -f json-pretty ...... 67 6.12.7 CephCfgInfo - command ceph df detail -f json-pretty ............ 67 6.12.8 CephOsdTree - command ceph osd tree -f json-pretty ............. 67 6.13 CephOsdLog - file var/log/ceph/ceph-osd.*.log ...................... 73 6.14 CephVersion - command /usr/bin/ceph -v ............................ 74 6.15 CertificatesEnddate - command /usr/bin/openssl x509 -noout -enddate -in path/to/cert/file ........................................ 74 6.16 checkin.conf - Files /etc/splice/checkin.conf ........................ 75 ii 6.17 ChkConfig - command chkconfig .................................. 76 6.18 Pacemaker configuration - file /var/lib/pacemaker/cib/cib.xml .............. 78 6.19 Cinder configuration - file /etc/cinder/cinder.conf ..................... 79 6.20 CinderVolumeLog - file /var/log/cinder/volume.log .................... 80 6.21 ClusterConf - file /etc/cluster/cluster.conf ........................ 81 6.22 CmdLine - File /proc/cmdline ................................... 81 6.23 Cobbler modules configuration - file /etc/cobbler/modules.conf .............. 82 6.24 Cobbler settings - /etc/cobbler/settings file......................... 83 6.25 SystemD service configuration...................................... 83 6.25.1 SystemdDocker - file /usr/lib/systemd/system/docker.service ....... 83 6.25.2 SystemdOpenshiftNode - file /usr/lib/systemd/system/ atomic-openshift-node.service .......................... 83 6.25.3 SystemdSystemConf - file /etc/systemd/system.conf ................ 83 6.26 CoroSyncConfig - file /etc/sysconfig/corosync ........................ 86 6.27 CpuInfo - file /proc/cpuinfo .................................... 87 6.28 Crontab listings.............................................. 89 6.28.1 CrontabL base class....................................... 89 6.28.2 HeatCrontab - command crontab -l -u heat ..................... 90 6.28.3 KeystoneCrontab - command crontab -l -u keystone ................ 91 6.28.4 RootCrontab - command crontab -l -u root ..................... 91 6.29 CurrentClockSource - file /sys/devices/system/clocksource/clocksource0/ current_clocksource ....................................... 91 6.30 Date parsers............................................... 92 6.30.1 Date - command date ..................................... 92 6.30.2 DateUTC - command dateutc ................................ 92 6.31 Dcbtool - Command /sbin/dcbtool gc {interface} dcb ................. 93 6.32 Disk free space commands........................................ 94 6.32.1 DiskFree_LI - command df -li ............................... 94 6.32.2 DiskFree_ALP - command df -alP ............................. 94 6.32.3 DiskFree_AL - command df -al ............................... 94 6.33 389 Directory Server logs........................................ 98 6.33.1 DirSrvAccessLog - files var/log/dirsrv/.*/access ................. 98 6.33.2 DirSrvErrorsLog - files var/log/dirsrv/.*/errors ................. 98 6.34 dirsrv_sysconfig - file /etc/sysconfig/dirsrv ......................... 100 6.35 DMesgLineList - command dmesg ................................... 100 6.36 DMIDecode - Command dmidecode ................................. 102 6.37 docker_host_machineid_parser - File /etc/redhat-access-insights/machine-id ... 104 6.38 DockerInspect - Command docker inspect --type={TYPE} ................. 104 6.39 DockerList - command /usr/bin/docker (images|ps) .................... 105 6.40 DockerStorageSetup - file /etc/sysconfig/docker-storage-setup ............ 107 6.41 DockerInfo - Comand /usr/bin/docker info .......................... 107 6.42 DumpE2FS - Command dumpe2fs -h ................................ 108 6.43 engine_config - command engine-config --all ......................... 109 6.44 EngineLog - file var/log/ovirt-engine/engine.log .................... 112 6.45 Ethtool parsers.............................................. 113 6.45.1 CoalescingInfo - command /sbin/ethtool -c {interface} ............ 113 6.45.2 Driver - command /sbin/ethtool -i {interface} ................. 113 6.45.3 Ethtool - command /sbin/ethtool {interface} ................... 113 6.45.4 Features - command /sbin/ethtool -k {interface} ................ 113 6.45.5 Pause - command /sbin/ethtool -a {interface} ................. 113 6.45.6