Skip to content

feat(flutter): add setAttributes and removeAttributes - #858

Open
abelonogov-ld wants to merge 4 commits into
mainfrom
andrey/global-attributes-flutter
Open

abelonogov-ld wants to merge 4 commits into
mainfrom
andrey/global-attributes-flutter

Conversation

@abelonogov-ld

@abelonogov-ld abelonogov-ld commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds global attributes to the Flutter observability SDK. This is one of a set of matching PRs across SDKs that share the same semantics (see #859, #860, #861, #856, #863, launchdarkly/swift-launchdarkly-observability#290).

  • LDObserve.setAttributes(Map<String, Object?> attributes) merges by key into one process-wide, in-memory map; LDObserve.removeAttributes(List<String> keys) removes keys.
  • Where globals apply:
    • Every span recorded from Dart: manual spans, flag evaluations, errors and Dart lifecycle spans, plus track, screen-view and click spans on web. An internal span processor, registered ahead of export, fills them in on span start.
    • Every log recorded through LDObserve.recordLog and captured debugPrint / print output.
    • On iOS and Android, the properties of track, screen-view and click events forwarded to the native SDK.
  • Precedence: per-call attributes > globals > resource. Globals only fill keys that aren't already set; a span takes the values current when it starts.
  • Reserved keys: session.id and highlight.session_id are ignored, as are values that can't be attributes (including null).
  • Lifetime: works before init, kept in memory for the life of the process, not cleared when the session changes, never persisted. Readers see an immutable snapshot rebuilt only on change.
  • Not covered:
  • README has a new "Global attributes" section.

How did you test this change?

  • New test/global_attributes_test.dart: merge and remove, reserved keys and invalid values ignored, immutable snapshot, fill precedence.
  • New test/global_attributes_pipeline_test.dart runs Otel.setup against a mocked native bridge:
    • globals set before init reach exported spans;
    • per-call properties and span.setAttribute win over globals;
    • spans keep their start-time values, and removed keys stop appearing;
    • error spans and logs carry globals, with per-call properties winning;
    • screen views, clicks and track events forwarded to native carry globals beneath their own properties.
  • test/web_exporters_test.dart: web track, screen-view, click and log spans carry globals without overriding the SDK's event.* keys.
  • test/public_api_test.dart covers the new LDObserve signatures.
  • dart format, flutter analyze (clean) and flutter test (292 tests) pass.

Are there any deployment considerations?

None. Two static methods are added to LDObserve; nothing changes unless an app calls them.


Note

Overview
Adds process-wide global attributes to the Flutter observability SDK via LDObserve.setAttributes and LDObserve.removeAttributes, aligned with matching SDK work elsewhere.

Globals merge in memory (safe before init), ignore reserved session keys and invalid values, and attach to Dart-recorded telemetry: spans get them at start through a new GlobalAttributesSpanProcessor; logs and native-forwarded track/screen-view/click properties are filled so per-call keys win. README documents precedence and limits (no Dart metrics API; native-only crash/lifecycle telemetry unchanged).

The example app gains repro.dart to demo UTM-style globals and expected LaunchDarkly row attributes. Coverage includes store/unit tests, a full pipeline test against the mocked native bridge, and web exporter assertions.

Reviewed by Cursor Bugbot for commit 7afd0f7. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-authored-by: Cursor <cursoragent@cursor.com>

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 3b0ee45. Configure here.

Co-authored-by: Cursor <cursoragent@cursor.com>
@abelonogov-ld abelonogov-ld changed the title feat(flutter): add setAttributes and custom span/log processors feat(flutter): add setAttributes and removeAttributes Oct 28, 2026
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
abelonogov-ld added a commit that referenced this pull request Nov 3, 2026
## Summary

Adds global attributes and custom span/log processors to the Java server
observability plugin. This is one of a set of matching PRs across RN,
Android, iOS, Flutter, MAUI, Java and Python that share the same
semantics (see #858, #859, #860,
launchdarkly/swift-launchdarkly-observability#290).

**Global attributes**
- `LDObserve.setAttributes(Attributes)` /
`LDObserve.removeAttributes(Collection<String>)` keep one process-wide
attribute set (`AtomicReference` to an immutable snapshot). Safe before
init and thread-safe.
- Applied to every span the plugin's tracer provider starts (manual
spans, flag evaluations, error spans, and instrumentation wired to
`LDObserve.getOpenTelemetry()`), every log record, and metrics recorded
through `LDObserve`.
- Precedence: per-call / span-builder values > globals > resource.
Globals only fill missing keys (matched by name, regardless of type);
spans get the values current at start.
- Globals survive `LDObserve.shutdown()` (process-wide lifetime).

**Custom processors** (init-time options)
- `ObservabilityOptions.Builder.spanProcessors(List<SpanProcessor>)` /
`logProcessors(List<LogRecordProcessor>)`, plus `spanProcessor(...)` /
`logProcessor(...)` to add one at a time (mirrors `customHeaders` /
`customHeader`).
- Order: global attributes → user processors (in order) → the plugin's
level filter, sampling and batch export, so user changes are exported
and sampling still applies.
- Each user call is wrapped in try/catch: a throwing processor is logged
(WARNING once, then FINE) and export continues; `forceFlush` /
`shutdown` are forwarded and return a failed result instead of
propagating.

**Dependency change:** `opentelemetry-sdk` moves from `implementation`
to `api` (compile scope in the published POM), because
`ObservabilityOptions` now exposes SDK processor types.
`checkPublishedPom` enforces this. Same version; it was already a
transitive runtime dependency.

Not covered: metrics recorded on a meter obtained via
`getOpenTelemetry()` (only `LDObserve` metric methods merge globals);
documented in the README.

## How did you test this change?

- `./gradlew :lib:build` (javadoc, POM, classpath and fixture checks,
tests) and `./gradlew :lib:test -PldServerSdkVersion=7.10.1` (as CI)
pass: 146 tests, 0 failures.
- Unit tests (`GlobalAttributesTest`, `SafeProcessorTest`):
merge/remove, name matching across types, per-call precedence,
null/empty input, concurrent writes, span and log filling, throwing
processors, flush/shutdown forwarding.
- End-to-end `PluginUserFlowTest` with a real `LDClient` and a local
OTLP collector: globals set before start reach flag-evaluation, manual
and error spans, logs and metrics; per-call values win; removed keys are
not applied; spans keep start-time values; user processors run in order
and their changes reach the exported payload; sampling still drops
matching spans; throwing processors don't break export, flush or
shutdown.
- A mutation check (removing the wrapping and the global-attributes
processor) makes the new end-to-end tests fail.
- `javap` confirms every SDK method used exists in OpenTelemetry 1.38.0,
the plugin's minimum.

## Are there any deployment considerations?

- The published POM lists `opentelemetry-sdk` at compile scope instead
of runtime scope; consumers see SDK types on their compile classpath.
- Purely additive API; no behavior change unless these APIs are used.
- Processors are read when the providers start; a second `LDClient` with
a different SDK key doesn't add its processors, consistent with how its
other options are already ignored.

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Overview**
> Adds **process-wide global attributes** and **user-defined
OpenTelemetry processors** to the Java observability plugin, aligned
with other LaunchDarkly SDKs.
> 
> **Global attributes:** New `LDObserve.setAttributes` /
`removeAttributes` keep a thread-safe, merge-by-key store (safe before
plugin init, survives shutdown). Globals are applied to exported spans
and logs via dedicated processors in `OtelManager`, and to metrics
recorded through `LDObserve` via `GlobalAttributes.merge`. Per-call or
span-builder attributes win on key conflicts; spans snapshot globals at
start.
> 
> **Custom processors:** `ObservabilityOptions` now accepts ordered
`SpanProcessor` and `LogRecordProcessor` lists (single-add helpers too).
They run after global-attribute injection and before level filtering,
sampling, and export; failures are wrapped in `SafeSpanProcessor` /
`SafeLogRecordProcessor` so export continues.
> 
> **Packaging:** `opentelemetry-sdk` is promoted to compile-scoped `api`
because processor types are part of the public options API; POM checks
were updated.
> 
> The Spring Boot e2e app sets UTM globals before startup and prints
`[#1]` expectations on each request so manual verification in
LaunchDarkly is straightforward.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
be24b27. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
abelonogov-ld added a commit that referenced this pull request Nov 6, 2026
## Summary

Adds a global attributes API to the Android observability SDK. This is
one of a set of matching PRs across SDKs that share the same semantics
(see #858, #859, #861, #856, #863,
launchdarkly/swift-launchdarkly-observability#290).

- `LDObserve.setAttributes(Attributes)` and
`LDObserve.setAttributes(Map<String, Any?>)` merge attributes by key
into one in-memory, process-wide map;
`LDObserve.removeAttributes(Collection<String>)` removes keys.
- Applied to every span (values captured at span start), every log
record (including crash reports) and every metric data point recorded
after the call, including the launch-time histogram.
- Precedence: per-call attributes > globals > resource. Globals only
fill missing keys and never overwrite. Upstream
`OtelRumConfig.setGlobalAttributes` is intentionally not used, because
its appenders overwrite per-call values. Instead, internal span and log
processors are registered ahead of the SDK's sampling and export
processors, and metric record methods merge globals under per-call
values.
- `session.id` and `highlight.session_id` are ignored (a warning is
logged).
- Not persisted and not cleared on session rotation. Calls made before
the SDK initializes take effect, because the store exists independently
of the SDK instance.
- Reads are a lock-free load of an immutable snapshot; writes rebuild it
under a lock.
- README documents the API with a Kotlin example.

## How did you test this change?

- New JVM unit tests (`GlobalAttributesStoreTest`,
`GlobalAttributesPipelineTest`): merge/remove, re-setting a key with a
different value type, reserved keys, per-call precedence, concurrent
writers, set-before-init through `LDObserve`, globals captured at span
start, and globals reaching exported spans, logs and metric data points
through real OpenTelemetry providers wired like the SDK.
- `./gradlew :lib:compileDebugKotlin :lib:test` passes (559 tests, debug
and release).

## Are there any deployment considerations?

- `ObservabilityOptions` is unchanged. The only API change is three new
methods on `Observe` (inherited by `LDObserve` and its companion), with
default implementations, so Kotlin implementers need no changes.
- Java and MAUI callers use `LDObserve.Companion.setAttributes(...)` /
`removeAttributes(...)`, like the other `LDObserve` methods. #863 (MAUI)
is stacked on this PR.
- Global attributes are added to metric data points, so they increase
metric cardinality.

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Overview**
> Adds **process-wide global attributes** on the Android observability
SDK via `LDObserve.setAttributes` (OTel `Attributes` or plain map) and
`LDObserve.removeAttributes`.
> 
> Globals are stored in a singleton **`GlobalAttributesStore`** so calls
**before SDK init** still apply once the pipeline starts. They are
merged into **spans** (snapshot at span start), **logs** (via new
processors registered ahead of sampling/export), and **metrics**
(including launch-time histograms), with **per-call attributes winning**
over globals and reserved session keys ignored with a warning. README
and the compose e2e app document/repro UTM-style globals and precedence.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
7e24d72. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Cursor <cursoragent@cursor.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants