Skip to content

Commit

Permalink
Update readme and snapcraft.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
dosaboy committed Dec 2, 2024
1 parent c6ebd96 commit 1ab5900
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Hotsos

Use hotsos to implement repeatable analysis and extract useful information from common cloud applications and subsystems. Write analysis Scenarios using a high-level language and helpful Python libraries. A catalog of analysis implementations is included.
Use hotsos to implement repeatable analysis and extract useful information from common cloud applications and subsystems. Write analysis *Scenarios* in YAML using a high-level language and helpful Python libraries. A catalog of analysis implementations is included.

The design of hotsos is oriented around “plugins” that provide easy access to the state of applications and subsystems. Hotsos is run against a Data Root which can either be the host it is run on or a sosreport. The output is a summary containing key information from each plugin along with any issuses or known bugs detected and suggestions on what actions can be taken to handle them.
Hotsos is plugin-oriented, providing easy access to the state of applications and subsystems. Hotsos is run against a *Data Root* which can either be the host it is run on or a sosreport. Output is a summary of key information from each plugin along with issuses or known bugs detected and suggestions on what actions can be taken to handle them.

## Documentation

Expand Down
18 changes: 15 additions & 3 deletions snap/snapcraft.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
name: hotsos
adopt-info: hotsos
summary: Collect application operational information.
description:
Software analysis toolkit. Define checks in high-level language and leverage
library to perform analysis of common Cloud applications.
description: |
Use hotsos to implement repeatable analysis and extract useful information
from common cloud applications and subsystems. Write analysis Scenarios in
YAML using a high-level language and helpful Python libraries. A catalog of
analysis implementations is included.
Hotsos is plugin-oriented, providing easy access to the state of
applications and subsystems. Hotsos is run against a Data Root which can
either be the host it is run on or a sosreport. Output is a summary of key
information from each plugin along with issuses or known bugs detected and
suggestions on what actions can be taken to handle them.
Installation and Usage: https://hotsos.readthedocs.io/en/latest/install/index.html
Contributing: https://hotsos.readthedocs.io/en/latest/contrib/index.html
Full documentation: https://hotsos.readthedocs.io/en/latest/
confinement: strict
grade: stable
base: core22
Expand Down

0 comments on commit 1ab5900

Please sign in to comment.