ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / lib / python3.9 / site-packages / sos / report / plugins

# Copyright (C) 2013 Adam Stokes <adam.stokes@ubuntu.com>
#
# This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.

import pwd
import json
import re
from sos.report.plugins import Plugin, UbuntuPlugin, PluginOpt

class Juju(Plugin, UbuntuPlugin):
    """The Juju plugin is aimed at collecting Juju-related logs,
    configurations, and controller/model state(s).

Logs and agent configuration information (/var/log/juju and /var/lib/juju)
    is collected by default since these are useful for troubleshooting.

The Juju state collection is disabled by default and can be enabled with
    the 'juju-state' option. Collecting Juju state is safe in theory, but it
    does act on the live controller(s)/model(s) and is therefore optional.

The default Juju state collection collects all controllers and models that
    the 'juju-user' (default=ubuntu) has access to.

Specific controllers or models can be collected using the 'controllers'
    and 'models' options.

Important: the string list is whitespace delimited, not colon delimited
    (sos plugin standard). This is due to the underlying Juju CLI accepting
    specific models in the format 'controller:model' and whitespaces are not
    allowed in either controller and model names.

Example: models="controller_a:model_x controller_b:model_y"
    """

short_desc = 'Juju orchestration tool'

plugin_name = 'juju'
    profiles = ('virt', 'sysmgmt',)

# Using files instead of packages here because there is no identifying
    # package on a juju machine.
    files = ('/var/log/juju',)

option_list = [
        PluginOpt(
            "juju-state",
            default=False,
            val_type=bool,
            desc="Include Juju state in the report",
        ),
        PluginOpt(
            "juju-user",
            default="ubuntu",
            val_type=str,
            desc="Juju client user.",
        ),
        PluginOpt(
            "controllers",
            default="",
            val_type=str,
            desc="Collect Juju state for specified controllers. Uses a \
            whitespace delimited list.",
        ),
        PluginOpt(
            "models",
            default="",
            val_type=str,
            desc="Collect Juju state for specified models. Uses a whitespace \
            delimited list.",
        ),
    ]

agent_name = ""

def setup(self):
        # Juju service names are not consistent through deployments,
        # so we need to use a wildcard to get the correct service names.
        for service in self.get_service_names("juju*"):
            self.add_journal(service)
            self.add_service_status(service)

juju_agent_cmds = {
            'juju_engine_report': 'depengine',
            'juju_goroutines': 'debug/pprof/goroutine?debug=1',
            'juju_heap_profile': 'debug/pprof/heap?debug=1',
            'juju_metrics': 'metrics',
            'juju_pubsub_report': 'pubsub',
            'juju_presence_report': 'presence',
            'juju_statepool_report': 'statepool',
            'juju_statetracker_report': ('debug/pprof/juju/state/tracker?'
                                         'debug=1'),
            'juju_unit_status': 'units?action=status',
        }

if self.path_exists("/var/lib/juju/agents"):
            for cmd, agent_cmd in juju_agent_cmds.items():
                self.add_cmd_output(
                    self._juju_agent(agent_cmd),
                    suggest_filename=cmd
                )

# Get agent configs for each agent.
        self.add_copy_spec("/var/lib/juju/agents/*/agent.conf")

# Get a directory listing of /var/log/juju and /var/lib/juju
        self.add_dir_listing([
            '/var/log/juju*',
            '/var/lib/juju*'
        ], recursive=True)

if self.get_option("all_logs"):
            # /var/lib/juju used to be in the default capture moving here
            # because it usually was way to big.  However, in most cases you
            # want all logs you want this too.
            self.add_copy_spec([
                "/var/log/juju",
                "/var/lib/juju",
                "/var/lib/juju/**/.*",
            ])
            self.add_forbidden_path("/var/lib/juju/kvm")
            self.add_forbidden_path("/var/lib/juju/tools")
        else:
            # We need this because we want to collect to the limit of all
            # logs in the directory.
            self.add_copy_spec("/var/log/juju/*.log")

# Only include the Juju state report if this plugin option is set
        if not self.get_option("juju-state"):
            return

juju_user = self.get_option("juju-user")
        try:
            pwd.getpwnam(juju_user)
        except KeyError:
            self._log_warn(
                f'User "{juju_user}" does not exist, '
                "will not collect Juju information."
            )
            return

if self.get_option("controllers") and self.get_option("models"):
            self._log_warn(
                "Options: controllers, models are mutually exclusive. "
                "Will not collect Juju information."
            )
            return

controllers_json = self.collect_cmd_output(
            "juju controllers --format=json", runas=juju_user
        )
        if controllers_json["status"] == 0:
            desired_controllers = set(
                self.get_option("controllers").split(" ")
            )
            # If a controller option is supplied, use it. Otherwise, get all
            #  controllers
            if desired_controllers and desired_controllers != {""}:
                controllers = desired_controllers
            else:
                controllers = set(
                    json.loads(controllers_json["output"])[
                        "controllers"
                    ].keys()
                )
        else:
            controllers = {}

# Specific models
        if self.get_option("models"):
            for model in self.get_option("models").split(" "):
                command = f"juju status -m {model} --format=json"
                self.add_cmd_output(command, runas=juju_user)

# All controllers and all models OR specific controllers and all
        #  models for each
        else:
            for controller in controllers:
                models_json = self.exec_cmd(
                    f"juju models --all -c {controller} --format=json",
                    runas=juju_user,
                )
                if models_json["status"] == 0:
                    models = json.loads(models_json["output"])["models"]
                    for model in models:
                        short_name = model["short-name"]
                        command = (
                            f"juju status -m {controller}:{short_name} "
                            f"--format=json"
                        )
                        self.add_cmd_output(command, runas=juju_user)

def _juju_agent(self, command):
        if self.agent_name == "":
            for dir_name in self.listdir("/var/lib/juju/agents"):
                if re.search('machine-*|controller-*|application-*', dir_name):
                    self.agent_name = dir_name
                    break

return f"juju-introspect --agent={self.agent_name} {command}"

def postproc(self):
        agents_path = "/var/lib/juju/agents/*"
        protect_keys = [
            "sharedsecret",
            "apipassword",
            "oldpassword",
            "statepassword",
        ]

# Redact simple yaml style "key: value".
        keys_regex = fr"(^\s*({'|'.join(protect_keys)})\s*:\s*)(.*)"
        sub_regex = r"\1*********"
        self.do_path_regex_sub(agents_path, keys_regex, sub_regex)

# Redact keys from Nova compute logs
        self.do_path_regex_sub("/var/log/juju/unit-nova-compute-(.*).log*",
                               r"auth\(key=(.*)\)", r"auth(key=******)")

# Redact certificates
        self.do_file_private_sub(agents_path)
        self.do_cmd_private_sub('juju controllers')

# vim: set et ts=4 sw=4 :

[+] ..
[-] freeipmi.py [edit]
[-] chrony.py [edit]
[-] crio.py [edit]
[-] multipath.py [edit]
[-] cman.py [edit]
[-] lxd.py [edit]
[-] xdp.py [edit]
[-] monit.py [edit]
[-] rabbitmq.py [edit]
[-] ssh.py [edit]
[-] cockpit.py [edit]
[-] ctdb.py [edit]
[-] omsa.py [edit]
[-] named.py [edit]
[-] ceph_mds.py [edit]
[-] fibrechannel.py [edit]
[-] openstack_database.py [edit]
[-] oddjob.py [edit]
[-] rhui_containerized.py [edit]
[-] container_log.py [edit]
[-] postgresql.py [edit]
[-] tigervnc.py [edit]
[-] krb5.py [edit]
[-] drbd.py [edit]
[-] procenv.py [edit]
[-] zfs.py [edit]
[-] kubernetes.py [edit]
[-] rpmostree.py [edit]
[-] wireless.py [edit]
[-] veritas.py [edit]
[-] s390.py [edit]
[-] kvm.py [edit]
[-] udev.py [edit]
[-] nis.py [edit]
[-] canonical_livepatch_onprem.py [edit]
[-] hpssm.py [edit]
[-] boom.py [edit]
[-] foreman.py [edit]
[-] firewalld.py [edit]
[-] ovirt.py [edit]
[-] ubuntu.py [edit]
[-] redis.py [edit]
[-] aap_containerized.py [edit]
[-] openstack_masakarimonitors.py [edit]
[-] console.py [edit]
[-] sas3ircu.py [edit]
[-] ebpf.py [edit]
[-] kernel.py [edit]
[-] openstack_ironic.py [edit]
[-] ostree.py [edit]
[-] charmed_mysql.py [edit]
[-] system.py [edit]
[-] salt.py [edit]
[-] ceph_mon.py [edit]
[-] validation_framework.py [edit]
[-] ppp.py [edit]
[-] md.py [edit]
[-] docker.py [edit]
[-] ldap.py [edit]
[-] kpatch.py [edit]
[-] valkey.py [edit]
[-] gluster.py [edit]
[-] microovn.py [edit]
[-] nodejs.py [edit]
[-] shmcli.py [edit]
[-] openstack_heat.py [edit]
[-] azure.py [edit]
[-] teamd.py [edit]
[-] mellanox_firmware.py [edit]
[-] kdump.py [edit]
[-] openstack_sahara.py [edit]
[-] navicli.py [edit]
[-] opendaylight.py [edit]
[-] microcloud.py [edit]
[-] udisks.py [edit]
[-] ovirt_hosted_engine.py [edit]
[-] dhcp.py [edit]
[-] lustre.py [edit]
[-] kimchi.py [edit]
[-] tftpserver.py [edit]
[-] dovecot.py [edit]
[-] mvcli.py [edit]
[-] foreman_installer.py [edit]
[-] cobbler.py [edit]
[-] microshift.py [edit]
[-] opensearch.py [edit]
[-] snapm.py [edit]
[-] ceph_common.py [edit]
[-] pulpcore.py [edit]
[-] charmed_postgresql.py [edit]
[-] etcd.py [edit]
[-] openvswitch.py [edit]
[-] rhui.py [edit]
[-] openstack_horizon.py [edit]
[-] skydive.py [edit]
[-] nvmetcli.py [edit]
[-] bird.py [edit]
[-] oratab.py [edit]
[-] rhcos.py [edit]
[-] symcli.py [edit]
[-] seagate_ses.py [edit]
[-] openstack_instack.py [edit]
[-] npm.py [edit]
[-] ntb.py [edit]
[-] openstack_edpm.py [edit]
[-] smclient.py [edit]
[-] ovn_host.py [edit]
[-] cifs.py [edit]
[-] boot.py [edit]
[-] devices.py [edit]
[-] unity.py [edit]
[-] systemtap.py [edit]
[-] rhc.py [edit]
[-] firewall_tables.py [edit]
[-] omnipath_manager.py [edit]
[-] systemd.py [edit]
[-] ovirt_imageio.py [edit]
[-] dracut.py [edit]
[-] snap.py [edit]
[-] mysql.py [edit]
[-] ultrapath.py [edit]
[-] cs.py [edit]
[-] autofs.py [edit]
[-] date.py [edit]
[-] ceph_osd.py [edit]
[-] xen.py [edit]
[-] stratis.py [edit]
[-] slurm.py [edit]
[-] sudo.py [edit]
[-] pam.py [edit]
[-] openstack_neutron.py [edit]
[-] perccli2.py [edit]
[-] vhostmd.py [edit]
[-] perccli.py [edit]
[-] rasdaemon.py [edit]
[-] snapper.py [edit]
[-] landscape.py [edit]
[-] pci.py [edit]
[-] libvirt.py [edit]
[-] squid.py [edit]
[-] activemq.py [edit]
[-] apport.py [edit]
[-] opencl.py [edit]
[-] nfsganesha.py [edit]
[-] rhv_analyzer.py [edit]
[-] hts.py [edit]
[-] ceph_mgr.py [edit]
[-] grafana.py [edit]
[-] manageiq.py [edit]
[-] sos_extras.py [edit]
[-] filesys.py [edit]
[-] subscription_manager.py [edit]
[-] mpt.py [edit]
[-] aap_hub.py [edit]
[-] microk8s.py [edit]
[-] openstack_aodh.py [edit]
[-] openstack_ansible.py [edit]
[-] sunbeam.py [edit]
[-] rpm.py [edit]
[-] openstack_barbican.py [edit]
[-] snmp.py [edit]
[-] anaconda.py [edit]
[-] unpackaged.py [edit]
[-] ceph_ansible.py [edit]
[-] telegraf.py [edit]
[-] ruby.py [edit]
[-] __init__.py [edit]
[-] xinetd.py [edit]
[-] smartcard.py [edit]
[-] jars.py [edit]
[-] watchdog.py [edit]
[-] collectd.py [edit]
[-] dlm.py [edit]
[-] infinidat.py [edit]
[-] apache.py [edit]
[-] os_net_config.py [edit]
[-] ipvs.py [edit]
[-] arcconf.py [edit]
[-] services.py [edit]
[-] block.py [edit]
[-] openssl.py [edit]
[-] sar.py [edit]
[-] nss.py [edit]
[-] saltmaster.py [edit]
[-] processor.py [edit]
[-] megacli.py [edit]
[-] ufw.py [edit]
[-] curtin.py [edit]
[-] foreman_proxy.py [edit]
[-] ansible.py [edit]
[-] vulkan.py [edit]
[-] pulseaudio.py [edit]
[-] distupgrade.py [edit]
[-] powerpc.py [edit]
[-] btrfs.py [edit]
[-] composer.py [edit]
[-] sunbeam_hypervisor.py [edit]
[-] fail2ban.py [edit]
[-] x11.py [edit]
[-] convert2rhel.py [edit]
[-] openstack_masakari.py [edit]
[-] apparmor.py [edit]
[-] mongodb.py [edit]
[-] openstack_nova.py [edit]
[-] openstack_cinder.py [edit]
[-] spyre.py [edit]
[-] collectl.py [edit]
[-] anacron.py [edit]
[-] tomcat.py [edit]
[-] conntrack.py [edit]
[-] juju.py [edit]
[-] ovirt_node.py [edit]
[-] sendmail.py [edit]
[-] i18n.py [edit]
[-] proxmox.py [edit]
[-] nfs.py [edit]
[-] login.py [edit]
[-] postfix.py [edit]
[-] containerd.py [edit]
[-] lvm2.py [edit]
[-] ptp.py [edit]
[-] apt.py [edit]
[-] aap_receptor.py [edit]
[-] usbguard.py [edit]
[-] python.py [edit]
[-] ovirt_provider_ovn.py [edit]
[-] grub2.py [edit]
[-] iscsi.py [edit]
[-] dbus.py [edit]
[-] ceph_iscsi.py [edit]
[-] radius.py [edit]
[-] aide.py [edit]
[-] cxl.py [edit]
[-] ds.py [edit]
[-] sanlock.py [edit]
[-] openstack_octavia.py [edit]
[-] loki.py [edit]
[-] pcp.py [edit]
[-] opencontrail.py [edit]
[-] sysvipc.py [edit]
[-] vdo.py [edit]
[-] dnf.py [edit]
[-] mssql.py [edit]
[-] acpid.py [edit]
[-] process.py [edit]
[-] pmem.py [edit]
[-] kafka.py [edit]
[-] openhpi.py [edit]
[-] dpkg.py [edit]
[-] hpasm.py [edit]
[-] podman.py [edit]
[-] targetcli.py [edit]
[-] omnipath_client.py [edit]
[-] containers_common.py [edit]
[-] lilo.py [edit]
[-] hyperv.py [edit]
[-] selinux.py [edit]
[-] ntp.py [edit]
[-] zvm.py [edit]
[-] openstack_tripleo.py [edit]
[-] lightdm.py [edit]
[-] cgroups.py [edit]
[-] opensvc.py [edit]
[-] origin.py [edit]
[-] kernelrt.py [edit]
[-] cups.py [edit]
[-] coredump.py [edit]
[-] fwupd.py [edit]
[-] auditd.py [edit]
[-] peripety.py [edit]
[-] grub.py [edit]
[-] libreswan.py [edit]
[-] saphana.py [edit]
[-] nvme.py [edit]
[-] gssproxy.py [edit]
[-] nvidia.py [edit]
[-] openstack_keystone.py [edit]
[-] greenboot.py [edit]
[-] bcache.py [edit]
[-] host.py [edit]
[-] canonical_livepatch.py [edit]
[-] qt.py [edit]
[-] haproxy.py [edit]
[-] keepalived.py [edit]
[-] nscd.py [edit]
[-] dellrac.py [edit]
[-] virtwho.py [edit]
[-] flatpak.py [edit]
[-] helm.py [edit]
[-] java.py [edit]
[-] rear.py [edit]
[-] numa.py [edit]
[-] ovirt_engine_backup.py [edit]
[-] storageconsole.py [edit]
[-] ipmitool.py [edit]
[-] qpid_dispatch.py [edit]
[-] gdm.py [edit]
[-] microshift_ovn.py [edit]
[-] libraries.py [edit]
[-] kata_containers.py [edit]
[-] gfs2.py [edit]
[-] xfs.py [edit]
[-] openstack_placement.py [edit]
[-] hardware.py [edit]
[-] dmraid.py [edit]
[-] cloud_init.py [edit]
[-] memory.py [edit]
[-] fcoe.py [edit]
[-] puppet.py [edit]
[-] openstack_designate.py [edit]
[-] elastic.py [edit]
[-] ceph_rgw.py [edit]
[-] psacct.py [edit]
[-] migration_results.py [edit]
[-] virsh.py [edit]
[-] logrotate.py [edit]
[-] devicemapper.py [edit]
[-] release.py [edit]
[-] storcli.py [edit]
[-] openstack_manila.py [edit]
[-] openshift_ovn.py [edit]
[-] sssd.py [edit]
[-] docker_distribution.py [edit]
[-] quagga.py [edit]
[-] openstack_ceilometer.py [edit]
[-] vsftpd.py [edit]
[-] maas.py [edit]
[-] alternatives.py [edit]
[-] instructlab.py [edit]
[-] vmware.py [edit]
[-] aap_gateway.py [edit]
[-] foreman_openscap.py [edit]
[-] qaucli.py [edit]
[-] cron.py [edit]
[-] logs.py [edit]
[-] iscsitarget.py [edit]
[-] candlepin.py [edit]
[-] openstack_novajoin.py [edit]
[-] pulp.py [edit]
[-] infiniband.py [edit]
[-] openshift.py [edit]
[-] clear_containers.py [edit]
[-] soundcard.py [edit]
[-] openstack_gnocchi.py [edit]
[-] ipa.py [edit]
[-] perl.py [edit]
[-] bootc.py [edit]
[-] authd.py [edit]
[-] ssmtp.py [edit]
[-] openstack_mistral.py [edit]
[+] __pycache__
[-] qpid.py [edit]
[-] openstack_swift.py [edit]
[-] aws.py [edit]
[-] memcached.py [edit]
[-] vectordev.py [edit]
[-] ata.py [edit]
[-] iprconfig.py [edit]
[-] networking.py [edit]
[-] usb.py [edit]
[-] insights.py [edit]
[-] aap_controller.py [edit]
[-] tuned.py [edit]
[-] corosync.py [edit]
[-] scsi.py [edit]
[-] gluster_block.py [edit]
[-] sapnw.py [edit]
[-] samba.py [edit]
[-] gcp.py [edit]
[-] keyutils.py [edit]
[-] vault.py [edit]
[-] buildah.py [edit]
[-] crypto.py [edit]
[-] kea.py [edit]
[-] openstack_glance.py [edit]
[-] nginx.py [edit]
[-] frr.py [edit]
[-] aap_eda.py [edit]
[-] sunrpc.py [edit]
[-] fapolicyd.py [edit]
[-] ovn_central.py [edit]
[-] tpm2.py [edit]
[-] sedutil.py [edit]
[-] opengl.py [edit]
[-] discovery.py [edit]
[-] openstack_trove.py [edit]
[-] lstopo.py [edit]
[-] pacemaker.py [edit]
[-] leapp.py [edit]
[-] vdsm.py [edit]
[-] unbound.py [edit]
[-] networkmanager.py [edit]
[-] powerpath.py [edit]
[-] abrt.py [edit]