more docs

Author: vaind

docs/platforms/powershell/performance/index.mdx

@@ -0,0 +1,38 @@
+---
+title: Set Up Performance
+description: "Learn how to enable performance monitoring in your app if it is not already set up."
+sidebar_order: 4000
+---
+
+With [performance monitoring](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/).
+
+<Note>
+
+If you’re adopting Performance in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.
+
+</Note>
+
+## Configure
+
+First, enable tracing and configure the sampling rate for transactions. Set the sample rate for your transactions by either:
+
+- Setting a uniform sample rate for all transactions using the <PlatformIdentifier name="traces-sample-rate" /> option in your SDK config to a number between `0` and `1`. (For example, to send 20% of transactions, set <PlatformIdentifier name="traces-sample-rate" /> to `0.2`.)
+- Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the <PlatformIdentifier name="traces-sampler" /> config option.
+
+The two options are meant to be mutually exclusive. If you set both, <PlatformIdentifier name="traces-sampler" /> will take precedence.
+
+<PlatformContent includePath="performance/configure-sample-rate" />
+
+Learn more about performance monitoring <PlatformLink to="/configuration/options/#tracing-options">options</PlatformLink>, or how to <PlatformLink to="/configuration/sampling/#sampling-transaction-events">sample transactions</PlatformLink>.
+
+## Verify
+
+Test out tracing by starting and finishing a transaction, which you _must_ do so transactions can be sent to Sentry. Learn how in our <PlatformLink to="/performance/instrumentation/custom-instrumentation/">Custom Instrumentation</PlatformLink> content.
+
+While you're testing, set <PlatformIdentifier name="traces-sample-rate" /> to `1.0`, as that ensures that every transaction will be sent to Sentry.
+
+Once testing is complete, you may want to set a lower <PlatformIdentifier name="traces-sample-rate" /> value, or switch to using <PlatformIdentifier name="traces-sampler" /> to selectively sample and filter your transactions, based on contextual data.
+
+## Next Steps
+
+<PageGrid />

docs/platforms/powershell/performance/instrumentation/custom-instrumentation.mdx

@@ -0,0 +1,17 @@
+---
+title: Custom Instrumentation
+description: "Learn how to capture performance data on any action in your app."
+sidebar_order: 20
+---
+
+<Note>
+
+To capture transactions and spans customized to your organization's needs, you must first <PlatformLink to="/performance/">set up performance monitoring.</PlatformLink>
+
+</Note>
+
+<PlatformContent includePath="performance/enable-manual-instrumentation" />
+
+<PlatformContent includePath="performance/add-spans-example" />
+
+<PlatformContent includePath="performance/retrieve-transaction" />

docs/platforms/powershell/performance/instrumentation/index.mdx

@@ -0,0 +1,9 @@
+---
+title: Instrumentation
+description: "Learn how to instrument performance in your app."
+sidebar_order: 20
+---
+
+Instrumenting performance monitoring is specific to your SDK.
+
+<PageGrid />

docs/platforms/powershell/performance/instrumentation/performance-metrics.mdx

@@ -0,0 +1,66 @@
+---
+title: Performance Metrics
+description: "Learn how to attach performance metrics to your transactions."
+sidebar_order: 20
+---
+
+Sentry's SDKs support sending performance metrics data to Sentry. These are numeric values attached to transactions that are aggregated and displayed in Sentry.
+
+## Custom Metrics
+
+In addition to automatic performance metrics, the SDK supports setting [custom performance metrics](/product/performance/metrics/#custom-performance-metrics) on transactions. This allows you to define metrics that are important to your application and send them to Sentry.
+
+To set a performance metric, you need to supply the following:
+
+- name (`string`)
+- value (any numeric type - `float`, `integer`, etc.)
+- unit (`string`, Defaults to the string `none` if omitted.)
+
+Sentry supports adding arbitrary custom units, but we recommend using one of the [supported units listed below](./#supported-performance-metric-units).
+
+<PlatformContent includePath="performance/custom-performance-metrics" />
+
+<Note>
+
+Currently, unit conversion is only supported once the data has already been stored. This means that, for example, `('myMetric', 60, 'second')` and `('myMetric', 3, 'minute')` would not be aggregated, but rather stored as two separate metrics. To avoid this, make sure to use a consistent unit when recording a custom metric.
+
+</Note>
+
+## Supported Performance Metric Units
+
+Units augment metric values by giving meaning to what otherwise might be abstract numbers. Adding units also allows Sentry to offer controls - unit conversions, filters, and so on - based on those units. For values that are unitless, you can supply an empty string or `none`.
+
+### Duration Units
+
+- `nanosecond`
+- `microsecond`
+- `millisecond`
+- `second`
+- `minute`
+- `hour`
+- `day`
+- `week`
+
+### Information Units
+
+- `bit`
+- `byte`
+- `kilobyte`
+- `kibibyte`
+- `megabyte`
+- `mebibyte`
+- `gigabyte`
+- `gibibyte`
+- `terabyte`
+- `tebibyte`
+- `petabyte`
+- `pebibyte`
+- `exabyte`
+- `exbibyte`
+
+### Fraction Units
+
+- `ratio`
+- `percent`
+
+If you want to explore further, you can find details about supported units in our [event ingestion documentation](https://getsentry.github.io/relay/relay_metrics/enum.MetricUnit.html).

platform-includes/performance/add-spans-example/powershell.mdx

@@ -0,0 +1,22 @@
+You can add individual spans to a transaction by calling the `StartChild` method on a transaction. 
+This method returns a new `SentrySpan` object that you can use to record the duration of the operation that the span represents. 
+When you're done with the operation, you can call the `Finish` method on the span to mark it as finished.
+
+```powershell
+# Transaction can be started by providing, at minimum, the name and the operation
+$transaction = Start-SentryTransaction 'test-transaction-name' 'test-transaction-operation'
+
+# Transactions can have child spans (and those spans can have child spans as well)
+$span = $transaction.StartChild("test-child-operation")
+# ...
+# (Perform the operation represented by the span/transaction)
+# ...
+$span.Finish() # Mark the span as finished
+
+$span = $transaction.StartChild("another-span")
+# ...
+$span.Finish()
+
+
+$transaction.Finish() # Mark the transaction as finished and send it to Sentry
+```

platform-includes/performance/configure-sample-rate/powershell.mdx

@@ -0,0 +1,6 @@
+```powershell
+Start-Sentry {
+    # Example uniform sample rate: capture 100% of transactions
+    $_.TracesSampleRate = 1.0
+}
+```

platform-includes/performance/custom-performance-metrics/powershell.mdx

@@ -0,0 +1,13 @@
+The following example shows how to set custom metrics on a `transaction`, including how obtain the current `span` and get its `transaction`.
+If you already have the `transaction` or `span`, you can use it directly.
+
+```powershell
+# Record amount of memory used
+[Sentry.SpanDataExtensions]::SetMeasurement($transaction, 'memory_used', 64, [Sentry.MeasurementUnit+Information]::Megabyte)
+
+# Record time it took to load user profile
+[Sentry.SpanDataExtensions]::SetMeasurement($transaction, 'user_profile_loading_time', 1.3, [Sentry.MeasurementUnit+Duration]::Second)
+
+# Record number of times the screen was loaded
+[Sentry.SpanDataExtensions]::SetMeasurement($transaction, 'screen_load_count', 4)
+```

platform-includes/performance/enable-manual-instrumentation/powershell.mdx

@@ -0,0 +1,12 @@
+To instrument certain regions of your code, you can create transactions to capture them.
+
+```powershell
+# Transaction can be started by providing, at minimum, the name and the operation
+$transaction = Start-SentryTransaction 'test-transaction-name' 'test-transaction-operation'
+
+# ...
+# (Perform the operation represented by the span/transaction)
+# ...
+
+$transaction.Finish() # Mark the transaction as finished and send it to Sentry
+```

platform-includes/performance/retrieve-transaction/powershell.mdx

@@ -0,0 +1,16 @@
+## Retrieve a Transaction
+
+In cases where you want to attach Spans to an already ongoing Transaction you can use `SentrySdk.GetSpan()`. If there is a running Transaction or Span currently on the scope, this method will return a `SentryTransaction` or `SentrySpan`; otherwise, it returns `$null`.
+
+```powershell
+$span = [Sentry.SentrySdk]::GetSpan()
+
+if ($null -eq $span)
+{
+    $span = Start-SentryTransaction 'task' 'op'
+}
+else
+{
+    $span = $span.StartChild('subtask')
+}
+```