Skip to content

HISTORY.md

Latest commit

 

History

History
394 lines (284 loc) · 13.6 KB

HISTORY.md

File metadata and controls

394 lines (284 loc) · 13.6 KB
Raw

Unreleased

Upgrade note: new request header

This release sends an X-Retry-Count request header on retries. If traffic to Segment passes 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.

Upgrade note: retries take longer than they used to

Both the LibCurl and Socket consumers previously gave up after roughly 13 seconds of waiting — seven retries for Socket, six for LibCurl, which checked its backoff ceiling before each attempt rather than after. Both now honour retry_count (default 10) and back off from 500ms rather than 100ms, so a failing upload is retried for considerably longer than before.

This matters most for the default LibCurl consumer, which retries inline on the calling thread: with the default retry_count a persistently failing upload spends around four minutes in waits, plus however long each attempt takes, before giving up. On a web request that is a worker held for the duration. Lower retry_count to restore a shorter schedule, or use the file consumer, which records events without making a network call.

The two consumers cap an individual wait differently: LibCurl caps each wait at 60 seconds, while Socket caps it at maximum_backoff_duration, whose default is 10 seconds.

Upgrade note: track() return value

track() and the other message methods return the result of a flush when the queue reaches flush_at. Previously the LibCurl consumer reported success for any response it had finished with, including a 4xx and a retry-exhausted upload, so that flush almost always returned true. It now returns false when the batch was not delivered, and flush() stops at the first failing batch rather than continuing through the queue. Code branching on the return value of track() will see failures it did not see before.

Retry handling

  • Uploads are retried on 408, 410, 429, 460, and 5xx except 501, 505 and 511.
  • 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, malformed values are ignored, and the value is capped at rate_limit_retry_after_cap.
  • Responses carrying Retry-After are retried for up to max_rate_limit_duration and do not consume the retry count. Other failures use exponential backoff limited by retry_count and by max_total_backoff_duration as an upper bound.
  • New options, all in seconds: max_rate_limit_duration (default 300 — deliberately shorter than in Segment's other server libraries, because the LibCurl consumer retries inline on the calling thread, so this budget is time a web request spends blocked and a PHP-FPM worker spends occupied), max_total_backoff_duration (default 43200) and rate_limit_retry_after_cap (default 300). Negative values are ignored, logged, and the default kept, as is a rate_limit_retry_after_cap of 0 — a cap of zero would clamp every wait to nothing and, since that path does not consume a retry, post continuously for the whole budget. A retry_count of 0 does mean do not retry, and curl_timeout of 0 still means no limit.
  • Retry-After is not read by the Socket consumer, which uses exponential backoff for every retryable response. Use the default LibCurl consumer if you need it.
  • Exhausting the rate-limit budget is logged regardless of the debug setting.
  • These budgets bound one batch: it is retried for up to max_rate_limit_duration on responses carrying Retry-After and, independently, up to max_total_backoff_duration on those without, so a response stream that mixes the two spends both — plus however long the request in flight takes, which curl_timeout bounds only if it has been set — it defaults to no limit. A single flush() sends as many batches as the queue holds, waiting flush_interval between them, so it can take considerably longer than any one batch's budget. Applications that cannot block for that long can use the file consumer, which records events to a log file with no network call and uploads them out of band.

Other changes

  • X-Retry-Count is sent on retries by the LibCurl and Socket consumers, 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: a redirect curl has already declined to follow will not succeed on one. The Segment endpoint does not redirect, so this affects only custom host values.

3.8.2 / 2026-03-11

  • Fix OS command injection in ForkCurl consumer (#246)

3.8.1 / 2025-01-27

  • Convert the exec output to string (#239)

3.8.0 / 2024-02-15

  • Include support for 8.3 (#231)

3.7.0 / 2023-09-11

  • Convert to github actions
  • Remove circleci config/files
  • Update autoloader

3.6.0 / 2023-03-28

  • Issue #208 Correct autoload require statement (#209)
  • Fix missing version information (#207)
  • Include support for 8.1 * 8.2 (#210)

3.5.0 / 2022-08-17

  • Correct Payload size check of 512kb (#202)
  • Add new consumer configurable options: curl_timeout, curl_connecttimeout, max_item_size_bytes, max_queue_size_bytes (#192, #197, #198)
  • Deprecate HTTP Option (#194 & #195)

3.0.0 / 2021-10-14

  • PSR-12 coding standard with Slevomat and phcs extensions
  • Namespace and file rearrangement to follow PSR-4 naming scheme and more logical separation
  • Provide strict types for all properties, parameters, and return values
  • Add an exception class so we can have segment-specific exceptions
  • Add dependencies on JSON extension
  • Add dependency on the Roave security checker
  • Since the library already required a minimum of PHP 7.4, make use of PHP 7.4+ features, and avoid compat issues with 8.0
  • More sensible error handling, don't try to catch exceptions that are never thrown
  • Extensive linting and static analysis using phpcs, psalm, phpstan, and PHPStorm to spot issues

2.0.0 / 2021-07-16

  • Modify Endpoint to match API docs (#171)
  • usleep in flush() causes unexpected delays on page loads (#173)
  • Support PHP 8 (#152)
  • Remove Support for PHP 7.2
  • Namespacing (#182)

1.8.0 / 2021-05-31

  • Fix socket return response (#174)
  • API Endpoint update (#168)
  • Update Batch Size Check (#168)
  • Remove messageID override capabilities (#163)
  • Update flush sleep waiting period (#161)

1.7.0 / 2021-03-10

  • Retry Network errors (#136)
  • Update Tests [Improvement] (#132)
  • Updtate Readme Status Badging (#139)
  • Bump e2e tests to latest version [Improvement] (#142)
  • Add Limits to message, batch and memory usage [Feature] (#137)
  • Add Configurable flush parameters [Feature] (#135)
  • Add ability to use custom consumer [Feature] (#61)
  • Add ability to set file permissions [Feature] (#122)
  • Fix curl error handler [Improvement] (#97)
  • Fix timestamp implementation for microseconds (#94)
  • Modify max queue size setting to match requirements (#153, #146)
  • Add ability to set userid as zero (#157)

1.6.1-beta / 2018-05-01

  • Fix tslint error in version.php

1.6.0-beta / 2018-04-30

  • Add License file
  • Coding style fixers (#112)
  • rename type to method to match new harness contract (#110)
  • Increase Code coverage (#108)
  • Add Linter to CI (#109)
  • When the message size is larger than 32KB, return FALSE instead of throw exception
  • Make writeKey required as a flag in the CLI instead of as an environment variable.
  • Verify message size is below than 32KB
  • Run E2E test when RUN_E2E_TESTS is defined
  • Add Rfc 7231 compliant user agent into request header
  • Add backoff for socket communication
  • Implement response error handling for POST request and add backoff (in LibCurl)
  • Change environment to precise as default
  • CI: Make PHP 5.3 test to be run in precise environment
  • Make host to be configurable
  • Add anonymousId in group payload

1.5.2 / 2017-08-18

  • Always set default context.

1.5.1 / 2017-04-06

  • Use require_once() instead of require(). Fixes issue where separate plugins in systems such as Moodle break because of class redeclaration when using separate internal versions of Segment.io.

1.5.0 / 2017-03-03

  • Adding context.library.consumer to all PHP events
  • libcurl consumer will retry once if http response is not 200
  • update link to php docs
  • improve portability and reliability of Makefile across different platforms (#74)

1.4.2 / 2016-07-11

  • remove the extra -e from echo in makefile

1.4.1 / 2016-07-11

  • use a more portable shebang

1.4.0 / 2016-07-11

  • adding a simple wrapper CLI
  • explicitly declare library version in global scope during creating new release to allow using library with custom autoload (composer for example)

1.3.0 / 2016-04-05

  • Introducing libcurl consumer
  • Change Consumer to protected instead of private

1.2.7 / 2016-03-04

  • adding global

1.2.6 / 2016-03-04

  • fix version

1.2.5 / 2016-03-04

  • Adding release script, fixing version
  • Pass back ->flush() result to allow caller code know if flushed successfully

1.2.4 / 2016-02-17

  • core: fix error name
  • send: make send.php executable
  • socket: adding fix for FIN packets from remote

1.2.3 / 2016-02-01

  • instead of using just is_int and is_float for checking timestamp, use filter_var since that can detect string ints and floats - if its not a string or float, consider it might be a ISO8601 or some other string, so use strtotime() to support other strings

1.2.1 / 2015-12-29

  • socket open error checking fix
  • Fix batch size check before flushing tracking queue
  • Fix bug in send.php

1.2.0 / 2015-04-27

  • removing outdated test
  • enabling ssl by default
  • socket: bump timeout to 5s

1.1.3 / 2015-03-03

  • formatTime: use is_* and fix to support floats

1.1.2 / 2015-03-03

  • send.php: fix error handling
  • client: fix float timestamp handling

1.1.1 / 2015-02-11

  • Add updated PHP version requirement for @phpunit
  • add .sentAt

1.1.0 / 2015-01-07

  • support microtime
  • Update README.md
  • drop the io

1.0.3 / 2014-10-14

  • fix: empty array for traits and properties

1.0.2 / 2014-09-29

  • fix: identify(), group() with empty traits
  • suppressing logs generated when attempting to write to a reset socket [j0ew00ds]
  • Added PHP 5.6, 5.5 and HHVM to travis.yml [Nyholm]

1.0.1 / 2014-09-16

  • fixing validation for Segment::page() calls
  • updating send.php error message
  • fix send.php to exit gracefully when there is no log file to process

1.0.0 / 2014-06-16

  • update to work with new spec
  • add ./composer.phar validation test
  • better send.php output
  • add validation
  • use strtotime in send.php and support php5.3
  • rename Analytics to Segment
  • add send.php to replace file_reader.py
  • add new methods implementation and tests
  • implement spec changes
  • change tests to reflect spec changes
  • test changes:
  • Fix typo in composer.json

0.4.8 / 8-21-2013

  • adding fix for socket requests which might complete in multiple fwrites

0.4.7 / 5-28-2013

  • chmod the log file to 0777 so that the file_reader.py can read it

0.4.6 / 5-25-2013

  • Check for status existing on response thanks to @gmoreira

0.4.5 / 5-20-2013

  • Check for empty secret thanks to @mustela.

0.4.3 / 5-1-2013

  • Make file_reader rename to a file in the same directory as the log file thanks to @marshally

0.4.2 / 4-26-2013

  • Fix for $written var on connection error thanks to @gmoreira

0.4.1 / 4-25-2013

  • Adding fix to file_reader alias

0.4.0 / 4-8-2013

  • Full Autoloading an PEAR naming by Cethy
  • Adding alias call

0.3.0 / 3-22-2013

  • Adding try-catch around fwrite cal

0.2.7 / 3-17-2013

  • Adding file_reader.py fix

0.2.6 / 3-15-2013

  • Rename analytics.php -> Analytics.php to allow autoloading by Cethy

0.2.5 / 2-22-2013

0.2.4 / 2-19-2013

  • Support fwrite retry on closed socket.

0.2.3 / 2-12-2013

  • Adding check for count in properties and traits length.

0.2.2 / 2-11-2013

  • Adding default args for properties

0.2.1 / 2-1-2013

  • Enabling pfsockopen for persistent connections
  • Making socket default

0.2.0 / 2-1-2013

  • Updating consumer class to use shared functions.
  • Removed fork consumer, renamed fork_queue to fork_curl.

0.1.1 / 1-30-2013

  • Adding fork consumer
  • Adding fork_queue consumer
  • Setting fork_queue consumer to be the default.

0.1.0 / 1-29-2013

Initial version