Skip to content

Commit 7232eda

Browse files
Abdkhan14Abdullah Khan
andauthored
docs(new-trace): Adding python perf onboaring docs to _index.json (#10792)
* docs(new-trace): Adding python perf onboaring docs to _index.json * docs(new-trace): Adding nextjs performance onboarding docs. * docs(new-trace): Adding django performance onboarding docs. * docs(new-trace): Adding django performance onboarding docs. * docs(new-trace): Adding node performance onboarding docs. * docs(new-trace): Adding PHP performance onboarding docs. --------- Co-authored-by: Abdullah Khan <abdullahkhan@PG9Y57YDXQ.local>
1 parent 5d92326 commit 7232eda

21 files changed

+142
-7
lines changed

public/_platforms/_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"key": "javascript.next-performance-onboarding-1-install",
3+
"type": "framework",
4+
"doc_link": "https://docs.sentry.io/platforms/javascript/guides/nextjs/tracing/",
5+
"name": "Next",
6+
"aliases": [],
7+
"categories": [],
8+
"body": "<h4 id=\"install\" style=\"position:relative;\">Install</h4>\n<p>Install the Next.js SDK using our installation wizard:\n<div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash highlight\"><code class=\"language-bash\"><span class=\"token function\">npx</span> @sentry/wizard@latest -i nextjs</code></pre></div>"
9+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"key": "javascript.next-performance-onboarding-2-configure",
3+
"type": "framework",
4+
"doc_link": "https://docs.sentry.io/platforms/javascript/guides/nextjs/tracing/",
5+
"name": "Next",
6+
"aliases": [],
7+
"categories": [],
8+
"body": "<h4 id=\"configure\" style=\"position:relative;\">Configure</h4>\n<p>To configure, set <code>tracesSampleRate</code> in your config files, <code>sentry.server.config.js</code>, <code>sentry.client.config.js</code>, and <code>sentry.edge.config.js</code>:</p>\n<p>Once this is done, Sentry's Next.js SDK captures all unhandled exceptions and transactions.</p>\n<div class=\"gatsby-highlight\" data-language=\"javascript\"><pre class=\"language-javascript highlight\"><code class=\"language-javascript\"><span class=\"token keyword\">import</span> <span class=\"token operator\">*</span> <span class=\"token keyword\">as</span> Sentry <span class=\"token keyword\">from</span> <span class=\"token string\">\"@sentry/nextjs\"</span><span class=\"token punctuation\">;</span>\n\nSentry<span class=\"token punctuation\">.</span><span class=\"token function\">init</span><span class=\"token punctuation\">(</span><span class=\"token punctuation\">{</span>\n <span class=\"token literal-property property\">dsn</span><span class=\"token operator\">:</span> <span class=\"token string\">\"___PUBLIC_DSN___\"</span><span class=\"token punctuation\">,</span>\n\n<span class=\"token comment\">// Set tracesSampleRate to 1.0 to capture 100%</span>\n <span class=\"token comment\">// of transactions for performance monitoring.</span>\n <span class=\"token comment\">// We recommend adjusting this value in production</span>\n <span class=\"token literal-property property\">tracesSampleRate</span><span class=\"token operator\">:</span> <span class=\"token number\">1.0</span><span class=\"token punctuation\">,</span></code></pre></div>\n<p>We recommend adjusting the value of <code>tracesSampleRate</code> in production. Learn more about tracing <a href=\"https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/options/#tracing-options\">options,</a> how to use the <a href=\"https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/sampling/#setting-a-sampling-function\">traces_sampler</a> function, or how to <a href=\"https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/sampling/#sampling-transaction-events\">sample transactions</a>.</p>"
9+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"key": "javascript.next-performance-onboarding-3-verify",
3+
"type": "framework",
4+
"doc_link": "https://docs.sentry.io/platforms/javascript/guides/nextjs/tracing/",
5+
"name": "Next",
6+
"aliases": [],
7+
"categories": [],
8+
"body": "<h4 id=\"verify\" style=\"position:relative;\">Verify</h4>\n<p>Verify that performance monitoring is working correctly with our <a href=\"https://docs.sentry.io/platforms/javascript/guides/nextjs/tracing/instrumentation/automatic-instrumentation/\">automatic instrumentation</a> by simply using your Next.js application.</p>\n<p>You have the option to manually construct a transaction using <a href=\"https://docs.sentry.io/platforms/javascript/guides/nextjs/tracing/instrumentation/custom-instrumentation/\">custom instrumentation</a>.\n<p>While you're testing, set <code>tracesSampleRate</code> to <code>1.0</code>, as that ensures that every transaction will be sent to Sentry. Once testing is complete, you may want to set a lower <code>tracesSampleRate</code> value, or switch to using <code>tracesSampler</code> to selectively sample and filter your transactions, based on contextual data.</p>"
9+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"key": "javascript.node-performance-onboarding-1-install",
3+
"type": "framework",
4+
"doc_link": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/",
5+
"name": "Node",
6+
"aliases": [],
7+
"categories": [],
8+
"body": "<h4 id=\"install\" style=\"position:relative;\">Install</h4>\n<p>Install our Node.js SDK using <code>npm</code>:</p>\n<div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash highlight\"><code class=\"language-bash\"><span class=\"token function\">npm</span> <span class=\"token function\">install</span> <span class=\"token parameter variable\">--save</span> @sentry/node</code></pre></div>"
9+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"key": "javascript.node-performance-onboarding-2-configure",
3+
"type": "framework",
4+
"doc_link": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/",
5+
"name": "Node",
6+
"aliases": [],
7+
"categories": [],
8+
"body": "<h4 id=\"configure\" style=\"position:relative;\">Configure</h4>\n<p>Sentry should be initialized as early in your app as possible. It is essential that you call <code>Sentry.init</code> before you require any other modules in your application—otherwise, auto-instrumentation of these modules will <strong>not</strong> work.</p>\n<p>Once this is done, Sentry's Node SDK captures unhandled exceptions as well as tracing data for your application.</p>\n<p>You need to create a file named <code>instrument.js</code> that imports and initializes Sentry:</p>\n<div class=\"gatsby-highlight\" data-language=\"javascript\"><pre class=\"language-javascript highlight\"><code class=\"language-javascript\"><span class=\"token keyword\">const</span> Sentry <span class=\"token operator\">=</span> <span class=\"token string\">require(\"@sentry/node\")</span><span class=\"token punctuation\">;</span>\n\n<span class=\"token comment\">// Ensure to call this before requiring any other modules!</span>\nSentry<span class=\"token punctuation\">.</span><span class=\"token function\">init</span><span class=\"token punctuation\">(</span><span class=\"token punctuation\">{</span>\n <span class=\"token literal-property property\">dsn</span><span class=\"token operator\">:</span> <span class=\"token string\">\"___PUBLIC_DSN___\"</span><span class=\"token punctuation\">,</span>\n <span class=\"token literal-property property\">integrations</span><span class=\"token operator\">:</span> <span class=\"token punctuation\">[<span class=\"token class-name\">Sentry<span class=\"token punctuation\">.</span>browserTracingIntegration</span><span class=\"token punctuation\">(</span><span class=\"token punctuation\">)</span><span class=\"token punctuation\">]</span><span class=\"token punctuation\">,</span>\n\n <span class=\"token comment\">// Set tracesSampleRate to 1.0 to capture 100%</span>\n <span class=\"token comment\">// of transactions for performance monitoring.</span>\n <span class=\"token comment\">// We recommend adjusting this value in production</span>\n <span class=\"token literal-property property\">tracesSampleRate</span><span class=\"token operator\">:</span> <span class=\"token number\">1.0</span><span class=\"token punctuation\">,</span>\n<span class=\"token punctuation\">}</span><span class=\"token punctuation\">)</span><span class=\"token punctuation\">;</span></code></pre></div>\n<p>We recommend adjusting the value of <code>tracesSampleRate</code> in production. Learn more about tracing <a href=\"https://docs.sentry.io/platforms/javascript/guides/node/configuration/options/#tracing-options\">options,</a> how to use the <a href=\"https://docs.sentry.io/platforms/javascript/guides/node/configuration/sampling/\">traces_sampler</a> function, or how to <a href=\"https://docs.sentry.io/platforms/javascript/guides/node/configuration/sampling/\">sample transactions</a>.</p>"
9+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"key": "javascript.node-performance-onboarding-3-verify",
3+
"type": "framework",
4+
"doc_link": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/",
5+
"name": "Node",
6+
"aliases": [],
7+
"categories": [],
8+
"body": "<h4 id=\"verify\" style=\"position:relative;\">Verify</h4>\n<p>Verify that performance monitoring is working correctly with our <a href=\"https://docs.sentry.io/platforms/javascript/guides/node/tracing/instrumentation/automatic-instrumentation/\">automatic instrumentation</a> by simply using your JavaScript application.</p>\n<p>You have the option to manually construct a transaction using <a href=\"https://docs.sentry.io/platforms/javascript/guides/node/tracing/instrumentation/custom-instrumentation/\">custom instrumentation</a>.</p>"
9+
}

public/_platforms/javascript/performance-onboarding-1-install.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
"name": "JavaScript",
66
"aliases": [],
77
"categories": [],
8-
"body": "<h4 id=\"install\" style=\"position:relative;\">Install</h4>\n<p>Install our JavaScript browser SDK using either <code>yarn</code> or <code>npm</code>:</p>\n<div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash highlight\"><code class=\"language-bash\"><span class=\"token comment\"># Using yarn</span>\n<span class=\"token function\">yarn</span> <span class=\"token function\">add</span> @sentry/browser\n\n<span class=\"token comment\"># Using npm</span>\n<span class=\"token function\">npm</span> <span class=\"token function\">install</span> <span class=\"token parameter variable\">--save</span> @sentry/browser</code></pre></div>"
8+
"body": "<h4 id=\"install\" style=\"position:relative;\">Install</h4>\n<p>Install our JavaScript browser SDK using either <code>yarn</code>\nor <code>npm</code>:</p>\n<div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash highlight\"><code class=\"language-bash\"><span class=\"token comment\"># Using yarn</span>\n<span class=\"token function\">yarn</span> <span class=\"token function\">add</span> @sentry/browser\n\n<span class=\"token comment\"># Using npm</span>\n<span class=\"token function\">npm</span> <span class=\"token function\">install</span> <span class=\"token parameter variable\">--save</span> @sentry/browser</code></pre></div>"
99
}

public/_platforms/javascript/react-performance-onboarding-1-install.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
"name": "React",
66
"aliases": [],
77
"categories": [],
8-
"body": "<h4 id=\"install\" style=\"position:relative;\">Install</h4>\n<p>Install our JavaScript browser SDK using either <code>yarn</code> or <code>npm</code>:</p>\n<div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash highlight\"><code class=\"language-bash\"><span class=\"token comment\"># Using yarn</span>\n<span class=\"token function\">yarn</span> <span class=\"token function\">add</span> @sentry/react\n\n<span class=\"token comment\"># Using npm</span>\n<span class=\"token function\">npm</span> <span class=\"token function\">install</span> <span class=\"token parameter variable\">--save</span> @sentry/react</code></pre></div>"
8+
"body": "<h4 id=\"install\" style=\"position:relative;\">Install</h4>\n<p>Install our JavaScript browser SDK using either <code>yarn</code>\nor <code>npm</code>:</p>\n<div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash highlight\"><code class=\"language-bash\"><span class=\"token comment\"># Using yarn</span>\n<span class=\"token function\">yarn</span> <span class=\"token function\">add</span> @sentry/react\n\n<span class=\"token comment\"># Using npm</span>\n<span class=\"token function\">npm</span> <span class=\"token function\">install</span> <span class=\"token parameter variable\">--save</span> @sentry/react</code></pre></div>"
99
}

0 commit comments

Comments
 (0)