Contributor Guide

All the information you need to start contributing to Hotsos.

Language Reference

Hotsos has its own YAML-based language used to write analysis. Using propertree mappings it provides a library of properties that can be used to implement analysis.

• Internals
  • Data Root
  • Property Overrides
  • Property Scope
  • MappedProperties
  • Context
  • PropertyCache
  • LogicalGroupings
  • FactoryClasses
• Principle Properties
  • Vars
  • Checks
  • Conclusions
  • Requires
• Shared Properties
  • Input
  • Search
• Requirement Types
  • Path
  • Property
  • Apt
  • Snap
  • Pebble
  • Systemd
  • Config
  • Varops

Writing Checks

• Background
• Pre-requisites

Scenarios

• Scenarios Overview
• Example Scenario

Events

• Events Overview
• Event Callbacks
• Examples

Testing

• Testing Checks
  • Writing tests in Yaml
  • Test Reference
  • Running Tests
  • Troubleshooting Tests