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

Support Jenkins restart #1039

Merged
merged 2 commits into from
Feb 10, 2025
Merged

Support Jenkins restart #1039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cb2c1d
Support Jenkins restart
cyrille-leclerc Feb 9, 2025
11cf9a4
Support Jenkins restart
cyrille-leclerc Feb 10, 2025
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
6 changes: 6 additions & 0 deletions src/main/java/io/jenkins/plugins/opentelemetry/JenkinsOpenTelemetryPluginConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import hudson.PluginWrapper;
import hudson.init.InitMilestone;
import hudson.init.Initializer;
import hudson.init.Terminator;
import hudson.model.Describable;
import hudson.model.Descriptor;
import hudson.tasks.BuildStep;
Expand Down Expand Up @@ -716,6 +717,11 @@ public FormValidation doCheckExportOtelConfigurationAsEnvironmentVariables(@Quer
return FormValidation.warning("Note that OpenTelemetry credentials, if configured, will be exposed as environment variables (likely in OTEL_EXPORTER_OTLP_HEADERS)");
}

/**
* Close the @link LogStorageRetriever}.
* As <code>@PreDestroy</code> doesn't seem to be honored by Jenkins, we use <code>@Terminator</code> in addition.
*/
@Terminator
@PreDestroy
public void preDestroy() throws Exception {
if (logStorageRetriever != null) {
Expand Down
15 changes: 14 additions & 1 deletion src/main/java/io/jenkins/plugins/opentelemetry/init/OtelJulHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package io.jenkins.plugins.opentelemetry.init;

import hudson.Extension;
import hudson.init.Terminator;
import io.jenkins.plugins.opentelemetry.api.OpenTelemetryLifecycleListener;
import io.jenkins.plugins.opentelemetry.api.ReconfigurableOpenTelemetry;
import io.opentelemetry.api.common.Attributes;
Expand All @@ -19,6 +20,7 @@
import jenkins.YesNoMaybe;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Inject;
import java.io.PrintWriter;
import java.io.StringWriter;
Expand Down Expand Up @@ -175,7 +177,18 @@ public void postConstruct() {
this.loggerProvider = openTelemetry.getLogsBridge();
this.captureExperimentalAttributes = openTelemetry.getConfig().getBoolean("otel.instrumentation.java-util-logging.experimental-log-attributes", false);
Logger.getLogger("").addHandler(this);
logger.log(Level.FINE, "Otel java.util.logging bridge initialized");
logger.log(Level.INFO, "OTel logging Handler registered on java.util.logging");
}

/**
* Unregister the java.util.logging handler.
* As <code>@PreDestroy</code> doesn't seem to be honored by Jenkins, we use <code>@Terminator</code> in addition.
*/
@Terminator
@PreDestroy
public void preDestroy() {
Logger.getLogger("").removeHandler(this);
logger.log(Level.INFO, "OTel logging Handler unregistered from java.util.logging");
}

/**
Expand Down
13 changes: 13 additions & 0 deletions src/main/java/io/jenkins/plugins/opentelemetry/init/ServletFilterInitializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@
package io.jenkins.plugins.opentelemetry.init;

import hudson.Extension;
import hudson.init.Terminator;
import hudson.util.PluginServletFilter;
import io.jenkins.plugins.opentelemetry.api.OpenTelemetryLifecycleListener;
import io.jenkins.plugins.opentelemetry.servlet.StaplerInstrumentationServletFilter;
import io.jenkins.plugins.opentelemetry.servlet.TraceContextServletFilter;
import jenkins.YesNoMaybe;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Inject;
import jakarta.servlet.Filter;
import jakarta.servlet.ServletException;
Expand Down Expand Up @@ -40,6 +42,17 @@ public void postConstruct() {
addToPluginServletFilter(staplerInstrumentationServletFilter);
}

/**
* Unregister the {@link Filter}s from the {@link PluginServletFilter}.
* As <code>@PreDestroy</code> doesn't seem to be honored by Jenkins, we use <code>@Terminator</code> in addition.
*/
@Terminator
@PreDestroy
public void preDestroy() throws ServletException {
PluginServletFilter.removeFilter(traceContextServletFilter);
PluginServletFilter.removeFilter(staplerInstrumentationServletFilter);
}

private void addToPluginServletFilter(Filter filter) {
if (PluginServletFilter.hasFilter(filter)) {
logger.log(Level.INFO, () -> filter.getClass().getName() + " already enabled");
Expand Down