From 83f9ad975e0e264f2db19f44b72501454cefc2ef Mon Sep 17 00:00:00 2001 From: Maxime mouial Date: Fri, 9 Oct 2020 12:36:37 +0200 Subject: [PATCH] Make telemetry creator functions private Those function should now have been public in the first place and there signature should not be part of the public API we support. Users shouldn't have any reason to use them as they can control everything through the client options. --- statsd/statsd.go | 4 ++-- statsd/telemetry.go | 6 +++--- statsd/telemetry_test.go | 14 +++++++------- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/statsd/statsd.go b/statsd/statsd.go index 357ee8c1..690d0b5e 100644 --- a/statsd/statsd.go +++ b/statsd/statsd.go @@ -332,10 +332,10 @@ func newWithWriter(w statsdWriter, o *Options, writerName string) (*Client, erro if o.Telemetry { if o.TelemetryAddr == "" { - c.telemetry = NewTelemetryClient(&c, writerName, o.DevMode) + c.telemetry = newTelemetryClient(&c, writerName, o.DevMode) } else { var err error - c.telemetry, err = NewTelemetryClientWithCustomAddr(&c, writerName, o.DevMode, o.TelemetryAddr, bufferPool) + c.telemetry, err = newTelemetryClientWithCustomAddr(&c, writerName, o.DevMode, o.TelemetryAddr, bufferPool) if err != nil { return nil, err } diff --git a/statsd/telemetry.go b/statsd/telemetry.go index 0516d308..8213e9eb 100644 --- a/statsd/telemetry.go +++ b/statsd/telemetry.go @@ -29,7 +29,7 @@ type telemetryClient struct { devMode bool } -func NewTelemetryClient(c *Client, transport string, devMode bool) *telemetryClient { +func newTelemetryClient(c *Client, transport string, devMode bool) *telemetryClient { return &telemetryClient{ c: c, tags: append(c.Tags, clientTelemetryTag, clientVersionTelemetryTag, "client_transport:"+transport), @@ -37,13 +37,13 @@ func NewTelemetryClient(c *Client, transport string, devMode bool) *telemetryCli } } -func NewTelemetryClientWithCustomAddr(c *Client, transport string, devMode bool, telemetryAddr string, pool *bufferPool) (*telemetryClient, error) { +func newTelemetryClientWithCustomAddr(c *Client, transport string, devMode bool, telemetryAddr string, pool *bufferPool) (*telemetryClient, error) { telemetryWriter, _, err := resolveAddr(telemetryAddr) if err != nil { return nil, fmt.Errorf("Could not resolve telemetry address: %v", err) } - t := NewTelemetryClient(c, transport, devMode) + t := newTelemetryClient(c, transport, devMode) // Creating a custom sender/worker with 1 worker in mutex mode for the // telemetry that share the same bufferPool. diff --git a/statsd/telemetry_test.go b/statsd/telemetry_test.go index a23b3cf7..5017b69b 100644 --- a/statsd/telemetry_test.go +++ b/statsd/telemetry_test.go @@ -46,7 +46,7 @@ func TestNewTelemetry(t *testing.T) { client, err := New("localhost:8125", WithoutTelemetry(), WithNamespace("test_namespace")) require.Nil(t, err) - telemetry := NewTelemetryClient(client, "test_transport", false) + telemetry := newTelemetryClient(client, "test_transport", false) assert.NotNil(t, telemetry) assert.Equal(t, telemetry.c, client) @@ -95,7 +95,7 @@ func TestTelemetry(t *testing.T) { client, err := New("localhost:8125", WithoutTelemetry()) require.Nil(t, err) - telemetry := NewTelemetryClient(client, "test_transport", false) + telemetry := newTelemetryClient(client, "test_transport", false) testTelemetry(t, telemetry, basicExpectedMetrics, basicExpectedTags) } @@ -112,7 +112,7 @@ func TestTelemetryDevMode(t *testing.T) { expectedMetrics[k] = v } - telemetry := NewTelemetryClient(client, "test_transport", true) + telemetry := newTelemetryClient(client, "test_transport", true) testTelemetry(t, telemetry, expectedMetrics, basicExpectedTags) } @@ -121,7 +121,7 @@ func TestTelemetryChannelMode(t *testing.T) { client, err := New("localhost:8125", WithoutTelemetry(), WithChannelMode()) require.Nil(t, err) - telemetry := NewTelemetryClient(client, "test_transport", false) + telemetry := newTelemetryClient(client, "test_transport", false) testTelemetry(t, telemetry, basicExpectedMetrics, basicExpectedTags) } @@ -133,7 +133,7 @@ func TestTelemetryWithGlobalTags(t *testing.T) { client, err := New("localhost:8125", WithoutTelemetry(), WithTags([]string{"tag1", "tag2"})) require.Nil(t, err) - telemetry := NewTelemetryClient(client, "test_transport", false) + telemetry := newTelemetryClient(client, "test_transport", false) expectedTelemetryTags := append([]string{"tag1", "tag2", "env:test"}, basicExpectedTags...) testTelemetry(t, telemetry, basicExpectedMetrics, expectedTelemetryTags) @@ -144,7 +144,7 @@ func TestTelemetryWithAggregation(t *testing.T) { client, err := New("localhost:8125", WithoutTelemetry(), WithClientSideAggregation()) require.Nil(t, err) - telemetry := NewTelemetryClient(client, "test_transport", false) + telemetry := newTelemetryClient(client, "test_transport", false) expectedMetrics := map[string]int64{ "datadog.dogstatsd.client.aggregated_context": 5, @@ -161,7 +161,7 @@ func TestTelemetryWithAggregationDevMode(t *testing.T) { client, err := New("localhost:8125", WithoutTelemetry(), WithClientSideAggregation(), WithDevMode()) require.Nil(t, err) - telemetry := NewTelemetryClient(client, "test_transport", true) + telemetry := newTelemetryClient(client, "test_transport", true) expectedMetrics := map[string]int64{ "datadog.dogstatsd.client.aggregated_context": 5,