Skip to content

Commit

Permalink
[receiver/zookeeper] remove duplicate Timeout field (#26082)
Browse files Browse the repository at this point in the history
Rely on the scraper helper's Timeout instead

---------

Signed-off-by: Alex Boten <[email protected]>
  • Loading branch information
Alex Boten authored Aug 25, 2023
1 parent 2837fb5 commit 15ebd27
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 14 deletions.
27 changes: 27 additions & 0 deletions .chloggen/codeboten_rm-dupe-timeout-zookeeper.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: zookeeperreceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Removes duplicate `Timeout` field. This change has no impact on end users of the component."

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [26082]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [api]
5 changes: 0 additions & 5 deletions receiver/zookeeperreceiver/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
package zookeeperreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/zookeeperreceiver"

import (
"time"

"go.opentelemetry.io/collector/config/confignet"
"go.opentelemetry.io/collector/receiver/scraperhelper"

Expand All @@ -16,7 +14,4 @@ type Config struct {
scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
confignet.TCPAddr `mapstructure:",squash"`
metadata.MetricsBuilderConfig `mapstructure:",squash"`

// Timeout within which requests should be completed.
Timeout time.Duration `mapstructure:"timeout"`
}
2 changes: 1 addition & 1 deletion receiver/zookeeperreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ func NewFactory() receiver.Factory {
func createDefaultConfig() component.Config {
cfg := scraperhelper.NewDefaultScraperControllerSettings(metadata.Type)
cfg.CollectionInterval = defaultCollectionInterval
cfg.Timeout = defaultTimeout

return &Config{
ScraperControllerSettings: cfg,
TCPAddr: confignet.TCPAddr{
Endpoint: ":2181",
},
Timeout: defaultTimeout,
MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
}
}
Expand Down
7 changes: 2 additions & 5 deletions receiver/zookeeperreceiver/scraper.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,12 @@ func (z *zookeeperMetricsScraper) shutdown(_ context.Context) error {
}

func (z *zookeeperMetricsScraper) scrape(ctx context.Context) (pmetric.Metrics, error) {
var ctxWithTimeout context.Context
ctxWithTimeout, z.cancel = context.WithTimeout(ctx, z.config.Timeout)

responseMntr, err := z.runCommand(ctxWithTimeout, "mntr")
responseMntr, err := z.runCommand(ctx, "mntr")
if err != nil {
return pmetric.NewMetrics(), err
}

responseRuok, err := z.runCommand(ctxWithTimeout, "ruok")
responseRuok, err := z.runCommand(ctx, "ruok")
if err != nil {
return pmetric.NewMetrics(), err
}
Expand Down
5 changes: 2 additions & 3 deletions receiver/zookeeperreceiver/scraper_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,6 @@ func TestZookeeperMetricsScraperScrape(t *testing.T) {
require.NoError(t, err)
require.Equal(t, "zookeeper", z.Name())

ctx := context.Background()

if tt.setConnectionDeadline != nil {
z.setConnectionDeadline = tt.setConnectionDeadline
}
Expand All @@ -301,7 +299,8 @@ func TestZookeeperMetricsScraperScrape(t *testing.T) {
if tt.sendCmd != nil {
z.sendCmd = tt.sendCmd
}

ctx, cancel := context.WithTimeout(context.Background(), z.config.Timeout)
defer cancel()
actualMetrics, err := z.scrape(ctx)
require.NoError(t, z.shutdown(ctx))

Expand Down

0 comments on commit 15ebd27

Please sign in to comment.