sentry-godot/doc_classes/SentryExperimental.xml at 88db15de0ba48ac7d37ec7019696b9c4b8a0e1ac · getsentry/sentry-godot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SentryExperimental" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
	<brief_description>
		Experimental options for Sentry SDK.
	</brief_description>
	<description>
		Contains configuration options for experimental features of the [SentrySDK]. These features may be unstable or subject to change in future versions.
		Access this configuration through [member SentryOptions.experimental].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="before_send_log" type="Callable" setter="set_before_send_log" getter="get_before_send_log" default="Callable()" deprecated="Logs are now generally available. Use [member SentryOptions.before_send_log] instead.">
			If assigned, this callback will be called before sending a log message to Sentry. It can be used to modify the log message or prevent it from being sent.
			[codeblock]
			func _before_send_log(log_entry: SentryLog) -&gt; SentryLog:
				# Filter junk.
				if log_entry.body == "Junk message":
					return null
				# Remove sensitive information from log messages.
				log_entry.body = log_entry.body.replace("Bruno", "REDACTED")
				# Add custom attributes.
				log_entry.set_attribute("current_scene", current_scene.name)
				return log_entry
			[/codeblock]
		</member>
		<member name="before_send_metric" type="Callable" setter="set_before_send_metric" getter="get_before_send_metric" default="Callable()" deprecated="Metrics are now generally available. Use [member SentryOptions.before_send_metric] instead.">
			If assigned, this callback will be called before sending a metric to Sentry. It can be used to modify the metric or prevent it from being sent.
			[codeblock]
			func _before_send_metric(metric: SentryMetric) -&gt; SentryMetric:
				# Drop debug-only metrics in release builds.
				if not OS.is_debug_build() and metric.name.begins_with("debug."):
					return null
				# Enrich with runtime context.
				metric.set_attribute("current_scene", get_tree().current_scene.name)
				return metric
			[/codeblock]
		</member>
		<member name="enable_logs" type="bool" setter="set_enable_logs" getter="get_enable_logs" default="false" deprecated="Logs are now generally available. Use [member SentryOptions.enable_logs] instead.">
			Enables Sentry structured logging functionality. When enabled, Godot's log messages are automatically captured and sent to Sentry, and you gain access to the dedicated logging APIs available through [member SentrySDK.logger].
		</member>
		<member name="enable_metrics" type="bool" setter="set_enable_metrics" getter="get_enable_metrics" default="true" deprecated="Metrics are now generally available. Use [member SentryOptions.enable_metrics] instead.">
			Enables Sentry metrics functionality. When enabled, you can emit custom metrics using the [SentryMetrics] API available through [member SentrySDK.metrics].
		</member>
	</members>
</class>