[Instrumentation.Hangfire] Add metrics support #3258

gorbach · 2025-10-21T18:51:32Z

Fixes #2075

Changes

Adds OpenTelemetry metrics support to Hangfire instrumentation following workflow semantic conventions.

Implemented metrics:

workflow.execution.count - Counter for task executions
workflow.execution.duration - Histogram for execution duration
workflow.execution.status - UpDownCounter for state transitions
workflow.execution.errors - Counter for execution errors
hangfire.queue.latency - Optional histogram for queue wait time

Merge requirement checklist

CONTRIBUTING guidelines followed
Unit tests added/updated
CHANGELOG.md updated
Changes in public API reviewed

linux-foundation-easycla · 2025-10-21T18:51:39Z

The committers listed above are authorized under a signed CLA.

✅ login: gorbach / name: Gorbach Oleksii (64514b8)

thompson-tomo

Looks to be a good step forward and I have suggested a couple of changes here as well as to the sem conv based on the learnings.

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetrics.cs

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireTagBuilder.cs

Kielek · 2025-10-22T04:46:50Z

@gorbach, please check this comment #2075 (comment)

The second point is technical requirements to separate metrics/traces signal. It will be great to rename classes in the separate PR and then merge it/rebase here.

Implements OpenTelemetry workflow semantic conventions for Hangfire metrics. Fixes open-telemetry#2075

…ve trigger.type to workflow-level metrics, add workflow.count

… DisplayNameFunc option

thompson-tomo

Looking good. Only 1 design question #3258 (comment) which when resolved would mean I approve.

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireTagBuilder.cs

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetricsStateFilter.cs

thompson-tomo

Have left a bunch of nits for things which could be improved/simplified.

...OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetricsErrorFilterAttribute.cs

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetricsInstrumentation.cs

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetricsStateFilter.cs

...OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetricsErrorFilterAttribute.cs

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireTagBuilder.cs

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetricsStateFilter.cs

…fireMetricsErrorFilterAttribute.cs Co-authored-by: James Thompson <[email protected]>

…fireMetricsInstrumentation.cs Co-authored-by: James Thompson <[email protected]>

…fireMetricsStateFilter.cs Co-authored-by: James Thompson <[email protected]>

…fireTagBuilder.cs Co-authored-by: James Thompson <[email protected]>

…fireMetricsStateFilter.cs Co-authored-by: James Thompson <[email protected]>

…fireMetricsErrorFilterAttribute.cs Co-authored-by: James Thompson <[email protected]>

…fireTagBuilder.cs Co-authored-by: James Thompson <[email protected]>

…fireMetricsStateFilter.cs Co-authored-by: James Thompson <[email protected]>

src/OpenTelemetry.Instrumentation.Hangfire/.publicApi/PublicAPI.Unshipped.txt

thompson-tomo

Looks good to me & thanks for adapting based on feedback.

fred2u · 2025-10-27T07:21:23Z

Thanks for the contribution, don't forget to update the CHANGELOG.md

src/OpenTelemetry.Instrumentation.Hangfire/README.md

gorbach · 2025-10-28T20:14:58Z

Thanks for the contribution, don't forget to update the CHANGELOG.md

Done, thanks!

fred2u · 2025-11-04T13:19:01Z

@Kielek Is there still something blocking this PR?

Kielek · 2025-11-04T13:37:57Z

@fred2u, I am not sure if there is any blocker. The metrics names suggests that all of them came from the opentelemetry-specification, but in fact, all of most of them are custom. Need to check with othet @open-telemetry/dotnet-contrib-approvers what to do with this PR.

For sure, in the same time, you can clean up public contract for spans/traces in the separate PR. It will be great to align to standard conventions from this repository: #2075 (comment)

github-actions · 2025-11-12T03:31:52Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

Kielek

I think that you need put clear information, that you are providing metrics, but all of them are hangfire specific, and it will be subject to change if there occurs any recommendations from the semantic convetion. When the statement will be clear, I think that we should be fine to merge.

Do you have any plan to work towards this definition?

Kielek · 2025-11-12T06:20:44Z

src/OpenTelemetry.Instrumentation.Hangfire/CHANGELOG.md


 ## Unreleased

+* Add metrics instrumentation following workflow semantic conventions.


It is not true. There is nothing like workflow semantic convention.

Kielek · 2025-11-12T06:20:59Z

src/OpenTelemetry.Instrumentation.Hangfire/README.md

+This instrumentation library collects metrics following the OpenTelemetry
+[workflow semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/workflow/workflow-metrics.md).


thompson-tomo

So the work to get these definitions into semconv is covered by open-telemetry/semantic-conventions#1688 with very recent interest from cicd sig to be involved, so hopefully this topic can now get traction.

I have added a comment on the readme with proposed text to make it clearer the signal definitions are subject to change.

thompson-tomo · 2025-11-12T09:19:19Z

src/OpenTelemetry.Instrumentation.Hangfire/README.md

+This instrumentation library collects metrics following the OpenTelemetry
+[workflow semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/workflow/workflow-metrics.md).


Howabout something like

Suggested change

This instrumentation library collects metrics following the OpenTelemetry

[workflow semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/workflow/workflow-metrics.md).

This instrumentation library collects metrics following a POC/draft definition of workflow metrics defined as part of [semantic-conventions/#1688](https://github.com/open-telemetry/semantic-conventions/issues/1688).

As those definitions evolve, changes including breaking ones will flow back to this implementation.

gorbach requested a review from a team as a code owner October 21, 2025 18:51

github-actions bot assigned fred2u Oct 21, 2025

github-actions bot requested a review from fred2u October 21, 2025 18:51

github-actions bot added the comp:instrumentation.hangfire Things related to OpenTelemetry.Instrumentation.Hangfire label Oct 21, 2025

gorbach force-pushed the feature/2075-hangfire-telemetry branch from 289b75d to 5655113 Compare October 21, 2025 19:55

thompson-tomo reviewed Oct 22, 2025

View reviewed changes

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetrics.cs Outdated Show resolved Hide resolved

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireTagBuilder.cs Outdated Show resolved Hide resolved

gorbach requested a review from thompson-tomo October 22, 2025 22:41

gorbach added 3 commits October 22, 2025 18:42

[Instrumentation.Hangfire] Add metrics support

2e804df

Implements OpenTelemetry workflow semantic conventions for Hangfire metrics. Fixes open-telemetry#2075

Align metrics with workflow semconv: use duration{state=pending}, mo…

08198ac

…ve trigger.type to workflow-level metrics, add workflow.count

Configure metrics in HangfireMetricsInstrumentationOptions class, add…

d43ee2c

… DisplayNameFunc option

gorbach force-pushed the feature/2075-hangfire-telemetry branch from dd6e74a to d43ee2c Compare October 22, 2025 22:42

thompson-tomo reviewed Oct 23, 2025

View reviewed changes

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetricsStateFilter.cs Outdated Show resolved Hide resolved

thompson-tomo reviewed Oct 24, 2025

View reviewed changes

src/OpenTelemetry.Instrumentation.Hangfire/Implementation/HangfireMetricsStateFilter.cs Outdated Show resolved Hide resolved

gorbach added 4 commits October 24, 2025 18:36

Add workflow.status metric to track complete job lifecycle

bc135e8

Use job formatter from hangfire

96d8aa8

Fix tests

742b2a0

Fix and speed up tests

aa3ac32

thompson-tomo reviewed Oct 26, 2025

View reviewed changes

gorbach and others added 9 commits October 26, 2025 08:45

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

1f909bd

…fireMetricsErrorFilterAttribute.cs Co-authored-by: James Thompson <[email protected]>

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

42476f8

…fireMetricsInstrumentation.cs Co-authored-by: James Thompson <[email protected]>

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

accd8bc

…fireMetricsStateFilter.cs Co-authored-by: James Thompson <[email protected]>

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

302542a

…fireMetricsStateFilter.cs Co-authored-by: James Thompson <[email protected]>

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

5af844c

…fireTagBuilder.cs Co-authored-by: James Thompson <[email protected]>

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

eae641c

…fireMetricsStateFilter.cs Co-authored-by: James Thompson <[email protected]>

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

38883b8

…fireMetricsErrorFilterAttribute.cs Co-authored-by: James Thompson <[email protected]>

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

2e7cdff

…fireTagBuilder.cs Co-authored-by: James Thompson <[email protected]>

Update src/OpenTelemetry.Instrumentation.Hangfire/Implementation/Hang…

3254ed2

…fireMetricsStateFilter.cs Co-authored-by: James Thompson <[email protected]>

build fix

693d1be

thompson-tomo reviewed Oct 26, 2025

View reviewed changes

src/OpenTelemetry.Instrumentation.Hangfire/.publicApi/PublicAPI.Unshipped.txt Outdated Show resolved Hide resolved

gorbach added 2 commits October 26, 2025 10:26

Rename metrics/attributes

044e500

Remove DisplayNameFunc from PublicAPI.Unshipped.txt and README.md

b58920e

gorbach requested a review from thompson-tomo October 26, 2025 15:09

Merge branch 'main' into feature/2075-hangfire-telemetry

cef13e5

thompson-tomo reviewed Oct 27, 2025

View reviewed changes

thompson-tomo approved these changes Oct 27, 2025

View reviewed changes

Kielek reviewed Oct 28, 2025

View reviewed changes

src/OpenTelemetry.Instrumentation.Hangfire/README.md Outdated Show resolved Hide resolved

gorbach added 2 commits October 28, 2025 16:01

remove wrong link

90022d0

update CHANGELOG.md

ded8e66

gorbach requested a review from Kielek October 28, 2025 20:15

Merge branch 'main' into feature/2075-hangfire-telemetry

64514b8

fred2u approved these changes Oct 29, 2025

View reviewed changes

github-actions bot added the Stale label Nov 12, 2025

Kielek removed the Stale label Nov 12, 2025

Kielek reviewed Nov 12, 2025

View reviewed changes

thompson-tomo approved these changes Nov 12, 2025

View reviewed changes


		## Unreleased

		* Add metrics instrumentation following workflow semantic conventions.

		This instrumentation library collects metrics following the OpenTelemetry
		[workflow semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/workflow/workflow-metrics.md).

[Instrumentation.Hangfire] Add metrics support #3258

Are you sure you want to change the base?

[Instrumentation.Hangfire] Add metrics support #3258

Uh oh!

Conversation

gorbach commented Oct 21, 2025

Changes

Merge requirement checklist

Uh oh!

linux-foundation-easycla bot commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thompson-tomo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Kielek commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thompson-tomo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thompson-tomo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thompson-tomo left a comment

Choose a reason for hiding this comment

Uh oh!

fred2u commented Oct 27, 2025

Uh oh!

Uh oh!

gorbach commented Oct 28, 2025

Uh oh!

fred2u commented Nov 4, 2025

Uh oh!

Kielek commented Nov 4, 2025

Uh oh!

github-actions bot commented Nov 12, 2025

Uh oh!

Kielek left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kielek Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Kielek Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

thompson-tomo left a comment

Choose a reason for hiding this comment

Uh oh!

thompson-tomo Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

linux-foundation-easycla bot commented Oct 21, 2025 •

edited

Loading

Kielek commented Oct 22, 2025 •

edited

Loading

Kielek left a comment •

edited

Loading