README
¶
Warnly
Exception monitoring system, designed specifically for self-hosting
About
·
Demo
·
Documentation
·
Developing
About
Error logs should be categorized into issues, with each issue assigned to the appropriate team member. In an ideal scenario, a well-functioning application should operate silently. Warnly, in line with Sentry's best practices, address this effectively.
Enterprise-focused solutions tend to prioritize complex features that create unnecessary overhead for self-hosting scenarios. There's an opportunity to take the core monitoring functionality and package it into a single binary that eliminates operational complexity while maintaining essential features. That's how Warnly was born: an open-source project designed specifically for self-hosting.
For more details, see About Warnly.
Demo
Try the demo application at https://demo.warnly.io. Use username admin and password admin to sign in. The infrastructure is graciously provided by VPSDime.
Documentation
See the documentation on the Warnly website.
Roadmap and Status
The high-level plan for warnly, in order:
| # | Step | Status |
|---|---|---|
| 1 | Backend exception monitoring | ⚠️ |
| 2 | Mobile and frontend exception monitoring | ❌ |
| 3 | Swappable storage | ❌ |
| 4 | SLO and flexible alerting rules | ❌ |
| N | Fancy features (to be expanded upon later) | ❌ |
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
warnly
command
|
|
|
internal
|
|
|
ch
Package ch provides a ClickHouse connection utility.
|
Package ch provides a ClickHouse connection utility. |
|
chprometheus
Package chprometheus provides a Prometheus collector for ClickHouse connection pool statistics.
|
Package chprometheus provides a Prometheus collector for ClickHouse connection pool statistics. |
|
kafka
Package kafka provides a Kafka integration for Warnly.
|
Package kafka provides a Kafka integration for Warnly. |
|
migrator
Package migrator provides functionality to manage database migrations.
|
Package migrator provides functionality to manage database migrations. |
|
mock
Package mock contains mock implementations of various interfaces.
|
Package mock contains mock implementations of various interfaces. |
|
mysql
Package mysql provides a connection to MySQL database with a connection pool.
|
Package mysql provides a connection to MySQL database with a connection pool. |
|
notifier
Package notifier implements webhook notifications.
|
Package notifier implements webhook notifications. |
|
server
Package server provides HTTP handlers and middlewares for application.
|
Package server provides HTTP handlers and middlewares for application. |
|
session
Package session provides session management functionality, including secure cookies, session storage, and session encoding/decoding using CBOR and secure cookies.
|
Package session provides session management functionality, including secure cookies, session storage, and session encoding/decoding using CBOR and secure cookies. |
|
stdlog
Package stdlog provides a logger implementation using the standard library's slog package used as adapter for logging interfaces.
|
Package stdlog provides a logger implementation using the standard library's slog package used as adapter for logging interfaces. |
|
svc/alert
Package alert provides the implementation of the warnly.AlertService interface.
|
Package alert provides the implementation of the warnly.AlertService interface. |
|
svc/event
Package event provides the implementation of the event service.
|
Package event provides the implementation of the event service. |
|
svc/initializer
Package initializer initializes warnly for the first time.
|
Package initializer initializes warnly for the first time. |
|
svc/notification
Package notification provides the implementation of the warnly.NotificationService interface.
|
Package notification provides the implementation of the warnly.NotificationService interface. |
|
svc/project
Package project provides the implementation of the ProjectService interface, which includes methods for managing projects, issues, and teams.
|
Package project provides the implementation of the ProjectService interface, which includes methods for managing projects, issues, and teams. |
|
svc/session
Package session provides the implementation of the SessionService interface, which includes methods for user authentication and session management.
|
Package session provides the implementation of the SessionService interface, which includes methods for user authentication and session management. |
|
svc/system
Package system provides the implementation of the SystemService interface, which includes methods for listing slow queries, schemas, and errors.
|
Package system provides the implementation of the SystemService interface, which includes methods for listing slow queries, schemas, and errors. |
|
svcotel
Package svcotel provides OpenTelemetry tracer provider interface and a no-op implementation.
|
Package svcotel provides OpenTelemetry tracer provider interface and a no-op implementation. |
|
uow
Package uow provides an interface in which the "repositories" that participate on it are asure that the functions/actions that are called will be rollback if the Unit of Work fails at some point.
|
Package uow provides an interface in which the "repositories" that participate on it are asure that the functions/actions that are called will be rollback if the Unit of Work fails at some point. |
|
warnly
Package warnly provides the core types and interfaces for the Warnly application.
|
Package warnly provides the core types and interfaces for the Warnly application. |
|
web
templ: version: v0.3.1001
|
templ: version: v0.3.1001 |
|
worker
Package worker provides background workers for processing alerts.
|
Package worker provides background workers for processing alerts. |
|
Package migrations provides database migration utilities and embedded migration files.
|
Package migrations provides database migration utilities and embedded migration files. |
Click to show internal directories.
Click to hide internal directories.