com.netflix.genie.web.configs

Class GenieTasksAutoConfiguration

java.lang.Object

com.netflix.genie.web.configs.GenieTasksAutoConfiguration

@Configuration
 @EnableScheduling
 @EnableConfigurationProperties(value={ClusterCheckerProperties.class,DatabaseCleanupProperties.class,DiskCleanupProperties.class,TasksExecutorPoolProperties.class,TasksSchedulerPoolProperties.class,UserMetricsProperties.class,AgentCleanupProperties.class})
public class GenieTasksAutoConfiguration
extends java.lang.Object

Configuration of beans for asynchronous tasks within Genie.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
GenieTasksAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
AgentJobCleanupTask	agentJobCleanupTask(JobSearchService jobSearchService, JobPersistenceService jobPersistenceService, AgentCleanupProperties agentCleanupProperties, io.micrometer.core.instrument.MeterRegistry registry) If required, get a AgentJobCleanupTask instance for use.
ClusterCheckerTask	clusterCheckerTask(GenieHostInfo genieHostInfo, ClusterCheckerProperties properties, JobSearchService jobSearchService, JobPersistenceService jobPersistenceService, org.springframework.web.client.RestTemplate restTemplate, org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties webEndpointProperties, io.micrometer.core.instrument.MeterRegistry registry) Create a ClusterCheckerTask if one hasn't been supplied.
DatabaseCleanupTask	databaseCleanupTask(DatabaseCleanupProperties cleanupProperties, JobPersistenceService jobPersistenceService, ClusterPersistenceService clusterPersistenceService, FilePersistenceService filePersistenceService, TagPersistenceService tagPersistenceService, io.micrometer.core.instrument.MeterRegistry registry) Create a DatabaseCleanupTask if one is required.
DiskCleanupTask	diskCleanupTask(DiskCleanupProperties properties, org.springframework.scheduling.TaskScheduler scheduler, org.springframework.core.io.Resource jobsDir, JobSearchService jobSearchService, JobsProperties jobsProperties, org.apache.commons.exec.Executor processExecutor, io.micrometer.core.instrument.MeterRegistry registry) If required get a DiskCleanupTask instance for use.
org.springframework.core.task.AsyncTaskExecutor	genieAsyncTaskExecutor(TasksExecutorPoolProperties tasksExecutorPoolProperties) Get a task executor for executing tasks asynchronously that don't need to be scheduled at a recurring rate.
org.springframework.core.task.SyncTaskExecutor	genieSyncTaskExecutor() Synchronous task executor.
org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler	genieTaskScheduler(TasksSchedulerPoolProperties tasksSchedulerPoolProperties) Get a task scheduler.
org.springframework.scheduling.TaskScheduler	heartBeatServiceTaskScheduler() Get the task scheduler used by the HeartBeat Service.
org.apache.commons.exec.Executor	processExecutor() Get an Executor to use for executing processes from tasks.
UserMetricsTask	userMetricsTask(io.micrometer.core.instrument.MeterRegistry registry, JobSearchService jobSearchService, UserMetricsProperties userMetricsProperties) If required get a UserMetricsTask instance for use.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenieTasksAutoConfiguration

public GenieTasksAutoConfiguration()

Method Detail

processExecutor

@Bean
 @ConditionalOnMissingBean(value=org.apache.commons.exec.Executor.class)
public org.apache.commons.exec.Executor processExecutor()

Get an Executor to use for executing processes from tasks.

Returns:

The executor to use

genieTaskScheduler

@Bean
 @ConditionalOnMissingBean(name="genieTaskScheduler")
public org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler genieTaskScheduler(TasksSchedulerPoolProperties tasksSchedulerPoolProperties)

Get a task scheduler.

Parameters:

tasksSchedulerPoolProperties - The properties regarding the thread pool to use for task scheduling

Returns:

The task scheduler

heartBeatServiceTaskScheduler

@Bean
 @ConditionalOnMissingBean(name="heartBeatServiceTaskScheduler")
public org.springframework.scheduling.TaskScheduler heartBeatServiceTaskScheduler()

Get the task scheduler used by the HeartBeat Service.

Returns:

The task scheduler

genieAsyncTaskExecutor

@Bean
 @ConditionalOnMissingBean(name="genieAsyncTaskExecutor")
public org.springframework.core.task.AsyncTaskExecutor genieAsyncTaskExecutor(TasksExecutorPoolProperties tasksExecutorPoolProperties)

Get a task executor for executing tasks asynchronously that don't need to be scheduled at a recurring rate.

Parameters:

tasksExecutorPoolProperties - The properties for the task executor thread pool

Returns:

The task executor the system to use

genieSyncTaskExecutor

@Bean
 @ConditionalOnMissingBean(name="genieSyncTaskExecutor")
public org.springframework.core.task.SyncTaskExecutor genieSyncTaskExecutor()

Synchronous task executor.

Returns:

The synchronous task executor to use

clusterCheckerTask

@Bean
 @ConditionalOnMissingBean(value=ClusterCheckerTask.class)
public ClusterCheckerTask clusterCheckerTask(GenieHostInfo genieHostInfo,
                                                                                                              ClusterCheckerProperties properties,
                                                                                                              JobSearchService jobSearchService,
                                                                                                              JobPersistenceService jobPersistenceService,
                                                                                                              @Qualifier(value="genieRestTemplate")
                                                                                                              org.springframework.web.client.RestTemplate restTemplate,
                                                                                                              org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties webEndpointProperties,
                                                                                                              io.micrometer.core.instrument.MeterRegistry registry)

Create a ClusterCheckerTask if one hasn't been supplied.

Parameters:

genieHostInfo - Information about the host this Genie process is running on

properties - The properties to use to configure the task

jobSearchService - The job search service to use

jobPersistenceService - The job persistence service to use

restTemplate - The rest template for http calls

webEndpointProperties - The properties where Spring actuator is running

registry - The spectator registry for getting metrics

Returns:

The ClusterCheckerTask instance

databaseCleanupTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.database-cleanup.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=DatabaseCleanupTask.class)
public DatabaseCleanupTask databaseCleanupTask(DatabaseCleanupProperties cleanupProperties,
                                                                                                                                                                                                                                  JobPersistenceService jobPersistenceService,
                                                                                                                                                                                                                                  ClusterPersistenceService clusterPersistenceService,
                                                                                                                                                                                                                                  FilePersistenceService filePersistenceService,
                                                                                                                                                                                                                                  TagPersistenceService tagPersistenceService,
                                                                                                                                                                                                                                  io.micrometer.core.instrument.MeterRegistry registry)

Create a DatabaseCleanupTask if one is required.

Parameters:

cleanupProperties - The properties to use to configure this task

jobPersistenceService - The persistence service to use to cleanup the data store

clusterPersistenceService - The cluster service to use to delete terminated clusters

filePersistenceService - The file service to use to delete unused file references

tagPersistenceService - The tag service to use to delete unused tag references

registry - The metrics registry

Returns:

The DatabaseCleanupTask instance to use if the conditions match

diskCleanupTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.disk-cleanup.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=DiskCleanupTask.class)
public DiskCleanupTask diskCleanupTask(DiskCleanupProperties properties,
                                                                                                                                                                                                                  @Qualifier(value="genieTaskScheduler")
                                                                                                                                                                                                                  org.springframework.scheduling.TaskScheduler scheduler,
                                                                                                                                                                                                                  org.springframework.core.io.Resource jobsDir,
                                                                                                                                                                                                                  JobSearchService jobSearchService,
                                                                                                                                                                                                                  JobsProperties jobsProperties,
                                                                                                                                                                                                                  org.apache.commons.exec.Executor processExecutor,
                                                                                                                                                                                                                  io.micrometer.core.instrument.MeterRegistry registry)
                                                                                                                                                                                                           throws java.io.IOException

If required get a DiskCleanupTask instance for use.

Parameters:

properties - The disk cleanup properties to use.

scheduler - The scheduler to use to schedule the cron trigger.

jobsDir - The resource representing the location of the job directory

jobSearchService - The service to find jobs with

jobsProperties - The jobs properties to use

processExecutor - The process executor to use to delete directories

registry - The metrics registry

Returns:

The DiskCleanupTask instance

Throws:

java.io.IOException - When it is unable to open a file reference to the job directory

userMetricsTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.user-metrics.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=UserMetricsTask.class)
public UserMetricsTask userMetricsTask(io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                                                                                                                                  JobSearchService jobSearchService,
                                                                                                                                                                                                                  UserMetricsProperties userMetricsProperties)

If required get a UserMetricsTask instance for use.

Parameters:

registry - The metrics registry

jobSearchService - The job search service

userMetricsProperties - The properties

Returns:

The UserMetricsTask instance

agentJobCleanupTask

@Bean
 @ConditionalOnProperty(value="genie.tasks.agent-cleanup.enabled",
                       havingValue="true")
 @ConditionalOnMissingBean(value=AgentJobCleanupTask.class)
public AgentJobCleanupTask agentJobCleanupTask(JobSearchService jobSearchService,
                                                                                                                                                                                                                               JobPersistenceService jobPersistenceService,
                                                                                                                                                                                                                               AgentCleanupProperties agentCleanupProperties,
                                                                                                                                                                                                                               io.micrometer.core.instrument.MeterRegistry registry)

If required, get a AgentJobCleanupTask instance for use.

Parameters:

jobSearchService - The job search service

jobPersistenceService - the job persistence service

agentCleanupProperties - the agent cleanup properties

registry - the metrics registry

Returns:

a AgentJobCleanupTask