Package io.jenkins.plugins.opentelemetry.backend.grafana

Class LokiLogStorageRetriever

java.lang.Object

io.jenkins.plugins.opentelemetry.backend.grafana.LokiLogStorageRetriever

All Implemented Interfaces:

LogStorageRetriever, Closeable, AutoCloseable

public class LokiLogStorageRetriever
extends Object
implements LogStorageRetriever, Closeable

Constructor Summary

Constructors

Constructor	Description
LokiLogStorageRetriever(String lokiUrl, boolean disableSslVerifications, Optional<org.apache.http.auth.Credentials> lokiCredentials, Optional<String> lokiTenantId, groovy.text.Template buildLogsVisualizationUrlTemplate, TemplateBindingsProvider templateBindingsProvider, String serviceName, Optional<String> serviceNamespace)

Method Summary

Modifier and Type	Method	Description
List<FormValidation>	checkLokiSetup()
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)

Methods inherited from class java.lang.Object

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

Constructor Details

LokiLogStorageRetriever

@MustBeClosed
public LokiLogStorageRetriever(@Nonnull
 String lokiUrl,
 boolean disableSslVerifications,
 @Nonnull
 Optional<org.apache.http.auth.Credentials> lokiCredentials,
 @Nonnull
 Optional<String> lokiTenantId,
 @NonNull
 groovy.text.Template buildLogsVisualizationUrlTemplate,
 @NonNull
 TemplateBindingsProvider templateBindingsProvider,
 @Nonnull
 String serviceName,
 @Nonnull
 Optional<String> serviceNamespace)

Method Details

overallLog

@Nonnull
public LogsQueryResult overallLog(@Nonnull
 String jobFullName,
 int runNumber,
 @Nonnull
 String traceId,
 @Nonnull
 String spanId,
 boolean complete,
 @Nonnull
 Instant startTime,
 @Nullable
 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()

checkLokiSetup

public List<FormValidation> checkLokiSetup()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException