OpenSearch Job Scheduler

OpenSearch JobScheduler plugin provides a framework for OpenSearch plugin developers to schedule periodical jobs running within OpenSearch nodes. You can schedule jobs by specify an interval, or using Unix Cron expression to define more flexible schedule to execute your job.

OpenSearch plugin developers can easily extend JobScheduler plugin to schedule jobs like running aggregation query against raw data and save the aggregated data into a new index every hour, or keep monitoring the shard allocation by calling OpenSearch API and post the output to a Webhook.

Getting Started

Add the following to your plugin to integrate with JobScheduler

Gradle
- Extend plugin from opensearch-job-scheduler
- Add this workaround to make sure that job-schedular plugin is correctly installed during integration tests.
Implement the following classes
- Implement these two interfaces ScheduledJobParameter and ScheduledJobRunner
- Extend class JobSchedulerExtension
Add the resource file
- Create org.opensearch.jobscheduler.spi.JobSchedulerExtension file.

Contributing

See developer guide and how to contribute to this project.

Getting Help

If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.

For more information, see project website and documentation. If you need help and are unsure where to open an issue, try forums.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.

License

This project is licensed under the Apache v2.0 License

opensearch-project / job-scheduler

readme