PyObservability 0.0.1

Lightweight OS-agnostic observability UI for PyNinja

PyObservability

Platform Supported

Deployments

Kick off

Recommendations

• Install python 3.11 or above
• Use a dedicated virtual environment

Install PyObservability

python -m pip install pyobservability

Initiate - IDE

import pyobservability


if __name__ == '__main__':
    pyobservability.start()

Initiate - CLI

pyobservability start

Use pyobservability --help for usage instructions.

Environment Variables

Sourcing environment variables from an env file

By default, PyObservability will look for a .env file in the current working directory. Other file options are supported with a custom kwarg or env var env_file pointing to the filepath.

Mandatory

• TARGETS - Target URLs running PyNinja in the following format.
  • TARGETS='[{"name":"node1","base_url":"http://192.168.1.10:8000","apikey":"token1"},{"name":"node2","base_url":"http://192.168.1.11:8000"}]'

Defaults

• HOST - Host IP to run PyObservability. Defaults to 127.0.0.1 or 0.0.0.0
• PORT - Port number to run PyObservability. Defaults to 8080
• INTERVAL - Polling interval to retrieve server information.

Optional

• USERNAME - Username to authenticate the monitoring page.
• PASSWORD - Password to authenticate the monitoring page.

License & copyright

© Vignesh Rao

Licensed under the MIT License