Skip to content

Releases

Release 1.16.1

Choose a tag to compare

@brettmc brettmc released this 06 Nov 02:32

Security

  • The host detector ran ioreg, kenv and powershell.exe through a shell, so they were
    looked up on PATH, and on Windows in the current directory. A program placed there ran
    instead. It runs /usr/sbin/ioreg, /bin/kenv and reg.exe by absolute path, without a
    shell (GHSA-fc6f-cp96-6g5w).
  • When the host id lookup failed, host.id was "" on macOS and Windows, or /bin/kenv on
    BSD. It is left out instead (GHSA-fc6f-cp96-6g5w).

Full Changelog: 1.16.0...1.16.1

Release 1.16.0

Choose a tag to compare

@brettmc brettmc released this 05 Nov 12:00

Breaking changes

  • OTEL_CONFIG_FILE names one file. It used to be split on commas for instrumentation config
    (#2105).
  • Requires PHP 8.2, and no longer requires symfony/polyfill-php82 (#2091).
  • Requires open-telemetry/api 1.11, for Logging::setLogLevel() (#2068).
  • Requires open-telemetry/sem-conv 1.45, for HttpIncubatingAttributes::HTTP_REQUEST_BODY_CONTENT
    (#2101).
  • If you set an Accept-Encoding header in the exporter headers, only gzip responses are decoded.
    The discovered Guzzle client used to decode responses, and no longer does, so the body of a response
    in another encoding, such as deflate or zstd, is ignored with a warning. Without that header the
    SDK asks for an uncompressed response (#2115, #2112).
  • PsrTransport only decodes gzip responses (also as x-gzip). The body of a successful response
    that can't be decoded, such as a deflate or br one that the specification doesn't mention, is
    ignored with a warning (#2112).

Added

  • OTEL_PHP_EXCLUDED_REQUEST_HEADERS disables the SDK for web requests that have a matching
    header, like OTEL_PHP_EXCLUDED_URLS does for a URL, for example
    User-Agent: kube-probe*,X-Skip-Tracing. Entries are name: value or name, the name ignores
    case and treats _ as -, and the value takes * wildcards. A value cannot contain a comma,
    and a header sent more than once is matched as one value joined with , . Headers are read from
    $_SERVER and are set by the client, so use a header that a trusted proxy sets or removes if
    clients must not be able to opt out. It is evaluated when the SDK autoloads, so it needs an
    autoload per request and does not work in workers that autoload once at boot (#2113).
  • Composable samplers in OpenTelemetry\SDK\Trace\Sampler\Consistent, led by
    CompositeSampler. All are experimental (#2077).
  • The auto root span names spans METHOD path, grouped by OTEL_PHP_TRANSACTION_URL_GROUPS. It
    captures the headers named in OTEL_INSTRUMENTATION_HTTP_SERVER_CAPTURE_REQUEST_HEADERS and
    OTEL_INSTRUMENTATION_HTTP_SERVER_CAPTURE_RESPONSE_HEADERS, and sets
    http.response.status_code. OTEL_PHP_TRANSACTION_SPAN_ENABLED turns it on, and
    OTEL_PHP_TRANSACTION_SPAN_ENABLED_CLI adds a root span for CLI scripts. New
    AutoRootSpan::start() (#2080).
  • OTEL_METRICS_EXEMPLAR_FILTER accepts always_on, always_off and trace_based, and defaults
    to trace_based. all, none and with_sampled_trace still work (#2057).
  • RandomTraceIdGeneratorInterface. Root spans from a generator that implements it, such as
    RandomIdGenerator, get the W3C random trace flag (#2092).
  • TemporalityPreference, an AggregationTemporalitySelectorInterface that picks temporality per
    instrument kind (#2095), and TemporalityPreference::fromName() (#2105).
  • DropAggregation, InstrumentUnitCriteria, ViewTemplate::withAggregationResolver(), and
    recordMinMax on ExplicitBucketHistogramAggregation (#2093).
  • ViewTemplate::withAttributeKeyFilter(), which keeps attribute keys by * and ? patterns.
    Excluded wins (#2095).
  • ConsoleMetricExporter accepts an AggregationTemporalitySelectorInterface and a
    TransportInterface (#2095).
  • SdkBuilder::setLogLevel(), applied by buildAndRegisterGlobal() until its scope is detached
    (#2068).
  • OTEL_PHP_INSTRUMENTATION_HTTP_SERVER_CAPTURE_REQUEST_BODY makes the auto root span record the
    request body as http.request.body.content, cut at
    OTEL_PHP_INSTRUMENTATION_HTTP_SERVER_CAPTURE_REQUEST_BODY_MAX_SIZE bytes (1024 by default).
    It is off by default, records only textual bodies, and does not redact them (#2101).

Changed

  • An unparseable OTEL_CONFIG_FILE, or one set without open-telemetry/sdk-configuration
    installed, logs a warning and leaves the SDK as noop. It used to throw (#2076).
  • Instrumentation config is read from the same parse of OTEL_CONFIG_FILE as the SDK. This needs
    open-telemetry/sdk-configuration 0.10. An older one logs a warning and instrumentation gets no
    config (#2076).
  • A malformed OTEL_RESOURCE_ATTRIBUTES logs a warning and is discarded in full. It used to
    throw, which left the SDK as noop (#2105).
  • A trailing or doubled comma in a map variable such as OTEL_RESOURCE_ATTRIBUTES or
    OTEL_EXPORTER_OTLP_HEADERS is skipped. An entry with an empty key is an error (#2105).
  • BatchSpanProcessor and BatchLogRecordProcessor lower a maxExportBatchSize above
    maxQueueSize to the queue size, with a warning. They used to throw (#2105). They accept a
    schedule delay or export timeout of 0 (#2095).
  • TraceIdRatioBasedSampler warns once when used as a child sampler (#2105). Its description is
    TraceIdRatioBased{...}, not TraceIdRatioBasedSampler{...} (#2092).
  • AlwaysRecordSampler is no longer experimental (#2092).
  • Exception attributes set explicitly on a log record win over those from setException()
    (#2092).
  • HTTP export retries 429, 502, 503 and 504. It used to retry 408, 429 and every 5xx (#2061).
  • Instrument::$unit and $description are strings. A null is stored as '' (#2105).
  • ConsoleMetricExporter writes through a stream transport, and returns false if the metrics
    can't be encoded. It writes NaN and infinities as "NaN", "Infinity" and "-Infinity"
    (#2095).
  • The console exporters' output format is unspecified and may change between releases (#2092).
  • SdkDistribution and DistributionRegistry are @internal. DistributionConfiguration and
    DistributionProperties are experimental (#2097).

Deprecated

  • OTEL_PHP_EXPERIMENTAL_AUTO_ROOT_SPAN. Use OTEL_PHP_TRANSACTION_SPAN_ENABLED, which wins when
    both are set (#2080).
  • EventLoggerProvider, EventLoggerProviderInterface and NoopEventLoggerProvider, with the
    rest of the Events API (#2092).

Fixed

  • Every export failed when the HTTP client decoded a gzip response itself and left Content-Encoding
    in place, as Symfony HttpClient does, because the body was decoded again. PsrTransport now sends
    Accept-Encoding: identity, so the server doesn't compress the response, and the discovered Guzzle
    client no longer decodes responses (decode_content is false). A client you pass in yourself keeps
    its own decoding, but gets the same Accept-Encoding header (#2115).
  • PsrTransport limits the OTLP/HTTP response body to 4 MiB, also after decompression, as the
    specification requires. A larger response is discarded with a warning and the export fails without
    a retry, whatever its status, even if the server accepted the data. Decompression is streamed and
    checked in small steps. The PSR-18 client may buffer the whole response before the limit applies
    (#2112).
  • OTEL_ATTRIBUTE_COUNT_LIMIT and OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT were ignored. They apply to
    span, event, link and log record limits that aren't set more specifically (#2058).
  • PsrTransportFactory ignored its cacert, cert and key arguments. It passes them to the
    HTTP client (#2060). A client that rejects them is created without them, with a warning, and
    Symfony HttpClient no longer rejects them (#2095).
  • A zero HTTP client timeout was dropped, or applied literally by Symfony HttpClient. It means no
    limit (#2095, #2105).
  • The wildcard matcher behind OTEL_PHP_TRANSACTION_URL_GROUPS matched texts it should not: a
    pattern with several * accepted its parts in the wrong order (*health*probe* matched
    client/probe/health) and the last part could overlap an earlier one (ab*bc matched abc)
    (#2113).

Full Changelog: 1.15.0...1.16.0

Release 1.15.0

Choose a tag to compare

@bobstrecansky bobstrecansky released this 15 Jul 15:51

What's Changed:

  • Avoid collecting unsanitized process arguments by @PuvaanRaaj in 1993
  • fix(sdk): don't emit placeholder service.version in Composer detector by @PuvaanRaaj in 2004
  • fix(ResourceInfoFactory): Align ResourceInfoFactory detectors to otel specification by @jerrytfleung in 2006
  • fix(sdk): require sem-conv ^1.38 for VERSION_1_38_0 constant by @PuvaanRaaj in 2003
  • fix(sdk): skip absent keys in FilteredAttributeProcessor by @jorgsowa in 2000
  • fix(sdk): guard Span::setAttributes() against mutation after end() by @jorgsowa in 1999
  • chore(deps): bump open-telemetry/sem-conv to ^1.36.0 by @intuibase in 1994
  • fix(sdk): wire meterProvider for span self-observability metrics and add otel.sdk.span.ended by @intuibase in 1990
  • feat(sdk): implement OTel SDK self-observability metrics by @intuibase in 1987
  • Fix(SDK): Auto root span start timestamps precision by @zigzagdev in 1985
  • Allow span suppression strategy configuration using file-based and env-based config by @Nevay in 1920
  • Fix span suppression with non recording spans by @Nevay in 1921

Full Changelog: 1.14.0...1.15.0

Release 1.14.0

Choose a tag to compare

@bobstrecansky bobstrecansky released this 25 Mar 14:04

What's Changed:

Full Changelog: 1.13.0...1.14.0

Release 1.13.0

Choose a tag to compare

@brettmc brettmc released this 10 Feb 10:49

What's Changed:

Full Changelog: 1.12.0...1.13.0

Release 1.12.0

Choose a tag to compare

@brettmc brettmc released this 25 Jan 05:52

What's Changed:

Full Changelog: 1.11.0...1.12.0

Release 1.11.0

Choose a tag to compare

@brettmc brettmc released this 16 Jan 23:41

What's Changed:

Full Changelog: 1.10.0...1.11.0

Release 1.10.0

Choose a tag to compare

@brettmc brettmc released this 25 Nov 11:10

What's Changed:

Full Changelog: 1.9.0...1.10.0

Release 1.9.0

Choose a tag to compare

@brettmc brettmc released this 02 Oct 23:48

What's Changed:

  • Implement span suppression strategies by @Nevay in 1599
  • rework ServiceInfoFactory priorities by @brettmc in 1644

Full Changelog: 1.8.0...1.9.0

Release 1.8.0

Choose a tag to compare

@brettmc brettmc released this 19 Sep 00:07

What's Changed:

Full Changelog: 1.7.1...1.8.0