cron.yaml로 작업 예약

App Engine Cron Service를 사용하면 지정된 시간이나 주기적인 간격으로 작동하는 정기 예약 태스크를 구성할 수 있습니다. 이러한 태스크를 일반적으로 크론 작업이라 합니다. 이러한 크론 작업은 App Engine Cron Service에 의해 자동으로 트리거됩니다. 예를 들어 크론 작업을 사용하여 일일 보고 이메일을 보내거나, 10분마다 캐시된 일부 데이터를 업데이트하거나, 한 시간마다 요약 정보를 업데이트할 수 있습니다.

크론 작업은 크론 작업이 구성된 동일한 앱의 지정된 엔드포인트에 대해 예약된 HTTP GET 요청을 수행합니다. 이 엔드포인트의 핸들러는 호출 시 로직을 실행합니다.

App Engine Cron Service는 App Engine 호스트 앱 외부의 웹 엔드포인트를 호출하는 데 사용할 수 없습니다. 호스트 앱 이외의 다른 앱에서 App Engine 엔드포인트를 호출하는 데 사용할 수 없습니다.

크론 작업 요청에는 다른 HTTP 요청과 동일한 제한이 적용됩니다. 무료 애플리케이션은 태스크를 최대 20개까지 예약할 수 있습니다. 유료 애플리케이션은 태스크를 최대 250개까지 예약할 수 있습니다.

일정을 배포하거나 업데이트하려면 계정에 다음 Identity and Access Management 역할 중 하나가 필요합니다.

Google Cloud 콘솔의 IAM 페이지에서 권한을 설정할 수 있습니다.

cron 구성 파일 정보

자바를 제외한 모든 런타임에서는 애플리케이션의 루트 디렉터리에 있는 cron.yaml 파일이 app.yaml과 함께 앱의 예약 태스크를 구성합니다.

자바의 경우 애플리케이션의 WEB-INF 디렉터리에 있는 cron.yaml 파일이 app.yaml과 함께 앱의 예약 태스크를 구성합니다.

다음은 cron.yaml 파일의 예시입니다.

cron:
- description: "daily summary job"
  url: /tasks/summary
  schedule: every 24 hours
- description: "monday morning mailout"
  url: /mail/weekly
  schedule: every monday 09:00
  timezone: Australia/NSW
- description: "new daily summary job"
  url: /tasks/summary
  schedule: every 24 hours
  target: beta

cron.yaml 파일은 YAML 문법을 사용하고 각 크론 작업의 정의로 구성됩니다. 작업 정의에는 url과 schedule이 포함되어야 합니다. 경우에 따라 description, timezone, target, retry_parameters를 지정할 수도 있습니다.

url
필수사항. 크론 서비스가 작업 요청을 보낼 앱의 URL입니다.
schedule
필수사항. 작업을 실행할 일정을 정의합니다. 아래 구문을 참조하세요.
description
선택사항. Google Cloud 콘솔 내에서 볼 수 있는 크론 작업을 설명합니다.
timezone
선택사항. 작업 일정에 사용할 시간대 이름 또는 '시간대 정보'입니다. 시간대를 지정하지 않으면 일정은 UTC(GMT라고도 함)를 사용합니다.
target
선택사항. 앱의 특정 서비스 이름입니다. target이 지정되면 Cron 서비스는 앱에서 해당 서비스에 대한 작업 요청을 타겟팅합니다. 작업 요청은 트래픽에 구성된 특정 서비스의 버전으로 라우팅됩니다. 요청이 라우팅되는 방법을 알아보세요.

target 관련 중요 고려사항:

  • 트래픽 분할을 사용 설정한 경우 작업 요청은 구성한 버전 간에서 분할되지 않습니다.
    • IP 주소 분할: 크론 서비스의 작업 요청은 항상 동일한 IP 주소에서 전송되므로 매번 같은 버전으로 라우팅됩니다.
    • 쿠키 분할: 작업 요청에 요청과 함께 쿠키가 포함되지 않으므로 다른 어떤 버전으로도 라우팅되지 않습니다.
  • 디스패치 파일을 사용하는 경우 dispatch.yaml에도 동일한 URL이 구성되어 있으면 작업이 다시 라우팅될 수 있습니다. 예를 들어 /tasks/hello_service2 URL이 다음 cron.yaml 파일과 dispatch.yaml 파일 모두에서 정의된 경우 target: service1이 지정되더라도 작업 요청은 service2로 전송됩니다.

    cron.yaml: 

    cron:
- description: "test dispatch vs target"
  url: /tasks/hello_service2
  schedule: every 1 mins
  target: service1

    dispatch.yaml:

    dispatch:
- url: '*/tasks/hello_service2'
  service: service2
retry_parameters
선택사항. 실패한 작업을 다시 실행하도록 지정합니다. 아래 구문을 참조하세요.

크론 작업 schedule 정의

크론 작업은 반복되는 일정 주기에 따라 예약되며 영어와 유사한 단순 형식으로 지정됩니다. 작업이 하루에 여러 번 실행되거나 특정 날짜와 특정 달에 실행되도록 일정을 정의할 수 있습니다.

하루 미만 간격

반복되는 일정에 따라 하루에 작업을 여러 번 실행하려면 하루 미만의 간격을 사용합니다. 종료 시간 간격 또는 시작 시간 간격을 정의할 수 있습니다.

  • 종료 시간 간격: 작업의 '종료 시간'과 다음 작업이 시작되는 시간 사이의 간격을 정의합니다. 여기서 '종료 시간'은 작업이 완료되거나 타임아웃되는 시간입니다. 크론 서비스는 작업 생성/업데이트 시간 후 1개 간격부터 하루 24시간 동안 이 유형의 간격으로 작업을 실행하며, 각 작업 사이에 지정된 간격만큼 대기합니다.

    예: every 5 minutes 일정의 경우 작업이 매일 5분 간격으로 실행됩니다. 이 일정으로 실행되는 작업의 인스턴스 하나가 02:01에 완료되면 다음 작업은 5분간 대기한 후 02:06에 다시 시작됩니다.

  • 시작 시간 간격: 크론 서비스가 각 작업을 시작할 정기적인 시간 간격을 정의합니다. 종료 시간 간격과 달리 시작 시간 간격은 이전 작업의 완료 또는 타임아웃 시점과 무관하게 각 작업을 실행합니다. 작업을 실행할 시간 범위를 설정하거나 지정된 시간 범위의 시작부터 하루 24시간 동안 작업을 실행할 수 있습니다.

    작업의 시작 시간은 엄격하게 적용되므로 작업 인스턴스가 정의된 시간 간격보다 오래 실행되면 크론 서비스가 작업을 건너뛸 수 있습니다. 즉, 이전 작업이 완료되지 않았거나 타임아웃되면 간격 내의 개별 시작 시간을 건너뛸 수 있습니다.

    예: every 5 minutes from 10:00 to 14:00 일정의 경우 첫 번째 작업이 10:00에 실행된 후 작업이 5분 간격으로 실행됩니다. 첫 번째 작업이 7분 동안 실행되면 10:05작업은 건너뛰게 되고, 따라서 크론 서비스는 10:10까지 이 작업의 다른 인스턴스를 실행하지 않습니다.

커스텀 간격

커스텀 간격을 사용하여 한 달 이상의 기간을 선택해 그동안 하루 이상의 날에 작업이 하루에 한 번 실행되는 일정을 정의할 수 있습니다. 커스텀 일정으로 실행되는 작업은 1년 중에서 선택한 월과 날짜의 특정 시간에만 실행됩니다.

예: 1,2,3 of month 07:00 일정의 경우 작업이 매월 처음 3일 동안 07:00에 한 번씩 실행됩니다.

schedule 관련 중요 고려사항:

  • 하루 미만의 간격 또는 커스텀 간격 중에서 사용할 간격을 결정해야 합니다. 다양한 간격 유형의 요소를 조합하여 사용할 수 없습니다. 예를 들어 schedule: every 6 hours mon,wed,fri는 잘못된 일정 정의의 예시입니다.
  • 작업 인스턴스는 한 번에 하나만 실행해야 합니다. 크론 서비스는 '최소 1회' 전송을 제공하도록 설계되어 있습니다. 즉, 작업이 예약되면 App Engine이 작업 요청을 최소 1회 이상 전송합니다. 드물지만 동일한 작업의 여러 인스턴스가 요청되는 경우가 있습니다. 따라서 요청 핸들러는 멱등적이어야 하며, 이러한 경우가 발생해도 유해한 부작용이 없도록 코드를 작성해야 합니다.

schedule 형식 지정

작업이 실행되는 시점을 지정하려면 다음 구문을 사용하여 schedule 요소를 정의해야 합니다.

schedule: [TYPE] [INTERVAL_VALUE] [INTERVAL_SCOPE]

schedule 요소를 정의할 간격 유형을 선택합니다.

종료 시간 간격
  • [TYPE]: 일일 간격에는 every 프리픽스가 포함되어야 합니다.

    예: schedule: every 12 hours

  • [INTERVAL_VALUE]: 정수 값과 해당 시간 단위입니다. 유효한 시간 단위 값은 다음과 같습니다.
    • minutes 또는 mins
    • hours
  • [INTERVAL_SCOPE]: 적용할 수 없습니다. 작업을 실행할 구체적인 시작 시간 또는 범위를 설정하려면 시작 시간 간격 또는 커스텀 간격의 구문을 참조하세요.
종료 시간 간격 예시
다음 예시를 살펴보면 종료 시간 간격을 사용하는 작업 일정을 정의하는 방법을 이해하는 데 도움이 됩니다.
  • 배포 후 5분 후에 처음 실행됩니다. 각 작업이 종료되면 크론 서비스는 5분간 대기한 후 다음 작업을 실행합니다. 
    schedule: every 5 minutes
  • 배포 후 30분 후에 처음 실행됩니다. 각 작업이 종료되면 크론 서비스는 30분간 대기한 후 다음 작업을 실행합니다. 
    schedule: every 30 mins
시작 시간 간격
  • [TYPE]: 일일 간격에는 every 프리픽스가 포함되어야 합니다.

    예: schedule: every 12 hours

  • [INTERVAL_VALUE]: 정수 값과 해당 시간 단위입니다. 유효한 시간 단위 값은 다음과 같습니다.
    • minutes 또는 mins
    • hours
  • [INTERVAL_SCOPE]: [INTERVAL_VALUE]에 해당하는 절을 지정합니다. 커스텀 시간 범위를 정의하거나 24시간 synchronized 옵션을 사용할 수 있습니다.
    • 작업을 실행할 구체적인 시작 시간과 범위를 설정하려면 from [HH:MM] to [HH:MM] 절을 포함합니다.

      시간 값은 24시간 형식(HH:MM)으로 지정해야 합니다. 각 항목의 의미는 다음과 같습니다.

      • HH은 00부터 23까지의 정수입니다.
      • MM은 00부터 59까지의 정수입니다.
    • [INTERVAL_VALUE] 값으로 균등하게 나뉘는 24시간 범위(from 00:00 to 23:59)를 지정하려면 synchronized를 사용합니다.

      중요: [INTERVAL_VALUE]는 24를 정수로 나누는 값이어야 하며, 그렇지 않으면 오류가 발생합니다. 즉, 유효한 [INTERVAL_VALUE] 값은 1, 2, 3, 4, 6, 8, 12, 24입니다.

시작 시간 간격 예시
다음 예시를 살펴보면 시작 시간 간격을 사용하는 작업 일정 정의 방법을 이해하는 데 도움이 됩니다.
  • 매일 10:00부터 14:00까지 5분 간격으로 실행: 
    schedule: every 5 minutes from 10:00 to 14:00
  • 매일 08:00부터 16:00까지 1시간 간격으로 실행:
    schedule: every 1 hours from 08:00 to 16:00
  • 매일 00:00부터 2시간 간격으로 실행: 
    schedule: every 2 hours synchronized
커스텀 간격
  • [TYPE]: 커스텀 간격에 every 프리픽스를 포함하여 반복 간격을 정의하거나 한 달 내에 있는 특정 날짜의 목록을 정의할 수 있습니다.
    • 반복 간격을 정의하려면 every 프리픽스를 사용합니다.

      예: 

      schedule: every day 00:00
schedule: every monday 09:00

    • 특정한 날짜를 정의하려면 서수를 사용해야 합니다. 유효한 값은 특정 월의 1일부터 해당 월의 마지막 날짜까지입니다. 예를 들면 다음과 같습니다.
      • 1st 또는 first
      • 2nd 또는 second
      • 3rd 또는 third
      • 최대 31st 또는 thirtyfirst

      예: 

      schedule: 1st,3rd tuesday
schedule: 2nd,third wednesday of month 09:00

  • [INTERVAL_VALUE]: 커스텀 간격은 작업을 실행할 특정 날짜의 목록을 포함합니다. 목록은 쉼표로 구분된 목록으로 정의되어야 하며 다음 값 중 하나를 포함할 수 있습니다.
    • 해당 월의 날짜에 해당하는 정수 값(최대 31일)입니다. 예를 들면 다음과 같습니다.
      • 1
      • 2
      • 3
      • 최대 31
    • 긴 값 또는 축약된 값을 조합한 요일 이름입니다. 사용할 수 있는 값은 다음과 같습니다.
      • monday 또는 mon
      • tuesday 또는 tue
      • wednesday 또는 wed
      • thursday 또는 thu
      • friday 또는 fri
      • saturday 또는 sat
      • sunday 또는 sun
      • 한 주의 모든 요일을 지정하려면 day를 사용합니다.

    예를 들면 다음과 같습니다. 

    schedule: 2nd monday,thu
schedule: 1,8,15,22 of month 09:00
schedule: 1st mon,wednesday,thu of sep,oct,nov 17:00

  • [INTERVAL_SCOPE]: 지정된 [INTERVAL_VALUE]에 해당하는 절을 지정합니다. 커스텀 간격은 1년 중 한 달을 지정하거나 쉼표로 구분된 여러 달의 목록을 지정하는 of [MONTH] 절을 포함할 수 있습니다. 또한 작업을 실행할 특정 시간을 정의해야 합니다(예: of [MONTH] [HH:MM]).

    of 절이 제외되면 기본적으로 커스텀 간격은 매달 실행됩니다.

    • [MONTH]: 월은 쉼표로 구분된 목록으로 지정해야 하며 다음과 같은 긴 값 또는 축약된 값의 조합을 포함할 수 있습니다.
      • january 또는 jan
      • february 또는 feb
      • march 또는 mar
      • april 또는 apr
      • may
      • june 또는 jun
      • july 또는 jul
      • august 또는 aug
      • september 또는 sep
      • october 또는 oct
      • november 또는 nov
      • december 또는 dec
      • 1년의 모든 달을 지정하려면 month를 사용합니다.
    • [HH:MM]: 시간 값은 24시간 형식(HH:MM)으로 지정해야 합니다. 각 항목의 의미는 다음과 같습니다.
      • HH은 00부터 23까지의 정수입니다.
      • MM은 00부터 59까지의 정수입니다.

      • 예: 

      schedule: 1st monday of sep,oct,nov 09:00
schedule: 1 of jan,april,july,oct 00:00

커스텀 간격 예시
다음 예시를 살펴보면 커스텀 간격을 사용하는 작업 일정 정의 방법을 이해하는 데 도움이 됩니다.
  • 매일 00:00에 실행: 
    schedule: every day 00:00
  • 매주 월요일 09:00에 실행:
    schedule: every monday 09:00
  • 3월 두 번째 수요일 17:00에 한 번 실행:
    schedule: 2nd wednesday of march 17:00
  • 5월에 6번 실행. 처음 2주 동안 매주 월요일, 수요일, 금요일 10:00에 한 번 실행:
    schedule: 1st,second mon,wed,fri of may 10:00
  • 1주일에 한 번 실행. 매월 1일부터 7일마다 09:00에 한 번 실행: 
    schedule: 1,8,15,22 of month 09:00
  • 격주로 실행. 매월 첫 번째, 세 번째 월요일 04:00에 한 번 실행: 
    schedule: 1st,third monday of month 04:00
  • 매년 3번 실행. 9월, 10월, 11월의 첫 번째 월요일 09:00에 한 번 실행: 
    schedule: 1st monday of sep,oct,nov 09:00
  • 분기마다 한 번 실행. 1월, 4월, 7월, 10월의 1일 00:00에 1번 실행: 
    schedule: 1 of jan,april,july,oct 00:00

재시도 지정

크론 작업의 요청 핸들러가 200부터 299까지의 범위를 벗어나는 상태 코드를 반환하면 App Engine은 해당 작업이 실패한 것으로 간주합니다. 실패한 작업은 기본적으로 재시도되지 않습니다. 구성 파일에 retry_parameters 블록을 포함하면 실패한 작업을 재시도할 수 있습니다.

다음은 백오프가 처음 2.5초로 시작하여 매번 2배로 증가하며 5번까지 재시도하도록 구성된 크론 작업 1개를 포함하는 샘플 cron.yaml 파일입니다.

cron:
- description: "retry demo"
  url: /retry
  schedule: every 10 mins
  retry_parameters:
    job_retry_limit: 5
    min_backoff_seconds: 2.5
    max_doublings: 5

크론 재시도 구문

아래 표에 재시도 매개변수가 설명되어 있습니다.

요소 설명
job_retry_limit 실패한 크론 작업의 최대 재시도 횟수를 나타내는 정수입니다. 최솟값은 0이고 최댓값은 5입니다. job_age_limit를 함께 지정하면 이 값이 두 한도에 도달할 때까지 App Engine이 크론 작업을 다시 시도합니다. job_retry_limit의 기본값은 0입니다.
job_age_limit 실패한 크론 작업을 다시 시도하기 위한 시간 제한으로, 크론 작업이 처음 실행된 시점을 기준으로 측정됩니다. 숫자 뒤에 시간 단위를 붙인 값으로, 단위는 s(초), m(분), h(시간), d(일)입니다. 예를 들어 5d 값은 크론 작업의 실행을 처음 시도한 후 5일을 제한 시간으로 지정합니다. job_retry_limit를 함께 지정하면 이 값이 두 한도에 도달할 때까지 App Engine이 크론 작업을 다시 시도합니다.
min_backoff_seconds 크론 작업이 실패한 후 다시 시도하기 전에 대기할 최소 시간(초)입니다.
max_backoff_seconds 크론 작업이 실패한 후 다시 시도하기 전에 대기할 최대 시간(초)입니다.
max_doublings 실패한 크론 작업 재시도 사이의 간격이 두 배가 되는 최대 횟수입니다. 이 횟수 이후에는 증분 값이 상수가 됩니다. 이 상수는 2**(max_doublings - 1) * min_backoff입니다.

크론 요청 유효성 검사

크론 URL에 대한 요청이 다른 소스가 아닌 App Engine에서 발생한 것임을 확인해야 하는 경우가 있습니다. 이를 수행하려면 요청의 HTTP 헤더와 소스 IP 주소의 유효성을 검사하면 됩니다.

  • 크론 서비스의 요청에는 다음 HTTP 헤더가 포함됩니다.

    "X-Appengine-Cron": "true"

    이 헤더와 다른 헤더는 App Engine에서 내부적으로 설정됩니다. 클라이언트가 이러한 헤더를 전송하면 요청에서 삭제됩니다.

  • App Engine은 IP 주소 0.1.0.2에서 크론 요청을 보냅니다. 이전 gcloud 버전(326.0.0 이전)에서 생성된 크론 작업의 경우 0.1.0.1에서 크론 요청이 발생합니다.

자바 런타임의 경우 Jetty 또는 Tomcat에서는 이 검증을 필터에서 수행할 수 있습니다.

요청 시간 종료

크론 요청 제한 시간은 60분입니다.

환경 및 확장 유형별 요청 제한 시간에 대한 자세한 내용은 App Engine 환경 선택을 참조하세요.

크론 작업 업로드

크론 작업을 업로드하려면 cron.yaml을 다음 gcloud 명령어의 매개변수로 지정해야 합니다.

gcloud app deploy cron.yaml

크론 작업 삭제

모든 크론 작업을 삭제하려면 다음만 포함하도록 cron.yaml 파일을 변경합니다.

cron:

Google Cloud Console에서 크론 지원

Google Cloud 콘솔 크론 작업 페이지에서 예약된 크론 작업을 확인할 수 있습니다.

로그 페이지를 방문하여 크론 작업이 추가 또는 삭제된 시점을 확인할 수도 있습니다.