Package 

Interface LogsApi


  • 
    public interface LogsApi
    
                        

    The public API that is used to send log messages.

    • 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 log
        severity - 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 log
        severity - the severity level of the log message
        properties - 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 log
        severity - the severity level of the log message
        properties - the properties to attach to the log message
        attachment - 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 log
        severity - the severity level of the log message
        properties - the properties to attach to the log message
        attachmentId - a UUID that identifies the attachment
        attachmentUrl - 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 log
        severity - 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 log
        severity - the severity level of the log message
        properties - 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 log
        severity - the severity level of the log message
        properties - custom key-value pairs to include with the log message
        message - 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 log
        severity - 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 log
        severity - the severity level of the log message
        properties - 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 log
        severity - the severity level of the log message
        properties - custom key-value pairs to include with the log message
        message - the message to remotely log instead of the throwable message