com.medallia.mxo.logging
All of APIs listed on this page are in the com.medallia.mxo.logging
package.
MXOLogComponent
A list of components to filter the messages the MXO SDK will log.
public enum class MXOLogComponent {
ANY,
INTERACTION,
INTERACTION_MAP,
ADMIN_UI,
OPT_OUT,
TOUCHPOINT,
CONFIGURATION,
OPTIMIZATIONS,
AUTHENTICATION,
AUTOMATIC,
IDENTITY,
NETWORKING,
DATABASE,
STATE,
FILELOGGING,
APP_INSTALL,
NONE,
}
Enum | Description |
---|---|
ANY | The combination of all components listed below other than NONE. |
INTERACTION | Interaction tracking log messages. |
INTERACTION_MAP | Interaction map log messages. |
ADMIN_UI | Admin User Interface log messages. |
TOUCHPOINT | Touchpoint log messages. |
CONFIGURATION | Configuration log messages. |
OPTIMIZATIONS | Optimization log messages. |
AUTHENTICATION | Authentication log messages. |
AUTOMATIC | Automatic Interactions log messages. |
IDENTITY | Identity Transfer log messages. |
NETWORKING | Networking log messages. |
DATABASE | Database log messages. |
STATE | State log messages. |
FILELOGGING | File logging messages. |
APP_INSTALL | App install Interaction log messages. |
NONE | Neither of the components listed above is logged. Used to opt out of logging. |
MXOLoggingConfiguration
The logging configuration object for the MXO SDK.
public class MXOLoggingConfiguration private constructor(
public val levels: Set<MXOLogLevel> = EnumSet.of(WARN, ERROR),
public val components: Set<MXOLogComponent> = EnumSet.of(ANY),
public val logWriters: Set<MXOLogWriter> = setOf(),
)
Property | Type | Description |
---|---|---|
levels | Set<MXOLogLevel> | A set of MXO log levels. |
components | Set<MXOLogComponent> | A set of MXO log components. |
logWriters | Set<MXOLogWriter> | A set of custom MXO loggers. |
Create an instance using the Builder as shown below:
@JvmSynthetic
public fun mxoLoggingConfiguration(
initializer: MXOLoggingConfiguration.Builder.() -> Unit = { },
): MXOLoggingConfiguration
MXOLogLevel
A list of levels (IE severity) to filter the messages the MXO SDK will log.
public enum class MXOLogLevel {
VERBOSE,
DEBUG,
ERROR,
WARN,
INFO,
ASSERT,
NONE,
}
Enum | Description |
---|---|
VERBOSE | Any amount of detail might be logged. |
DEBUG | Debug details are logged, and all the levels below. |
ERROR | Error details are logged, and all the levels below. |
WARN | Warning details are logged, and all the levels below. |
INFO | Info details are logged, and the level below. |
ASSERT | Assert details only are logged. |
NONE | Neither of the levels listed above is logged. Used to opt out of logging. |
MXOLogWriter
The required base class to write Medallia SDK logs to a custom destination.
public interface MXOLogWriter {
public fun log(
logLevel: MXOLogLevel,
component: MXOLogComponent,
message: String,
throwable: Throwable?,
)
}
Property | Type | Description |
---|---|---|
logLevel | MXOLogLevel | The level of error to log. |
component | MXOLogComponent | The feature component of the MXO SDK to log logs from. |
message | String | The message to log. |
throwable | Throwable? | The potential error that a caller might log a message with. |