Skip to content

Commit d05ec00

Browse files
stephanie-andersonstephanie-anderson
authored
Remove PlatformSection component from Unreal Engine docs (#8729)
1 parent baff6b1 commit d05ec00

File tree

32 files changed

+284
-1785
lines changed

32 files changed

+284
-1785
lines changed

‎src/platforms/unreal/configuration/environments.mdx

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
11
---
22
title: Environments
3-
sidebar_order: 30
43
description: "Learn how to configure your SDK to tell Sentry about your environments."
4+
sidebar_order: 30
55
---
66

77
Environments tell you where an error occurred, whether that's in your production system, your staging server, or elsewhere.
88

99
Sentry automatically creates an environment when it receives an event with the `environment` parameter set.
1010

11-
Environments are case sensitive. The environment name can't contain newlines, spaces or forward slashes, can't be the string "None", or exceed 64 characters. You can't delete environments, but you can [hide](/product/sentry-basics/environments/#hidden-environments) them.
11+
Environments are case-sensitive. The environment name can't contain newlines, spaces or forward slashes, can't be the string "None", or exceed 64 characters. You can't delete environments, but you can [hide](/product/sentry-basics/environments/#hidden-environments) them.
12+
13+
```cpp
14+
FConfigureSettingsDelegate SettingsDelegate;
15+
SettingsDelegate.BindDynamic(this, &USomeClass::HandleSettingsDelegate);
16+
17+
void USomeClass::HandleSettingsDelegate(USentrySettings* Settings)
18+
{
19+
Settings->Environment = FString(TEXT("MyEnvironment"));
20+
}
21+
22+
...
23+
24+
USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem>();
25+
26+
SentrySubsystem->InitializeWithSettings(SettingsDelegate);
27+
```
1228
13-
<PlatformContent includePath="set-environment" />
29+
By default, the SDK reports `Editor` when running inside the Unreal Engine Editor. You can also set the default environment to `Release`, `Development`, or `Debug` in your build configuration or override the environment value manually.
1430
1531
Environments help you better filter issues, releases, and user feedback in the Issue Details page of sentry.io, which you learn more about in our [documentation that covers using environments](/product/sentry-basics/environments/).

‎src/platforms/unreal/configuration/filtering.mdx

Lines changed: 1 addition & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Filtering
3-
sidebar_order: 60
43
description: "Learn more about how to configure your SDK to filter events reported to Sentry."
4+
sidebar_order: 60
55
---
66

77
When you add Sentry to your app, you get a lot of valuable information about errors and performance. And lots of information is good -- as long as it's the right information, at a reasonable volume.
@@ -21,128 +21,3 @@ All Sentry SDKs support the <PlatformIdentifier name="before-send" /> callback m
2121
<PlatformContent includePath="configuration/before-send" />
2222

2323
Note also that breadcrumbs can be filtered, as discussed in [our Breadcrumbs documentation](/product/error-monitoring/breadcrumbs/).
24-
25-
<PlatformSection notSupported={["apple", "dotnet", "elixir", "rust", "unreal", "kotlin-multiplatform"]}>
26-
27-
#### Event Hints
28-
29-
The <PlatformIdentifier name="before-send" /> callback is passed both the `event` and a second argument, `hint`, that holds one or more hints.
30-
31-
Typically a `hint` holds the original exception so that additional data can be extracted or grouping is affected. In this example, the fingerprint is forced to a common value if an exception of a certain type has been caught:
32-
33-
<PlatformContent includePath="configuration/before-send-hint" />
34-
35-
When the SDK creates an event or breadcrumb for transmission, that transmission is typically created from some sort of source object. For instance, an error event is typically created from a log record or exception instance. For better customization, SDKs send these objects to certain callbacks (<PlatformIdentifier name="before-send" />, <PlatformIdentifier name="before-breadcrumb" /> or the event processor system in the SDK).
36-
37-
</PlatformSection>
38-
39-
<PlatformSection notSupported={["native", "apple", "dotnet", "unreal", "elixir", "kotlin-multiplatform"]}>
40-
41-
### Using Hints
42-
43-
Hints are available in two places:
44-
45-
1. <PlatformIdentifier name="before-send" /> / <PlatformIdentifier name="before-breadcrumb" />
46-
2. `eventProcessors`
47-
48-
Event and breadcrumb `hints` are objects containing various information used to put together an event or a breadcrumb. Typically `hints` hold the original exception so that additional data can be extracted or grouping can be affected.
49-
50-
For events, hints contain properties such as `event_id`, `originalException`, `syntheticException` (used internally to generate cleaner stack trace), and any other arbitrary `data` that you attach.
51-
52-
For breadcrumbs, the use of `hints` is implementation dependent. For XHR requests, the hint contains the xhr object itself; for user interactions the hint contains the DOM element and event name and so forth.
53-
54-
<PlatformContent includePath="configuration/before-send-fingerprint">
55-
56-
In this example, the fingerprint is forced to a common value if an exception of a certain type has been caught:
57-
58-
</PlatformContent>
59-
60-
#### Hints for Events
61-
62-
`originalException`
63-
64-
: The original exception that caused the Sentry SDK to create the event. This is useful for changing how the Sentry SDK groups events or to extract additional information.
65-
66-
`syntheticException`
67-
68-
: When a string or a non-error object is raised, Sentry creates a synthetic exception so you can get a basic stack trace. This exception is stored here for further data extraction.
69-
70-
#### Hints for Breadcrumbs
71-
72-
<PlatformContent includePath="configuration/breadcrumb-hints" />
73-
74-
</PlatformSection>
75-
76-
<PlatformSection supported={["javascript", "node", "go"]} >
77-
78-
### Using <PlatformIdentifier name="ignore-errors" />
79-
80-
You can use the <PlatformIdentifier name="ignore-errors" /> option to filter out errors that match a certain pattern. This option receives a list of strings and regular expressions to match against the error message. When using strings, partial matches will be filtered out, so if you need to filter by exact match, use regex patterns instead.
81-
82-
<PlatformContent includePath="configuration/ignore-errors" />
83-
</PlatformSection>
84-
85-
<PlatformSection supported={["php"]} >
86-
87-
### Using <PlatformIdentifier name="ignore-exceptions" />
88-
89-
You can use the <PlatformIdentifier name="ignore-exceptions" /> option to filter out errors that match a type or subtype.
90-
91-
<PlatformContent includePath="configuration/ignore-exceptions" />
92-
</PlatformSection>
93-
94-
<PlatformSection supported={["android", "javascript", "java", "python"]} notSupported={["kotlin-multiplatform"]}>
95-
96-
### Decluttering Sentry
97-
98-
<PlatformContent includePath="configuration/decluttering" />
99-
100-
</PlatformSection>
101-
102-
<PlatformSection supported={["node", "javascript", "python", "php", "dotnet", "java", "ruby", "go", "react-native", "android", "dart"]} notSupported={["javascript.cordova", "unreal", "kotlin-multiplatform"]}>
103-
104-
## Filtering Transaction Events
105-
106-
To prevent certain transactions from being reported to Sentry, use the <PlatformIdentifier name="traces-sampler" /> or <PlatformIdentifier name="before-send-transaction" /> configuration option, which allows you to provide a function to evaluate the current transaction and drop it if it's not one you want.
107-
108-
### Using <PlatformIdentifier name="traces-sampler" />
109-
110-
**Note:** The <PlatformIdentifier name="traces-sampler" /> and <PlatformIdentifier name="traces-sample-rate" /> config options are mutually exclusive. If you define a <PlatformIdentifier name="traces-sampler" /> to filter out certain transactions, you must also handle the case of non-filtered transactions by returning the rate at which you'd like them sampled.
111-
112-
In its simplest form, used just for filtering the transaction, it looks like this:
113-
114-
<PlatformContent includePath="performance/traces-sampler-as-filter" />
115-
116-
It also allows you to sample different transactions at different rates.
117-
118-
If the transaction currently being processed has a parent transaction (from an upstream service calling this service), the parent (upstream) sampling decision will always be included in the sampling context data, so that your <PlatformIdentifier name="traces-sampler" /> can choose whether and when to inherit that decision. In most cases, inheritance is the right choice, to avoid breaking distributed traces. A broken trace will not include all your services. See <PlatformLink to="/configuration/sampling/#inheritance">Inheriting the parent sampling decision</PlatformLink> to learn more.
119-
120-
Learn more about <PlatformLink to="/configuration/sampling/">configuring the sample rate</PlatformLink>.
121-
122-
<PlatformSection supported={["node", "javascript", "php", "go", "python", "java", "ruby"]}>
123-
124-
### Using <PlatformIdentifier name="before-send-transaction" />
125-
126-
<PlatformContent includePath="configuration/before-send-transaction" />
127-
128-
</PlatformSection>
129-
130-
<PlatformSection supported={["javascript", "node", "go"]} >
131-
132-
### Using <PlatformIdentifier name="ignore-transactions" />
133-
134-
You can use the <PlatformIdentifier name="ignore-transactions" /> option to filter out transactions that match a certain pattern. This option receives a list of strings and regular expressions to match against the transaction name. When using strings, partial matches will be filtered out, so if you need to filter by exact match, use regex patterns instead.
135-
136-
<PlatformContent includePath="configuration/ignore-transactions" />
137-
</PlatformSection>
138-
139-
<PlatformSection supported={["php"]} >
140-
141-
### Using <PlatformIdentifier name="ignore-transactions" />
142-
143-
You can use the <PlatformIdentifier name="ignore-transactions" /> option to filter out transactions that match a certain string.
144-
145-
<PlatformContent includePath="configuration/ignore-transactions" />
146-
</PlatformSection>
147-
148-
</PlatformSection>

0 commit comments

Comments
 (0)