Package io.jenkins.plugins.opentelemetry.job.log

Interface LogStorageRetriever

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

CustomLogStorageRetriever, ElasticsearchLogStorageRetriever

public interface LogStorageRetriever
extends AutoCloseable

Method Summary

Modifier and Type	Method	Description
LogsQueryResult	overallLog(String jobFullName, int runNumber, String traceId, String spanId, boolean complete, Instant startTime, Instant endTime)
LogsQueryResult	stepLog(String jobFullName, int runNumber, String flowNodeId, String traceId, String spanId, boolean complete, Instant startTime, Instant endTime)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

overallLog

@NonNull
LogsQueryResult overallLog(@NonNull
                           String jobFullName,
                           int runNumber,
                           @NonNull
                           String traceId,
                           @NonNull
                           String spanId,
                           boolean complete,
                           @NonNull
                           Instant startTime,
                           @Nullable
                           Instant endTime)
                    throws IOException

Parameters:

jobFullName - see AbstractItem.getFullName()

runNumber - see Run.getNumber()

complete - if true, we claim to be serving the complete log for a build, so implementations should be sure to retrieve final log lines

startTime - Pipeline run start time. See Run.getStartTimeInMillis()

endTime - null if the pipeline is still running. See Run.getDuration()

Throws:

IOException

stepLog

@NonNull
LogsQueryResult stepLog(@NonNull
                        String jobFullName,
                        int runNumber,
                        @NonNull
                        String flowNodeId,
                        @NonNull
                        String traceId,
                        @NonNull
                        String spanId,
                        boolean complete,
                        @NonNull
                        Instant startTime,
                        @Nullable
                        Instant endTime)
                 throws IOException

Parameters:

jobFullName - see AbstractItem.getFullName()

runNumber - see Run.getNumber()

flowNodeId - see FlowNode.getId()

complete - if true, we claim to be serving the complete log for a build, so implementations should be sure to retrieve final log lines

startTime - Pipeline run start time. See Run.getStartTimeInMillis()

endTime - null if the pipeline is still running. See Run.getDuration()

Throws:

IOException