Skip to content

Commit b5881fb

Browse files
authored
Merge branch 'main' into feat/speed-up-tests
2 parents 723becd + 4b1510b commit b5881fb

File tree

655 files changed

+33295
-6515
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

655 files changed

+33295
-6515
lines changed

.claude/settings.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"permissions": {
3+
"allow": [
4+
"Bash(find:*)",
5+
"Bash(ls:*)",
6+
"Bash(git:*)",
7+
"Bash(git status:*)",
8+
"Bash(git log:*)",
9+
"Bash(git diff:*)",
10+
"Bash(git show:*)",
11+
"Bash(git branch:*)",
12+
"Bash(git remote:*)",
13+
"Bash(git tag:*)",
14+
"Bash(git stash list:*)",
15+
"Bash(git rev-parse:*)",
16+
"Bash(gh pr view:*)",
17+
"Bash(gh pr list:*)",
18+
"Bash(gh pr checks:*)",
19+
"Bash(gh pr diff:*)",
20+
"Bash(gh issue view:*)",
21+
"Bash(gh issue list:*)",
22+
"Bash(gh run view:*)",
23+
"Bash(gh run list:*)",
24+
"Bash(gh run logs:*)",
25+
"Bash(gh repo view:*)",
26+
"WebFetch(domain:github.com)",
27+
"WebFetch(domain:docs.sentry.io)",
28+
"WebFetch(domain:develop.sentry.dev)",
29+
"Bash(grep:*)",
30+
"Bash(mv:*)"
31+
],
32+
"deny": []
33+
}
34+
}
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
name: create-java-pr
3+
description: Create a pull request in sentry-java. Use when asked to "create pr", "prepare pr", "prep pr", "open pr", "ready for pr", "prepare for review", "finalize changes". Handles branch creation, code formatting, API dump, committing, pushing, PR creation, and changelog.
4+
---
5+
6+
# Create Pull Request (sentry-java)
7+
8+
Prepare local changes and create a pull request for the sentry-java repo.
9+
10+
## Step 1: Ensure Feature Branch
11+
12+
```bash
13+
git branch --show-current
14+
```
15+
16+
If on `main` or `master`, create and switch to a new branch:
17+
18+
```bash
19+
git checkout -b <type>/<short-description>
20+
```
21+
22+
Derive the branch name from the changes being made. Use `feat/`, `fix/`, `ref/`, etc. matching the commit type conventions.
23+
24+
## Step 2: Format Code and Regenerate API Files
25+
26+
```bash
27+
./gradlew spotlessApply apiDump
28+
```
29+
30+
This is **required** before every PR in this repo. It formats all Java/Kotlin code via Spotless and regenerates the `.api` binary compatibility files.
31+
32+
If the command fails, diagnose and fix the issue before continuing.
33+
34+
## Step 3: Commit Changes
35+
36+
Check for uncommitted changes:
37+
38+
```bash
39+
git status --porcelain
40+
```
41+
42+
If there are uncommitted changes, invoke the `sentry-skills:commit` skill to stage and commit them following Sentry conventions.
43+
44+
**Important:** When staging, ignore changes that are only relevant for local testing and should not be part of the PR. Common examples:
45+
46+
| Ignore Pattern | Reason |
47+
|---|---|
48+
| Hardcoded booleans flipped for testing | Local debug toggles |
49+
| Sample app config changes (`sentry-samples/`) | Local testing configuration |
50+
| `.env` or credentials files | Secrets |
51+
52+
Restore these files before committing:
53+
54+
```bash
55+
git checkout -- <file-to-restore>
56+
```
57+
58+
## Step 4: Push the Branch
59+
60+
```bash
61+
git push -u origin HEAD
62+
```
63+
64+
If the push fails due to diverged history, ask the user how to proceed rather than force-pushing.
65+
66+
## Step 5: Create PR
67+
68+
Invoke the `sentry-skills:create-pr` skill to create a draft PR. When providing the PR body, use the repo's PR template structure from `.github/pull_request_template.md`:
69+
70+
```
71+
## :scroll: Description
72+
<Describe the changes in detail>
73+
74+
## :bulb: Motivation and Context
75+
<Why is this change required? What problem does it solve?>
76+
77+
## :green_heart: How did you test it?
78+
<Describe how you tested>
79+
80+
## :pencil: Checklist
81+
- [ ] I added GH Issue ID _&_ Linear ID
82+
- [ ] I added tests to verify the changes.
83+
- [ ] No new PII added or SDK only sends newly added PII if `sendDefaultPII` is enabled.
84+
- [ ] I updated the docs if needed.
85+
- [ ] I updated the wizard if needed.
86+
- [ ] Review from the native team if needed.
87+
- [ ] No breaking change or entry added to the changelog.
88+
- [ ] No breaking change for hybrid SDKs or communicated to hybrid SDKs.
89+
90+
## :crystal_ball: Next steps
91+
```
92+
93+
Fill in each section based on the changes being PR'd. Check any checklist items that apply.
94+
95+
Then continue to Step 6.
96+
97+
## Step 6: Update Changelog
98+
99+
After the PR is created, add an entry to `CHANGELOG.md` under the `## Unreleased` section.
100+
101+
### Determine the subsection
102+
103+
| Change Type | Subsection |
104+
|---|---|
105+
| New feature | `### Features` |
106+
| Bug fix | `### Fixes` |
107+
| Refactoring, internal cleanup | `### Internal` |
108+
| Dependency update | `### Dependencies` |
109+
110+
Create the subsection under `## Unreleased` if it does not already exist.
111+
112+
### Entry format
113+
114+
```markdown
115+
- <Short description of the change> ([#<PR_NUMBER>](https://github.com/getsentry/sentry-java/pull/<PR_NUMBER>))
116+
```
117+
118+
Use the PR number returned by `sentry-skills:create-pr`. Match the style of existing entries — sentence case, ending with the PR link, no trailing period.
119+
120+
### Commit and push
121+
122+
Stage `CHANGELOG.md`, commit with message `changelog`, and push:
123+
124+
```bash
125+
git add CHANGELOG.md
126+
git commit -m "changelog"
127+
git push
128+
```

.craft.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,15 @@ targets:
4141
maven:io.sentry:sentry-android-fragment:
4242
maven:io.sentry:sentry-bom:
4343
maven:io.sentry:sentry-openfeign:
44+
maven:io.sentry:sentry-openfeature:
4445
maven:io.sentry:sentry-opentelemetry-agent:
4546
maven:io.sentry:sentry-opentelemetry-agentcustomization:
4647
maven:io.sentry:sentry-opentelemetry-agentless:
4748
maven:io.sentry:sentry-opentelemetry-agentless-spring:
4849
maven:io.sentry:sentry-opentelemetry-bootstrap:
4950
maven:io.sentry:sentry-opentelemetry-core:
51+
# maven:io.sentry:sentry-opentelemetry-otlp:
52+
# maven:io.sentry:sentry-opentelemetry-otlp-spring:
5053
maven:io.sentry:sentry-apollo:
5154
maven:io.sentry:sentry-jdbc:
5255
maven:io.sentry:sentry-graphql:
@@ -64,3 +67,5 @@ targets:
6467
maven:io.sentry:sentry-apollo-4:
6568
maven:io.sentry:sentry-reactor:
6669
maven:io.sentry:sentry-ktor-client:
70+
maven:io.sentry:sentry-async-profiler:
71+
maven:io.sentry:sentry-spotlight:

.cursor/rules/api.mdc

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
alwaysApply: false
3+
description: Public API surface, binary compatibility, and common classes to modify
4+
---
5+
# Java SDK Public API
6+
7+
## API Compatibility
8+
9+
Public API is tracked via `.api` files generated by the [Binary Compatibility Validator](https://github.com/Kotlin/binary-compatibility-validator) Gradle plugin. Each module has its own file at `<module>/api/<module>.api`.
10+
11+
- **Never edit `.api` files manually.** Run `./gradlew apiDump` to regenerate them.
12+
- `./gradlew check` validates current code against `.api` files and fails on unintended changes.
13+
- `@ApiStatus.Internal` marks classes/methods as internal — they still appear in `.api` files but are not part of the public contract.
14+
- `@ApiStatus.Experimental` marks API that may change in future versions.
15+
16+
## Key Public API Classes
17+
18+
### Entry Point
19+
20+
`Sentry` (`sentry` module) is the static entry point. Most public API methods on `Sentry` delegate to `getCurrentScopes()`. When adding a new method to `Sentry`, it typically calls through to `IScopes`.
21+
22+
### Interfaces
23+
24+
| Interface | Description |
25+
|-----------|-------------|
26+
| `IScope` | Single scope — holds data (tags, extras, breadcrumbs, attributes, user, contexts, etc.) |
27+
| `IScopes` | Multi-scope container — manages global, isolation, and current scope; delegates capture calls to `SentryClient` |
28+
| `ISpan` | Performance span — timing, tags, data, measurements |
29+
| `ITransaction` | Top-level transaction — extends `ISpan` |
30+
31+
### Configuration
32+
33+
`SentryOptions` is the base configuration class. Platform-specific subclasses:
34+
- `SentryAndroidOptions` — Android-specific options
35+
- Integration modules may add their own (e.g. `SentrySpringProperties`)
36+
37+
New features must be **opt-in by default** — add a getter/setter pair to the appropriate options class.
38+
39+
### Internal Classes (Not Public API)
40+
41+
| Class | Description |
42+
|-------|-------------|
43+
| `SentryClient` | Sends events/envelopes to Sentry — receives captured data from `Scopes` |
44+
| `SentryEnvelope` / `SentryEnvelopeItem` | Low-level envelope serialization |
45+
| `Scope` | Concrete implementation of `IScope` |
46+
| `Scopes` | Concrete implementation of `IScopes` |
47+
48+
## Adding New Public API
49+
50+
When adding a new method that users can call (e.g. a new scope operation), these classes typically need changes:
51+
52+
### Interfaces and Static API
53+
1. `IScope` — add the method signature
54+
2. `IScopes` — add the method signature (usually delegates to a scope)
55+
3. `Sentry` — add static method that calls `getCurrentScopes()`
56+
57+
### Implementations
58+
4. `Scope` — actual implementation with data storage
59+
5. `Scopes` — delegates to the appropriate scope (global, isolation, or current based on `defaultScopeType`)
60+
6. `CombinedScopeView` — defines how the three scope types combine for reads (merge, first-wins, or specific scope)
61+
62+
### No-Op and Adapter Classes
63+
7. `NoOpScope` — no-op stub for `IScope`
64+
8. `NoOpScopes` — no-op stub for `IScopes`
65+
9. `ScopesAdapter` — delegates to `Sentry` static API
66+
10. `HubAdapter` — deprecated bridge from old `IHub` API
67+
11. `HubScopesWrapper` — wraps `IScopes` as `IHub`
68+
69+
### Serialization (if the data is sent to Sentry)
70+
12. Add serialization/deserialization in the relevant data class or create a new one implementing `JsonSerializable` and `JsonDeserializer`
71+
72+
### Tests
73+
13. Write tests for all implementations, especially `Scope`, `Scopes`, `SentryTest`, and any new data classes
74+
14. No-op classes typically don't need separate tests unless they have non-trivial logic
75+
76+
## Protocol / Data Model Classes
77+
78+
Classes in the `io.sentry.protocol` package represent the Sentry event protocol. They implement `JsonSerializable` for serialization and have a companion `Deserializer` class implementing `JsonDeserializer`. When adding new fields to protocol classes, update both serialization and deserialization.
79+
80+
## Namespaced APIs
81+
82+
Newer features are namespaced under `Sentry.<feature>()` rather than added directly to `Sentry`. Each namespaced API has an interface, implementation, and no-op. Examples:
83+
84+
- `Sentry.logger()` → `ILoggerApi` / `LoggerApi` / `NoOpLoggerApi` (structured logging, `io.sentry.logger` package)
85+
- `Sentry.metrics()` → `IMetricsApi` / `MetricsApi` / `NoOpMetricsApi` (metrics)
86+
87+
Options for namespaced features are similarly nested under `SentryOptions`, e.g. `SentryOptions.getMetrics()`, `SentryOptions.getLogs()`.
88+
89+
These APIs may share infrastructure like the type system (`SentryAttributeType.inferFrom()`) — changes to shared components (e.g. attribute types) may require updates across multiple namespaced APIs.

.cursor/rules/feature_flags.mdc

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
alwaysApply: false
3+
description: Feature Flags
4+
---
5+
# Java SDK Feature Flags
6+
7+
There is a scope based and a span based API for tracking feature flag evaluations.
8+
9+
## Scope Based API
10+
11+
The `addFeatureFlag` method can be used to track feature flag evaluations. It exists on `Sentry` static API as well as `IScopes` and `IScope`.
12+
13+
When using static API, `IScopes` or COMBINED scope type, Sentry will also invoke `addFeatureFlag` on the current span. This does not happen, when directly invoking `addFeatureFlag` on `IScope` (except for COMBINED scope type).
14+
15+
The `maxFeatureFlags` option controls how many flags are tracked per scope and also how many are sent to Sentry as part of events.
16+
Scope based feature flags can also be disabled by setting the value to 0. Defaults to 100 feature flag evaluations.
17+
18+
Order of feature flag evaluations is important as we only keep track of the last {maxFeatureFlag} items.
19+
20+
When a feature flag evaluation with the same name is added, the previous one is removed and the new one is stored so that it'll be dropped last.
21+
Refer to `FeatureFlagBuffer` fore more details. `FeatureFlagBuffer` has been optimized for storing scope based feature flag evaluations, especially clone performance.
22+
23+
When sending out an error event, feature flag buffers from all three scope types (global, isolation and current scope) are merged, choosing the newest {maxFeatureFlag} entries across all scope types. Feature flags are sent as part of the `flags` context.
24+
25+
## Span Based API
26+
27+
It's also possible to use the `addFeatureFlag` method on `ISpan` (and by extension `ITransaction`). Feature flag evaluations tracked this way
28+
will not be added to the scope and thus won't be added to error events.
29+
30+
Each span has its own `SpanFeatureFlagBuffer`. When starting a child span, feature flag evaluations are NOT copied from the parent. Each span starts out with an empty buffer and has its own limit.
31+
`SpanFeatureFlagBuffer` has been optimized for storing feature flag evaluations on spans.
32+
33+
Spans have a hard coded limit of 10 feature flag evaluations. When full, new entries are rejected. Updates to existing entries are still allowed even if full.
34+
35+
## Integrations
36+
37+
We offer integrations that automatically track feature flag evaluations.
38+
39+
Android:
40+
- LaunchDarkly (`SentryLaunchDarklyAndroidHook`)
41+
42+
JVM (non Android):
43+
- LaunchDarkly (`SentryLaunchDarklyServerHook`)
44+
- OpenFeature (`SentryOpenFeatureHook`)

.cursor/rules/metrics.mdc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
alwaysApply: false
3+
description: Metrics API
4+
---
5+
# Java SDK Metrics API
6+
7+
Metrics are enabled by default.
8+
9+
API has been namespaced under `Sentry.metrics()` and `IScopes.metrics()` using the `IMetricsApi` interface and `MetricsApi` implementation.
10+
11+
Options are namespaced under `SentryOptions.getMetrics()`.
12+
13+
Three different APIs exist:
14+
- `count`: Counters are one of the more basic types of metrics and can be used to count certain event occurrences.
15+
- `distribution`: Distributions help you get the most insights from your data by allowing you to obtain aggregations such as p90, min, max, and avg.
16+
- `gauge`: Gauges let you obtain aggregates like min, max, avg, sum, and count. They can be represented in a more space-efficient way than distributions, but they can't be used to get percentiles. If percentiles aren't important to you, we recommend using gauges.
17+
18+
Refer to `SentryMetricsEvent` for details about available fields.
19+
20+
`MetricsBatchProcessor` handles batching (`MAX_BATCH_SIZE`), automatic sending of metrics after a timeout (`FLUSH_AFTER_MS`) and rejecting if `MAX_QUEUE_SIZE` has been hit.
21+
22+
The flow is `IMetricsApi` -> `IMetricsBatchProcessor` -> `SentryClient.captureBatchedMetricsEvents` -> `ITransport`.
23+
24+
Each `SentryMetricsEvent` goes through `SentryOptions.metrics.beforeSend` (if configured) and can be modified or dropped.
25+
26+
For sending, a batch of `SentryMetricsEvent` objects is sent inside a `SentryMetricsEvents` object.

.cursor/rules/opentelemetry.mdc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ The Sentry Java SDK provides comprehensive OpenTelemetry integration through mul
1414
- `sentry-opentelemetry-agentless-spring`: Spring-specific agentless integration
1515
- `sentry-opentelemetry-bootstrap`: Classes that go into the bootstrap classloader when the agent is used. For agentless they are simply used in the applications classloader.
1616
- `sentry-opentelemetry-agentcustomization`: Classes that help wire up Sentry in OpenTelemetry. These land in the agent classloader when the agent is used. For agentless they are simply used in the application classloader.
17+
- `sentry-opentelemetry-otlp`: Classes for using OpenTelemetry to send spans to Sentry using the OTLP endpoint and have Sentry use OpenTelemetry trace and span id.
18+
- `sentry-opentelemetry-otlp-spring`: Spring Boot convenience module that includes `sentry-opentelemetry-otlp` and the OpenTelemetry Spring Boot starter as transitive dependencies.
1719

1820
## Advantages over using Sentry without OpenTelemetry
1921

@@ -86,3 +88,10 @@ After creating the transaction with child spans `SentrySpanExporter` uses Sentry
8688
## Troubleshooting
8789

8890
To debug forking of `Scopes`, we added a reference to `parent` `Scopes` and a `creator` String to store the reason why `Scopes` were created or forked.
91+
92+
# OTLP
93+
When using `sentry-opentelemetry-otlp`, Sentry only loads trace ID and span ID from OpenTelemetry `Context` (via `OpenTelemetryOtlpEventProcessor`). Sentry does not rely on OpenTelemetry `Context` for scope storage and propagation, instead relying on its `DefaultScopesStorage`.
94+
It is common to keep Performance in Sentry SDK disabled since that part is taken over by OpenTelemetry.
95+
The `sentry-opentelemetry-otlp` module is not connected to the other `sentry-opentelemetry-*` modules but instead intended only when the goal is to run OpenTelemetry for creating spans and Sentry for other products like errors, logs, metrics etc.
96+
The `sentry-opentelemetry-otlp-spring` module wraps `sentry-opentelemetry-otlp` and includes the OpenTelemetry Spring Boot starter for easier setup in Spring Boot applications.
97+
The OTLP module does not easily work with the OpenTelemetry agent as it would require customizing the agent.JAR in order to get the propagator loaded.

0 commit comments

Comments
 (0)