Skip to content
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

Add Meter for in-progress jobs #139

Merged
merged 5 commits into from
Nov 26, 2024
Merged

Add Meter for in-progress jobs #139

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f15eeee
Add Gauge for in-progress jobs
ptoffy Nov 25, 2024
3c86781
Whitespace nit
ptoffy Nov 25, 2024
19823fa
Move the gauge to the right place
ptoffy Nov 25, 2024
d3256eb
Make `Gauge` a `Meter` and add test
ptoffy Nov 25, 2024
dadc6ac
Change back job duration timer label
ptoffy Nov 26, 2024
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
16 changes: 12 additions & 4 deletions Sources/Queues/QueueWorker.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ public struct QueueWorker: Sendable {
logger[metadataKey: "queue"] = "\(self.queue.queueName.string)"
logger.trace("Popping job from queue")

Gauge(
label: "jobs.in.progress.gauge",
dimensions: [("queueName", self.queue.queueName.string)]
).record(1)

guard let id = try await self.queue.pop().get() else {
// No job found, go around again.
logger.trace("No pending jobs")
Expand Down Expand Up @@ -122,17 +127,15 @@ public struct QueueWorker: Sendable {
queue: any Queue,
error: (any Error)? = nil
) {
// Checks how long the job took to complete
Timer(
label: "\(jobName).jobDurationTimer",
label: "\(jobName).duration.timer",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this can be considered a breaking change, but people who use this might have to switch

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this would break integrations. SemVer wise it's technically fine but it could cause issues. We're not actually changing any information here right? Though the display unit was incorrect before right?

@maciejtrybilo you're using this correct?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed the name back. The display unit is probably worth keeping as seconds is just not a great metric for job duration IMO

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this would break integrations. SemVer wise it's technically fine but it could cause issues. We're not actually changing any information here right? Though the display unit was incorrect before right?

@maciejtrybilo you're using this correct?

I am, but it's no catastrophe to change the units. I'm good!

dimensions: [
("success", error == nil ? "true" : "false"),
("jobName", jobName),
],
preferredDisplayUnit: .seconds
preferredDisplayUnit: .milliseconds
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above

).recordNanoseconds(DispatchTime.now().uptimeNanoseconds - startTime)

// Adds the completed job to a different counter depending on its result
if error != nil {
Counter(
label: "error.completed.jobs.counter",
Expand All @@ -144,5 +147,10 @@ public struct QueueWorker: Sendable {
dimensions: [("queueName", queue.queueName.string)]
).increment()
}

Gauge(
label: "jobs.in.progress.gauge",
dimensions: [("queueName", queue.queueName.string)]
).record(-1)
}
}
Loading