diff options
author | Jake Hunsaker <jhunsake@redhat.com> | 2020-04-27 14:57:12 -0400 |
---|---|---|
committer | Jake Hunsaker <jhunsake@redhat.com> | 2020-05-29 13:06:36 -0400 |
commit | ad037308df9c08879918b5e4cf7481d7a71bbe0f (patch) | |
tree | 98e9eba441510d1f70daef2855526530101ad825 /docs/policies.rst | |
parent | 6150afbbc7db76743553b7284d382f4ce8b99d94 (diff) | |
download | sos-ad037308df9c08879918b5e4cf7481d7a71bbe0f.tar.gz |
[component|collect|report] Add metadata collection
Adds facilities to capture metadata information about a particular sos
run, and save it to any resulting archive as `manifest.json`. This
manifest will include component-specific information that should assist
in analysis of sos runs.
For `report`, this is an extension of existing reporting functionality,
that records information on a per-plugin basis regarding command output
and file collection. However, more information is recorded in this
collection than the JSON or HTML reporting structures that review a
finished archive.
Manifest data is added at the time of collection; for commands this includes
a breakout of command, parameters, full execution syntax, filepath relative
to archive root, and the actual return code of the command, even if non-zero.
For files, the copied files are grouped by the specification set in
`add_copy_spec()` calls, I.E. for any file pattern regex that collects
at least one file, all files collected by that regex are listed.
Additionally, this adds a `tags` parameter to `add_copy_spec()`,
`add_cmd_output()`, and `collect_cmd_output()` that if used will add
tagging information to the manifest entries for those collections. This
is intended to assist in future sos work (E.G. `sos examine`) and third
party utilities in identifying relevant/connected data that is present
in the archive. Note that all collections specified by a single call to
any of these collection methods will inherit the same tags.
For `collect` we now record the cluster type, node list, and a separate
entry for each node in the node list that includes the sos version, node
sos policy, and the archive within the collect tarball that was
collected for that host.
Closes: #1990
Resolves: #2050
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'docs/policies.rst')
0 files changed, 0 insertions, 0 deletions