Skip to content

History.md

Latest commit

 

History

History
316 lines (233 loc) · 11.2 KB

History.md

File metadata and controls

316 lines (233 loc) · 11.2 KB
Raw

Unreleased

Upgrade note: new request header and proxy allowlists

This release sends an X-Retry-Count request header on retries. If your traffic to Segment goes through a proxy, gateway or WAF that allowlists request headers, add it before upgrading or retried uploads will be rejected. The Authorization header is unchanged: this client has always sent the write key as HTTP Basic credentials.

  • Send X-Retry-Count on retries, so the server can distinguish a retry from a first attempt. Omitted on the first attempt.
  • Unified retry handling: 429, 408, 410, 460 and 5xx (except 501, 505 and 511) are retried. Retry-After is honoured on all of them, not just 429, which brings 529 in through the generic 5xx rule.
  • Retry-After accepts numeric seconds and the RFC 7231 HTTP-date formats, capped at 300s (rate_limit_retry_after_cap).
  • Rate-limited retries are bounded by elapsed time rather than counted against the retry limit, so a long Retry-After no longer exhausts the budget.
  • New options max_total_backoff_duration and max_rate_limit_duration (default 12 hours each) bound the two waits.
  • Only 2xx responses count as a successful upload. A 3xx is now reported as a failed upload rather than silently treated as delivered. It is not retried: a redirect Net::HTTP already declined to follow will not succeed on a retry. The Segment endpoint does not redirect, so this only affects custom host values.
  • Network errors are retried on the same backoff schedule as failed responses instead of dropping the batch.
  • Backoff waits no longer block shutdown for the full delay.
  • Retry timing uses a monotonic clock, so a system clock change cannot stretch or collapse a backoff.
  • Backoff intervals are now jittered at the ceiling as well, so clients that back off together do not retry in lockstep.
  • Default backoff pacing changed: the base wait is 500ms (was 100ms), the ceiling is 60s (was 10s), and the multiplier is 2 (was 1.5). This aligns ruby with the other Segment SDKs, but it does mean a retry schedule that was previously 100ms, 150ms, 225ms… now starts at 500ms and climbs faster. Set min_timeout_ms, max_timeout_ms and multiplier on a BackoffPolicy to keep the old pacing.
  • A backoff_policy supplied by the caller that does not implement reset! now logs a warning. One policy instance serves every batch, so without reset! its attempt count accumulates and retries get slower the longer the process runs.
  • Fix retries granting one fewer attempt than configured. A configured 10 performed 9, and retries: 1 performed none at all.

2.5.0 / 2024-07-17

  • Fix silent failures (#269)
  • Update to Ruby 3.2 (#262)
  • Rename Segment namespace to SegmentIO (#259)
  • Lower allocated and retained strings (#258)
  • Modify timestamp to have 3 fractional digits (#250 && #251)
  • Fix for empty user_id or anonymous_id (#245)
  • Not enqueuing test action in real queue (#237)
  • Fix test queue reset! documentation (#235)

2.4.0 / 2021-05-05

  • Enable overriding transport Pass options when initializing Transport (#230)

2.3.1 / 2021-04-13

  • Add test option for easier testing (#222)

2.3.0 / 2021-03-26

  • Improvement: Update timestamp for sub-millisecond reporting
  • Update supported Ruby versions (2.4, 2.5, 2.6, 2.7), remove unsupported Ruby versions (2.0, 2.1, 2.2, 2.3)

2.2.8 / 2020-02-10

  • Promoted pre-release version to stable.

2.2.8.pre / 2019-11-29

  • Fix: Fix log message for stubbed requests
  • Deprecate: Deprecate Ruby <2.0 support

2.2.7 / 2019-05-09

  • Fix: Allow anonymous_id in #alias and #group.

2.2.6 / 2018-06-11

  • Promote pre-release version to stable.
  • Fix: Don't assume all errors are 'ConnectionError's

2.2.6.pre / 2018-06-27

  • Fix: Revert 'reuse TCP connections' to fix EMFILE errors
  • Fix: Fix oj/rails conflict
  • Fix: Add missing 'Forwardable' requirement
  • Improvement: Better logging

2.2.5 / 2018-05-01

  • Fix: Require version module first.

2.2.4 / 2018-04-30

  • Promote pre-release version to stable.

2.2.4.pre / 2018-02-04

  • Fix: Prevent 'batch size exceeded' errors by automatically batching items according to size
  • Performance: Reuse TCP connections
  • Improvement: Emit logs when in-memory queue is full
  • Improvement: Emit logs when messages exceed maximum allowed size
  • Improvement: Add exponential backoff to retries
  • Improvement: Handle HTTP status code failure appropriately

2.2.3.pre / 2017-09-14

  • Fix: Override respond_to_missing instead of respond_to? to facilitate mock the library in tests.

2.2.2 / 2016-08-03

  • adding commander as dep (for CLI)

2.2.1 / 2016-08-03

  • add executables to spec

2.2.0 / 2016-08-03

  • Adding an (experimental) CLI

2.1.0 / 2016-06-17

  • Fix: Ensure error handler is called before Client#flush finishes.
  • Feature: Support setting a custom message ID.

2.0.13 / 2015-09-15

  • readme: updated install docs
  • fix: page/screen to allow no name
  • git: ignore ruby version
  • travis-ci: remove old rubys

2.0.12 / 2015-01-10

  • Fix batch being cleared and causing duplicates

2.0.11 / 2014-09-22

  • fix: don't clear batch if request failed

2.0.10 / 2014-09-22

  • Move timeout retry above output

2.0.9 / 2014-09-22

  • Fix rescuing timeouts

2.0.8 / 2014-09-11

  • fix: add 3 ms to timestamp

2.0.7 / 2014-08-27

  • fix: include optional options hash in calls

2.0.6 / 2014-08-12

  • fix: category param on #page and #screen

2.0.5 / 2014-05-26

  • fix: datetime conversions

2.0.4 / 2014-06-11

  • fix: isofying trait dates in #group

2.0.3 / 2014-06-04

  • fix: undefined method `is_requesting?' for nil:NilClass when calling flush (#51)

2.0.2 / 2014-05-30

  • fix: formatting ios dates
  • fix: respond_to? implementation
  • add: able to stub requests by setting STUB env var

2.0.1 / 2014-05-15

  • add: namespace under Segment::Analytics
  • add: can create multiple instances with creator method (rather than having a singleton)
  • add: logging with Logger instance or Rails.logger if available
  • add: able to stub requests so they just log and don't hit the server
  • fix: worker continues running across forked processes
  • fix: removed usage of ActiveSupport methods since its not a dependency
  • fix: sending data that matches segment's new api spec

(there is no v2.0.0)

1.1.0 / 2014-04-17

1.0.0 / 2014-03-12

  • removing faraday dependency

0.6.0 / 2014-02-19

  • adding .group(), .page(), and .screen() calls
  • relaxing faraday dependency, fixes #31

0.5.4 / 2013-12-31

  • Add requestId fields to all requests for tracing.

0.5.3 / 2013-12-31

  • Allow the consumer thread to shut down so it won't remain live in hot deploy scenarios. This fixes the jruby memory leak by @nirvdrum

0.5.2 / 2013-12-02

  • adding sleep backoff between connection retries

0.5.1 / 2013-11-22

  • adding retries for connection hangups

0.5.0 / 2013-10-03

  • Removing global Analytics constant in favor of adding it to our config. NOTE: If you are upgrading from a previous version and want to continue using the Analytics namespace, you'll have to add Analytics = AnalyticsRuby to your config. Otherwise you WILL NOT be sending analytics data. See the setup docs for more info

0.4.0 / 2013-08-30

  • Adding support and tests for 1.8.7

0.3.4 / 2013-08-26

  • Pass Time values as iso8601 timestamp strings

0.3.3 / 2013-08-02

  • Allow init/track/identify/alias to accept strings as keys. by @shipstar

0.3.2 / 2013-05-28

0.3.1 / 2013-04-29

  • Adding check for properties to be a Hash

0.3.0 / 2013-04-05

  • Adding alias call

0.2.0 / 2013-03-21

  • Adding flush method

0.1.4 / 2013-03-19

  • Adding ClassMethods for more extensibility by arronmabrey

0.1.3 / 2013-03-19

0.1.2 / 2013-03-11

  • Fixing thrown exception on non-initialized tracks thanks to sbellity

0.1.1 / 2013-02-11

  • Updating dependencies
  • Adding actual support for MultiJson 1.0

0.1.0 / 2013-01-22

  • Updated docs to point at segment.io

0.0.5 / 2013-01-21

  • Renaming of all the files for proper bundling usage

0.0.4 / 2013-01-17

  • Updated readme and install instruction courtesy of @zeke
  • Removed typhoeus and reverted to default adapter
  • Removing session_id in favor of a single user_id

0.0.3 / 2013-01-16

  • Rakefile and renaming courtesy of @kiennt
  • Updated tests with mocks