You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/contributing/approach/sdk-docs/write-performance.mdx
+19-6Lines changed: 19 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,29 +31,42 @@ This file is `index.mdx`. It explains how to install or set up (if appropriate)
31
31
32
32
To develop content for this file:
33
33
34
-
1.Determine if the SDK needs an installation step or a property set to enable tracing. If so, add the SDK to `Supported` list in the `<PlatformSection>`, then add a code sample to `performance/enable-tracing/`. If not, add the SDK to `notSupported` list, which will prevent the **Enable Tracing** heading from displaying for this SDK.
34
+
1.If the SDK is still a work-in-progress and is exposed as an experimental or an early access feature, add the platform to the `<PlatformSection>` wrapping the appropriate alert located at the beginning of the content for the page.
35
35
36
-
2. Add a code sample to `/src/includes/performance/configure-sample-rate/` that covers how to set sample rates.
36
+
1. If the SDK is expected to be used in a high-throughput environment, add the platform to the following `<PlatformSection>` which advises testing before deploying to production.
37
37
38
-
3. Determine if you want to have users verify using our custom instrumentation. If so, add the SDK to `Supported` list in the `<PlatformSection>`. If not, add the SDK to `notSupported` list, which will prevent the `<PlatformLink>`to the Custom Instrumentation page from displaying for this SDK.
38
+
1. If automatic instrumentation is still in preview/beta for the SDK, add your platform to the next `<PlatformSection>`that wraps around text that discusses this.
39
39
40
-
4. Determine if the paragraph regarding pageload and navigation applies to the SDK. If so, add the SDK to `Supported` list in the `<PlatformSection>`. If not, add the SDK to `notSupported` list, which will prevent the content from displaying for this SDK.
40
+
1. If automatic instrumentation is supported, add your platform to the `<PlatformSection>` immediately following **Verify** which advises users to either use auto or custom (or manual) instrumentation to verify the feature. Either omit the platform from the `supported` list or add the platform to the `notSupported` list if auto instrumentation is not available.
41
41
42
-
5. Determine the level of instrumentation support for verification and add as appropriate to the `Supported` list in the `<PlatformSection>`.
42
+
1. Add a code sample to `/src/includes/performance/configure-sample-rate/` that covers how to set sample rates. Make sure to update `/platforms/common/configuration/sampling.mdx` and **Tracing Options** in `/platforms/common/configuration/options.mdx`.
43
+
44
+
1. Do one of the following based on whether automatic instrumentation is available for the SDK or not:
45
+
a. If automatic instrumentation is supported, add your platform to the `<PlatformSection>` immediately following **Verify** which advises users to either use auto or custom (a.k.a. manual) instrumentation to verify the feature. Either omit the platform from `supported` or the platform to `notSupported`.
46
+
47
+
b. If automatic instrumentation is not supported, add your platform to the second `<PlatformSection>` after **Verify** which advises users to test out tracing using custom (manual) instrumentation. Omit the platform from the `supported` list or add it to the `notSupported` list if automatic instrumentation is available.
48
+
49
+
1. Determine if the paragraph regarding pageload and navigation applies to the SDK. If so, add the SDK to the `Supported` list in the `<PlatformSection>`. If not, either omit the platform from the `supported` list or add the platform to the `notSupported` list, which will prevent the content from displaying for this SDK.
43
50
44
51
### Custom Instrumentation
45
52
46
53
We expect this content to apply to all SDKS.
47
54
48
55
This file is `performance/instrumentation/custom-instrumentation.mdx`. It explains how to manually instrument transactions.
49
56
57
+
If custom instrumentation for the SDK is exposed as an experimental or an early access feature, add the platform to the `<PlatformSection>` wrapping the appropriate alert located at the beginning of the content for the page.
58
+
50
59
To develop content for this file, add code samples to these directories:
Then determine whether to provide a code sample illustrating how to connect errors and spans. If so, add the SDK to `Supported` list in the `<PlatformSection>`, then add a code sample `/src/includes/performance/connect-errors-spans/`.
65
+
If any of the above files are not applicable to your platform, find the `<PlatformSection>` wrapping the `<PlatformContent>` pointing to the unsupported file, and add your platform to its `notSupported` list. If such a `<PlatformSection>` doesn't already exist, create one and add your platform to its `notSupported` list.
66
+
67
+
Then, determine whether to provide a code sample illustrating how to connect errors and spans. If so, add the SDK to the `Supported` list in the appropriate `<PlatformSection>`, then add a code sample `/src/includes/performance/connect-errors-spans/`.
68
+
69
+
If the platform supports distributed tracing using custom instrumentation, add the SDK to the appropriate `<PlatformSection>` and create an appropriate file at `src/includes/performance/distributed-tracing`.
Copy file name to clipboardExpand all lines: src/platforms/common/performance/index.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ Performance monitoring is still an experimental, work-in-progress feature, and i
43
43
44
44
</Note>
45
45
46
-
</PlatformSection>
46
+
</PlatformSection>
47
47
48
48
<Note>
49
49
@@ -77,7 +77,7 @@ Automatic instrumentation for monitoring the performance of your application is
77
77
78
78
## Configure the Sample Rate
79
79
80
-
Once you configure the <PlatformLinkto="/configuration/sampling/">sample rate</PlatformLink>, tracing will be enabled in your app. Set the sample rate for your transactions by either:
80
+
Sampling for transactions must also be configured before tracing is be enabled in your app. Set the sample rate for your transactions by either:
81
81
82
82
1. Setting a uniform sample rate for all transactions using the <PlatformIdentifiername="traces-sample-rate" /> option in your SDK config to a number between `0` and `1`. (For example, to send 20% of transactions, set <PlatformIdentifiername="traces-sample-rate" /> to `0.2`.)
83
83
2. Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the <PlatformIdentifiername="traces-sampler" /> config option.
0 commit comments