silverbackhq/silverback

🧬 A Status and Incident Communication Tool (Beta Version).

Silverback

A Status and Incident Communication Tool.

Silverback is a free and open source project for web infrastructure, developer APIs, services and SaaS companies to set up their very own status page in minutes.

Overview

• Auto Installer.
• User management with different roles.
• Services and service groups statuses.
• Uptime charts for services and service groups.
• Incidents and incident updates management.
• Metrics with third party integrations (NewRelic and more ...).
• Subscriber notifications via email, SMS, customer endpoint, RSS feed and Atom Feed.
• Asynchronous workers for subscriber notifications with ability to run any number to scale.
• Realtime administration dashboard.
• Multilingual.
• Easy Theme System! Easily give silverback a complete makeover.
• and much more ...

Installation

• Install for Development Purposes.
• Install on Ubuntu 18.04.
• Install on Docker Compose.
• Install on Kubernetes.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Silverback is maintained under the Semantic Versioning guidelines and release process is predictable and business-friendly.

See the Releases section of our GitHub project for changelogs for each release version of Silverback. It contains summaries of the most noteworthy changes made in each release. Also see the Milestones section for the future roadmap.

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/silverbackhq/silverback/issues

Security Issues

If you discover a security vulnerability within Silverback, please send an email to [email protected]

Contributing

We are an open source, community-driven project so please feel free to join us. see the contributing guidelines for more details.

Credits

Shoutout to these awesome open source projects and their maintainers.

• Django.
• Celery.
• Requests.
• Tabler.
• VueJs.
• and other projects ...

License

© 2019, Silverback. Released under Apache License, Version 2.0.

Silverback is authored and maintained by @silverbackhq.

silverback's Issues

Build Admin/Users Dashboard

• Admin:
  • Users Count.
  • Incidents Count.
• User:

Validation Layer

• Optional Fields.
• Description Fields.
• Title / Name / Subject Fields.
• Markdown Fields.

Count Delivery Success & Failures from Notification Table

Add Twilio for SMS Delivery

Show Notifications on Notification Page like Activity

Async Jobs Engine Enhancements 🐊

• Fully Functional.
• Able to Manage Errors.

Incident Update Notification Engine.

Add Health Check Command & Route

• Skelton.
• check_db.
• check_io.
• check_workers ping-pong check.
• check_cache.

Test Modules.Util Layer

Request Tracing With Correlation Id

StatusPage - History Status Page

Add Activity Tracking.

Incidents / Incident Updates Management

Status Page Redesign 🚀

The status pages need a new design

Incident Update Notification Tracking.

Add Uptime to component groups

Metrics Management

More Logging!

DEBUG: Low level system information for debugging purposes
INFO: General system information
WARNING: Information describing a minor problem that has occurred.
ERROR: Information describing a major problem that has occurred.
CRITICAL: Information describing a critical problem that has occurred.

Currently we log

• Incoming Request.
• Outgoing Response.

All Logs done on middleware layer and controllers

Format --> https://stripe.com/en-nl/blog/canonical-log-lines

Test Models Layer

Ability to upload favicon & Logo

still we need to keep a stateless silverback!

Build the Skeleton

Python
Django
Vuejs
Celery for Async Jobs

Change incident update timing to tz aware

So Input fields should be on APP_TIMEZONE and backend will transfer them to timezone aware and store them on database but on UTC.

These inputs will shown but again will be change from UTC to APP_TIMEZONE

StatusPage - Builder

• Company Name
• Website URL
• Support URL
• Privacy policy URL
• Logo
• Time zone

Add X-axis, Y-axis to metric entries

Create a rocking docs

• Overview
• Features
• Installation
• For Contributors
• Changelog

Show Incident Time on UTC

Deliver Notifications to Subscribers

• Email Subscribers.
• Endpoint Subscribers.
• Mobile Subscribers.

Integrations Roadmap

Scheduled Maintenance

Add scheduled to incidents types

Open Source Silverback 🚀

Components / Groups Management

• Component.
• Component Groups.

Build Metrics Data Source Modules

• NewRelic

Add Highchart for status page charts

Subscribers Management

StatusPage - Single Status Page

Sketch

• Django + Celery.
• Async Engine.
• Auto Installer.
• DB Schema ---> #5
• Team Members Management Invitation Workflow ---> #3
• Global Settings.
  • Google Analytics tracking
• Components / Groups Management ---> #7
  • Name
  • Description
  • Uptime graph based on Incidents
• Incidents Management ---> #9
  • Incident Name
  • Status (Open/Closed).
  • Updates:
    • Message
    • Status (Investigating, Identified, Monitoring, Update, Resolved)
    • Services Affected
    • Time
    • Notify Subscribers
• Incident Update Notification Engine ---> #16
• Incident Update Notification Tracking ---> #15
• Add affected Components to Incident Update ---> #17
• Activity Tracking ---> #10
• Validation Layer ---> #13
• Metrics Management ---> #11
  • Name
  • Description
  • Datasource
• Metrics Datasource Driver for Graphite & Prometheus ---> #23
• Settings for StatusPage & Builder ---> #4
  • Company Name
  • Website URL
  • Support URL
  • Privacy policy URL
  • Logo
  • Time zone
• Subscribers Management ---> #12
  • Emails
  • Phone
  • Endpoint with X-AUTH Token
  • RSS feed
• Admin/Users Dashboard ---> #14
• Control through IMAP (Badger Listen to Email Address).
• More Logging ---> #27

Test Modules.Validation Layer

Database Schema

Add affected Components to Incident Update.

Close Incident when it has a resolved update

Team Members Management

• Create Users.
• Invite Users.

Public API Endpoints

Test Modules.Entity Layer

Silverback Beta Release

• Fix #81
• Fix #82
• Fix #87
• Fix #150
• Fix #80
• Fix #83
• Fix #84

Postponed - [ ] Fix #85
Postponed - [ ] Fix #86

Track most of actions under activity

Update Code to Silverback

Add Affected Component with empty value throw error

Add Affected Component with empty value throw error

Test Modules.Core Layer

Test Modules.Service Layer

Fix Create Token before profile got created

When i update the token before the user has a profile, it will throw error