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

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

# 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 os
import yaml

from sos.report.plugins import Plugin, UbuntuPlugin

SNAP_COMMON_PATH = "/var/snap/charmed-postgresql/common"
SNAP_CURRENT_PATH = "/var/snap/charmed-postgresql/current"

PATHS = {
    "POSTGRESQL_CONF": SNAP_COMMON_PATH + "/var/lib/postgresql",
    "POSTGRESQL_LOGS": SNAP_COMMON_PATH + "/var/log/postgresql",
    "PATRONI_CONF": SNAP_CURRENT_PATH + "/etc/patroni",
    "PATRONI_LOGS": SNAP_COMMON_PATH + "/var/log/patroni",
    "PGBACKREST_CONF": SNAP_CURRENT_PATH + "/etc/pgbackrest",
    "PGBACKREST_LOGS": SNAP_COMMON_PATH + "/var/log/pgbackrest",
    "PGBOUNCER_CONF": SNAP_CURRENT_PATH + "/etc/pgbouncer",
    "PGBOUNCER_LOGS": SNAP_COMMON_PATH + "/var/log/pgbouncer",
}

PATRONI_CONFIG_FILE = f"{PATHS['PATRONI_CONF']}/patroni.yaml"

RUNAS = "snap_daemon"
PSQL = "charmed-postgresql.psql"
PATRONICTL = "charmed-postgresql.patronictl"

class CharmedPostgreSQL(Plugin, UbuntuPlugin):

short_desc = "Charmed PostgreSQL"
    plugin_name = "charmed_postgresql"
    packages = ('charmed-postgresql',)

@property
    def patronictl_args(self) -> str:
        return f"--config-file {PATRONI_CONFIG_FILE}"

@property
    def psql_args(self) -> str:
        return (f"-U {self.postgresql_username} "
                f"-h {self.postgresql_host} "
                f"-p {self.postgresql_port} "
                r"-d postgres -P pager=off")

def setup(self):
        # --- FILE EXCLUSIONS ---

# Keys and certificates
        self.add_forbidden_path([
            f"{PATHS['PATRONI_CONF']}/*.pem",
            f"{PATHS['PGBOUNCER_CONF']}/*.pem",
        ])

# --- FILE INCLUSIONS ---

self.add_copy_spec([
            f"{PATHS['POSTGRESQL_CONF']}/*.conf*",
            f"{PATHS['POSTGRESQL_LOGS']}",
            f"{PATHS['PATRONI_CONF']}/*.y*ml",
            f"{PATHS['PATRONI_LOGS']}",
            f"{PATHS['PGBACKREST_CONF']}",
            f"{PATHS['PGBACKREST_LOGS']}",
            f"{PATHS['PGBOUNCER_CONF']}",
            f"{PATHS['PGBOUNCER_LOGS']}",
        ])

# --- SNAP LOGS ---

self.add_journal("snap.charmed-postgresql.*")

# --- SNAP INFO ---

self.add_cmd_output(
            "snap info charmed-postgresql",
            suggest_filename="snap-info",
        )

# Read and parse patroni config, finish setup if there are errors
        try:
            with open(PATRONI_CONFIG_FILE, encoding='utf-8') as f:
                patroni_config = yaml.safe_load(f)
            self.patroni_cluster_name = patroni_config["scope"]
            postgresql = patroni_config["postgresql"]
            host_port = postgresql["connect_address"].split(":")
            self.postgresql_host, self.postgresql_port = host_port
            authentication = postgresql["authentication"]
            superuser = authentication["superuser"]
            self.postgresql_username = superuser["username"]
            self.postgresql_password = superuser["password"]
        except (OSError, yaml.YAMLError, TypeError,
                ValueError, KeyError, AttributeError) as error:
            self._log_warn("Can not run additional commands due to "
                           "an error on opening or parsing the config file "
                           f"{PATRONI_CONFIG_FILE}: "
                           f'{error}')
            return

# --- TOPOLOGY ---

self.add_cmd_output(
            (f"{PATRONICTL} {self.patronictl_args} "
             f"topology {self.patroni_cluster_name}"),
            suggest_filename="patroni-topology",
            runas=RUNAS,
        )

# --- HISTORY ---

self.add_cmd_output(
            (f"{PATRONICTL} {self.patronictl_args} "
             f"history {self.patroni_cluster_name}"),
            suggest_filename="patroni-history",
            runas=RUNAS,
        )

# --- DCS CONFIGS ---

self.add_cmd_output(
            (f"{PATRONICTL} {self.patronictl_args} "
             f"show-config {self.patroni_cluster_name}"),
            suggest_filename="patroni-dcs-config",
            runas=RUNAS,
        )

# ADD DB PASSWORD TO ENVIRONMENT
        os.environ["PGPASSWORD"] = self.postgresql_password

# --- DATABASES ---

self.add_cmd_output(
            (f"{PSQL} {self.psql_args} "
             r"-c '\l+'"),
            suggest_filename="postgresql-databases",
            runas=RUNAS,
        )

# --- USERS ---

self.add_cmd_output(
            (f"{PSQL} {self.psql_args} "
             r"-c '\duS+'"),
            suggest_filename="postgresql-users",
            runas=RUNAS,
        )

# --- TABLES ---

self.add_cmd_output(
            (f"{PSQL} {self.psql_args} "
             r"-c '\dtS+'"),
            suggest_filename="postgresql-tables",
            runas=RUNAS,
        )

def postproc(self):

# REMOVE DB PASSWORD FROM ENVIRONMENT
        if "PGPASSWORD" in os.environ:
            del os.environ["PGPASSWORD"]

# --- SCRUB PASSWORDS ---

# Match lines containing password: and
        # followed by anything which may be enclosed with "
        self.do_path_regex_sub(
            f"{PATHS['PATRONI_CONF']}/*",
            r'(password: )"?.*"?',
            r'\1"*********"',
        )

# https://pgbackrest.org/configuration.html#section-repository/option-repo-s3-key
        # https://pgbackrest.org/configuration.html#section-repository/option-repo-s3-key-secret
        self.do_path_regex_sub(
            f"{PATHS['PGBACKREST_CONF']}/pgbackrest.conf",
            r'(.*s3-key.*=).*',
            r'\1*********',
        )

# https://www.pgbouncer.org/config.html#authentication-file-format
        self.do_path_regex_sub(
            f"{PATHS['PGBOUNCER_CONF']}/pgbouncer/userlist.txt",
            r'(".*" )".*"',
            r'\1"*********"',
        )

[+] ..
[-] 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]