mwarkentin / django-watchman

django-watchman exposes a status endpoint for your backing services like databases, caches, etc.
BSD 3-Clause "New" or "Revised" License
524 stars 62 forks source link

Docs for new comers: Calling side of django-watchman #97

Open guettli opened 7 years ago

guettli commented 7 years ago

I think it would help new comers, if you could tell some words about the "calling side" of django-watchman. I mean the client which calls the http end point and which collects and acts on the reported status messages.

I know that this is not the job of django-watchman, but it helps new comers to understand the big picture.

mwarkentin commented 7 years ago

@guettli Thanks for the suggestion! I agree that this would be really helpful - it would be nice to have configuration instructions for pingdom, panopta, and so on.

If I have some time I'll try to add some documentation, and of course contributions are always welcome!

stale[bot] commented 6 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

guettli commented 6 years ago

I know that new features look far more appealing than new comer friendly docs. Nevertheless I still think that new comer friendly docs containing a "big picture" are the key to success.

mwarkentin commented 6 years ago

@guettli I have to agree with you there - I've made sure this issue won't be closed as stale. Any chance you're interested in helping to get that sort of doc started? Even a rough outline of what you think the main pieces might be would be helpful.

guettli commented 6 years ago

@mwarkentin thank you for looking at this issue again. Up to now I don't use django-watchman since we have not decided which tool we want to use to collect the results. That's why I am curious what you suggest :-)

mwarkentin commented 6 years ago

Ok makes sense. Personally I’ve used both Pingdom and more recently Panopta. Both have worked well for us.

Seems like it would make sense to have an “integrations” section to the doc where it could walk through the configuration for various services.

mwarkentin commented 2 years ago

Some integrations we could document:

Upptime
UptimeRobot: Free Website Monitoring Service
Start monitoring in 30 seconds. Use advanced SSL, keyword and cron monitoring. Get notified by email, SMS, Slack and more. Get 50 monitors for FREE!
StatusCake
StatusCake - Uptime monitoring, Page speed monitoring, and more
Website Monitoring solution that drives revenue & keeps you online. Track your uptime, page speed, domain, server, & SSL certificates.
pingdom.com
Website Performance and Availability Monitoring | Pingdom
We help you gain instant insights into your website’s availability and performance so that you can outsmart competition with an amazing end-user experience.
Panopta
Panopta: Centralized IT Operations Management Platform
Empower your organization with centralized IT operations management. Eliminate IT tool sprawl with monitoring, incident response and automation in one platform.
updown.io – Website monitoring, simple and inexpensive
ϟ Website monitoring — beautiful, simple and inexpensive.
Simple monitoring for any application | Cron Monitoring | Website Monitoring | & more | Cronitor
Monitor and understand your critical cron jobs, background tasks, websites, APIs and more. Instant alerts when something goes wrong. Free 14 day trial.
Better Uptime - Free Web Monitoring & Status Page
Radically better uptime monitoring platform with phone call alerts, status pages, and incident management built-in. Free plan included!