Skip to content

HISTORY.md

Latest commit

 

History

History
211 lines (144 loc) · 7.08 KB

HISTORY.md

File metadata and controls

211 lines (144 loc) · 7.08 KB
Raw

Unreleased

Upgrade note: new request headers

This release sends two request headers that earlier versions did not: Authorization (HTTP Basic, carrying your write key) and X-Retry-Count (sent on retries only). If traffic to Segment passes through a proxy, gateway or WAF that allowlists request headers, add both before upgrading or uploads will be rejected.

Retry handling

  • Uploads are retried on 408, 410, 429, 460, and 5xx except 501 and 505. 511 is retried only when an oauth_manager is configured, and dropped otherwise.
  • A Retry-After header is honoured on any retryable response, not only 429. Numeric seconds and the RFC 7231 HTTP-date formats are both accepted, and the value is capped at 300 seconds.
  • Responses carrying Retry-After are retried for up to max_rate_limit_duration and do not consume the retry count. A Retry-After that will not fit in what is left of the budget ends the episode rather than being shortened: retrying inside the window the server asked for sends a request it has already declined to serve, and the budget would be spent by then anyway. Other failures use exponential backoff from 500ms to a 60 second ceiling, limited by max_retries and by max_total_backoff_duration as an upper bound.
  • New client options, both in seconds: max_rate_limit_duration (default 1800) and max_total_backoff_duration (default 43200).
  • flush() and shutdown() are bounded by the same limits, and a pending retry does not delay shutdown.

Other changes

  • The write key is sent as an Authorization: Basic header. It remains in the request body, so no server-side change is required. Deployments using OAuth continue to send Authorization: Bearer.
  • X-Retry-Count is sent on retries, allowing the server to distinguish a retry from a first attempt. It is omitted on the first attempt.
  • Only 2xx responses count as a successful upload. A 3xx is reported as a failed upload rather than treated as delivered, and is not retried. The Segment endpoint does not redirect, so this affects only custom host values.

2.3.6 / 2026-4-7

  • Update and widen PyJWT version to address security issue

2.3.5 / 2025-11-18

  • Fix for Github Issue #516
  • Fix for Github Issue #515
  • Fix for Github Issue #493
  • Updated the version to 2.3.5
  • Enhanced retry logic in segment/analytics/consumer.py by adding detailed debug logs for each retry attempt and logging an error when all retries are exhausted.
  • Moved the return success out of the finally block in segment/analytics/consumer.py at Line 84.
  • Removed redundant error logging in segment/analytics/request.py to avoid duplicate logs when exceptions are raised.

2.3.4 / 2025-2-24

  • Fix for proxy values not being used

2.3.3 / 2024-10-07

  • Update time handling and OAuth

2.3.2 / 2024-02-15

  • Updating version to create a release wheel without the outdated /analytics files

2.3.1 / 2024-02-07

  • Fixing dependency for JWT

2.3.0 / 2024-01-29

  • OAuth 2.0 support
  • Adding Python 3.10 and 3.11 classifiers by @mvinogradov-wavefin
  • Update from monotonic to time module by @rudyardrichter
  • Correct HISTORY header for most recent release by @DavidCain

2.2.3 / 2023-06-12

  • Update project to use GitHub Actions
  • Support for Python 3.10 and 3.11
  • Return values for function calls via the proxy

2.2.2 / 2022-11-29

  • Specifying milliseconds as the isoformat rather than the default microseconds in timestamp

2.2.1 / 2022-06-23

  • Empty Catch fix #217
  • Build Isolation fix #216
  • Removing remaining string_type references

2.2.0 / 2022-03-07

  • Remove Python 2 support
  • Remove six package

2.1.0 / 2022-03-04

  • Raise exception on large message
  • Automatically coerce Enum values inside messages
  • Handle exceptions in the try catch and log them

2.0.0 / 2021-10-01

  • Update package name and namespace name

1.5.0 / 2021-09-23

  • Update tests with latest dependencies
  • Remove unsupported python versions 2.7 & 3.5

1.4.0 / 2021-07-16

  • Fix the missing upload_size parameter

1.3.1 / 2021-05-12

  • Fix linting code and readme heling basic things.
  • Add support for HTTP proxy
  • Allows more settings to be configured from singleton

1.3.0-beta1 / 2019-04-27

  • Add sync_mode option (#147)

1.3.0-beta0 / 2018-10-10

  • Add User-Agent header to messages
  • Don't retry sending on client errors except 429
  • Allow user-defined upload interval
  • Add shutdown function
  • Add gzip support
  • Add exponential backoff with jitter when retrying
  • Add a parameter in Client to configure max retries
  • Limit batch upload size to 500KB
  • Drop messages greater than 32kb
  • Allow user-defined upload size
  • Support custom messageId

1.2.9 / 2017-11-28

  • Fix: Stringify non-string userIds and anonymousIds.

1.2.8 / 2017-09-20

  • Fix: Date objects are removed from event properties.
  • Fix: Fix for regression introduced in version 1.2.4.

1.2.7 / 2017-01-31

  • Fix: Correctly serialize date objects.

1.2.6 / 2016-12-07

  • don't add messages to the queue if send is false
  • drop py32 support

1.2.5 / 2016-07-02

  • Fix outdated python-dateutil<2 requirement for python2 - dateutil > 2.1 runs is python2 compatible
  • Fix a bug introduced in 1.2.4 where we could try to join a thread that was not yet started

1.2.4 / 2016-06-06

  • Fix race conditions in overflow and flush tests
  • Join daemon thread on interpreter exit to prevent value errors
  • Capitalize HISTORY.md (#76)
  • Quick fix for Decimal to send as a float

1.2.3 / 2016-03-23

  • relaxing requests dep

1.2.2 / 2016-03-17

  • Fix environment markers definition
  • Use proper way for defining conditional dependencies

1.2.1 / 2016-03-11

  • fixing requirements.txt

1.2.0 / 2016-03-11

  • adding versioned requirements.txt file

1.1.0 / 2015-06-23

  • Adding fixes for handling invalid json types
  • Fixing byte/bytearray handling
  • Adding logging.DEBUG fix for setLevel
  • Support HTTP keep-alive using a Session connection pool
  • Suppport universal wheels
  • adding .sentAt
  • make it really testable
  • fixing overflow test
  • removing .io's
  • Update README.md
  • spacing

1.0.3 / 2014-09-30

  • adding top level send option

1.0.2 / 2014-09-17

  • fixing debug logging levels

1.0.1 / 2014-09-08

  • fixing Unicode handling, for write_key and events
  • adding six to requirements.txt and install scripts

1.0.0 / 2014-09-05

  • updating to spec 1.0
  • adding python3 support
  • moving to analytics.write_key API
  • moving consumer to a separate thread
  • adding request retries
  • making analytics.flush() synchronous
  • adding full Travis tests

0.4.4 / 2013-11-21

  • add < python 2.7 compatibility by removing delta.total_seconds

0.4.3 / 2013-11-13

  • added datetime serialization fix (alexlouden)

0.4.2 / 2013-06-26

  • Added history.d change log
  • Merging #14 to add support for lists and PEP8 fixes. Thanks https://github.com/dfee!
  • Fixing #12, adding static public API to analytics.init