Crate rpfm_telemetry

Expand description

Logging, crash reporting and anonymous action telemetry for RPFM.

This crate bundles three related concerns that share the same Sentry lifecycle:

Structured logging: re-exports log’s info!/warn!/error! macros so every crate can emit log lines without pulling Sentry.
Crash reporting: Logger::init installs panic hooks, writes local crash reports and wires up Sentry for release builds.
Action telemetry: a lightweight action counter that aggregates anonymous usage data and ships it to Sentry on graceful shutdown.

Libraries (rpfm_lib, rpfm_extensions, rpfm_ui_common, …) depend only on the plain log crate. The executables (rpfm_ui, rpfm_server) depend on this crate to wire up the full stack.

Re-exports§

pub use sentry;

Modules§

debugid: Represents a debug ID.
map: The internally used arbitrary data map type.
value: An arbitrary (JSON) value.

Macros§

debug: Logs a message at the debug level.
error: Logs a message at the error level.
info: Logs a message at the info level.
release_name: Returns the intended release for Sentry as an Option<Cow<'static, str>>.
trace: Logs a message at the trace level.
warn: Logs a message at the warn level.

Structs§

Addr: Represents an address.
AppContext: Holds app information.
AppleDebugImage: Represents an apple debug image in the debug meta.
Attachment: Represents an attachment item.
Breadcrumb: Represents a single breadcrumb.
BrowserContext: Holds information about the web browser.
CError: POSIX signal with optional extended data.
ClientInitGuard: Helper struct that is returned from init.
ClientOptions: Configuration settings for the client.
ClientSdkInfo: Information on the SDK client.
ClientSdkPackage: Represents an installed package relevant to the SDK.
CrontabParseError: Error type for errors with parsing a crontab schedule
DebugMeta: Represents debug meta information.
DeviceContext: Holds device information.
DynamicSamplingContext: The Dynamic Sampling Context.
Envelope: A Sentry Envelope.
EnvelopeHeaders: The supported Sentry Envelope Headers.
EnvelopeItemIter: An Iterator over the items of an Envelope.
Event: Represents a full event for Sentry.
Exception: Represents a single exception.
Frame: Represents a frame.
GpuContext: GPU context describes the GPU of the device.
Log: A single structured log.
LogAttribute: An attribute that can be attached to a log.
LogEntry: Represents a log entry message.
LogSeverityNumber: A number indicating the severity of a log, according to the OpenTelemetry SeverityNumber spec.
Logger: Crash report data structure.
MachException: Mach exception information.
Map: An ordered map based on a B-Tree.
Mechanism: Represents a single exception.
MechanismMeta: Operating system or runtime meta information to an exception mechanism.
MonitorCheckIn: The monitor check-in payload.
MonitorConfig: The monitor configuration playload for upserting monitors during check-in
OrganizationId: An ID that identifies an organization in the Sentry backend.
OsContext: Holds operating system information.
OtelContext: OpenTelemetry context
ParseLevelError: An error used when parsing Level.
ParseSessionStatusError: An error used when parsing SessionStatus.
ParseStatusError: An error used when parsing SpanStatus.
PosixSignal: POSIX signal with optional extended data.
ProguardDebugImage: Represents a proguard mapping file reference.
RegVal: Represents a register value.
Request: Represents http request data.
ResponseContext: Holds information about an HTTP response.
RuntimeContext: Holds information about the runtime.
SampleRand: A random number generated at the start of a trace by the head of trace SDK.
SentryLayer: Provides a tracing layer that dispatches events to sentry
SentryLogger: Provides a dispatching logger.
SessionAggregateItem: An aggregation grouped by started and distinct_id.
SessionAggregates: An Aggregation of Release Health Sessions
SessionAttributes: Additional attributes for Sessions.
SessionUpdate: A Release Health Session.
Span: Represents a tracing span.
SpanId: Holds the identifier for a Span
Stacktrace: Represents a stacktrace.
SymbolicDebugImage: Represents a symbolic debug image.
SystemSdkInfo: Holds information about the system SDK.
TemplateInfo: Represents template debug info.
Thread: Represents a single thread.
TraceContext: Holds information about a tracing event.
TraceId: Holds the identifier for a Trace
Transaction: Represents a tracing transaction.
Url: A parsed URL record.
User: Represents user info.
Uuid: A Universally Unique Identifier (UUID).
Values: A wrapper type for collections with attached meta data.
WasmDebugImage: Represents a WebAssembly debug image.

Enums§

AttachmentType: The different types an attachment can have.
Context: Typed contextual data.
DebugImage: Represents a debug image.
EnvelopeError: Raised if a envelope cannot be parsed from a given input.
EnvelopeItem: An Envelope Item.
InvalidSampleRandError: An error that indicates failure to construct a SampleRand.
IpAddress: An IP address, either IPv4, IPv6 or Auto.
ItemContainer: A container for a list of multiple items. It’s considered a single envelope item, with its type corresponding to the contained items’ type.
Level: Represents the level of severity of an event or breadcrumb.
LogError: Error type for the logging crate.
LogLevel: Indicates the severity of a log, according to the OpenTelemetry SeverityText spec.
MonitorCheckInStatus: Represents the status of the monitor check-in
MonitorIntervalUnit: The unit for the interval schedule type
MonitorSchedule: Configuration object of the monitor schedule.
Orientation: Optional device screen orientation
SessionMode: The Session Mode of the SDK.
SessionStatus: The Status of a Release Health Session.
SpanStatus: The status of a Span.
ThreadId: Represents a thread id.
Value: Represents any valid JSON value.

Statics§

SENTRY_DSN: Sentry DSN (Data Source Name) for error reporting.

Functions§

end_session: End the current Release Health Session.
end_session_with_status: End the current Release Health Session with the given SessionStatus.
flush: Sends accumulated action telemetry to Sentry and clears the counters.
is_crash_reports_enabled: Returns the current crash-reports enabled state.
is_usage_telemetry_enabled: Returns the current usage-telemetry enabled state.
record_action: Records a single action occurrence without emitting a log line.
send_user_feedback: Captures a single user-feedback message and ships it to Sentry.
set_crash_reports_enabled: Enables or disables automatic Sentry crash-report uploads.
set_usage_telemetry_enabled: Enables or disables usage-telemetry counter updates.
track_action: Records a single action occurrence.

Type Aliases§

Result: Result type for the logging crate.

Crate rpfm_telemetry

Crate rpfm_telemetry Copy item path

Re-exports§

Modules§

Macros§

Structs§

Enums§

Statics§

Functions§

Type Aliases§

Crate rpfm_telemetry