Metadata-Version: 2.4
Name: os4d-birder
Version: 2.0
Summary: Healthcheck and uptime system monitoring platform
Project-URL: Docker Image, https://hub.docker.com/repository/docker/os4d/birder/general
Project-URL: Documentation, https://os4d.github.io/birder/
Project-URL: Homepage, https://github.com/os4d/birder
Project-URL: Issues, https://github.com/ os4d/birder/issues
Project-URL: Pypi Home, https://pypi.org/project/os4d-birder/
Project-URL: Repository, https://github.com/os4d/birder
Author-email: mark <hanarero@gmail.com>, sax <s.apostolico@gmail.com>
License: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Requires-Python: ==3.12.*
Requires-Dist: attrs>=24.3
Requires-Dist: beautifulsoup4>=4.12.3
Requires-Dist: bitarray>=3
Requires-Dist: boto3>=1.35.90
Requires-Dist: celery>=5.4
Requires-Dist: channels-redis>=4.2.1
Requires-Dist: channels>=4.2
Requires-Dist: circus>=0.18
Requires-Dist: click>=8.1.8
Requires-Dist: daphne>=4.1.2
Requires-Dist: django-admin-extra-buttons>=1.6
Requires-Dist: django-adminfilters>=2.5.2
Requires-Dist: django-constance>=4.1.3
Requires-Dist: django-csp>=3.8
Requires-Dist: django-dramatiq>=0.12
Requires-Dist: django-environ>=0.11.2
Requires-Dist: django-fernet-encrypted-fields>=0.3
Requires-Dist: django-flags>=5.0.13
Requires-Dist: django-markdown-deux>=1.0.6
Requires-Dist: django-redis>=5.4
Requires-Dist: django-regex>=0.5
Requires-Dist: django-strategy-field>=3.1
Requires-Dist: django-stubs>=5.2
Requires-Dist: django-tailwind>=3.8
Requires-Dist: django-timezone-field>=7
Requires-Dist: django-valkey[libvalkey]>=0.1.8
Requires-Dist: django>=5.2
Requires-Dist: djangorestframework>=3.15.2
Requires-Dist: dramatiq-crontab[sentry]>=1.0.8
Requires-Dist: dramatiq>=1.17.1
Requires-Dist: durations-nlp>=1.0.1
Requires-Dist: flower>=2.0.1
Requires-Dist: jmespath>=1.0.1
Requires-Dist: kombu>=5.4.2
Requires-Dist: ldap3>=2.9.1
Requires-Dist: lxml>=5.3
Requires-Dist: minio>=7.2.13
Requires-Dist: pandas>=2.2.3
Requires-Dist: pexpect>=4.9
Requires-Dist: pip>=24.3.1
Requires-Dist: prometheus-client==0.20
Requires-Dist: psycopg2-binary>=2.9.10
Requires-Dist: pymemcache>=4
Requires-Dist: pymysql>=1.1.1
Requires-Dist: python-redis-lock[django]>=4
Requires-Dist: pytz>=2024.2
Requires-Dist: redis-timeseries>=0.1.9
Requires-Dist: redis>=5.2.1
Requires-Dist: requests>=2.32.3
Requires-Dist: sentry-sdk>=2.19.2
Requires-Dist: social-auth-app-django>=5.4.2
Requires-Dist: tabulate>=0.9
Requires-Dist: valkey[libvalkey]>=6.0.2
Description-Content-Type: text/markdown

# Birder

---

[![Test](https://github.com/os4d/birder/actions/workflows/test.yml/badge.svg)](https://github.com/os4d/birder/actions/workflows/test.yml)
[![Lint](https://github.com/os4d/birder/actions/workflows/lint.yml/badge.svg)](https://github.com/os4d/birder/actions/workflows/lint.yml)
[![codecov](https://codecov.io/github/os4d/birder/graph/badge.svg?token=FBUB7HML5S)](https://codecov.io/github/os4d/birder)
[![Documentation](https://github.com/os4d/birder/actions/workflows/docs.yml/badge.svg)](https://os4d.github.io/birder/)
[![Docker Pulls](https://img.shields.io/docker/pulls/os4d/birder)](https://hub.docker.com/repository/docker/os4d/birder/tags)
[![Pypi](https://badge.fury.io/py/os4d-birder.svg)](https://badge.fury.io/py/os4d-birder)

![screenshot](https://github.com/os4d/birder/blob/develop/docs/src/img/screenshot.png?raw=true)
![screenshot](https://github.com/os4d/birder/blob/develop/docs/src/img/smtp.png?raw=true)


Birder is an Open source service uptime monitor.
It is not intended to be a replacement of Nagios or other system administrator's monitoring tools,
it has been designed to be simple and easy do deploy on any environment,
its audience is web site users to display SLA compliance and systems availability.

It is provided both as [Python package](https://pypi.org/project/os4d-birder/) as well as [Docker Image](https://hub.docker.com/repository/docker/os4d/birder/general)

## Supported Checkers

 - http/https
 - Postgres/Postgis
 - Redis
 - RabbitMQ / AMQP
 - MySQL/MariaDB
 - MemCached
 - SSH
 - FTP
 - SMTP
 - LDAP / ActiveDirectory

### Specialised Checkers

 - JSON
 - XML
 - Celery (workers running not only broker)


## Contributing

Test locally:

    docker compose -f services-compose.yml down
    ./manage.py upgrade
    ./manage.py demo
    ./manage.py runserver
