Skip to content

Latest commit

 

History

History
24 lines (12 loc) · 898 Bytes

HOW_TO.md

File metadata and controls

24 lines (12 loc) · 898 Bytes
Raw

How Tos

Advanced guides for working with Atoparser. For basic guides, refer to the README.

Table Of Contents

Add a new version

  1. Copy the previous struct definition in atoparser/atop_structs/ to a new file by the <major>_<minor> version.

  2. Update any individual struct definitions as needed. Additional guidelines for this process outlined in the files.

  3. Update the atoparser/utils.py file to include the new version in the imports and _VERSIONS list.

  4. Use the utils/build_atop.sh script to generate a new sample Atop log file, and place in atoparser/test/files/.

  5. Compress the new log with gzip to reduce storage overhead.

  6. Add new tests to atoparser/test/test_atoparser.py to ensure the new version is parsed correctly.

  7. Update the README.md file to include the new supported version.