Skip to content

Commit 04b008d

Browse files
alexvanboxelalexvanboxel
committed
[receiver/googlecloudpubsub] Turn noisy warn in reset metric (open-telemetry#37571)
1 parent 54896e7 commit 04b008d

14 files changed

+416
-179
lines changed

‎.chloggen/pubsubreceiver-turn-warn-into-reset-metric.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
change_type: enhancement
2+
3+
component: googlecloudpubsubreceiver
4+
5+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
6+
note: Turn noisy `warn` log about Pub/Sub servers into `debug`, and turn the reset count into a metric
7+
8+
issues: [37571]
9+
10+
subtext: |
11+
The receiver uses the Google Cloud Pub/Sub StreamingPull API and keeps a open connection. The Pub/Sub servers
12+
recurrently close the connection after a time period to avoid a long-running sticky connection. Before the
13+
receiver logged `warn` log lines everytime this happened. These log lines are moved to debug so that fleets with
14+
lots of collectors with the receiver don't span logs at warn level. To keep track of the resets, whenever a
15+
connection reset happens a `otelcol_receiver_googlecloudpubsub_stream_restarts` metric is increased by one.
16+
17+
change_logs: [user]

‎receiver/googlecloudpubsubreceiver/documentation.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
2+
3+
# googlecloudpubsub
4+
5+
## Internal Telemetry
6+
7+
The following telemetry is emitted by this component.
8+
9+
### otelcol_receiver.googlecloudpubsub.stream_restarts
10+
11+
Number of times the stream (re)starts due to a Pub/Sub servers connection close
12+
13+
The receiver uses the Google Cloud Pub/Sub StreamingPull API and keeps a open connection. The Pub/Sub servers
14+
recurrently close the connection after a time period to avoid a long-running sticky connection. This metric
15+
counts the number of the resets that occurred during the lifetime of the container.
16+
17+
18+
| Unit | Metric Type | Value Type | Monotonic |
19+
| ---- | ----------- | ---------- | --------- |
20+
| 1 | Sum | Int | true |

‎receiver/googlecloudpubsubreceiver/factory.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,24 +41,24 @@ func (factory *pubsubReceiverFactory) CreateDefaultConfig() component.Config {
4141
return &Config{}
4242
}
4343

44-
func (factory *pubsubReceiverFactory) ensureReceiver(params receiver.Settings, config component.Config) (*pubsubReceiver, error) {
44+
func (factory *pubsubReceiverFactory) ensureReceiver(settings receiver.Settings, config component.Config) (*pubsubReceiver, error) {
4545
receiver := factory.receivers[config.(*Config)]
4646
if receiver != nil {
4747
return receiver, nil
4848
}
4949
rconfig := config.(*Config)
5050
obsrecv, err := receiverhelper.NewObsReport(receiverhelper.ObsReportSettings{
51-
ReceiverID: params.ID,
51+
ReceiverID: settings.ID,
5252
Transport: reportTransport,
53-
ReceiverCreateSettings: params,
53+
ReceiverCreateSettings: settings,
5454
})
5555
if err != nil {
5656
return nil, err
5757
}
5858
receiver = &pubsubReceiver{
59-
logger: params.Logger,
59+
settings: settings,
6060
obsrecv: obsrecv,
61-
userAgent: strings.ReplaceAll(rconfig.UserAgent, "{{version}}", params.BuildInfo.Version),
61+
userAgent: strings.ReplaceAll(rconfig.UserAgent, "{{version}}", settings.BuildInfo.Version),
6262
config: rconfig,
6363
}
6464
factory.receivers[config.(*Config)] = receiver

‎receiver/googlecloudpubsubreceiver/go.mod

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
module github.com/open-telemetry/opentelemetry-collector-contrib/receiver/googlecloudpubsubreceiver
22

3-
go 1.22.0
3+
go 1.22.7
44

55
require (
66
cloud.google.com/go/logging v1.13.0
7-
cloud.google.com/go/pubsub v1.45.3
7+
cloud.google.com/go/pubsub v1.46.0
88
github.com/google/go-cmp v0.6.0
99
github.com/googleapis/gax-go/v2 v2.14.1
1010
github.com/iancoleman/strcase v0.3.0
@@ -20,31 +20,34 @@ require (
2020
go.opentelemetry.io/collector/pdata v1.24.1-0.20250130000211-c119b2a55eb4
2121
go.opentelemetry.io/collector/receiver v0.118.1-0.20250130000211-c119b2a55eb4
2222
go.opentelemetry.io/collector/receiver/receivertest v0.118.1-0.20250130000211-c119b2a55eb4
23+
go.opentelemetry.io/otel v1.34.0
24+
go.opentelemetry.io/otel/metric v1.34.0
25+
go.opentelemetry.io/otel/sdk/metric v1.34.0
26+
go.opentelemetry.io/otel/trace v1.34.0
2327
go.uber.org/goleak v1.3.0
2428
go.uber.org/multierr v1.11.0
2529
go.uber.org/zap v1.27.0
2630
google.golang.org/api v0.219.0
27-
google.golang.org/genproto v0.0.0-20241118233622-e639e219e697
28-
google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576
31+
google.golang.org/genproto v0.0.0-20250127172529-29210b9bc287
32+
google.golang.org/genproto/googleapis/api v0.0.0-20250127172529-29210b9bc287
2933
google.golang.org/grpc v1.70.0
3034
google.golang.org/protobuf v1.36.4
3135
)
3236

3337
require (
34-
cloud.google.com/go v0.117.0 // indirect
35-
cloud.google.com/go/auth v0.14.0 // indirect
38+
cloud.google.com/go v0.118.1 // indirect
39+
cloud.google.com/go/auth v0.14.1 // indirect
3640
cloud.google.com/go/auth/oauth2adapt v0.2.7 // indirect
3741
cloud.google.com/go/compute/metadata v0.6.0 // indirect
38-
cloud.google.com/go/iam v1.2.2 // indirect
39-
cloud.google.com/go/longrunning v0.6.2 // indirect
42+
cloud.google.com/go/iam v1.3.1 // indirect
43+
cloud.google.com/go/longrunning v0.6.4 // indirect
4044
github.com/cenkalti/backoff/v4 v4.3.0 // indirect
4145
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
4246
github.com/felixge/httpsnoop v1.0.4 // indirect
4347
github.com/go-logr/logr v1.4.2 // indirect
4448
github.com/go-logr/stdr v1.2.2 // indirect
4549
github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
4650
github.com/gogo/protobuf v1.3.2 // indirect
47-
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
4851
github.com/google/s2a-go v0.1.9 // indirect
4952
github.com/google/uuid v1.6.0 // indirect
5053
github.com/googleapis/enterprise-certificate-proxy v0.3.4 // indirect
@@ -57,34 +60,29 @@ require (
5760
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
5861
github.com/modern-go/reflect2 v1.0.2 // indirect
5962
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
60-
go.einride.tech/aip v0.68.0 // indirect
61-
go.opencensus.io v0.24.0 // indirect
63+
go.einride.tech/aip v0.68.1 // indirect
6264
go.opentelemetry.io/auto/sdk v1.1.0 // indirect
63-
go.opentelemetry.io/collector/config/configretry v1.24.1-0.20250130000211-c119b2a55eb4 // indirect
65+
go.opentelemetry.io/collector/config/configretry v1.24.1-0.20250123125445-24f88da7b583 // indirect
6466
go.opentelemetry.io/collector/config/configtelemetry v0.118.1-0.20250130000211-c119b2a55eb4 // indirect
65-
go.opentelemetry.io/collector/consumer/consumererror v0.118.1-0.20250130000211-c119b2a55eb4 // indirect
66-
go.opentelemetry.io/collector/consumer/xconsumer v0.118.1-0.20250130000211-c119b2a55eb4 // indirect
67+
go.opentelemetry.io/collector/consumer/consumererror v0.118.1-0.20250123125445-24f88da7b583 // indirect
68+
go.opentelemetry.io/collector/consumer/xconsumer v0.118.1-0.20250123125445-24f88da7b583 // indirect
6769
go.opentelemetry.io/collector/extension v0.118.1-0.20250130000211-c119b2a55eb4 // indirect
68-
go.opentelemetry.io/collector/extension/xextension v0.118.1-0.20250130000211-c119b2a55eb4 // indirect
69-
go.opentelemetry.io/collector/featuregate v1.24.1-0.20250130000211-c119b2a55eb4 // indirect
70+
go.opentelemetry.io/collector/extension/xextension v0.118.1-0.20250123125445-24f88da7b583 // indirect
71+
go.opentelemetry.io/collector/featuregate v1.24.1-0.20250123125445-24f88da7b583 // indirect
7072
go.opentelemetry.io/collector/pdata/pprofile v0.118.1-0.20250130000211-c119b2a55eb4 // indirect
71-
go.opentelemetry.io/collector/pipeline v0.118.1-0.20250130000211-c119b2a55eb4 // indirect
72-
go.opentelemetry.io/collector/receiver/xreceiver v0.118.1-0.20250130000211-c119b2a55eb4 // indirect
73-
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.54.0 // indirect
74-
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.54.0 // indirect
75-
go.opentelemetry.io/otel v1.34.0 // indirect
76-
go.opentelemetry.io/otel/metric v1.34.0 // indirect
73+
go.opentelemetry.io/collector/pipeline v0.118.1-0.20250123125445-24f88da7b583 // indirect
74+
go.opentelemetry.io/collector/receiver/xreceiver v0.118.1-0.20250123125445-24f88da7b583 // indirect
75+
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.59.0 // indirect
76+
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.59.0 // indirect
7777
go.opentelemetry.io/otel/sdk v1.34.0 // indirect
78-
go.opentelemetry.io/otel/sdk/metric v1.34.0 // indirect
79-
go.opentelemetry.io/otel/trace v1.34.0 // indirect
8078
golang.org/x/crypto v0.32.0 // indirect
8179
golang.org/x/net v0.34.0 // indirect
8280
golang.org/x/oauth2 v0.25.0 // indirect
8381
golang.org/x/sync v0.10.0 // indirect
8482
golang.org/x/sys v0.29.0 // indirect
8583
golang.org/x/text v0.21.0 // indirect
8684
golang.org/x/time v0.9.0 // indirect
87-
google.golang.org/genproto/googleapis/rpc v0.0.0-20250124145028-65684f501c47 // indirect
85+
google.golang.org/genproto/googleapis/rpc v0.0.0-20250127172529-29210b9bc287 // indirect
8886
gopkg.in/yaml.v3 v3.0.1 // indirect
8987
)
9088

0 commit comments

Comments
 (0)