HangfireIO / HangfireIO/Hangfire.Documentation

No Documentation For IMonitoringApi

Open
#65 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
58
Forks
138
PR merge metrics
No merged PRs in 30d

Description

I've seen suggestions for using JobStorage.Current.GetMonitoringApi() to get information and statistics about Hangfire Jobs. The issue is that this no documentation for IMonitoringApi.
I'm having a hard time figuring out what IMonitoringApi can and cannot do.

image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no documentation file or test. Start by locating IMonitoringApi and the JobStorage.Current.GetMonitoringApi() entry point, then document what the API can and cannot do. Done when the documentation explains the available monitoring capabilities and how users can access them.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.