feat: add docs about new regex on main thread performance issue (#7303)

Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>

Author: 3 people

src/docs/product/issues/issue-details/performance-issues/index.mdx

@@ -103,6 +103,9 @@ The following is a list of available performance issues:
             Image Decoding on Main Thread
           </a>
         </li>
+        <li>
+          <a href="./regex-main-thread/">Regex on Main Thread</a>
+        </li>
         <li>
           <a href="./n-one-api-calls/">N+1 API Calls</a>
         </li>

src/docs/product/issues/issue-details/performance-issues/regex-main-thread/index.mdx

@@ -0,0 +1,64 @@
+---
+title: "Regex on Main Thread"
+sidebar_order: 30
+redirect_from:
+  - /product/issues/performance-issues/regex-decoding-main-thread/
+description: "Learn more about Regex on Main Thread issues and how to diagnose and fix them."
+---
+
+The main (or UI) thread in a mobile app is responsible for handling all user interaction and needs to be able to respond to gestures and taps in real time. If a long-running operation blocks the main thread, the app becomes unresponsive, impacting the quality of the user experience.
+
+Evaluating matches between strings and regular expressions (regex) can be long-running operations that may impact app responsiveness. If a long-running regex operation is detected on the main thread that can be offloaded to the background, Sentry will flag it as an issue.
+
+## Detection Criteria
+
+[Profiling](/product/profiling/) needs to be enabled for Sentry to detect Regex on Main Thread issues. Sentry looks for functions related to regular expressions that have been running on the main thread for at least 40ms. This threshold was chosen so that the function appears in a sufficient number of samples collected by the profile (~10ms per sample x 4 = ~40ms total) before it gets detected as an issue.
+
+## Function Evidence
+
+To find additional information about your Regex on Main Thread problem, go to its **Issue Details** page and scroll down to the "Function Evidence" section, which shows the following:
+
+- **Transaction Name:** The name of the transaction where the issue was detected.
+- **Suspect function:** The function that triggered the issue detection (in this case, a regular expression function).
+- **Duration:** How long the function took to execute and the number of consecutive samples collected by the profiler that contained the function
+
+![Regex on Main Thread Function Evidence](regex-function-evidence.png)
+
+To view the entire profile associated with the issue, click the “View Profile” button.
+
+The profile will indicate where the suspect function was called from, along with other functions being called _by_ the suspect function:
+
+![Regex on Main Thread Profile](regex-profile.png)
+
+## Stack Trace
+
+The “Stack Trace” section shows a full stack trace for where the detected regex function was called from:
+
+![Regex on Main Thread Stack Trace](regex-stack-trace.png)
+
+## Example
+
+### iOS
+
+The following code searches for matches against a regular expression in a large string:
+
+```swift
+let url = Bundle.main.url(forResource: "mobydick", withExtension: "txt")!
+let text = try! String(contentsOf: url)
+let regex = try! NSRegularExpression(pattern: #"([tT]he)?.*([wW]hale)"#, options: [.dotMatchesLineSeparators])
+let results = regex.matches(in: text, range: NSMakeRange(0, text.count))
+```
+
+Performance could be improved by moving the calls both to create and use the regex to a lower priority queue (as well as the calls to load the text field being searched, in this example):
+
+```swift
+DispatchQueue.global(qos: .userInitiated).async {
+    let url = Bundle.main.url(forResource: "mobydick", withExtension: "txt")!
+    let text = try! String(contentsOf: url)
+	let regex = try! NSRegularExpression(pattern: #"([tT]he)?.*([wW]hale)"#, options: [.dotMatchesLineSeparators])
+	let results = regex.matches(in: text, range: NSMakeRange(0, text.count))
+	DispatchQueue.main.async {
+		// display results...
+	}
+}
+```