Skip to content

Latest commit

 

History

History
468 lines (344 loc) · 21.3 KB

CHANGELOG.md

File metadata and controls

468 lines (344 loc) · 21.3 KB
Raw

Changes

5.6.0 / xxxx-xx-xx

5.5.0 / 2024-01-23

  • [FEATURE] Added support for Origin Detection when the container-id is unavailable from inside the application container, only applies to cgroupv2. See #291.
  • [FEATURE] Added DistributionSamples which is similar to Distribution, but it lets the client handle the sampling. The rate is passed to the Agent and not used for further sampling. See #296.
  • [IMPROVEMENT] The Aggregator no longer allocates memory if there are no tags present. See #297.

5.4.0 / 2023-12-07

  • [FEATURE] Add WithMaxSamplesPerContext() option to limit the number of samples per context. See #292.
  • [BUGFIX] Fix the rate of distributions and histograms when using client side aggregation. See #283.

5.3.0 / 2023-03-06

  • [FEATURE] Added support for DD_DOGSTATSD_URL. You can now use this env var to set the URL to use to connect to DogStatsD. See #273
    • Please be aware that DD_DOGSTATSD_URL takes precedence over the DD_AGENT_HOST. If you have both set please make sure the value for DD_DOGSTATSD_URL is correct.

5.2.0 / 2022-12-21

  • [BETA][FEATURE] Support sending counters and gauges with timestamp. See #262
  • [BUGFIX] Fix issue where ticker.Stop() wasn't being called when aggregator is stopped. See #269, thanks @byronwolfman.

5.1.1 / 2022-05-05

  • [BUGFIX] Fix issue where tags of aggregated contexts could be modified after being sampled. See #258.

5.1.0 / 2022-03-02

  • [FEATURE] Adding support for container origin detection. See #250.
  • [FEATURE] Adding IsClosed method the client. See #254, thanks @lucassscaravelli.
  • [FEATURE] Adding a mock for the Client interface to ease testing from users. See #255.
  • [IMPROVEMENT] Optimize getContext and getContextAndTags functions. See #253, thanks @martin-sucha.
  • [IMPROVEMENT] Export error MessageTooLongError to catch error when sending message that can't fit in a buffer. See #252.
  • [BUGFIX] Add missing GetTelemetry from the Client Interface. See #255.

5.0.2 / 2021-11-29

5.0.1 / 2021-10-18

  • [BUGFIX] Fix Event.Check method: text is no longer required. See #235.

5.0.0 / 2021-10-01

Breaking changes

Many field/methods have been removed from the public API of the client to allow for the client internals to evolve more easily in the future without breaking the public API of the client.

  • New import path for the v5 is github.com/DataDog/datadog-go/v5/statsd
  • The project now use go.mod file for its dependencies.
  • WithDevMode option has been removed. The extended telemetry enabled by WithDevMode is now part of the default telemetry.
  • WithWriteTimeoutUDS option has been renamed WithWriteTimeout since it also impact named pipe transport.
  • SetWriteTimeout method has been removed in favor of WithWriteTimeout option.
  • The following internal fields and methods have been removed from the public API:
    • WriterNameUDP
    • WriterNameUDS
    • WriterWindowsPipe
    • TelemetryInterval
  • Field Client.Namespace is now private, please use the WithNamespace option.
  • Field Client.Tags is now private, please use the WithTags option.
  • Method NewBuffered has been removed in favor of the WithMaxMessagesPerPayload() option. Instead of statsd.NewBuffered(add, bufferLength) please use statsd.New(addr, statsd.WithMaxMessagesPerPayload(bufferLength))
  • Encode method for Event and ServiceCheck have been removed.
  • The Check method for Event and ServiceCheck now uses pointer receivers.
  • All Options internals are no longer part of the public API. Only the part needed by the client app is left in the public API. This also improves/clarifies the Options documentation and usage.
  • statsdWriter have been removed from the API, io.WriteCloser can now be used instead.
  • SenderMetrics and ClientMetrics structs as well as FlushTelemetryMetrics method have been removed from the public API in favor of the Telemetry struct and the GetTelemetry method. The client telemetry is now cummulative since the start of the client instead of being reset after being sent to the Agent. See Telemetry struct documentation for more information on what each field represents. This allows client apps to take action based on the telemetry (ex: adapting sampling rate based on the number of packets dropped). The telemetry sent to the agent hasn't changed so the same dashboard can be used for V4 and V5 apps.
  • Client side aggregation for Counts, Gauges and Sets is enabled by default. See WithoutClientSideAggregation() option to disable it.
  • WithBufferShardCount option has been renamed WithWorkersCount.

Notes

  • [FEATURE] Adding public method GetTelemetry to retrieve the client internal telemetry since the start of the client.
  • [FEATURE] Client side aggregation for Counts, Gauges and Sets is enabled by default. WithExtendedClientSideAggregation() for Timings, Histograms and Distributions is still disabled by default. Both features are no longer considered BETA.

4.8.3 / 2021-10-27

  • [BUGFIX] Fix Event.Check method: text is no longer required. See #237.

4.8.2 / 2021-09-06

  • [BETA][BUGFIX] Fix race condition in aggregation where two sample could overwrite each other when sampled for the first time. See #225

4.8.1 / 2021-07-09

  • [BUGFIX] Prevent telemetry from using the client global namespace. See #205
  • [BETA][BUGFIX] Fix timings having a different precision with and without extended aggregation. See #204

4.8.0 / 2021-06-14

  • [BETA][IMPROVEMENT] Reduce aggregation default window to 2s to reduce sampling aliasing. See #199
  • [IMPROVEMENT] Automatically add a "\n" after each metric so the agent can determine if a metric is truncated. Per source EOL detection was made available in agent 7.28 with the dogstatsd_eol_required setting. See #198

4.7.0 / 2021-05-05

  • [BETA] Increase the number of workers in the aggregator when using channelMode with extended aggregation to have similar performance than channelMode without aggregation. See #195.

4.6.1 / 2021-04-30

  • [BETA BUGFIX] Fix telemetry with extended aggregation and channelMode. See #194.

4.6.0 / 2021-04-16

  • [BETA] Support sample rate and channel mode for extended aggregation (ie: histograms, distributions and timings). See #187.

4.5.1 / 2021-03-31

  • [BUGFIX] Fix support of UDS and named pipe for DD_AGENT_HOST environment variable. See #192.

4.5.0 / 2021-03-15

  • [IMPROVEMENT] Increase UDS default timeout from 1ms to 100ms. See #186.
  • [IMPROVEMENT] Defer connection establishment to first write for Windows Named Pipe. See #190.

4.4.0 / 2021-02-10

  • [BETA BUGFIX] Fix multi-metric aggregation when packing different metrics in the same packet. See #181.
  • [FEATURE] Add support for Windows Named Pipes (Windows only). See #182 and #185.

4.3.1 / 2021-01-28

  • [BUGFIX] Fix race condition when using sample rate (introduce in 4.3.0). See #179.

4.3.0 / 2021-01-20

  • [BETA] Adding client side aggregation for distributions, histograms and timings. See #176.
  • [IMPROVEMENT] Use a worker-specific random source to remove lock contention. See #178. Thanks to @matthewdale.
  • [IMPROVEMENT] Update devMode telemetry naming and taging to ease graphing in Datadog. See #175.

4.2.0 / 2020-11-02

  • [UDS] Use better payload size defaults for UDS connections. See #171.

4.1.0 / 2020-10-23

[BETA BUGFIX] Ignore sampling rate when client side aggregation is enabled (for Gauge, Count and Set). See #170. [FEATURE] Adding a new option WithDevMode(), to send more telemetry metrics to ease troubleshooting issues. See #169.

4.0.1 / 2020-10-07

Notes

  • [BUGFIX] Fix incomplete manual flush of the sender when the client isn't stopped. See #163.

4.0.0 / 2020-08-21

Notes

  • [FEATURE] Add new option WithTelemetryAddr, to send the telemetry data to a different endpoint. See #157.
  • [BUGFIX] Fix race condition in the flush mechanism of the aggregator. See [#166][]. Thanks to @cyx.

Breaking changes

  • Dropping support for EOL versions of Golang 1.11 and lower.

3.7.2 / 2020-06-16

Notes

  • [BUGFIX] Fix panic on 32bits and ARM when using the telemetry. See #156.
  • [BETA BUGFIX] Fix typo in method name to configure the aggregation window interval. See #154.

3.7.1 / 2020-05-01

Notes

  • [BUGFIX] Fix panic when calling CloneWithExtraOptions with a nil client. See #148.

3.7.0 / 2020-04-29

Notes

  • [FEATURE] Add new function to clone a Client, so library can inherit and extend options from the main application. See #147.
  • [IMPROVEMENT] Auto append a '.' when needed to namespace. See #145. Thanks to @kamatama41.
  • [IMPROVEMENT] Add the client global tags to the telemetry tags. See #143. Thanks to @chrisleavoy.

3.6.0 / 2020-04-21

Notes

  • [IMPROVEMENT] Reduce lock contention by sharding worker by metric name. See #108.
  • [FEATURE] Adding a "channel mode" to send metrics to the client, disable by default. See #134.
  • [BUGFIX] Fix metrics not being flushed when the client is closed. See #144.
  • [BETA] Adding client side aggregation for Gauge, Count and Set. See #139.

3.5.0 / 2020-03-17

Notes

  • [IMPROVEMENT] Add support for DD_ENV, DD_SERVICE, and DD_VERSION to set global tags for env, service and version/ See #137

3.4.1 / 2020-03-10

Notes

  • [BUGFIX] Fix possible deadlock when closing the client. See #135. Thanks to @danp60.

3.4.0 / 2020-01-15

Notes

  • [IMPROVEMENT] Improve tags for the telemetry. See #118.
  • [IMPROVEMENT] Add option to disable the telemetry. See #117.
  • [IMPROVEMENT] Add metrics, event and service check count to the telemetry. See #118.

3.3.1 / 2019-12-13

Notes

  • [BUGFIX] Fix Unix domain socket path extraction. See #113.
  • [BUGFIX] Fix an issue with custom writers leading to metric drops. See #106.
  • [BUGFIX] Fix an error check in uds.Write leading to unneeded re-connections. See #115.

3.3.0 / 2019-12-02

Notes

  • [BUGFIX] Close the stop channel when closing a statsd client to avoid leaking. See #107.

3.2.0 / 2019-10-28

Notes

  • [IMPROVEMENT] Add all Client public methods to the ClientInterface and NoOpClient. See #100. Thanks @skaji.

3.1.0 / 2019-10-24

Notes

3.0.0 / 2019-10-18

Notes

  • [FEATURE] Add a way to configure the maximum size of a single payload (was always 1432, the optimal size for local UDP). See #91.
  • [IMPROVEMENT] Various performance improvements. See #91.
  • [OTHER] The client now pre-allocates 4MB of memory to queue up metrics. This can be controlled using the WithBufferPoolSize option.

Breaking changes

  • Sending a metric over UDS won't return an error if we fail to forward the datagram to the agent. We took this decision for two main reasons:
    • This made the UDS client blocking by default which is not desirable
    • This design was flawed if you used a buffer as only the call that actually sent the buffer would return an error
  • The Buffered option has been removed as the client can only be buffered. If for some reason you need to have only one dogstatsd message per payload you can still use the WithMaxMessagesPerPayload option set to 1.
  • The AsyncUDS option has been removed as the networking layer is now running in a separate Goroutine.

2.3.0 / 2019-10-15

Notes

  • [IMPROVEMENT] Use an error constant for "nil client" errors. See #90. Thanks @asf-stripe.

2.2.0 / 2019-04-11

Notes

  • [FEATURE] UDS: non-blocking implementation. See #81.
  • [FEATURE] Support configuration from standard environment variables. See #78.
  • [FEATURE] Configuration at client creation. See #82.
  • [IMPROVEMENT] UDS: change Mutex to RWMutex for fast already-connected path. See #84. Thanks @KJTsanaktsidis.
  • [IMPROVEMENT] Return error when using on nil client. See #65. Thanks @Aceeri.
  • [IMPROVEMENT] Reduce Client.format allocations. See #53. Thanks @vcabbage.
  • [BUGFIX] UDS: add lock to writer for concurrency safety. See #62.
  • [DOCUMENTATION] Document new options, non-blocking client, etc. See #85.
  • [TESTING] Adding go 1.10 and go 1.11 to CI. See #75. Thanks @thedevsaddam.

2.1.0 / 2018-03-30

Notes

  • [IMPROVEMENT] Protect client methods from nil client. See #52, thanks @ods94065.

2.0.0 / 2018-01-29

Details

Version 2.0.0 contains breaking changes and beta features, please refer to the Notes section below for details.

Notes

  • [BREAKING] statsdWriter now implements io.Writer interface. See #46.
  • [BUGFIX] Flush buffer on close. See #47.
  • [BETA] Add support for global distributions. See #45.
  • [FEATURE] Add support for Unix Domain Sockets. See #37.
  • [FEATURE] Export eventAlertType and eventPriority. See #42, thanks @thomas91310.
  • [FEATURE] Export Flush method. See #40, thanks @colega.
  • [BUGFIX] Prevent panics when closing the udsWriter. See #43, thanks @jacek-adamek.
  • [IMPROVEMENT] Fix issues reported by Golint. See #39, thanks @tariq1890.
  • [IMPROVEMENT] Improve message building speed by using less fmt.Sprintfs. See #32, thanks @corsc.

1.1.0 / 2017-04-27

Notes

  • [FEATURE] Export serviceCheckStatus allowing interfaces to statsd.Client. See #19 (Thanks @Jasrags)
  • [FEATURE] Client.sendMsg(). Check payload length for all messages. See #25 (Thanks @theckman)
  • [BUGFIX] Remove new lines from tags. See #21 (Thanks @sjung-stripe)
  • [BUGFIX] Do not panic on Client.Event when nil. See #28
  • [DOCUMENTATION] Update decr documentation to match implementation. See #30 (Thanks @kcollasarundell)

1.0.0 / 2016-08-22

Details

We hadn't been properly versioning this project. We will begin to do so with this 1.0.0 release. We had some contributions in the past and would like to thank the contributors @aviau, @sschepens, @jovanbrakus, @abtris, @tummychow, @gphat, @diasjorge, @victortrac, @seiffert and @w-vi, in no particular order, for their work.

Below, for reference, the latest improvements made in 07/2016 - 08/2016

Notes

  • [FEATURE] Implemented support for service checks. See #17 and #5. (Thanks @jovanbrakus and @diasjorge).
  • [FEATURE] Add Incr, Decr, Timing and more docs.. See #15. (Thanks @gphat)
  • [BUGFIX] Do not append to shared slice. See #16. (Thanks @tummychow)