Package io.jenkins.plugins.opentelemetry.backend.custom

Class CustomLogStorageRetriever

java.lang.Object

io.jenkins.plugins.opentelemetry.backend.custom.CustomLogStorageRetriever

All Implemented Interfaces:

LogStorageRetriever, AutoCloseable

public class CustomLogStorageRetriever
extends Object
implements LogStorageRetriever

Constructor Summary

Constructors

Constructor	Description
CustomLogStorageRetriever(groovy.text.Template buildLogsVisualizationUrlTemplate, TemplateBindingsProvider templateBindingsProvider)

Method Summary

Modifier and Type	Method	Description
void	close()
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)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomLogStorageRetriever

public CustomLogStorageRetriever(@NonNull
                                 groovy.text.Template buildLogsVisualizationUrlTemplate,
                                 @NonNull
                                 TemplateBindingsProvider templateBindingsProvider)

Method Detail

overallLog

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

Specified by:

overallLog in interface LogStorageRetriever

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()

stepLog

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

Specified by:

stepLog in interface LogStorageRetriever

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()

toString

public String toString()

Overrides:

toString in class Object

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception