Skip to main content

aind_watchdog_service

Usage

Watchdog runs in the background (see deployment), and watches a directory for newly-created yaml files containing instructions to transfer files.

On a computer where the watchdog service is running, manifests can be submitted by creating a file in the right folder. To do this in your software, pip install aind-watchdog-service and use the aind_watchdog_service.models.ManifestConfig object to write your manifest file in the proper format. See the examples/ folder in this repo for more details.

Configuration

Watchdog is configured using SIPE's configuration zookeeper server. The configuration options are listed in /src/aind_watchdog_service/models/watch_config.py.

Monitoring

Watchdog logs can be monitored from the main SIPE logserver (http://eng-logtools:8080/?channel_filter=watchdog&hide=location,count) or this grafana dashboard.

Deployment

Deployment in the institute is handled by SIPE systems engineers, submit a SIPE Request if you need watchdog installed somewhere.

Github actions are used to compile aind-watchdog-service into an executable using pyinstaller. This executable is attached to a Github Release and uploaded to SIPE's software /releases storage, where it can be deployed to rigs in the institute.

Watchdog should be deployed on a SIPE-accessible rig via the install-aind_watchdog_service.yml ansible script. This will download the app and set up a windows scheduled task to run the service. By default, the scheduled task includes a nightly restart at 11:30pm. If the task is running, the scheduler will kill the old instance and start the new one - due to how task scheduler force kills processes, the death of an old process will not generate a stop log.

Testing

Watchdog has a bundled test function that will create some dummy data on the rig and create a manifest file to transfer that data. Once Run it with the below commands:

cd "C://Program Files/AIBS_MPE/aind_watchdog_service"
aind_watchdog_service.exe --test

It will print something like the following:

Data created at C:\ProgramData\AIBS_MPE\aind_watchdog_service\logs\test_data
Manifest created at C:\Users\svc_mpe\Documents\aind_watchdog_service\manifest\test_manifest_2024-11-15_17-31-25.yml

Make sure that the running instance of watchdog picks up the manifest and completes the transfer.

Development

Clone the repo Install dependencies with uv sync --extra service --extra dev Run the service with uv run src/aind_watchdog_service/main.py

(If not using uv, use pip install .[service] and python src/aind_watchdog_service/main.py)

Metadata

Release files for aind-watchdog-service 0.1.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aind-watchdog-service 0.1.10
File Size Uploaded Provenance Actions
aind_watchdog_service-0.1.10.tar.gz 394.3 kB Without provenance Details for aind_watchdog_service-0.1.10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aind-watchdog-service 0.1.10
File Interpreter ABI Platform Actions
aind_watchdog_service-0.1.10-py3-none-any.whl Python 3 none any Details for aind_watchdog_service-0.1.10-py3-none-any.whl

Total release size: 442.8 kB

Release files / aind_watchdog_service-0.1.10.tar.gz

Download URL aind_watchdog_service-0.1.10.tar.gz
Size 394.3 kB
Tags Source
SHA-256 checksum
How to use checksums
a39f3cda00ca8f09f325d04441f19a1a9682ccdc21fe067fa5e3e8f8f3ac2c5f
BLAKE2b-256 checksum
How to use checksums
21573310fd9de6d9237e6b0c5e224cfb529448a49b0d8be4fbfaebde796bc4a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / aind_watchdog_service-0.1.10-py3-none-any.whl

Download URL aind_watchdog_service-0.1.10-py3-none-any.whl
Size 48.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3887b38187f9e2f314f2266cb0ce11de10c5bc59dde0a624d2043787e35cd7e7
BLAKE2b-256 checksum
How to use checksums
5a3b4df9267864747761bc875cc85c26e84015aa53402d3fcec730fe952ebb97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for aind-watchdog-service 0.1.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page