Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add SCM metadata to the transactions that are Multibranch Pipelines #184

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add SCM metadata to the transactions that are Multibranch Pipelines #184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions src/main/java/io/jenkins/plugins/opentelemetry/job/MonitoringRunListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,19 @@
import io.opentelemetry.api.trace.StatusCode;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import jenkins.branch.BranchSource;
import jenkins.branch.MultiBranchProject;
import jenkins.model.Jenkins;
import jenkins.plugins.git.GitSCMSource;
import org.jenkinsci.plugins.workflow.job.WorkflowRun;

import javax.annotation.Nonnull;
import javax.annotation.PostConstruct;
import javax.inject.Inject;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Level;
import java.util.logging.Logger;
Expand Down Expand Up @@ -95,8 +100,31 @@ public void _onInitialize(Run run) {

String rootSpanName = this.spanNamingStrategy.getRootSpanName(run);
String runUrl = Objects.toString(Jenkins.get().getRootUrl(), "") + run.getUrl();
SpanBuilder rootSpanBuilder = getTracer().spanBuilder(rootSpanName)
.setSpanKind(SpanKind.SERVER);
SpanBuilder rootSpanBuilder = null;

// Populate the SCM metadata and create the root span.
if (OtelUtils.isMultibranch(run)) {
try {
MultiBranchProject mbp = (MultiBranchProject) run.getParent().getParent();
// TODO: let's support all the sources such as Gitea, GitHub, BitBucket, GitLab (see https://www.jenkins.io/doc/book/pipeline/multibranch/#supporting-pull-requests)
Optional branchSource = mbp.getSCMSources().stream().filter(source -> source instanceof GitSCMSource).findFirst();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

Optional< GitSCMSource> branchSource

GitSCMSource scmSource;
if (branchSource.isPresent()) {
scmSource = (GitSCMSource) branchSource.get();
// TODO: get branch name
rootSpanBuilder = new GitStepHandler().createSpanBuilder(scmSource.getRemote(), "", scmSource.getCredentialsId(), "git", getTracer(), (WorkflowRun) run);
}
} catch (Exception e) {
LOGGER.log(Level.WARNING, run.getFullDisplayName() + " failure to handle SCM source", e);
}
}

// Otherwise, let's create the root span
if (rootSpanBuilder == null) {
rootSpanBuilder = getTracer().spanBuilder(rootSpanName);
}

rootSpanBuilder.setSpanKind(SpanKind.SERVER);

// TODO move this to a pluggable span enrichment API with implementations for different observability backends
// Regarding the value `unknown`, see https://github.com/jenkinsci/opentelemetry-plugin/issues/51
Expand Down