Package io.jenkins.plugins.onmonit

Class RemoteOtelContribProcessFactory

java.lang.Object

io.jenkins.plugins.onmonit.RemoteOtelContribProcessFactory

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

DelegatedOtelContribProcessFactory, ExecDownloadedOtelContribProcessFactory, ExecRemoteOtelContribProcessFactory, ExecUploadedOtelContribProcessFactory

public abstract class RemoteOtelContribProcessFactory
extends Object
implements ExtensionPoint

Extension point for otel-contrib providers.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
RemoteOtelContribProcessFactory()

Method Summary

Modifier and Type	Method	Description
abstract RemoteOtelContribProcess	create(LauncherProvider launcherProvider, TaskListener listener, ComputerInfo info, FilePath temp, String envCookie, String additionalOptions, boolean debug)	Create an otel-contrib process on the specified launcher.
abstract String	getDisplayName()	The display name of the factory.
abstract boolean	isSupported(Launcher launcher, TaskListener listener, ComputerInfo info)	Checks if the supplied launcher is supported by this factory.

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteOtelContribProcessFactory

public RemoteOtelContribProcessFactory()

Method Details

getDisplayName

public abstract String getDisplayName()

The display name of the factory.

Returns:

The display name of the factory.

isSupported

public abstract boolean isSupported(Launcher launcher,
 TaskListener listener,
 ComputerInfo info)

Checks if the supplied launcher is supported by this factory.

Parameters:

launcher - the launcher on which the factory would be asked to start an otel-contrib process.

listener - a listener in case any user diagnostics are to be printed.

info - information about the target environment (OS, arch)

Returns:

false if the factory does not want to try and start a node-exporter on the launcher.

create

public abstract RemoteOtelContribProcess create(LauncherProvider launcherProvider,
 TaskListener listener,
 ComputerInfo info,
 FilePath temp,
 String envCookie,
 String additionalOptions,
 boolean debug)
                                         throws Throwable

Create an otel-contrib process on the specified launcher. This does not yet start it.

Parameters:

launcherProvider - provides launchers on which to start an otel-contrib process.

listener - a listener for any diagnostics.

info - information about the target environment (OS, arch)

temp - a temporary directory to use

envCookie - a value to distinguish the created process

additionalOptions - any additional arguments to pass to the launched process

debug - whether to pass any process output to the Job console log (useful for troubleshooting)

Returns:

the process.

Throws:

Throwable - if the process cannot be started.