Skip to content

Commit 5c73ecc

Browse files
CopilotJohnRoesler
andcommitted
docs: add implementations sections for Monitor, MonitorStatus, and SchedulerMonitor
Co-authored-by: JohnRoesler <19351306+JohnRoesler@users.noreply.github.com>
1 parent 5177ab9 commit 5c73ecc

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,11 +171,15 @@ The provided NewLogger uses the standard library's log package.
171171
### Metrics
172172
Metrics may be collected from the execution of each job and scheduler lifecycle events.
173173
- [**Monitor**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#Monitor):
174-
- [**MonitorStatus**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#MonitorStatus) (includes status and error (if any) of the Job)
175174
A monitor can be used to collect metrics for each job from a scheduler.
176175
- Implementations: There are currently no open source implementations of the Monitor interface available.
177176
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)
178177
to get started, or reach out on [Slack](https://gophers.slack.com/archives/CQ7T0T1FW) if you'd like to discuss your implementation.
178+
- [**MonitorStatus**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#MonitorStatus):
179+
Extends Monitor with status and error tracking for each job.
180+
- Implementations: There are currently no open source implementations of the MonitorStatus interface available.
181+
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)
182+
to get started, or reach out on [Slack](https://gophers.slack.com/archives/CQ7T0T1FW) if you'd like to discuss your implementation.
179183
- [**SchedulerMonitor**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#SchedulerMonitor):
180184
A scheduler monitor provides comprehensive observability into scheduler and job lifecycle events.
181185

@@ -217,6 +221,10 @@ A scheduler monitor provides comprehensive observability into scheduler and job
217221

218222
**Use Cases:** Prometheus metrics, custom dashboards, alerting systems, performance monitoring
219223

224+
- Implementations: There are currently no open source implementations of the SchedulerMonitor interface available.
225+
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)
226+
to get started, or reach out on [Slack](https://gophers.slack.com/archives/CQ7T0T1FW) if you'd like to discuss your implementation.
227+
220228
### Testing
221229
The gocron library is set up to enable testing.
222230
- Mocks are provided in [the mock package](mocks) using [gomock](https://github.com/uber-go/mock).

0 commit comments

Comments
 (0)