Skip to content

feat: Use new AM SDK API #19041

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 28, 2020
Merged

feat: Use new AM SDK API #19041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6549a19
feat: Use new AM SDK API
HazAT May 27, 2020
68f2bc4
fix: webpack build time script
HazAT May 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 20 additions & 34 deletions build-utils/sentry-instrumentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class SentryInstrumentation {

this.initialBuild = false;
this.Sentry = require('@sentry/node');
require('@sentry/apm');
require('@sentry/apm'); // This is required to patch Sentry

this.Sentry.init({
dsn: 'https://3d282d186d924374800aa47006227ce9@sentry.io/2053674',
Expand All @@ -46,16 +46,6 @@ class SentryInstrumentation {
);
}

/**
* Waits for Sentry SDK to finish requests
*/
async sdkFinish() {
const client = this.Sentry.getCurrentHub().getClient();
if (client) {
await client.flush();
}
}

/**
* Measures the file sizes of assets emitted from the entrypoints
*/
Expand All @@ -70,20 +60,22 @@ class SentryInstrumentation {
const asset = compilation.assets[assetName];
const sizeInKb = asset.size() / 1024;

// can also be written as this.Sentry.startTransaction
const transaction = hub.startSpan({
op: 'webpack-asset',
transaction: assetName,
name: assetName,
description: `webpack bundle size for ${entrypointName} -> ${assetName}`,
data: {
entrypointName,
file: assetName,
size: `${Math.round(sizeInKb)} KB`,
},
trimEnd: true,
});

const start = transaction.startTimestamp;

const span = hub.startSpan({
const span = transaction.startChild({
op: 'asset',
startTimestamp: start,
description: assetName,
Expand All @@ -93,10 +85,8 @@ class SentryInstrumentation {
size: `${Math.round(sizeInKb)} KB`,
},
});
span.startTimestamp = start;
span.finish();
span.timestamp = start + sizeInKb / 1000;
transaction.finish(true);
span.finish(start + sizeInKb / 1000);
Copy link
Member Author

@HazAT HazAT May 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@billyvg I made the changes to the file to use the new API.
But this line here in terms of calculating the endTimestamp for the Span seems very odd.
Time + Filesize? What is the reason behind this?
I suppose you are abusing the Span chart to visualize file size?

Copy link
Member

Choose a reason for hiding this comment

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

Correct

transaction.finish();
})
)
);
Expand All @@ -106,20 +96,18 @@ class SentryInstrumentation {
if (!this.Sentry) {
return;
}

const hub = this.Sentry.getCurrentHub();

const transaction = hub.startSpan(
{
op: 'webpack-build',
transaction: !this.initialBuild ? 'initial-build' : 'incremental-build',
description: 'webpack build times',
},
true
);
transaction.startTimestamp = startTime;
// can also be written as this.Sentry.startTransaction
const transaction = hub.startSpan({
op: 'webpack-build',
name: !this.initialBuild ? 'initial-build' : 'incremental-build',
description: 'webpack build times',
startTimestamp: startTime,
trimEnd: true,
});

const span = transaction.child({
const span = transaction.startChild({
op: 'build',
description: 'webpack build',
data: {
Expand All @@ -131,12 +119,10 @@ class SentryInstrumentation {
: 'N/A',
loadavg: os.loadavg(),
},
startTimestamp: startTime,
});
span.startTimestamp = startTime;
span.finish();
span.timestamp = endTime;

transaction.finish(true);
span.finish(endTime);
transaction.finish();
}

apply(compiler) {
Expand All @@ -156,7 +142,7 @@ class SentryInstrumentation {
}

this.initialBuild = true;
await this.sdkFinish();
await this.Sentry.flush();
done();
}
);
Expand Down
10 changes: 5 additions & 5 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@
"@emotion/babel-preset-css-prop": "^10.0.27",
"@emotion/core": "^10.0.27",
"@emotion/styled": "^10.0.27",
"@sentry/apm": "5.16.0-beta.3",
"@sentry/browser": "5.16.0-beta.3",
"@sentry/integrations": "5.16.0-beta.3",
"@sentry/apm": "5.16.0-beta.4",
"@sentry/browser": "5.16.0-beta.4",
"@sentry/integrations": "5.16.0-beta.4",
"@sentry/release-parser": "^0.5.0",
"@sentry/rrweb": "^0.1.1",
"@sentry/utils": "5.16.0-beta.3",
"@sentry/utils": "5.16.0-beta.4",
"@types/classnames": "^2.2.0",
"@types/clipboard": "^2.0.1",
"@types/color": "^3.0.0",
Expand Down Expand Up @@ -133,7 +133,7 @@
"devDependencies": {
"@babel/plugin-transform-react-jsx-source": "^7.2.0",
"@pmmmwh/react-refresh-webpack-plugin": "^0.3.1",
"@sentry/node": "^5.16.0-beta.3",
"@sentry/node": "^5.16.0-beta.4",
"@storybook/addon-a11y": "^5.3.3",
"@storybook/addon-actions": "^5.3.3",
"@storybook/addon-docs": "^5.3.3",
Expand Down
8 changes: 4 additions & 4 deletions src/sentry/static/sentry/app/bootstrap.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ Sentry.init({
...window.__SENTRY__OPTIONS,
integrations: getSentryIntegrations(hasReplays),
tracesSampleRate,
_experiments: {useEnvelope: true},
async beforeSend(event) {
return normalizeTransactionName(appRoutes, event);
},
});

Sentry.addGlobalEventProcessor(async event => {
return normalizeTransactionName(appRoutes, event);
Comment on lines +89 to +92
Copy link
Member Author

@HazAT HazAT May 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@dashed Transaction still goes through event processors and this is the internal workaround for it.
EventProcessors are considered internal. And they work the same as beforeSend :)

Copy link
Member

Choose a reason for hiding this comment

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

Oh Interesting 👍

});

if (window.__SENTRY__USER) {
Expand Down
122 changes: 61 additions & 61 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1823,76 +1823,76 @@
react-lifecycles-compat "^3.0.4"
warning "^3.0.0"

"@sentry/apm@5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/apm/-/apm-5.16.0-beta.3.tgz#e241cbd9a308e301a681c086e1096b47c04d225a"
integrity sha512-3PmDRh9Hsj+Wfnq5+eWq/RA7CvExlWHCEK2AJZ5pG1WjvWuQ9nj8MXiVNoIA7t2WGujCcEFoDJuUofsMTekdWA==
dependencies:
"@sentry/browser" "5.16.0-beta.3"
"@sentry/hub" "5.16.0-beta.3"
"@sentry/minimal" "5.16.0-beta.3"
"@sentry/types" "5.16.0-beta.3"
"@sentry/utils" "5.16.0-beta.3"
"@sentry/apm@5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/apm/-/apm-5.16.0-beta.4.tgz#285cc056668a7881e930ccb1197a8968ace659c4"
integrity sha512-hojFb1fxZIVpLbwsuDD1BdWEj1Ax33KBFohZ3kQ14Q5LeGIzMfbKNFlCrtNv+I6+Fe83y22shMXVWVssrIflcw==
dependencies:
"@sentry/browser" "5.16.0-beta.4"
"@sentry/hub" "5.16.0-beta.4"
"@sentry/minimal" "5.16.0-beta.4"
"@sentry/types" "5.16.0-beta.4"
"@sentry/utils" "5.16.0-beta.4"
tslib "^1.9.3"

"@sentry/browser@5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-5.16.0-beta.3.tgz#176a0ed01e567c6c0fb59248801b9dcff97e3836"
integrity sha512-mHTrXBSRA9oCG9VukyrB2U6xiqQ2yK5oDsWdt1HDB8ApwOSdOZPfV5TbgfvNa6hEIbLhjbFC0AyQcRgkANveDg==
"@sentry/browser@5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-5.16.0-beta.4.tgz#6bdedeb7333de00f1641d7cb67992522c950a15b"
integrity sha512-aaSJOj32N8mG+mypMCjFv5wyaPbjx+VLt2z/QOiBpnC3WbV1lRUR0trvUIqq55L4CkcLXB8+6PBG2fS39+MpbA==
dependencies:
"@sentry/core" "5.16.0-beta.3"
"@sentry/types" "5.16.0-beta.3"
"@sentry/utils" "5.16.0-beta.3"
"@sentry/core" "5.16.0-beta.4"
"@sentry/types" "5.16.0-beta.4"
"@sentry/utils" "5.16.0-beta.4"
tslib "^1.9.3"

"@sentry/core@5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/core/-/core-5.16.0-beta.3.tgz#b2a60fb8a81c19f5321a9e3bb17d372aaed74a46"
integrity sha512-9owqHefHt2dv+2bxcic9inneOrji9El9PqkwbRNxIcsduO6+Tu6nFJokBlxUZFi1eKpuAoOjjp0loaYvStKfNw==
"@sentry/core@5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/core/-/core-5.16.0-beta.4.tgz#680163ab88c02f1bbb532ac4bfd58e2ec16b6016"
integrity sha512-yhufues9ahGZi7lmB+C5EkORwmxcGXovaFVPvZxr7YgtT9xHwKB1SV0GnP14sQIs0VbiufWNVvHWtUQVN/fIwg==
dependencies:
"@sentry/hub" "5.16.0-beta.3"
"@sentry/minimal" "5.16.0-beta.3"
"@sentry/types" "5.16.0-beta.3"
"@sentry/utils" "5.16.0-beta.3"
"@sentry/hub" "5.16.0-beta.4"
"@sentry/minimal" "5.16.0-beta.4"
"@sentry/types" "5.16.0-beta.4"
"@sentry/utils" "5.16.0-beta.4"
tslib "^1.9.3"

"@sentry/hub@5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/hub/-/hub-5.16.0-beta.3.tgz#51c72daa459215654291f38cbdc7e8eb410cfd72"
integrity sha512-yGNnz4nafrjkk6XMDhpAcLwWUGPMShZKOOvYLrBa02Y7mOh+3mBcUaZmGnVA+X1M8idwE72LE1WRkJzBv6t9QA==
"@sentry/hub@5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/hub/-/hub-5.16.0-beta.4.tgz#ac436b901a6bd930973ee99df48ab2c6820784f6"
integrity sha512-QSbYdgr2mE/slPxL9JeXHtmWIybUbpQNlTiWt6gaQyc8H+DsKYzT19AwH32U/4+Z6HC9yk8H0UGpb4HewV1BFw==
dependencies:
"@sentry/types" "5.16.0-beta.3"
"@sentry/utils" "5.16.0-beta.3"
"@sentry/types" "5.16.0-beta.4"
"@sentry/utils" "5.16.0-beta.4"
tslib "^1.9.3"

"@sentry/integrations@5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/integrations/-/integrations-5.16.0-beta.3.tgz#8ecc5018a35b2917225c78dfdcda2d406616336d"
integrity sha512-pC4I1PKK+/FORGElPGFXT7thH3A+xqyPi4QQ8lBLkzKBNn/STvXZhx33nqLGnf6OoihZqpn9GNAGzvGpo7AR2w==
"@sentry/integrations@5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/integrations/-/integrations-5.16.0-beta.4.tgz#31b99c9c7465e5f76b3c3020ea02f09b476037a7"
integrity sha512-K4o4QRw93+5AH/lXLWydnCiIhvIWGRd1U6LynJ9qXdHNCCR6E/OYEMnf3t7kOIQuZzFgqrqnr938fwU/edwQeQ==
dependencies:
"@sentry/types" "5.16.0-beta.3"
"@sentry/utils" "5.16.0-beta.3"
"@sentry/types" "5.16.0-beta.4"
"@sentry/utils" "5.16.0-beta.4"
tslib "^1.9.3"

"@sentry/minimal@5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/minimal/-/minimal-5.16.0-beta.3.tgz#9340b21e7259f015efbfa932b6f48f42cdf72c0a"
integrity sha512-YUksBXrUp8lRwE40fsWRu6B7YJ/f1d+klyFxyc4ECDCWtByTa80SOwmvwhrApADzFa4g9v/wGXC+KTYybGb3Tg==
"@sentry/minimal@5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/minimal/-/minimal-5.16.0-beta.4.tgz#cd8e067c336f5d1ef98a121852f567dc80592d5c"
integrity sha512-qcTa1OafWylxhZIRiFVkh4P69BNB7h1syAStSt00o5wnlSSk5xP8u5CORibVVQSN1KbBWljlSyrWY2xKSDXU7A==
dependencies:
"@sentry/hub" "5.16.0-beta.3"
"@sentry/types" "5.16.0-beta.3"
"@sentry/hub" "5.16.0-beta.4"
"@sentry/types" "5.16.0-beta.4"
tslib "^1.9.3"

"@sentry/node@^5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/node/-/node-5.16.0-beta.3.tgz#5debe9c29dd9bbaf8acce9d665b2c1d48ab11b3c"
integrity sha512-69cIGhK+0H8PpWizJhvnpbFAoAsSvqGnHUk8tr3VjchdhgVqV1fZSPijqs2VIj/2RUN3r6Hl6XVGLr7Cu1gLmg==
"@sentry/node@^5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/node/-/node-5.16.0-beta.4.tgz#b43fbdee7336108a6b70e38230cbc94bbaabc6aa"
integrity sha512-RiFm7YEJJ5lorqKMbpz/4vUgpNH8OSEJScMNiUTZ1gtysZ5/1YR0lQv536NZkNp2IwjJMThnxKgUrcydTnf2Qg==
dependencies:
"@sentry/apm" "5.16.0-beta.3"
"@sentry/core" "5.16.0-beta.3"
"@sentry/hub" "5.16.0-beta.3"
"@sentry/types" "5.16.0-beta.3"
"@sentry/utils" "5.16.0-beta.3"
"@sentry/apm" "5.16.0-beta.4"
"@sentry/core" "5.16.0-beta.4"
"@sentry/hub" "5.16.0-beta.4"
"@sentry/types" "5.16.0-beta.4"
"@sentry/utils" "5.16.0-beta.4"
cookie "^0.3.1"
https-proxy-agent "^4.0.0"
lru_map "^0.3.3"
Expand All @@ -1908,17 +1908,17 @@
resolved "https://registry.yarnpkg.com/@sentry/rrweb/-/rrweb-0.1.1.tgz#1e2ef7381d5c5725ea3bf3ac20987d50eee83dd1"
integrity sha512-bFzZ+NVaGFpkmBvSHsvM/Pc/wiy7UeP/ICofkY2iY5PwiRHpZCX5hLrLYA7o921VR847EKZB44fQYWZC1YFB1Q==

"@sentry/types@5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/types/-/types-5.16.0-beta.3.tgz#0658562166aac515977b3a979ced9af01dca153c"
integrity sha512-UfIYazvDhOV/dcfFg8OvA8mR1mcOmRE3m2F6qn2jJiQbccKUSXKsaZRXdk/Dj2c0862VFY+wSxpVgG+Vjb0frQ==
"@sentry/types@5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/types/-/types-5.16.0-beta.4.tgz#cb59d32ee6f6ea0c4b700dfe8d877f4bbfdad711"
integrity sha512-1aUBt/kmHmB06BjyXFKRg2ra/x2tt/BTUtu4zuezpX8XvtzzBdHt27sxUpDsJCgal1hVyFMer5EaGAISVbNmIg==

"@sentry/utils@5.16.0-beta.3":
version "5.16.0-beta.3"
resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-5.16.0-beta.3.tgz#8d40d2b88e46ad97ac9356f5e627ece23dcb08b0"
integrity sha512-PXFWvC5kSvOSVPlK6xylmPcILNEjBkcBBPmWmvSR8r2he70JmeFDGHkhNP9LaLydcCBZ/eH59bCQqD1sWgTbow==
"@sentry/utils@5.16.0-beta.4":
version "5.16.0-beta.4"
resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-5.16.0-beta.4.tgz#6b591bec35aec79bfbf4d9a056cd3fcccdbf6448"
integrity sha512-VZ2MSqBGEng2On9GywKuntby6JM4C6J+HUVNyBTk03K2GGjkV49bTQrUvbffXRcmvHcGZDic2kXTfV5m+A/hRA==
dependencies:
"@sentry/types" "5.16.0-beta.3"
"@sentry/types" "5.16.0-beta.4"
tslib "^1.9.3"

"@storybook/addon-a11y@^5.3.3":
Expand Down