Skip to content

Document custom metrics on Monitor.ping #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aflanagan wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Document custom metrics on Monitor.ping #46

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a0e56fe
Document and test arbitrary custom metrics on Monitor.ping
cursoragent Sep 11, 2026
70b8cd3
Remove rejected_metrics handling from ping responses
cursoragent Sep 11, 2026
ad8a800
Drop unused MagicMock import after rejected_metrics test removal
cursoragent Sep 11, 2026
7752d76
Narrow custom-metrics PR to a README-only note
cursoragent Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,15 @@ monitor.ping(
metrics={
'duration': 100, # how long the job ran (complete|fail only). cronitor will calculate this when not provided
'count': 4500, # if your job is processing a number of items you can report a count
'error_count': 10 # the number of errors that occurred while this job was running
'error_count': 10, # the number of errors that occurred while this job was running
'queue_depth': 42, # custom metric: any named numeric measurement
'quality_score': 0.87
}
)
```

Custom metric names (for example `queue_depth` or `quality_score`) use the same `metrics` dict and are sent as repeated `metric=name:value` query params. Server-side, names are lowercased, max 63 characters, and may contain letters, numbers, underscores, and hyphens.

## Configuring Monitors

### YAML Configuration File
Expand Down
Loading