Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf(opentelemetry): Bucket spans for cleanup #14154

Merged
merged 9 commits into from
Nov 27, 2024
Merged

Conversation

fmorett
Copy link
Contributor

@fmorett fmorett commented Oct 31, 2024

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

We had a huge performance problem with a overhead of 5x or so in CPU Load. We investigated the issue and saw that the cleanup logic for OTEL ran on every span end. Thats why we rewrote this to run only once every interval.

I do not guarantee that this code is perfect, this is just a hint, that there is something wrong currently.

@AbhiPrasad
Copy link
Member

Hey @fmorett thank you for the PR.

I opened a GH issue in #14177 for this so that we can discuss further as a group and see what other users think as well.

We'll try to get a maintainer assigned to this ASAP - appreciate your patience in the meantime.

@lforst lforst self-requested a review November 12, 2024 11:48
@lforst lforst self-assigned this Nov 12, 2024
@lforst lforst changed the title perf(otel): Only cleanup old spans every interval once perf(opentelemetry): Bucket spans for cleanup Nov 12, 2024
@lforst lforst requested a review from mydea November 12, 2024 13:49
}

/** Try to flush any pending spans immediately. */
public flush(): void {
this._clearTimeout();

const openSpanCount = this._finishedSpans.length;
const finishedSpans: ReadableSpan[] = [];
this._finishedSpanBuckets.forEach(bucket => {
Copy link
Member

Choose a reason for hiding this comment

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

l: Can we instead add a get _finishSpans(): ReadableSpan[] getter on the exporter class and use this? This makes it easier to test this as well as we can just access this in tests too? 🤔

Copy link
Member

@lforst lforst Nov 14, 2024

Choose a reason for hiding this comment

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

I will not add a public function for this. This is an implementation detail that should not be exposed. I can however extract this functionality into a private fn, which I also do not particularly like since we do this operation exactly one time (apart from in tests, which is whatever).

Copy link
Member

Choose a reason for hiding this comment

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

yeah I do not mean a public function, but just making it a private method on the class, then it is also not exposed but we can use it in tests. right now we duplicate the logic in the test so if that runs apart we may not notice (it's really a nit so feel free to disregard). In the tests we could then do, instead of:

const finishedSpans1 = [];
    exporter['_finishedSpanBuckets'].forEach((bucket: any) => {
      if (bucket) {
        finishedSpans1.push(...bucket.spans);
      }
    });

just

const finishedSpans1 = exporter['_finishedSpans'];

or something like this.

@lforst lforst requested a review from mydea November 14, 2024 10:19
@mydea
Copy link
Member

mydea commented Nov 14, 2024

@fmorett any chance you could test @lforst 's updated implementation in this PR and see if that actually fixes/improves the overhead? FWIW I think it is a good change regardless, but would be cool to know if this actually fixes the problem or if another problem remains.

@lforst
Copy link
Member

lforst commented Nov 27, 2024

@mydea I'd like to merge this sooner rather than later.

Copy link
Member

@mydea mydea left a comment

Choose a reason for hiding this comment

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

:shipit:

@lforst lforst merged commit a4138e9 into getsentry:develop Nov 27, 2024
94 checks passed
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Dec 8, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.40.0` -> `8.42.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.40.0/8.42.0) |
| [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.40.0` -> `8.42.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.40.0/8.42.0) |

---

### Release Notes

<details>
<summary>getsentry/sentry-javascript (@&#8203;sentry/node)</summary>

### [`v8.42.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8420)

[Compare Source](getsentry/sentry-javascript@8.41.0...8.42.0)

##### Important Changes

-   **feat(react): React Router v7 support (library) ([#&#8203;14513](getsentry/sentry-javascript#14513

    This release adds support for [React Router v7 (library mode)](https://reactrouter.com/home#react-router-as-a-library).
    Check out the docs on how to set up the integration: [Sentry React Router v7 Integration Docs](https://docs.sentry.io/platforms/javascript/guides/react/features/react-router/v7/)

##### Deprecations

-   **feat: Warn about source-map generation ([#&#8203;14533](getsentry/sentry-javascript#14533

    In the next major version of the SDK we will change how source maps are generated when the SDK is added to an application.
    Currently, the implementation varies a lot between different SDKs and can be difficult to understand.
    Moving forward, our goal is to turn on source maps for every framework, unless we detect that they are explicitly turned off.
    Additionally, if we end up enabling source maps, we will emit a log message that we did so.

    With this particular release, we are emitting warnings that source map generation will change in the future and we print instructions on how to prepare for the next major.

-   **feat(nuxt): Deprecate `tracingOptions` in favor of `vueIntegration` ([#&#8203;14530](getsentry/sentry-javascript#14530

    Currently it is possible to configure tracing options in two places in the Sentry Nuxt SDK:

    -   In `Sentry.init()`
    -   Inside `tracingOptions` in `Sentry.init()`

    For tree-shaking purposes and alignment with the Vue SDK, it is now recommended to instead use the newly exported `vueIntegration()` and its `tracingOptions` option to configure tracing options in the Nuxt SDK:

    ```ts
    // sentry.client.config.ts
    import * as Sentry from '@&#8203;sentry/nuxt';

    Sentry.init({
      // ...
      integrations: [
        Sentry.vueIntegration({
          tracingOptions: {
            trackComponents: true,
          },
        }),
      ],
    });
    ```

##### Other Changes

-   feat(browser-utils): Update `web-vitals` to v4.2.4 ([#&#8203;14439](getsentry/sentry-javascript#14439))
-   feat(nuxt): Expose `vueIntegration` ([#&#8203;14526](getsentry/sentry-javascript#14526))
-   fix(feedback): Handle css correctly in screenshot mode ([#&#8203;14535](getsentry/sentry-javascript#14535))

### [`v8.41.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8410)

[Compare Source](getsentry/sentry-javascript@8.40.0...8.41.0)

##### Important Changes

-   **meta(nuxt): Require minimum Nuxt v3.7.0 ([#&#8203;14473](getsentry/sentry-javascript#14473

    We formalized that the Nuxt SDK is at minimum compatible with Nuxt version 3.7.0 and above.
    Additionally, the SDK requires the implicit `nitropack` dependency to satisfy version `^2.10.0` and `ofetch` to satisfy `^1.4.0`.
    It is recommended to check your lock-files and manually upgrade these dependencies if they don't match the version ranges.

##### Deprecations

We are deprecating a few APIs which will be removed in the next major.

The following deprecations will *potentially* affect you:

-   **feat(core): Update & deprecate `undefined` option handling ([#&#8203;14450](getsentry/sentry-javascript#14450

    In the next major version we will change how passing `undefined` to `tracesSampleRate` / `tracesSampler` / `enableTracing` will behave.

    Currently, doing the following:

    ```ts
    Sentry.init({
      tracesSampleRate: undefined,
    });
    ```

    Will result in tracing being *enabled* (although no spans will be generated) because the `tracesSampleRate` key is present in the options object.
    In the next major version, this behavior will be changed so that passing `undefined` (or rather having a `tracesSampleRate` key) will result in tracing being disabled, the same as not passing the option at all.
    If you are currently relying on `undefined` being passed, and and thus have tracing enabled, it is recommended to update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

    The same applies to `tracesSampler` and `enableTracing`.

-   **feat(core): Log warnings when returning `null` in `beforeSendSpan` ([#&#8203;14433](getsentry/sentry-javascript#14433

    Currently, the `beforeSendSpan` option in `Sentry.init()` allows you to drop individual spans from a trace by returning `null` from the hook.
    Since this API lends itself to creating "gaps" inside traces, we decided to change how this API will work in the next major version.

    With the next major version the `beforeSendSpan` API can only be used to mutate spans, but no longer to drop them.
    With this release the SDK will warn you if you are using this API to drop spans.
    Instead, it is recommended to configure instrumentation (i.e. integrations) directly to control what spans are created.

    Additionally, with the next major version, root spans will also be passed to `beforeSendSpan`.

-   **feat(utils): Deprecate `@sentry/utils` ([#&#8203;14431](getsentry/sentry-javascript#14431

    With the next major version the `@sentry/utils` package will be merged into the `@sentry/core` package.
    It is therefore no longer recommended to use the `@sentry/utils` package.

-   **feat(vue): Deprecate configuring Vue tracing options anywhere else other than through the `vueIntegration`'s `tracingOptions` option ([#&#8203;14385](getsentry/sentry-javascript#14385

    Currently it is possible to configure tracing options in various places in the Sentry Vue SDK:

    -   In `Sentry.init()`
    -   Inside `tracingOptions` in `Sentry.init()`
    -   In the `vueIntegration()` options
    -   Inside `tracingOptions` in the `vueIntegration()` options

    Because this is a bit messy and confusing to document, the only recommended way to configure tracing options going forward is through the `tracingOptions` in the `vueIntegration()`.
    The other means of configuration will be removed in the next major version of the SDK.

-   **feat: Deprecate `registerEsmLoaderHooks.include` and `registerEsmLoaderHooks.exclude` ([#&#8203;14486](getsentry/sentry-javascript#14486

    Currently it is possible to define `registerEsmLoaderHooks.include` and `registerEsmLoaderHooks.exclude` options in `Sentry.init()` to only apply ESM loader hooks to a subset of modules.
    This API served as an escape hatch in case certain modules are incompatible with ESM loader hooks.

    Since this API was introduced, a way was found to only wrap modules that there exists instrumentation for (meaning a vetted list).
    To only wrap modules that have instrumentation, it is recommended to instead set `registerEsmLoaderHooks.onlyIncludeInstrumentedModules` to `true`.

    Note that `onlyIncludeInstrumentedModules: true` will become the default behavior in the next major version and the `registerEsmLoaderHooks` will no longer accept fine-grained options.

The following deprecations will *most likely* not affect you unless you are building an SDK yourself:

-   feat(core): Deprecate `arrayify` ([#&#8203;14405](getsentry/sentry-javascript#14405))
-   feat(core): Deprecate `flatten` ([#&#8203;14454](getsentry/sentry-javascript#14454))
-   feat(core): Deprecate `urlEncode` ([#&#8203;14406](getsentry/sentry-javascript#14406))
-   feat(core): Deprecate `validSeverityLevels` ([#&#8203;14407](getsentry/sentry-javascript#14407))
-   feat(core/utils): Deprecate `getNumberOfUrlSegments` ([#&#8203;14458](getsentry/sentry-javascript#14458))
-   feat(utils): Deprecate `memoBuilder`, `BAGGAGE_HEADER_NAME`, and `makeFifoCache` ([#&#8203;14434](getsentry/sentry-javascript#14434))
-   feat(utils/core): Deprecate `addRequestDataToEvent` and `extractRequestData` ([#&#8203;14430](getsentry/sentry-javascript#14430))

##### Other Changes

-   feat: Streamline `sentry-trace`, `baggage` and DSC handling ([#&#8203;14364](getsentry/sentry-javascript#14364))
-   feat(core): Further optimize debug ID parsing ([#&#8203;14365](getsentry/sentry-javascript#14365))
-   feat(node): Add `openTelemetryInstrumentations` option ([#&#8203;14484](getsentry/sentry-javascript#14484))
-   feat(nuxt): Add filter for not found source maps (devtools) ([#&#8203;14437](getsentry/sentry-javascript#14437))
-   feat(nuxt): Only delete public source maps ([#&#8203;14438](getsentry/sentry-javascript#14438))
-   fix(nextjs): Don't report `NEXT_REDIRECT` from browser ([#&#8203;14440](getsentry/sentry-javascript#14440))
-   perf(opentelemetry): Bucket spans for cleanup ([#&#8203;14154](getsentry/sentry-javascript#14154))

Work in this release was contributed by [@&#8203;NEKOYASAN](https://github.com/NEKOYASAN) and [@&#8203;fmorett](https://github.com/fmorett). Thank you for your contributions!

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4xNDIuNyIsInVwZGF0ZWRJblZlciI6IjM4LjE0Mi43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=-->

Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/374
Reviewed-by: Alexandre Soro <code@soro.dev>
Co-authored-by: renovate <renovate@git.tristess.app>
Co-committed-by: renovate <renovate@git.tristess.app>
@jeengbe
Copy link
Contributor

jeengbe commented Dec 9, 2024

This code breaks if you configure maxSpanWaitDuration: Infinity 🙂 I sadly don't have the time to fix it myself

image

@mydea
Copy link
Member

mydea commented Dec 10, 2024

Huh, I do not think that setting this to Infinity is really a supported use case right now, but we can probably be more explicit about this and validate this against a max. size - I'll open a PR for this.

@jeengbe
Copy link
Contributor

jeengbe commented Dec 10, 2024

Purely semantically I think it makes sense to support "wait an infinite time for spans to complete". A workaround for now is to set it to a sufficiently large number (don't have enough memory for Number.MAX_SAFE_INTEGER though)

@mydea
Copy link
Member

mydea commented Dec 10, 2024

Yeah, I agree. We will probably/hopefully revisit this in the future anyhow, for now we can at least avoid this blowing up!

mydea added a commit that referenced this pull request Dec 10, 2024
Today, if you pass e.g. `Infinity` or another large number to
`maxSpanWaitDuration`, the SDK will error out because we try to do `new
Array(maxSpanWaitDuration)`, which is impossible.

Ideally, we can properly allow an infinite wait time, but for now this
adds checks to ensure only valid values are passed in there, and we do
not explode.

See
#14154 (comment)
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.

5 participants