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

fix(node): ANR fixes and additions #9998

Merged
merged 7 commits into from
Jan 3, 2024

Conversation

timfish
Copy link
Collaborator

@timfish timfish commented Dec 29, 2023

This PR makes a few fixes and additions to the ANR feature.

  • Stops passing the sdk property with the event since enhanceEventWithSdkInfo results in duplicate integrations/packages being sent!
  • Allows the passings of staticTags to attach to ANR events
    • Required by Electron SDK to tag the source process/origin/environment
    • Could also be useful for other users
  • Optionally enable normalising of stack frame paths to the app root

The path normalisation code (and tests) are from the Electron SDK and is well tested on all platforms. However, it will only be called when appRootPath is supplied. If/when we add path normalisation to Node, it will have a default which can be overridden.

The Electron SDK will then wrap the Node Anr integration something like this:

class Anr extends NodeAnr {
  public constructor(options: Partial<Options> = {}) {
    super({
      ...options,
      staticTags: {
        'event.environment': 'javascript',
        'event.origin': 'electron',
        'event.process': 'browser',
        ...options.tags,        
      },
      appRootPath: app.getAppPath(),
    });
  }
}

@timfish timfish changed the title fix(node): ANR fixes and improvements fix(node): ANR fixes and additions Dec 29, 2023
@timfish timfish requested a review from AbhiPrasad January 2, 2024 09:48
packages/node/src/integrations/anr/common.ts Outdated Show resolved Hide resolved
@AbhiPrasad AbhiPrasad merged commit 011ba71 into getsentry:develop Jan 3, 2024
75 checks passed
anonrig pushed a commit that referenced this pull request Jan 3, 2024
This PR makes a few fixes and additions to the ANR feature.
- Stops passing the `sdk` property with the event since
`enhanceEventWithSdkInfo` results in duplicate integrations/packages
being sent!
- Allows the passings of `staticTags` to attach to ANR events 
- Required by Electron SDK to tag the source
`process/origin/environment`
  - Could also be useful for other users
- Optionally enable normalising of stack frame paths to the app root
  - Required for Electron
  - Soon required for Node with #9072

The path normalisation code (and tests) are from the Electron SDK and is
well tested on all platforms. However, it will only be called when
`appRootPath` is supplied. If/when we add path normalisation to Node, it
will have a default which can be overridden.

The Electron SDK will then wrap the Node Anr integration something like
this:
```ts
class Anr extends NodeAnr {
  public constructor(options: Partial<Options> = {}) {
    super({
      ...options,
      staticTags: {
        'event.environment': 'javascript',
        'event.origin': 'electron',
        'event.process': 'browser',
        ...options.tags,        
      },
      appRootPath: app.getAppPath(),
    });
  }
}
```
@timfish timfish deleted the fix/anr-issues branch January 10, 2024 16:12
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.

3 participants