-
public interface LogsApiThe public API that is used to send log messages.
-
-
Method Summary
Modifier and Type Method Description abstract UnitlogMessage(String message, Severity severity)Remotely logs a message at the given severity level. abstract UnitlogMessage(String message, Severity severity, Map<String, Object> properties)Remotely logs a message at the given severity level. abstract UnitlogMessage(String message, Severity severity, Map<String, Object> properties, ByteArray attachment)Remotely logs a message at the given severity level with an attachment. abstract UnitlogMessage(String message, Severity severity, Map<String, Object> properties, String attachmentId, String attachmentUrl)Remotely logs a message at the given severity level with an attachment that has been persisted on a 3rd party hosting solution. abstract UnitlogInfo(String message)Remotely logs a message at INFO level. abstract UnitlogWarning(String message)Remotely logs a message at WARN level. abstract UnitlogError(String message)Remotely logs a message at ERROR level. abstract UnitlogException(Throwable throwable)Remotely logs a Throwable/Exception at ERROR level. abstract UnitlogException(Throwable throwable, Severity severity)Remotely logs a Throwable/Exception at given severity level. abstract UnitlogException(Throwable throwable, Severity severity, Map<String, Object> properties)Remotely logs a Throwable/Exception at given severity level. abstract UnitlogException(Throwable throwable, Severity severity, Map<String, Object> properties, String message)Remotely logs a Throwable/Exception at given severity level. abstract UnitlogCustomStacktrace(Array<StackTraceElement> stacktraceElements)Remotely logs a custom stacktrace at ERROR level. abstract UnitlogCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity)Remotely logs a custom stacktrace at given severity level. abstract UnitlogCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity, Map<String, Object> properties)Remotely logs a custom stacktrace at given severity level. abstract UnitlogCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity, Map<String, Object> properties, String message)Remotely logs a custom stacktrace at given severity level. -
-
Method Detail
-
logMessage
abstract Unit logMessage(String message, Severity severity)
Remotely logs a message at the given severity level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
message- the message to remotely logseverity- the severity level of the log message
-
logMessage
abstract Unit logMessage(String message, Severity severity, Map<String, Object> properties)
Remotely logs a message at the given severity level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
message- the message to remotely logseverity- the severity level of the log messageproperties- the properties to attach to the log message
-
logMessage
abstract Unit logMessage(String message, Severity severity, Map<String, Object> properties, ByteArray attachment)
Remotely logs a message at the given severity level with an attachment. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
message- the message to remotely logseverity- the severity level of the log messageproperties- the properties to attach to the log messageattachment- an attachment to include with the log message.
-
logMessage
abstract Unit logMessage(String message, Severity severity, Map<String, Object> properties, String attachmentId, String attachmentUrl)
Remotely logs a message at the given severity level with an attachment that has been persisted on a 3rd party hosting solution. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
message- the message to remotely logseverity- the severity level of the log messageproperties- the properties to attach to the log messageattachmentId- a UUID that identifies the attachmentattachmentUrl- a URL that gives the location of the attachment
-
logInfo
abstract Unit logInfo(String message)
Remotely logs a message at INFO level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
message- the message to remotely log
-
logWarning
abstract Unit logWarning(String message)
Remotely logs a message at WARN level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
message- the message to remotely log
-
logError
abstract Unit logError(String message)
Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
message- the message to remotely log
-
logException
abstract Unit logException(Throwable throwable)
Remotely logs a Throwable/Exception at ERROR level. These log messages and stacktraces will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
throwable- the throwable to remotely log
-
logException
abstract Unit logException(Throwable throwable, Severity severity)
Remotely logs a Throwable/Exception at given severity level. These log messages and stacktraces will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
throwable- the throwable to remotely logseverity- the severity level of the log message
-
logException
abstract Unit logException(Throwable throwable, Severity severity, Map<String, Object> properties)
Remotely logs a Throwable/Exception at given severity level. These log messages and stacktraces will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
throwable- the throwable to remotely logseverity- the severity level of the log messageproperties- custom key-value pairs to include with the log message
-
logException
abstract Unit logException(Throwable throwable, Severity severity, Map<String, Object> properties, String message)
Remotely logs a Throwable/Exception at given severity level. These log messages and stacktraces will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
throwable- the throwable to remotely logseverity- the severity level of the log messageproperties- custom key-value pairs to include with the log messagemessage- the message to remotely log instead of the throwable message
-
logCustomStacktrace
abstract Unit logCustomStacktrace(Array<StackTraceElement> stacktraceElements)
Remotely logs a custom stacktrace at ERROR level. These log messages and stacktraces will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
stacktraceElements- the stacktrace to remotely log
-
logCustomStacktrace
abstract Unit logCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity)
Remotely logs a custom stacktrace at given severity level. These log messages and stacktraces will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
stacktraceElements- the stacktrace to remotely logseverity- the severity level of the log message
-
logCustomStacktrace
abstract Unit logCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity, Map<String, Object> properties)
Remotely logs a custom stacktrace at given severity level. These log messages and stacktraces will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
stacktraceElements- the stacktrace to remotely logseverity- the severity level of the log messageproperties- custom key-value pairs to include with the log message
-
logCustomStacktrace
abstract Unit logCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity, Map<String, Object> properties, String message)
Remotely logs a custom stacktrace at given severity level. These log messages and stacktraces will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.
- Parameters:
stacktraceElements- the stacktrace to remotely logseverity- the severity level of the log messageproperties- custom key-value pairs to include with the log messagemessage- the message to remotely log instead of the throwable message
-
-
-
-