com.epam.reportportal.service

Class LoggingContext

java.lang.Object

com.epam.reportportal.service.LoggingContext

public class LoggingContext
extends java.lang.Object

Logging context holds thread-local context for logging and converts SaveLogRQ to multipart HTTP request to ReportPortal Basic flow: After start some test item (suite/test/step) context should be initialized with observable of item ID and ReportPortal client. Before actual finish of test item, context should be closed/completed. Context consists of Flowable with buffering back-pressure strategy to be able to batch incoming log messages into one request

See Also:

init(Maybe, Maybe, ReportPortalClient, Scheduler)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE Deprecated.
static int	DEFAULT_LOG_BATCH_SIZE

Method Summary

Modifier and Type	Method and Description
static io.reactivex.Completable	complete() Completes context attached to the current thread
io.reactivex.Completable	completed() Marks flow as completed
static LoggingContext	context() Return current logging context attached to the current thread.
void	emit(java.util.function.Function<java.lang.String,com.epam.ta.reportportal.ws.model.log.SaveLogRQ> logSupplier) Emits log.
void	emit(io.reactivex.Maybe<java.lang.String> logItemUuid, java.util.function.Function<java.lang.String,com.epam.ta.reportportal.ws.model.log.SaveLogRQ> logSupplier) Emits log.
static LoggingContext	init(io.reactivex.Maybe<java.lang.String> launchUuid, io.reactivex.Maybe<java.lang.String> itemUuid, ReportPortalClient client, io.reactivex.Scheduler scheduler) Initializes new logging context and attaches it to current thread
static LoggingContext	init(io.reactivex.Maybe<java.lang.String> launchUuid, io.reactivex.Maybe<java.lang.String> itemUuid, ReportPortalClient client, io.reactivex.Scheduler scheduler, int batchLogsSize, boolean convertImages) Initializes new logging context and attaches it to current thread
static LoggingContext	init(io.reactivex.Maybe<java.lang.String> launchUuid, io.reactivex.Maybe<java.lang.String> itemUuid, ReportPortalClient client, io.reactivex.Scheduler scheduler, ListenerParameters parameters) Initializes new logging context and attaches it to current thread
static LoggingContext	init(io.reactivex.Maybe<java.lang.String> launchUuid, io.reactivex.Maybe<java.lang.String> itemUuid, ReportPortalClient client, io.reactivex.Scheduler scheduler, ListenerParameters parameters, io.reactivex.FlowableSubscriber<com.epam.ta.reportportal.ws.model.BatchSaveOperatingRS> loggingSubscriber) Initializes new logging context and attaches it to current thread

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LOG_BATCH_SIZE

public static final int DEFAULT_LOG_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE

@Deprecated
public static final int DEFAULT_BUFFER_SIZE

Deprecated.

See Also:

Constant Field Values

Method Detail

context

@Nullable
public static LoggingContext context()

Return current logging context attached to the current thread. Return parent thread context if self context not found. And return 'null' if nothing was found at all.

Returns:

current or parent logging context or 'null'

init

@Nonnull
public static LoggingContext init(@Nonnull
                                           io.reactivex.Maybe<java.lang.String> launchUuid,
                                           @Nullable
                                           io.reactivex.Maybe<java.lang.String> itemUuid,
                                           @Nonnull
                                           ReportPortalClient client,
                                           @Nonnull
                                           io.reactivex.Scheduler scheduler,
                                           @Nonnull
                                           ListenerParameters parameters,
                                           @Nonnull
                                           io.reactivex.FlowableSubscriber<com.epam.ta.reportportal.ws.model.BatchSaveOperatingRS> loggingSubscriber)

Initializes new logging context and attaches it to current thread

Parameters:

launchUuid - a UUID of a Launch

itemUuid - a Test Item UUID

client - Client of ReportPortal

scheduler - a Scheduler to use with this LoggingContext

parameters - ReportPortal client configuration parameters

loggingSubscriber - RxJava subscriber on logging results

Returns:

New Logging Context

init

@Nonnull
public static LoggingContext init(@Nonnull
                                           io.reactivex.Maybe<java.lang.String> launchUuid,
                                           @Nullable
                                           io.reactivex.Maybe<java.lang.String> itemUuid,
                                           @Nonnull
                                           ReportPortalClient client,
                                           @Nonnull
                                           io.reactivex.Scheduler scheduler,
                                           @Nonnull
                                           ListenerParameters parameters)

Initializes new logging context and attaches it to current thread

Parameters:

launchUuid - a UUID of a Launch

itemUuid - a Test Item UUID

client - Client of ReportPortal

scheduler - a Scheduler to use with this LoggingContext

parameters - ReportPortal client configuration parameters

Returns:

New Logging Context

init

@Nonnull
public static LoggingContext init(@Nonnull
                                           io.reactivex.Maybe<java.lang.String> launchUuid,
                                           @Nullable
                                           io.reactivex.Maybe<java.lang.String> itemUuid,
                                           @Nonnull
                                           ReportPortalClient client,
                                           @Nonnull
                                           io.reactivex.Scheduler scheduler,
                                           int batchLogsSize,
                                           boolean convertImages)

Initializes new logging context and attaches it to current thread

Parameters:

launchUuid - a UUID of a Launch

itemUuid - a Test Item UUID

client - Client of ReportPortal

scheduler - a Scheduler to use with this LoggingContext

batchLogsSize - Size of a log batch

convertImages - Whether Image should be converted to BlackAndWhite

Returns:

New Logging Context

init

@Nonnull
public static LoggingContext init(@Nonnull
                                           io.reactivex.Maybe<java.lang.String> launchUuid,
                                           @Nullable
                                           io.reactivex.Maybe<java.lang.String> itemUuid,
                                           @Nonnull
                                           ReportPortalClient client,
                                           @Nonnull
                                           io.reactivex.Scheduler scheduler)

Initializes new logging context and attaches it to current thread

Parameters:

launchUuid - a UUID of a Launch

itemUuid - a Test Item UUID

client - Client of ReportPortal

scheduler - a Scheduler to use with this LoggingContext

Returns:

New Logging Context

complete

@Nonnull
public static io.reactivex.Completable complete()

Completes context attached to the current thread

Returns:

Waiting queue to be able to track request sending completion

emit

public void emit(@Nonnull
                 java.util.function.Function<java.lang.String,com.epam.ta.reportportal.ws.model.log.SaveLogRQ> logSupplier)

Emits log. Basically, put it into processing pipeline

Parameters:

logSupplier - Log Message Factory. Key if the function is actual test item ID

emit

public void emit(@Nonnull
                 io.reactivex.Maybe<java.lang.String> logItemUuid,
                 @Nonnull
                 java.util.function.Function<java.lang.String,com.epam.ta.reportportal.ws.model.log.SaveLogRQ> logSupplier)

Emits log. Basically, put it into processing pipeline

Parameters:

logItemUuid - Test Item ID promise

logSupplier - Log Message Factory. Key if the function is actual test item ID

completed

@Nonnull
public io.reactivex.Completable completed()

Marks flow as completed

Returns:

Completable