salt.beacons.status module¶

The status beacon is intended to send a basic health check event up to the master, this allows for event driven routines based on presence to be set up.

The intention of this beacon is to add the config options to add monitoring stats to the health beacon making it a one stop shop for gathering systems health and status data

To configure this beacon to use the defaults, set up an empty dict for it in the minion config:

beacons:
  status: []

By default, all of the information from the following execution module functions will be returned:

• loadavg

• cpustats

• meminfo

• vmstats

• time

You can also configure your own set of functions to be returned:

beacons:
  status:
    - time:
      - all
    - loadavg:
      - all

You may also configure only certain fields from each function to be returned. For instance, the loadavg function returns the following fields:

• 1-min

• 5-min

• 15-min

If you wanted to return only the 1-min and 5-min fields for loadavg then you would configure:

beacons:
  status:
    - loadavg:
      - 1-min
      - 5-min

Other functions only return a single value instead of a dictionary. With these, you may specify all or 0. The following are both valid:

beacons:
  status:
    - time:
      - all

beacons:
  status:
    - time:
      - 0

If a status function returns a list, you may return the index marker or markers for specific list items:

beacons:
  status:
    - w:
      - 0
      - 1
      - 2

salt.beacons.status.beacon(config)¶

Return status for requested information

salt.beacons.status.validate(config)¶

Validate the config is a dict