com.facebook.spectrum.logging

Interface SpectrumLogger

All Known Implementing Classes:

BaseSpectrumLogger, SpectrumLogcatLogger

public interface SpectrumLogger

The interface to be implemented by the global logger for Spectrum events which are emitted for all requests. The implementation needs to be thread-safe as Spectrum might execute multiple operations in parallel.

Method Summary

Modifier and Type	Method and Description
void	onError(java.lang.Object loggingContext, java.lang.Exception exception) Called for any exception that occurs during the operation.
void	onFinish(java.lang.Object loggingContext, SpectrumResult result) Called when the operation finishes.
java.lang.Object	onStart(Options options, java.lang.Object callerContext) Called before the operation is started.

Method Detail

onStart

@Nullable
java.lang.Object onStart(Options options,
                                   java.lang.Object callerContext)

Called before the operation is started.

Parameters:

options - The given Options for the operation

callerContext - An integration specific object that provides information about the calling site

Returns:

A logging context that will be returned to this class when the onFinish(java.lang.Object, com.facebook.spectrum.SpectrumResult) and onError(java.lang.Object, java.lang.Exception) methods are called. This can be used to differentiate operations. Can be null.

onError

void onError(@Nullable
             java.lang.Object loggingContext,
             java.lang.Exception exception)

Called for any exception that occurs during the operation.

Parameters:

loggingContext - The logging context that was returned initially by the onStart(com.facebook.spectrum.options.Options, java.lang.Object) method (if any).

exception - The exception that was thrown

onFinish

void onFinish(@Nullable
              java.lang.Object loggingContext,
              @Nullable
              SpectrumResult result)

Called when the operation finishes. This method is guaranteed to be called exactly once and no other callback is called afterwards for a given operation.

Parameters:

loggingContext - The logging context that was returned initially by the onStart(com.facebook.spectrum.options.Options, java.lang.Object) method (if any).

result - The SpectrumResult returned by the operation