%PDF-
%PDF-
Mini Shell
Mini Shell
#!/usr/bin/env python3
# Copyright (C) 2017 Canonical Ltd.
#
# This file is part of cloud-init. See LICENSE file for license information.
"""Define 'collect-logs' utility and handler to include in cloud-init cmd."""
import argparse
import os
import shutil
import subprocess
import sys
from datetime import datetime
from pathlib import Path
from typing import NamedTuple
from cloudinit.cmd.devel import read_cfg_paths
from cloudinit.helpers import Paths
from cloudinit.stages import Init
from cloudinit.subp import ProcessExecutionError, subp
from cloudinit.temp_utils import tempdir
from cloudinit.util import (
chdir,
copy,
ensure_dir,
get_config_logfiles,
write_file,
)
CLOUDINIT_RUN_DIR = "/run/cloud-init"
class ApportFile(NamedTuple):
path: str
label: str
INSTALLER_APPORT_SENSITIVE_FILES = [
ApportFile(
"/var/log/installer/autoinstall-user-data", "AutoInstallUserData"
),
ApportFile("/autoinstall.yaml", "AutoInstallYAML"),
ApportFile("/etc/cloud/cloud.cfg.d/99-installer.cfg", "InstallerCloudCfg"),
]
INSTALLER_APPORT_FILES = [
ApportFile("/var/log/installer/ubuntu_desktop_installer.log", "UdiLog"),
ApportFile(
"/var/log/installer/subiquity-server-debug.log", "SubiquityServerDebug"
),
ApportFile(
"/var/log/installer/subiquity-client-debug.log", "SubiquityClientDebug"
),
ApportFile("/var/log/installer/curtin-install.log", "CurtinLog"),
# Legacy single curtin config < 22.1
ApportFile(
"/var/log/installer/subiquity-curtin-install.conf",
"CurtinInstallConfig",
),
ApportFile(
"/var/log/installer/curtin-install/subiquity-initial.conf",
"CurtinConfigInitial",
),
ApportFile(
"/var/log/installer/curtin-install/subiquity-curthooks.conf",
"CurtinConfigCurtHooks",
),
ApportFile(
"/var/log/installer/curtin-install/subiquity-extract.conf",
"CurtinConfigExtract",
),
ApportFile(
"/var/log/installer/curtin-install/subiquity-partitioning.conf",
"CurtinConfigPartitioning",
),
# Legacy curtin < 22.1 curtin error tar path
ApportFile("/var/log/installer/curtin-error-logs.tar", "CurtinError"),
ApportFile("/var/log/installer/curtin-errors.tar", "CurtinError"),
ApportFile("/var/log/installer/block/probe-data.json", "ProbeData"),
]
def _get_user_data_file() -> str:
paths = read_cfg_paths()
return paths.get_ipath_cur("userdata_raw")
def _get_cloud_data_path() -> str:
paths = read_cfg_paths()
return paths.get_cpath("data")
def get_parser(parser=None):
"""Build or extend and arg parser for collect-logs utility.
@param parser: Optional existing ArgumentParser instance representing the
collect-logs subcommand which will be extended to support the args of
this utility.
@returns: ArgumentParser with proper argument configuration.
"""
if not parser:
parser = argparse.ArgumentParser(
prog="collect-logs",
description="Collect and tar all cloud-init debug info",
)
parser.add_argument(
"--verbose",
"-v",
action="count",
default=0,
dest="verbosity",
help="Be more verbose.",
)
parser.add_argument(
"--tarfile",
"-t",
default="cloud-init.tar.gz",
help=(
"The tarfile to create containing all collected logs."
" Default: cloud-init.tar.gz"
),
)
user_data_file = _get_user_data_file()
parser.add_argument(
"--include-userdata",
"-u",
default=False,
action="store_true",
dest="userdata",
help=(
"Optionally include user-data from {0} which could contain"
" sensitive information.".format(user_data_file)
),
)
return parser
def _copytree_rundir_ignore_files(curdir, files):
"""Return a list of files to ignore for /run/cloud-init directory"""
ignored_files = [
"hook-hotplug-cmd", # named pipe for hotplug
]
if os.getuid() != 0:
# Ignore root-permissioned files
ignored_files.append(Paths({}).lookups["instance_data_sensitive"])
return ignored_files
def _write_command_output_to_file(cmd, filename, msg, verbosity):
"""Helper which runs a command and writes output or error to filename."""
ensure_dir(os.path.dirname(filename))
try:
output = subp(cmd).stdout
except ProcessExecutionError as e:
write_file(filename, str(e))
_debug("collecting %s failed.\n" % msg, 1, verbosity)
else:
write_file(filename, output)
_debug("collected %s\n" % msg, 1, verbosity)
return output
def _stream_command_output_to_file(cmd, filename, msg, verbosity):
"""Helper which runs a command and writes output or error to filename."""
ensure_dir(os.path.dirname(filename))
try:
with open(filename, "w") as f:
subprocess.call(cmd, stdout=f, stderr=f)
except OSError as e:
write_file(filename, str(e))
_debug("collecting %s failed.\n" % msg, 1, verbosity)
else:
_debug("collected %s\n" % msg, 1, verbosity)
def _debug(msg, level, verbosity):
if level <= verbosity:
sys.stderr.write(msg)
def _collect_file(path, out_dir, verbosity):
if os.path.isfile(path):
copy(path, out_dir)
_debug("collected file: %s\n" % path, 1, verbosity)
else:
_debug("file %s did not exist\n" % path, 2, verbosity)
def collect_installer_logs(log_dir, include_userdata, verbosity):
"""Obtain subiquity logs and config files."""
for src_file in INSTALLER_APPORT_FILES:
destination_dir = Path(log_dir + src_file.path).parent
if not destination_dir.exists():
ensure_dir(str(destination_dir))
_collect_file(src_file.path, str(destination_dir), verbosity)
if include_userdata:
for src_file in INSTALLER_APPORT_SENSITIVE_FILES:
destination_dir = Path(log_dir + src_file.path).parent
if not destination_dir.exists():
ensure_dir(str(destination_dir))
_collect_file(src_file.path, str(destination_dir), verbosity)
def collect_logs(tarfile, include_userdata: bool, verbosity=0):
"""Collect all cloud-init logs and tar them up into the provided tarfile.
@param tarfile: The path of the tar-gzipped file to create.
@param include_userdata: Boolean, true means include user-data.
"""
if include_userdata and os.getuid() != 0:
sys.stderr.write(
"To include userdata, root user is required."
" Try sudo cloud-init collect-logs\n"
)
return 1
init = Init(ds_deps=[])
tarfile = os.path.abspath(tarfile)
log_dir = datetime.utcnow().date().strftime("cloud-init-logs-%Y-%m-%d")
with tempdir(dir="/tmp") as tmp_dir:
log_dir = os.path.join(tmp_dir, log_dir)
version = _write_command_output_to_file(
cmd=["cloud-init", "--version"],
filename=os.path.join(log_dir, "version"),
msg="cloud-init --version",
verbosity=verbosity,
)
dpkg_ver = _write_command_output_to_file(
cmd=["dpkg-query", "--show", "-f=${Version}\n", "cloud-init"],
filename=os.path.join(log_dir, "dpkg-version"),
msg="dpkg version",
verbosity=verbosity,
)
if not version:
version = dpkg_ver if dpkg_ver else "not-available"
print("version: ", version)
_debug("collected cloud-init version: %s\n" % version, 1, verbosity)
_stream_command_output_to_file(
cmd=["dmesg"],
filename=os.path.join(log_dir, "dmesg.txt"),
msg="dmesg output",
verbosity=verbosity,
)
_stream_command_output_to_file(
cmd=["journalctl", "--boot=0", "-o", "short-precise"],
filename=os.path.join(log_dir, "journal.txt"),
msg="systemd journal of current boot",
verbosity=verbosity,
)
init.read_cfg()
for log in get_config_logfiles(init.cfg):
_collect_file(log, log_dir, verbosity)
if include_userdata:
user_data_file = _get_user_data_file()
_collect_file(user_data_file, log_dir, verbosity)
collect_installer_logs(log_dir, include_userdata, verbosity)
run_dir = os.path.join(log_dir, "run")
ensure_dir(run_dir)
if os.path.exists(CLOUDINIT_RUN_DIR):
try:
shutil.copytree(
CLOUDINIT_RUN_DIR,
os.path.join(run_dir, "cloud-init"),
ignore=_copytree_rundir_ignore_files,
)
except shutil.Error as e:
sys.stderr.write("Failed collecting file(s) due to error:\n")
sys.stderr.write(str(e) + "\n")
_debug("collected dir %s\n" % CLOUDINIT_RUN_DIR, 1, verbosity)
else:
_debug(
"directory '%s' did not exist\n" % CLOUDINIT_RUN_DIR,
1,
verbosity,
)
if os.path.exists(os.path.join(CLOUDINIT_RUN_DIR, "disabled")):
# Fallback to grab previous cloud/data
cloud_data_dir = Path(_get_cloud_data_path())
if cloud_data_dir.exists():
shutil.copytree(
str(cloud_data_dir),
Path(log_dir + str(cloud_data_dir)),
)
with chdir(tmp_dir):
subp(["tar", "czvf", tarfile, log_dir.replace(tmp_dir + "/", "")])
sys.stderr.write("Wrote %s\n" % tarfile)
return 0
def handle_collect_logs_args(name, args):
"""Handle calls to 'cloud-init collect-logs' as a subcommand."""
return collect_logs(args.tarfile, args.userdata, args.verbosity)
def main():
"""Tool to collect and tar all cloud-init related logs."""
parser = get_parser()
return handle_collect_logs_args("collect-logs", parser.parse_args())
if __name__ == "__main__":
sys.exit(main())
Zerion Mini Shell 1.0