Skip to main content

Get sosreport dynflow files and generates user friendly html pages for tasks, plans, actions and steps

Project description

dynflowparser

Reads the dynflow files from a sosreport and generates user friendly html pages for Tasks, Plans, Actions and Steps. Companion command dynflowparser-export-tasks helps to overcome sosreport file size limitations. (Read Limitations below)

  • Only unsuccessful Tasks are parsed by default. (Use '-a' to parse all).
  • Failed Actions & Steps are automatically expanded on the Plan page for easy error location.
  • Indented Actions & Steps json fields.
  • Useful data on header: Hostname, Timezone, Satellite version, RAM, CPU, Tuning.
  • Dynflow UTC dates are automatically converted to honor sosreport timezone according to "/sos_commands/systemd/timedatectl".
  • Automatically opens output on default browser.
  • Lynx friendly.
Tasks list Task details Lynx

Dependencies

Required python libraries:

  • Jinja2>=3.1.3
  • python_dateutil>=2.8.2

Installation

pip install dynflowparser

dynflowparser Usage

usage: dynflowparser [-h] [-a] [-d {D,I,W,E}] [-f DATEFROM] [-t DATETO] [-n] [-q] [sosreport_path] [output_path]

Get sosreport dynflow files and generates user friendly html pages for tasks, plans, actions and steps

positional arguments:
  sosreport_path        Path to sos report folder. Default is current path.
  output_path           Output path. Default is './dynflowparser/'.

optional arguments:
  -h, --help            show this help message and exit
  -a, --all             Parse all. By default only unsuccess plans are parsed.
  -d {D,I,W,E}, --debug {D,I,W,E}
                        Debug level. Default 'W'
  -f DATEFROM, --from DATEFROM
                        Parse only Plans that were running from this datetime.
  -t DATETO, --to DATETO
                        Parse only Plans that were running up to this datetime.
  -n, --nosql           Reuse existent sqlite file. (Useful for development).
  -q, --quiet           Quiet. Don't show progress bar.

dynflowparser-export-tasks Usage

This command must be executed on the Foreman server.

usage: dynflowparser-export-tasks [-h] [-d DAYS] [-f FILTER] [-r {cancelled,error,pending,success,warning}] [-s {paused,planning,pending,running,scheduled,stopped}]

Create a Foreman task-export compressed file.

options:
  -h, --help            show this help message and exit
  -d DAYS, --days DAYS  Number of days to export. By default last 14 days.
  -f FILTER, --filter FILTER
                        Filter query. E.g: label LIKE '%Manifest%'.
  -r {cancelled,error,pending,success,warning}, --result {cancelled,error,pending,success,warning}
                        Filter by Task Result.
  -s {paused,planning,pending,running,scheduled,stopped}, --state {paused,planning,pending,running,scheduled,stopped}
                        Filter by Task State.

Limitations

  • sosreport by default requests last 14 days.
  • sosreport truncates output files at 100M, hence some records could be missing.
  • Only Dynflow schema version 24 is supported. (v20 is not CSV compliant)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dynflowparser-0.1.4.tar.gz (612.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dynflowparser-0.1.4-py3-none-any.whl (128.2 kB view details)

Uploaded Python 3

File details

Details for the file dynflowparser-0.1.4.tar.gz.

File metadata

  • Download URL: dynflowparser-0.1.4.tar.gz
  • Upload date:
  • Size: 612.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for dynflowparser-0.1.4.tar.gz
Algorithm Hash digest
SHA256 1ac22ba584512eb7e71a78044ab249ae9bf4e95674a30e5fe82e05de4f06dba6
MD5 6ad6c896a3befcdff9c00bbc2350274c
BLAKE2b-256 c0d9f026156fcbea2d96af22c91dc3373e3cd27516a38b1ecbd7d5dd7957b9de

See more details on using hashes here.

Provenance

The following attestation bundles were made for dynflowparser-0.1.4.tar.gz:

Publisher: publish-pypi.yml on pafernanr/dynflowparser

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dynflowparser-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: dynflowparser-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 128.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for dynflowparser-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c5fa7e1047214f57730571d5d299cfad025a17d364ef4e2e3bc7e1ba3f0cf664
MD5 24ad98b9387930df051cacccd626bc22
BLAKE2b-256 5a07771be11b4fe933a4e9bbe302605664fd004ef6b7f4198c12b23e9e55600a

See more details on using hashes here.

Provenance

The following attestation bundles were made for dynflowparser-0.1.4-py3-none-any.whl:

Publisher: publish-pypi.yml on pafernanr/dynflowparser

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page