From 5c73ecc0b1fdbeeaf76b3bb6a855079578e7e574 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 28 Jan 2026 16:12:10 +0000 Subject: [PATCH] docs: add implementations sections for Monitor, MonitorStatus, and SchedulerMonitor Co-authored-by: JohnRoesler <19351306+JohnRoesler@users.noreply.github.com> --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d7783e3..11ed63d 100644 --- a/README.md +++ b/README.md @@ -171,11 +171,15 @@ The provided NewLogger uses the standard library's log package. ### Metrics Metrics may be collected from the execution of each job and scheduler lifecycle events. - [**Monitor**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#Monitor): -- [**MonitorStatus**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#MonitorStatus) (includes status and error (if any) of the Job) A monitor can be used to collect metrics for each job from a scheduler. - Implementations: There are currently no open source implementations of the Monitor interface available. We'd love for you to be the first to contribute one! Check out the [Monitor interface documentation](https://pkg.go.dev/github.com/go-co-op/gocron/v2#Monitor) to get started, or reach out on [Slack](https://gophers.slack.com/archives/CQ7T0T1FW) if you'd like to discuss your implementation. +- [**MonitorStatus**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#MonitorStatus): +Extends Monitor with status and error tracking for each job. + - Implementations: There are currently no open source implementations of the MonitorStatus interface available. + We'd love for you to be the first to contribute one! Check out the [MonitorStatus interface documentation](https://pkg.go.dev/github.com/go-co-op/gocron/v2#MonitorStatus) + to get started, or reach out on [Slack](https://gophers.slack.com/archives/CQ7T0T1FW) if you'd like to discuss your implementation. - [**SchedulerMonitor**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#SchedulerMonitor): A scheduler monitor provides comprehensive observability into scheduler and job lifecycle events. @@ -217,6 +221,10 @@ A scheduler monitor provides comprehensive observability into scheduler and job **Use Cases:** Prometheus metrics, custom dashboards, alerting systems, performance monitoring + - Implementations: There are currently no open source implementations of the SchedulerMonitor interface available. + We'd love for you to be the first to contribute one! Check out the [SchedulerMonitor interface documentation](https://pkg.go.dev/github.com/go-co-op/gocron/v2#SchedulerMonitor) + to get started, or reach out on [Slack](https://gophers.slack.com/archives/CQ7T0T1FW) if you'd like to discuss your implementation. + ### Testing The gocron library is set up to enable testing. - Mocks are provided in [the mock package](mocks) using [gomock](https://github.com/uber-go/mock).