com.netflix.genie.web.agent.launchers

Interface AgentLauncher

All Superinterfaces:

org.springframework.boot.actuate.health.HealthContributor, org.springframework.boot.actuate.health.HealthIndicator

All Known Implementing Classes:

LocalAgentLauncherImpl, TitusAgentLauncherImpl

public interface AgentLauncher
extends org.springframework.boot.actuate.health.HealthIndicator

A interface which implementations will launch instances of an agent in some manner in order to run a job.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LAUNCH_TIMER Shared name of a timer that can be used by launchers to record how long it took them to perform their respective launch.
static java.lang.String	LAUNCHER_CLASS_EXT_FIELD Shared key representing the class that key for the Launcher Ext context the API can return.
static java.lang.String	LAUNCHER_CLASS_KEY Shared key for a tag that can be added to the timer metric to add the implementation class in order to aid in adding a convenient dimension.
static java.lang.String	SOURCE_HOST_EXT_FIELD Shared key representing the hostname of the Genie server the Agent Launcher was executed on.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<com.fasterxml.jackson.databind.JsonNode>	launchAgent(ResolvedJob resolvedJob, com.fasterxml.jackson.databind.JsonNode requestedLauncherExt) Launch an agent to execute the given ResolvedJob information.

Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator

getHealth, health

Field Detail

LAUNCH_TIMER

static final java.lang.String LAUNCH_TIMER

Shared name of a timer that can be used by launchers to record how long it took them to perform their respective launch.

See Also:

Constant Field Values

LAUNCHER_CLASS_KEY

static final java.lang.String LAUNCHER_CLASS_KEY

Shared key for a tag that can be added to the timer metric to add the implementation class in order to aid in adding a convenient dimension.

See Also:

LAUNCH_TIMER, Constant Field Values

LAUNCHER_CLASS_EXT_FIELD

static final java.lang.String LAUNCHER_CLASS_EXT_FIELD

Shared key representing the class that key for the Launcher Ext context the API can return.

See Also:

Constant Field Values

SOURCE_HOST_EXT_FIELD

static final java.lang.String SOURCE_HOST_EXT_FIELD

Shared key representing the hostname of the Genie server the Agent Launcher was executed on.

See Also:

Constant Field Values

Method Detail

launchAgent

java.util.Optional<com.fasterxml.jackson.databind.JsonNode> launchAgent(ResolvedJob resolvedJob,
                                                                        @Nullable
                                                                        com.fasterxml.jackson.databind.JsonNode requestedLauncherExt)
                                                                 throws AgentLaunchException

Launch an agent to execute the given ResolvedJob information.

Parameters:

resolvedJob - The ResolvedJob information for the agent to act on

requestedLauncherExt - The launcher requested extension, or null

Returns:

an optional JsonNode with the launcher context about the launched job

Throws:

AgentLaunchException - For any error launching an Agent instance to run the job