data class FusClientConfig(val productName: String, val productCode: String, val recorderCode: String, val recorderVersion: String, val regionCode: RegionCode = RegionCode.ALL, val productVersion: String, val baselineVersion: Int, val anonymizationSalt: String? = null, val isTest: Boolean, val reduceInitialMetadataUpdateDelay: Boolean, val enableAsyncEventLogging: Boolean = true, val isRecordEnabled: () -> Boolean = { true }, val isSendEnabled: () -> Boolean = { true }, val isLoggingEnabled: () -> Boolean = { true })

FusComponent

interface FusComponent

Interface providing lifecycle hooks to FUS components.

FusEvent

data class FusEvent(val event: Any, val rawEventId: String?, val rawEventData: Map<String, Any>?)

FusHttpClient

interface FusHttpClient : FusComponent

Minimal HTTP client abstraction used by the FUS client to talk to backend services. Implementations should be synchronous.

FusHttpClientProvider

fun interface FusHttpClientProvider

FusJsonSerializer

interface FusJsonSerializer : FusComponent

JSON serialization abstraction used by the FUS client. Implementations can delegate to different JSON libraries.

FusJsonSerializerProvider

fun interface FusJsonSerializerProvider

FusLoggerFactory

fun interface FusLoggerFactory : FusComponent

Factory for creating simple logger instances used by the FUS client. Implementations can bridge to platform-specific logging (e.g., java.util.logging).

FusLoggerFactoryProvider

fun interface FusLoggerFactoryProvider

FusReportDispatcher

interface FusReportDispatcher<E, R> : FusComponent

Dispatches validated reports to the backend. Implementations typically serialize the report to JSON and send it over HTTP.

FusReportDispatcherProvider

fun interface FusReportDispatcherProvider<E, R>

HttpResponse

data class HttpResponse(val statusCode: Int, val body: String?)

Simple HTTP response wrapper.

LoadError

data class LoadError(val errorType: LoadErrorType, val statusCode: Int)

LoadErrorType

enum LoadErrorType : Enum<LoadErrorType>

Possible stages at which a metadata load/update error can occur

Logger

interface Logger

Minimal logging abstraction used within the FUS client. Log levels are intentionally limited to keep the API portable across platforms.

MessageBus

class MessageBus(scope: CoroutineScope)

Lightweight pub/sub message bus for intra-component communication.

MessageHandler

class MessageHandler<T : Any>(messageBus: MessageBus, scope: CoroutineScope, topic: Topic<T>, handleError: suspend (Throwable) -> Unit = {}, handleMessage: suspend (message: T) -> Unit) : FusComponent

A handler for subscribing to a specific message topic on a MessageBus. It listens for messages published to the specified Topic and processes them using the provided handler function on a new coroutine in the provided CoroutineScope.

MessageHandlerProvider

fun interface MessageHandlerProvider<T : Any>

MetadataStorage

interface MetadataStorage<T : Comparable<T>?> : FusComponent

Provides access to validation rules and anonymization metadata required for processing FUS reports. Implementations may fetch and cache metadata from remote sources and/or bundled resources.

MetadataStorageProvider

fun interface MetadataStorageProvider

RegionCode

enum RegionCode : Enum<RegionCode>

RemoteConfig

interface RemoteConfig : FusComponent

Resolves remote endpoints and client options used by the FUS client. Implementations can consult product configuration, environment, and server responses.

RemoteConfigProvider

fun interface RemoteConfigProvider

ReportAnonymizer

interface ReportAnonymizer<E> : FusComponent

Performs anonymization of sensitive fields in a report according to metadata rules.

ReportAnonymizerProvider

fun interface ReportAnonymizerProvider<E, R>

ReportValidator

interface ReportValidator<E> : FusComponent

Validates a report against metadata rules (group rules, event id rules, fields, etc.).

ReportValidatorProvider

fun interface ReportValidatorProvider<E, R>

Topic

data class Topic<T : Any>(val name: String, val clazz: KClass<T>)

Holds the topic key and data type information of messages.

Properties

DICTIONARY_LIST_LOAD_FAILED_TOPIC

val DICTIONARY_LIST_LOAD_FAILED_TOPIC: Topic<LoadError>

Failed to load the JSON file listing validation dictionaries.

DICTIONARY_LIST_UPDATE_FAILED_TOPIC

val DICTIONARY_LIST_UPDATE_FAILED_TOPIC: Topic<LoadError>

Failed to update the JSON file listing validation dictionaries.

DICTIONARY_LOAD_FAILED_TOPIC

val DICTIONARY_LOAD_FAILED_TOPIC: Topic<LoadError>

A validation dictionary failed to load.

DICTIONARY_LOADED_TOPIC

val DICTIONARY_LOADED_TOPIC: Topic<DictionaryUpdate>

A validation dictionary was loaded.

DICTIONARY_UPDATE_FAILED_TOPIC

val DICTIONARY_UPDATE_FAILED_TOPIC: Topic<LoadError>

A validation dictionary was update failed.

DICTIONARY_UPDATED_TOPIC

val DICTIONARY_UPDATED_TOPIC: Topic<DictionaryUpdate>

A validation dictionary was updated.

METADATA_LOAD_FAILED_TOPIC

val METADATA_LOAD_FAILED_TOPIC: Topic<LoadError>

METADATA_LOADED_TOPIC

val METADATA_LOADED_TOPIC: Topic<String>

Topic type String represents the version of the metadata that was loaded.

METADATA_UPDATE_FAILED_TOPIC

val METADATA_UPDATE_FAILED_TOPIC: Topic<LoadError>

METADATA_UPDATED_TOPIC

val METADATA_UPDATED_TOPIC: Topic<String>

Topic type String represents the version of the updated metadata.

RAW_EVENT_TOPIC

val RAW_EVENT_TOPIC: Topic<FusEvent>

An event was validated and queued for sending. Contains both the processed event and the original (raw) event data.

REMOTE_CONFIG_OPTIONS_UPDATE_FAILED

val REMOTE_CONFIG_OPTIONS_UPDATE_FAILED: Topic<Pair<String, Long>>

Topic for notifying subscribers about configuration option update failures.

REMOTE_CONFIG_OPTIONS_UPDATED

val REMOTE_CONFIG_OPTIONS_UPDATED: Topic<Map<String, String>>

Remote config options have been updated. The updates may contain no changes.

Functions

bundledFileStorage

fun FusClientComponents.Builder<*, *>.bundledFileStorage(provider: FileStorageProvider)

Use bundledFileStorage in case your product comes with pre-bundled metadata if clients are not connected to the internet on the first startup of the product.

closeAsync

fun FusClient<*, *>.closeAsync(): Promise<JsAny?>

components

fun <E, R> FusClient.Builder<E, R>.components(init: FusClientComponents.Builder<E, R>.() -> Unit)

Configures the FusClient components. Include defaultBusinessLogic from com.jetbrains.fus.reporting.defaults and the DFL functions displayed below.

config

fun FusClient.Builder<*, *>.config(init: FusClientConfig.Builder.() -> Unit)

Jump to the source of FusClientConfig.Builder for the configuration options.

eventLogFileStorage

fun FusClientComponents.Builder<*, *>.eventLogFileStorage(provider: FileStorageProvider)

Use eventLogFileStorage to specify a separate file storage for event log data used by the report dispatcher. If not set, the regular fileStorage will be used instead.

fileStorage

fun FusClientComponents.Builder<*, *>.fileStorage(provider: FileStorageProvider)

Provide file storage for caching metadata, dictionaries, and event logs.

fusClient

fun <E, R> fusClient(init: FusClient.Builder<E, R>.() -> Unit): FusClient<E, R>

Build and configure a client that collects, enriches, and sends events. Required:

httpClient

fun FusClientComponents.Builder<*, *>.httpClient(provider: FusHttpClientProvider)

Provide an HTTP client for communicating with FUS backend services.

jsonSerializer

fun FusClientComponents.Builder<*, *>.jsonSerializer(provider: FusJsonSerializerProvider)

Provide JSON (de)serialization for events, metadata, and configuration.

loggerFactory

fun FusClientComponents.Builder<*, *>.loggerFactory(provider: FusLoggerFactoryProvider)

Provide logging for all internal FUS operations by bridging to your application's logging framework.

loggingEnabled

fun FusClientConfig.Builder.loggingEnabled(loggingEnabled: () -> Boolean)

messageHandler

fun <T : Any> FusClient.Builder<*, *>.messageHandler(topic: Topic<T>, errorHandler: (Throwable) -> Unit = {}, handle: suspend (message: T) -> Unit)

Registers a callback that runs asynchronously when the step identified by topic occurs inside the FusClient. Message handlers can run concurrently, so shared resources must be thread-safe.

metadataStorage

fun FusClientComponents.Builder<*, *>.metadataStorage(provider: MetadataStorageProvider)

recordEnabled

fun FusClientConfig.Builder.recordEnabled(recordEnabled: () -> Boolean)

remoteConfig

fun FusClientComponents.Builder<*, *>.remoteConfig(provider: RemoteConfigProvider)

reportAnonymizer

fun <E, R> FusClientComponents.Builder<E, R>.reportAnonymizer(provider: ReportAnonymizerProvider<E, R>)

reportDispatcher

fun <E, R> FusClientComponents.Builder<E, R>.reportDispatcher(provider: FusReportDispatcherProvider<E, R>)

reportValidator

fun <E, R> FusClientComponents.Builder<E, R>.reportValidator(provider: ReportValidatorProvider<E, R>)

runBlockingPlatform

expect fun <T> runBlockingPlatform(block: suspend CoroutineScope.() -> T): T

actual fun <T> runBlockingPlatform(block: suspend CoroutineScope.() -> T): T

sendEnabled

fun FusClientConfig.Builder.sendEnabled(sendEnabled: () -> Boolean)

topic

inline fun <T : Any> topic(name: String): Topic<T>