Skip to content

Commit 9733ca7

Browse files
jhernandjhernand
committed
Rename Metrics to MetricsSubsystem
The original name wasn't a good choice, the new one reflects better what it does. The old name is preserved for backwards compatibility. Signed-off-by: Juan Hernandez <[email protected]>
1 parent 78b0a91 commit 9733ca7

File tree

4 files changed

+52
-44
lines changed

4 files changed

+52
-44
lines changed

‎connection.go

+17-9
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ type ConnectionBuilder struct {
8080
transportWrapper TransportWrapper
8181

8282
// Metrics:
83-
subsystem string
83+
metricsSubsystem string
8484

8585
// Error detected while populating the builder. Once set calls to methods to
8686
// set other builder parameters will be ignored and the Build method will
@@ -411,10 +411,10 @@ func (b *ConnectionBuilder) TransportWrapper(transportWrapper TransportWrapper)
411411
return b
412412
}
413413

414-
// Metrics sets the name of the subsystem that will be used by the connection to register metrics
415-
// with Prometheus. If this isn't explicitly specified, or if it is an empty string, then no metrics
416-
// will be registered. For example, if the value is `api_outbound` then the following metrics will
417-
// be registered:
414+
// MetricsSubsystem sets the name of the subsystem that will be used by the connection to register
415+
// metrics with Prometheus. If this isn't explicitly specified, or if it is an empty string, then no
416+
// metrics will be registered. For example, if the value is `api_outbound` then the following
417+
// metrics will be registered:
418418
//
419419
// api_outbound_request_count - Number of API requests sent.
420420
// api_outbound_request_duration_sum - Total time to send API requests, in seconds.
@@ -460,14 +460,22 @@ func (b *ConnectionBuilder) TransportWrapper(transportWrapper TransportWrapper)
460460
//
461461
// Note that setting this attribute is not enough to have metrics published, you also need to
462462
// create and start a metrics server, as described in the documentation of the Prometheus library.
463-
func (b *ConnectionBuilder) Metrics(value string) *ConnectionBuilder {
463+
func (b *ConnectionBuilder) MetricsSubsystem(value string) *ConnectionBuilder {
464464
if b.err != nil {
465465
return b
466466
}
467-
b.subsystem = value
467+
b.metricsSubsystem = value
468468
return b
469469
}
470470

471+
// Metrics sets the name of the subsystem that will be used by the connection to register metrics
472+
// with Prometheus.
473+
//
474+
// Deprecated: has been replaced by MetricsSubsystem.
475+
func (b *ConnectionBuilder) Metrics(value string) *ConnectionBuilder {
476+
return b.MetricsSubsystem(value)
477+
}
478+
471479
// Load loads the connection configuration from the given source. The source must be a YAML
472480
// document with content similar to this:
473481
//
@@ -787,8 +795,8 @@ func (b *ConnectionBuilder) BuildContext(ctx context.Context) (connection *Conne
787795
connection.tokenMutex = &sync.Mutex{}
788796

789797
// Register metrics:
790-
if b.subsystem != "" {
791-
err = connection.registerMetrics(b.subsystem)
798+
if b.metricsSubsystem != "" {
799+
err = connection.registerMetrics(b.metricsSubsystem)
792800
if err != nil {
793801
err = fmt.Errorf("can't register metrics: %w", err)
794802
return

‎examples/prometheus_metrics.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ func main() {
5555
connection, err := sdk.NewConnectionBuilder().
5656
Logger(logger).
5757
Tokens(token).
58-
Metrics("api_outbound").
58+
MetricsSubsystem("api_outbound").
5959
BuildContext(ctx)
6060
if err != nil {
6161
fmt.Fprintf(os.Stderr, "Can't build connection: %v\n", err)

‎methods_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,12 @@ var _ = Describe("Methods", func() {
6666
// Metrics subsystem - value doesn't matter but configuring it enables
6767
// prometheus exporting, exercising the counter increment functionality
6868
// (e.g. will catch inconsistent labels).
69-
metrics := "test_subsystem"
69+
metricsSubsystem := "test_subsystem"
7070

7171
// Create the connection:
7272
connection, err = NewConnectionBuilder().
7373
Logger(logger).
74-
Metrics(metrics).
74+
MetricsSubsystem(metricsSubsystem).
7575
TokenURL(oidServer.URL()).
7676
URL(apiServer.URL()).
7777
Tokens(refreshToken).

‎token_test.go

+32-32
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ var _ = Describe("Tokens", func() {
4747
// Metrics subsystem - value doesn't matter but configuring it enables
4848
// prometheus exporting, exercising the counter increment functionality
4949
// (e.g. will catch inconsistent labels).
50-
metrics := "test_subsystem"
50+
metricsSubsystem := "test_subsystem"
5151

5252
BeforeEach(func() {
5353
// Create the servers:
@@ -84,7 +84,7 @@ var _ = Describe("Tokens", func() {
8484
// Create the connection:
8585
connection, err := NewConnectionBuilder().
8686
Logger(logger).
87-
Metrics(metrics).
87+
MetricsSubsystem(metricsSubsystem).
8888
TokenURL(oidServer.URL()).
8989
URL(apiServer.URL()).
9090
TrustedCAFile(oidCA).
@@ -117,7 +117,7 @@ var _ = Describe("Tokens", func() {
117117
// Create the connection:
118118
connection, err := NewConnectionBuilder().
119119
Logger(logger).
120-
Metrics(metrics).
120+
MetricsSubsystem(metricsSubsystem).
121121
TokenURL(oidServer.URL()).
122122
URL(apiServer.URL()).
123123
TrustedCAFile(oidCA).
@@ -155,7 +155,7 @@ var _ = Describe("Tokens", func() {
155155
// Create the connection:
156156
connection, err := NewConnectionBuilder().
157157
Logger(logger).
158-
Metrics(metrics).
158+
MetricsSubsystem(metricsSubsystem).
159159
TokenURL(oidServer.URL()).
160160
URL(apiServer.URL()).
161161
TrustedCAFile(oidCA).
@@ -188,7 +188,7 @@ var _ = Describe("Tokens", func() {
188188
// Create the connection:
189189
connection, err := NewConnectionBuilder().
190190
Logger(logger).
191-
Metrics(metrics).
191+
MetricsSubsystem(metricsSubsystem).
192192
TokenURL(oidServer.URL()).
193193
URL(apiServer.URL()).
194194
TrustedCAFile(oidCA).
@@ -224,7 +224,7 @@ var _ = Describe("Tokens", func() {
224224
// Create the connection:
225225
connection, err := NewConnectionBuilder().
226226
Logger(logger).
227-
Metrics(metrics).
227+
MetricsSubsystem(metricsSubsystem).
228228
TokenURL(oidServer.URL()).
229229
URL(apiServer.URL()).
230230
TrustedCAFile(oidCA).
@@ -247,7 +247,7 @@ var _ = Describe("Tokens", func() {
247247
// Create the connection:
248248
connection, err := NewConnectionBuilder().
249249
Logger(logger).
250-
Metrics(metrics).
250+
MetricsSubsystem(metricsSubsystem).
251251
TokenURL(oidServer.URL()).
252252
URL(apiServer.URL()).
253253
TrustedCAFile(oidCA).
@@ -269,7 +269,7 @@ var _ = Describe("Tokens", func() {
269269
// Create the connection:
270270
connection, err := NewConnectionBuilder().
271271
Logger(logger).
272-
Metrics(metrics).
272+
MetricsSubsystem(metricsSubsystem).
273273
TokenURL(oidServer.URL()).
274274
URL(apiServer.URL()).
275275
TrustedCAFile(oidCA).
@@ -291,7 +291,7 @@ var _ = Describe("Tokens", func() {
291291
// Create the connection:
292292
connection, err := NewConnectionBuilder().
293293
Logger(logger).
294-
Metrics(metrics).
294+
MetricsSubsystem(metricsSubsystem).
295295
TokenURL(oidServer.URL()).
296296
URL(apiServer.URL()).
297297
TrustedCAFile(oidCA).
@@ -329,7 +329,7 @@ var _ = Describe("Tokens", func() {
329329
// Create the connection:
330330
connection, err := NewConnectionBuilder().
331331
Logger(logger).
332-
Metrics(metrics).
332+
MetricsSubsystem(metricsSubsystem).
333333
TokenURL(oidServer.URL()).
334334
URL(apiServer.URL()).
335335
TrustedCAFile(oidCA).
@@ -371,7 +371,7 @@ var _ = Describe("Tokens", func() {
371371
// Create the connection:
372372
connection, err := NewConnectionBuilder().
373373
Logger(logger).
374-
Metrics(metrics).
374+
MetricsSubsystem(metricsSubsystem).
375375
TokenURL(oidServer.URL()).
376376
URL(apiServer.URL()).
377377
TrustedCAFile(oidCA).
@@ -412,7 +412,7 @@ var _ = Describe("Tokens", func() {
412412
// Create the connection:
413413
connection, err := NewConnectionBuilder().
414414
Logger(logger).
415-
Metrics(metrics).
415+
MetricsSubsystem(metricsSubsystem).
416416
TokenURL(oidServer.URL()).
417417
URL(apiServer.URL()).
418418
TrustedCAFile(oidCA).
@@ -451,7 +451,7 @@ var _ = Describe("Tokens", func() {
451451
// Create the connection:
452452
connection, err := NewConnectionBuilder().
453453
Logger(logger).
454-
Metrics(metrics).
454+
MetricsSubsystem(metricsSubsystem).
455455
TokenURL(oidServer.URL()).
456456
URL(apiServer.URL()).
457457
TrustedCAFile(oidCA).
@@ -489,7 +489,7 @@ var _ = Describe("Tokens", func() {
489489
// Create the connection:
490490
connection, err := NewConnectionBuilder().
491491
Logger(logger).
492-
Metrics(metrics).
492+
MetricsSubsystem(metricsSubsystem).
493493
TokenURL(oidServer.URL()).
494494
URL(apiServer.URL()).
495495
TrustedCAFile(oidCA).
@@ -532,7 +532,7 @@ var _ = Describe("Tokens", func() {
532532
// Create the connection:
533533
connection, err := NewConnectionBuilder().
534534
Logger(logger).
535-
Metrics(metrics).
535+
MetricsSubsystem(metricsSubsystem).
536536
TokenURL(oidServer.URL()).
537537
URL(apiServer.URL()).
538538
TrustedCAFile(oidCA).
@@ -575,7 +575,7 @@ var _ = Describe("Tokens", func() {
575575
// Create the connection:
576576
connection, err := NewConnectionBuilder().
577577
Logger(logger).
578-
Metrics(metrics).
578+
MetricsSubsystem(metricsSubsystem).
579579
TokenURL(oidServer.URL()).
580580
URL(apiServer.URL()).
581581
TrustedCAFile(oidCA).
@@ -608,7 +608,7 @@ var _ = Describe("Tokens", func() {
608608
// Create the connection:
609609
connection, err := NewConnectionBuilder().
610610
Logger(logger).
611-
Metrics(metrics).
611+
MetricsSubsystem(metricsSubsystem).
612612
TokenURL(oidServer.URL()).
613613
URL(apiServer.URL()).
614614
TrustedCAFile(oidCA).
@@ -635,7 +635,7 @@ var _ = Describe("Tokens", func() {
635635
// Create the connection:
636636
connection, err := NewConnectionBuilder().
637637
Logger(logger).
638-
Metrics(metrics).
638+
MetricsSubsystem(metricsSubsystem).
639639
TokenURL(oidServer.URL()).
640640
URL(apiServer.URL()).
641641
TrustedCAFile(oidCA).
@@ -671,7 +671,7 @@ var _ = Describe("Tokens", func() {
671671
// Create the connection:
672672
connection, err := NewConnectionBuilder().
673673
Logger(logger).
674-
Metrics(metrics).
674+
MetricsSubsystem(metricsSubsystem).
675675
TokenURL(oidServer.URL()).
676676
URL(apiServer.URL()).
677677
TrustedCAFile(oidCA).
@@ -701,7 +701,7 @@ var _ = Describe("Tokens", func() {
701701
// Create the connection:
702702
connection, err := NewConnectionBuilder().
703703
Logger(logger).
704-
Metrics(metrics).
704+
MetricsSubsystem(metricsSubsystem).
705705
TokenURL(oidServer.URL()).
706706
URL(apiServer.URL()).
707707
TrustedCAFile(oidCA).
@@ -725,7 +725,7 @@ var _ = Describe("Tokens", func() {
725725
// Create the connection:
726726
connection, err := NewConnectionBuilder().
727727
Logger(logger).
728-
Metrics(metrics).
728+
MetricsSubsystem(metricsSubsystem).
729729
TokenURL(oidServer.URL()).
730730
URL(apiServer.URL()).
731731
TrustedCAFile(oidCA).
@@ -760,7 +760,7 @@ var _ = Describe("Tokens", func() {
760760
// Create the connection:
761761
connection, err := NewConnectionBuilder().
762762
Logger(logger).
763-
Metrics(metrics).
763+
MetricsSubsystem(metricsSubsystem).
764764
TokenURL(oidServer.URL()).
765765
TrustedCAFile(oidCA).
766766
TrustedCAFile(apiCA).
@@ -798,7 +798,7 @@ var _ = Describe("Tokens", func() {
798798
// Create the connection:
799799
connection, err := NewConnectionBuilder().
800800
Logger(logger).
801-
Metrics(metrics).
801+
MetricsSubsystem(metricsSubsystem).
802802
TokenURL(oidServer.URL()).
803803
TrustedCAFile(oidCA).
804804
TrustedCAFile(apiCA).
@@ -841,7 +841,7 @@ var _ = Describe("Tokens", func() {
841841
// Create the connection:
842842
connection, err := NewConnectionBuilder().
843843
Logger(logger).
844-
Metrics(metrics).
844+
MetricsSubsystem(metricsSubsystem).
845845
TokenURL(oidServer.URL()).
846846
URL(apiServer.URL()).
847847
TrustedCAFile(oidCA).
@@ -884,7 +884,7 @@ var _ = Describe("Tokens", func() {
884884
// Create the connection:
885885
connection, err := NewConnectionBuilder().
886886
Logger(logger).
887-
Metrics(metrics).
887+
MetricsSubsystem(metricsSubsystem).
888888
TokenURL(oidServer.URL()).
889889
URL(apiServer.URL()).
890890
TrustedCAFile(oidCA).
@@ -917,7 +917,7 @@ var _ = Describe("Tokens", func() {
917917
// Create the connection:
918918
connection, err := NewConnectionBuilder().
919919
Logger(logger).
920-
Metrics(metrics).
920+
MetricsSubsystem(metricsSubsystem).
921921
TokenURL(oidServer.URL()).
922922
URL(apiServer.URL()).
923923
TrustedCAFile(oidCA).
@@ -944,7 +944,7 @@ var _ = Describe("Tokens", func() {
944944
// Create the connection:
945945
connection, err := NewConnectionBuilder().
946946
Logger(logger).
947-
Metrics(metrics).
947+
MetricsSubsystem(metricsSubsystem).
948948
TokenURL(oidServer.URL()).
949949
URL(apiServer.URL()).
950950
TrustedCAFile(oidCA).
@@ -981,7 +981,7 @@ var _ = Describe("Tokens", func() {
981981
// Create the connection:
982982
connection, err := NewConnectionBuilder().
983983
Logger(logger).
984-
Metrics(metrics).
984+
MetricsSubsystem(metricsSubsystem).
985985
TokenURL(oidServer.URL()).
986986
URL(apiServer.URL()).
987987
TrustedCAFile(oidCA).
@@ -1020,7 +1020,7 @@ var _ = Describe("Tokens", func() {
10201020
// Create the connection:
10211021
connection, err := NewConnectionBuilder().
10221022
Logger(logger).
1023-
Metrics(metrics).
1023+
MetricsSubsystem(metricsSubsystem).
10241024
TokenURL(oidServer.URL()).
10251025
URL(apiServer.URL()).
10261026
TrustedCAFile(oidCA).
@@ -1068,7 +1068,7 @@ var _ = Describe("Tokens", func() {
10681068
// Create the connection:
10691069
connection, err := NewConnectionBuilder().
10701070
Logger(logger).
1071-
Metrics(metrics).
1071+
MetricsSubsystem(metricsSubsystem).
10721072
TokenURL(oidServer.URL()).
10731073
URL(apiServer.URL()).
10741074
TrustedCAFile(oidCA).
@@ -1116,7 +1116,7 @@ var _ = Describe("Tokens", func() {
11161116
// Create the connection:
11171117
connection, err := NewConnectionBuilder().
11181118
Logger(logger).
1119-
Metrics(metrics).
1119+
MetricsSubsystem(metricsSubsystem).
11201120
TokenURL(oidServer.URL()).
11211121
URL(apiServer.URL()).
11221122
TrustedCAFile(oidCA).
@@ -1151,7 +1151,7 @@ var _ = Describe("Tokens", func() {
11511151
// Create the connection:
11521152
connection, err := NewConnectionBuilder().
11531153
Logger(logger).
1154-
Metrics(metrics).
1154+
MetricsSubsystem(metricsSubsystem).
11551155
TokenURL(oidServer.URL()).
11561156
URL(apiServer.URL()).
11571157
TrustedCAFile(oidCA).

0 commit comments

Comments
 (0)