Skip to content

Let the Zinc counter be narrowed to a path #45

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

Merged
noha merged 1 commit into from
Sep 18, 2026
Merged

Let the Zinc counter be narrowed to a path #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions source/Canopy-Metrics-Tests/CanopyZincCounterTest.class.st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,34 @@ Class {
#package : 'Canopy-Metrics-Tests'
}

{ #category : 'as yet unclassified' }
CanopyZincCounterTest >> testAnExcludedPrefixIsNotCounted [
"The scrape endpoint is the obvious one to leave out: a counter of HTTP requests that counts
the requests reading it measures partly itself."
| counter |
counter := CanopyZincCounter new.
counter addExcludePrefix: '/metrics'.
counter handleAnnouncement: (CanopyZincTestAnnouncement new url: '/metrics'; responseCode: 200 duration: 5; yourself).
self assert: counter requests equals: 0.
counter handleAnnouncement: (CanopyZincTestAnnouncement new url: '/api/grids'; responseCode: 200 duration: 5; yourself).
self assert: counter requests equals: 1
]

{ #category : 'as yet unclassified' }
CanopyZincCounterTest >> testOnlyRequestsUnderAnIncludedPrefixAreCounted [
"What the deployed servers do: narrow the count to '/api'. Without it Canopy counted every
request the image ever answered, which is not the number the dashboards have been showing."
| counter |
counter := CanopyZincCounter new.
counter addIncludePrefix: '/api'.
counter handleAnnouncement: (CanopyZincTestAnnouncement new url: '/status'; responseCode: 200 duration: 5; yourself).
self assert: counter requests equals: 0.
self assert: (counter responses at: 200) equals: 0.
counter handleAnnouncement: (CanopyZincTestAnnouncement new url: '/api/grids'; responseCode: 200 duration: 5; yourself).
self assert: counter requests equals: 1.
self assert: (counter responses at: 200) equals: 1
]

{ #category : 'as yet unclassified' }
CanopyZincCounterTest >> testAFreshCounterAlreadyCarriesTheUsualStatusCodes [
"Parity with what the servers export today: the status series exist from the first scrape at
Expand Down
15 changes: 14 additions & 1 deletion source/Canopy-Metrics-Tests/CanopyZincTestAnnouncement.class.st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ Class {
#superclass : 'Object',
#instVars : [
'responseCode',
'duration'
'duration',
'url'
],
#category : 'Canopy-Metrics-Tests',
#package : 'Canopy-Metrics-Tests'
Expand All @@ -19,6 +20,18 @@ CanopyZincTestAnnouncement >> responseCode [
^ responseCode
]

{ #category : 'accessing' }
CanopyZincTestAnnouncement >> url [
"Defaults to a path the deployed servers count, so a test that does not care about filtering
does not have to say anything about it."
^ url ifNil: [ '/api/grids' asZnUrl ]
]

{ #category : 'accessing' }
CanopyZincTestAnnouncement >> url: aString [
url := aString asZnUrl
]

{ #category : 'accessing' }
CanopyZincTestAnnouncement >> responseCode: aCode duration: aDuration [
responseCode := aCode.
Expand Down
32 changes: 31 additions & 1 deletion source/Canopy-Metrics/CanopyZincCounter.class.st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Class {
'requests',
'responses',
'duration',
'registration'
'registration',
'includePrefixes',
'excludePrefixes'
],
#classInstVars : [
'instance'
Expand Down Expand Up @@ -40,6 +42,20 @@ CanopyZincCounter class >> uninstall [
^ self instance uninstall
]

{ #category : 'configuring' }
CanopyZincCounter >> addExcludePrefix: aString [
"Do not count requests to this path. The scrape endpoint itself is the obvious candidate -
left alone, a counter of HTTP requests counts the requests that read it."
excludePrefixes add: aString
]

{ #category : 'configuring' }
CanopyZincCounter >> addIncludePrefix: aString [
"Count only requests to this path. As soon as one is named, everything else is ignored -
the deployed servers narrow the count to '/api' this way."
includePrefixes add: aString
]

{ #category : 'counting' }
CanopyZincCounter >> adjustDuration: aDuration [
duration ifNil: [ ^ duration := aDuration ].
Expand All @@ -60,8 +76,20 @@ CanopyZincCounter >> durationCanopy [
value: self duration
]

{ #category : 'counting' }
CanopyZincCounter >> countsRequestTo: aUrl [
"Named prefixes narrow what is counted, excluded ones drop out of whatever is left. Both
lists are honoured; with neither, everything counts."
| pfad |
pfad := aUrl pathPrintString.
(excludePrefixes anySatisfy: [ :each | pfad beginsWith: each ]) ifTrue: [ ^ false ].
includePrefixes ifEmpty: [ ^ true ].
^ includePrefixes anySatisfy: [ :each | pfad beginsWith: each ]
]

{ #category : 'counting' }
CanopyZincCounter >> handleAnnouncement: anAnnouncement [
(self countsRequestTo: anAnnouncement url) ifFalse: [ ^ self ].
self increaseRequests.
self increaseStatusCode: anAnnouncement responseCode.
self adjustDuration: anAnnouncement duration
Expand All @@ -85,6 +113,8 @@ CanopyZincCounter >> initialize [
requests := 0.
duration := 0.
responses := Dictionary new.
includePrefixes := OrderedCollection new.
excludePrefixes := OrderedCollection new.
self initializeResponses
]

Expand Down
Loading