Skip to main content

health checks module

Project description


Bravo! You have received a Medical Diploma in "jumpsuit" from
the Orbital Convergence University International Air and Water Embassy of the Tangerine Planet.

You are now officially certified to include "jumpsuit" in your practice.


jumpsuit


description

This is a module that can reliably ascertain the health status of software.

(It's like a testing framework)


install

[ZSH] pip install jumpsuit


documentation (this opens a server process that sends HTML)

[ZSH] jumpsuit shares


internal status tests of the module

[ZSH] jumpsuit internal-status

These checks are run with pypi "body_scan"
"jumpsuit" is built from a fork of "body_scan"
("body_scan" checks are written with "unittest")


Tutorial

  • Checks are started simultaneously, unless "--simultaneous no"

Create a status file (glob pattern "**/status_*.py").

(The glob pattern can be modified with the progammatic python3 interface)

# status_1.py

def check_1 ():
	print ("check 1")
	
def check_2 ():
	print ("check 2")
	
def check_3 ():
	raise Exception ("not 110%")

checks = {
	"check 1": check_1,
	"check 2": check_2,
	"check 3": check_3
}

from a directory deeper than the status file "status_1.py"

[ZSH] jumpsuit status

This is the equivalent of: [ZSH] jumpsuit status --glob-string "**/status_*.py"

The report then should appear like this

paths: [
	{
		"path": "../status_1.py",
		"empty": false,
		"parsed": true,
		"stats": {
			"passes": 2,
			"alarms": 1
		},
		"checks": [
			{
				"check": "check 1",
				"passed": true,
				"elapsed": [
					4.054199962411076e-05,
					"seconds"
				]
			},
			{
				"check": "check 2",
				"passed": true,
				"elapsed": [
					1.72930003827787e-05,
					"seconds"
				]
			},
			{
				"check": "check 3",
				"passed": false,
				"exception": "Exception('not 110%')",
				"exception trace": [
					"Traceback (most recent call last):",
					"  File \"/home/veganecology/.local/lib/python3.11/site-packages/jumpsuit/processes/scan/process/keg/check.py\", line 68, in start",
					"    checks [ check ] ()",
					"  File \"<string>\", line 13, in check_3",
					"Exception: not 110%"
				]
			}
		]
	}
]
alarms: [
	{
		"path": "../status_1.py",
		"checks": [
			{
				"check": "check 3",
				"passed": false,
				"exception": "Exception('not 110%')",
				"exception trace": [
					"Traceback (most recent call last):",
					"  File \"/home/veganecology/.local/lib/python3.11/site-packages/jumpsuit/processes/scan/process/keg/check.py\", line 68, in start",
					"    checks [ check ] ()",
					"  File \"<string>\", line 13, in check_3",
					"Exception: not 110%"
				]
			}
		]
	}
]
stats: {
	"alarms": 0,
	"empty": 0,
	"checks": {
		"passes": 2,
		"alarms": 1
	}
}

Advanced Tutorial

It's recommended to run jumpsuit programmatilly.

An example of this can be found in the "_book/advanced tutorial"
section of the documentation.


Contacts

bgrace2468@pm.me

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jumpsuit-1.0.0.tar.gz (78.0 kB view details)

Uploaded Source

File details

Details for the file jumpsuit-1.0.0.tar.gz.

File metadata

  • Download URL: jumpsuit-1.0.0.tar.gz
  • Upload date:
  • Size: 78.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for jumpsuit-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b7416ec2e6f1bdf9cfe987d4bf70ad4a5e6980e173904d2ee148baabfcc11001
MD5 4c866a9201064e6f757cf3b1c16818ff
BLAKE2b-256 016ca5e537adfb904a5fdad6a868cb524a51c4cb61c4f933416333d43d837353

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page