gocron

Gocron：Golangジョブスケジューリングパッケージ

Gocronは、事前に決定された間隔でGO機能を実行できるジョブスケジューリングパッケージです。

チャットしたい場合は、Slackで私たちを見つけることができます

クイックスタート

 go get github.com/go-co-op/gocron/v2

 package main

import (
	"fmt"
	"time"

	"github.com/go-co-op/gocron/v2"
)

func main () {
	// create a scheduler
	s , err := gocron . NewScheduler ()
	if err != nil {
		// handle error
	}

	// add a job to the scheduler
	j , err := s . NewJob (
		gocron . DurationJob (
			10 * time . Second ,
		),
		gocron . NewTask (
			func ( a string , b int ) {
				// do things
			},
			"hello" ,
			1 ,
		),
	)
	if err != nil {
		// handle error
	}
	// each job has a unique id
	fmt . Println ( j . ID ())

	// start the scheduler
	s . Start ()

	// block until you are ready to shut down
	select {
	case <- time . After ( time . Minute ):
	}

	// when you're done, shut it down
	err = s . Shutdown ()
	if err != nil {
		// handle error
	}
}

例

• ドキュメントの例にアクセスしてください
• 例ディレクトリ

概念

• ジョブ：ジョブは、GO機能と関数パラメーターで構成される「タスク」をカプセル化します。その後、ジョブはスケジューラに、ジョブが次に実行するようにスケジュールする時間を提供します。
• スケジューラ：スケジューラは、すべてのジョブを追跡し、実行の準備ができたら各ジョブをエグゼキューターに送信します。
• 執行者：執行者はジョブのタスクを呼び出し、異なるジョブ実行タイミング要件の複雑さを管理します（例えば、互いにオーバーランしないシングルトン、実行中の最大数を制限する）

特徴

ジョブタイプ

ジョブはさまざまな間隔で実行できます。

• 期間：ジョブは固定time.Durationで実行できます。
• ランダムな期間：ジョブは、ランダムなtime.Durationで実行できます。
• CRON ：JobsはCrontabを使用して実行できます。
• 毎日：ジョブは、特定の時間に毎日X日を実行できます。
• 毎週：ジョブは、週の特定の日と特定の時間に毎週毎週実行できます。
• 毎月：ジョブは、月の特定の日と特定の時間にXか月ごとに実行できます。
• 一度：ジョブは特定の時点で（1回または何度も）実行できます。

同時実行制限

ジョブは、個別に、またはスケジューラ全体で制限できます。

• シングルトンモードでのジョブの制限：ジョブは、再スケジュール（スキップの実行）またはキュー（以前の実行が終了するのを待つ）のいずれかの単一の同時実行に限定できます。
• スケジューラごとの制限モードでの制限モード：ジョブは、reschedule（制限が満たされたときにスキップ）またはキュー（ジョブをキューに追加して制限が利用可能になるのを待つ）を使用して、スケジューラ全体で特定の数の同時実行に制限できます。
• 注：スケジューラ制限とジョブ制限の両方を有効にできます。

Gocronの分散インスタンス

Gocronの複数のインスタンスを実行できます。

• 選挙人：選挙人を使用して、Gocronの単一のインスタンスを選択してプライマリとして実行することができます。
  • 実装：GO-CO-OP選挙人（必要なものが表示されませんか？それに貢献するために作成されたレポを取得するためにSlackでリクエスト！）
• ロッカー：ロッカーを使用して、ジョブの各実行をGocronの単一のインスタンスにロックできます。ロッカーは、職務とスケジューラの両方で定義されている場合、ジョブのロッカーが優先されます。
  • 実装：GO-CO-OPロッカー（必要なものが表示されないのですか？SLACKでリクエストして、それに貢献するために作成されたリポジトリを取得します！）

イベント

ジョブイベントはアクションをトリガーできます。

• リスナー：ジョブイベントを聞いてアクションをトリガーするために、スケジューラ全体のすべてのジョブを使用して、イベントリスナー、またはすべてのジョブでジョブに追加できます。

オプション

多くのジョブとスケジューラのオプションが利用可能です。

• ジョブオプション： NewJobを使用してジョブを作成するときにジョブオプションを設定できます。
• グローバルジョブオプション： NewSchedulerとWithGlobalJobOptionsオプションを使用してスケジューラを作成するときにグローバルジョブオプションを設定できます。
• スケジューラオプション： NewSchedulerを使用してスケジューラを作成するときにスケジューラオプションを設定できます。

ロギング

ログを有効にできます。

• ロガー：ロガーインターフェイスは、目的のロギングライブラリで実装できます。提供されたNewLoggerは、標準のライブラリのログパッケージを使用します。

メトリック

メトリックは、各ジョブの実行から収集される場合があります。

• モニター：モニター
• MonitorStatus （ジョブのステータスとエラー（もしあれば）を含む）モニターを使用して、スケジューラから各ジョブのメトリックを収集できます。
  • 実装：go-co-opモニター（必要なものが表示されませんか？それに貢献するために作成されたリポジトリを取得するためにSlackでリクエスト！）

テスト

Gocronライブラリは、テストを有効にするために設定されています。

• 模擬パッケージには、Gomockを使用して模擬パッケージに提供されます。
• 時間をocklockに渡すことで時間をock笑することができます - withclockの例を参照してください。

サポーター

無料およびオープンソースソフトウェアのサポートに感謝します！

このプロジェクトは次のようにサポートされています。

ジェットブレイン

セントリー

星の歴史