@totemstan/dogs

DOGS

DOGS provides DEBE watchdogs.

Manage

npm install @totemstan/dogs		# install
npm run start [ ? | $ | ...]	# Unit test
npm run verminor				# Roll minor version
npm run vermajor				# Roll major version
npm run redoc					# Regen documentation

Usage

Require, optionally configure and start DOGS:

const DOGS = require("dogs").config({
	key: value, 						// set key
	"key.key": value, 					// indexed set
	"key.key.": value					// indexed append
});

where configuration keys follow ENUMS deep copy conventions

Program Reference

Open/Close

WATCHDOGS

Define DEBE watchdogs:

sql => {  // watchdog
	const { ... } = site;  	// pull required site info
	// do your thing
}

This module documented in accordance with jsdoc.

Requires: module:enums

• WATCHDOGS
  • .repos()
  • .daily()
  • .weekly()
  • .system()
  • .detectors()
  • .bricks()
  • .catalog()
  • .licenses()
  • .voxels()
  • .cache()
  • .jobs()
  • .email()
  • .clients()
  • .news()
  • .notebooks()
  • .users()

WATCHDOGS.repos()

Repository watchdog

Kind: static method of WATCHDOGS

WATCHDOGS.daily()

Daily watchdog to distribute email updates

Kind: static method of WATCHDOGS

WATCHDOGS.weekly()

Weekly watchdog to distribute email updates

Kind: static method of WATCHDOGS

WATCHDOGS.system()

System health and utilization watchdog

Kind: static method of WATCHDOGS

WATCHDOGS.detectors()

Detector training stats watchdog

Kind: static method of WATCHDOGS

WATCHDOGS.bricks()

Data brick ingesting watchdog

Kind: static method of WATCHDOGS

WATCHDOGS.catalog()

Reserved watchdog for building mater catalogs

Kind: static method of WATCHDOGS

WATCHDOGS.licenses()

Watchdog for monitoring code licenses

Kind: static method of WATCHDOGS

WATCHDOGS.voxels()

Watchdog for monitoring data voxels

Kind: static method of WATCHDOGS

WATCHDOGS.cache()

Watchdog for monitoring data cache

Kind: static method of WATCHDOGS

WATCHDOGS.jobs()

Watchdog for monitoring notebook jobs

Kind: static method of WATCHDOGS

WATCHDOGS.email()

Watchdog for monitoring email

Kind: static method of WATCHDOGS

WATCHDOGS.clients()

Watchdog for monitoring client profiles

Kind: static method of WATCHDOGS

WATCHDOGS.news()

Watchdog for creating system news

Kind: static method of WATCHDOGS

WATCHDOGS.notebooks()

Watchdog for monitoring notebook usage

Kind: static method of WATCHDOGS

WATCHDOGS.users()

Watchdog for monitoring system users

Kind: static method of WATCHDOGS

Contacting, Contributing, Following

Feel free to

• submit and status TOTEM issues
• contribute to TOTEM notebooks
• revise TOTEM requirements
• browse TOTEM holdings
• or follow TOTEM milestones

License

MIT

© 2012 ACMESDS