Package-level declarations

Types

Link copied to clipboard
class AnonymizedEventField(val name: String, val description: String?) : StringEventField
Link copied to clipboard
sealed class BaseEventId

Represents a base class for event identifiers used in the event logging framework.

Link copied to clipboard
Link copied to clipboard
data class BooleanEventField(val name: String, val description: String?) : PrimitiveEventField<Boolean>
Link copied to clipboard
data class DoubleEventField(val name: String, val description: String?) : PrimitiveEventField<Double>
Link copied to clipboard
data class EnumEntryEventField<T : Enum<T>>(val name: String, val description: String?, enumEntries: EnumEntries<T>, transform: (T) -> String) : PrimitiveEventField<T>

On JVM targets com.jetbrains.fus.reporting.schema.EnumEventField can be used alternatively

Link copied to clipboard
data class EnumEventField<T : Enum<*>>(val name: String, val description: String?, enumClass: Class<T>, transform: (T) -> String) : PrimitiveEventField<T>
Link copied to clipboard
sealed class EventField<T>
Link copied to clipboard
class EventFieldDelegate<T>(val eventField: EventField<T>)
EventFields
Link copied to clipboard
object EventFields : IEventFields
object EventFields : IEventFields
Link copied to clipboard
class EventId(group: EventLogGroup, eventId: String, description: String) : BaseEventId

An event without any fields.

Link copied to clipboard
class EventId1<T>(group: EventLogGroup, eventId: String, field: EventField<T>, description: String) : BaseEventId

An event with one field.

Link copied to clipboard
class EventId2<T1, T2>(group: EventLogGroup, eventId: String, field1: EventField<T1>, field2: EventField<T2>, description: String) : BaseEventId

An event with two fields.

Link copied to clipboard
class EventId3<T1, T2, T3>(group: EventLogGroup, eventId: String, field1: EventField<T1>, field2: EventField<T2>, field3: EventField<T3>, description: String) : BaseEventId

An event with three fields.

Link copied to clipboard
class EventLogGroup(val id: String, val version: Int, val type: EventLogGroup.Type, description: String, val plugin: PluginSchemeDescriptor? = null)

Represents a group of events used for feature usage statistics.

Link copied to clipboard
data class EventPair<T>(val field: EventField<T>, val data: T)
Link copied to clipboard
Link copied to clipboard
abstract class FieldListDescription
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class FloatEventField(val name: String, val description: String?) : PrimitiveEventField<Float>
Link copied to clipboard
interface IEventFields
Link copied to clipboard
data class IntEventField(val name: String, val description: String?) : PrimitiveEventField<Int>
Link copied to clipboard
abstract class ListEventField<T> : EventField<List<T>>
Link copied to clipboard
data class LongEventField(val name: String, val description: String?) : PrimitiveEventField<Long>
Link copied to clipboard
data class LongListEventField(val name: String, val description: String?) : ListEventField<Long>
Link copied to clipboard
class ObjectEventField<D : FieldListDescription>(name: String, description: String?, creator: () -> D) : BaseObjectEventField
Link copied to clipboard
class ObjectEventField1<T>(name: String, description: String?, field: EventField<T>) : BaseObjectEventField
Link copied to clipboard
class ObjectEventField2<T1, T2>(name: String, description: String?, field1: EventField<T1>, field2: EventField<T2>) : BaseObjectEventField
Link copied to clipboard
class ObjectEventField3<T1, T2, T3>(name: String, description: String?, field1: EventField<T1>, field2: EventField<T2>, field3: EventField<T3>) : BaseObjectEventField
Link copied to clipboard
class ObjectListEventField<D : FieldListDescription>(name: String, description: String?, creator: () -> D) : BaseObjectListEventField
Link copied to clipboard
class ObjectListEventField1<T>(name: String, description: String?, field: EventField<T>) : BaseObjectListEventField
Link copied to clipboard
class ObjectListEventField2<T1, T2>(name: String, description: String?, field1: EventField<T1>, field2: EventField<T2>) : BaseObjectListEventField
Link copied to clipboard
class ObjectListEventField3<T1, T2, T3>(name: String, description: String?, field1: EventField<T1>, field2: EventField<T2>, field3: EventField<T3>) : BaseObjectListEventField
Link copied to clipboard
abstract class PrimitiveEventField<T> : EventField<T>
Link copied to clipboard
class RecorderDefinition(val fusRecorder: FusRecorder)

Recorders can have their own schema (ids, cliend_data & system_data), which describes fields that are sent with every event.

Link copied to clipboard
data class RecorderField<T>(val field: EventField<T>, val required: Boolean, val provider: () -> T??)

A wrapper around the EventField with an additional required flag and an optional value provider.

Link copied to clipboard

RegisteredLogDescriptionsProcessor is responsible for managing storing descriptions of event log groups and their events. Provides functionality to store, retrieve descriptions for groups and their events.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class VarargEventId<D : FieldListDescription>(group: EventLogGroup, eventId: String, creator: () -> D, description: String) : BaseEventId

An event with an arbitrary number of fields.