Checking Job State

When there’s an issue with a Gobblin job to troubleshoot, it is often helpful to check the state of the job persisted in the state store. Gobblin provides a tool `gobblin-dist/bin/statestore-checker.sh’ for checking job states. The tool print job state(s) as a Json document that are easily readable. The usage of the tool is as follows:

  1. usage: statestore-checker.sh
  2.  -a,--all                                  Whether to convert all past job
  3.                                            states of the given job
  4.  -i,--id <gobblin job id>                  Gobblin job id
  5.  -kc,--keepConfig                          Whether to keep all
  6.                                            configuration properties
  7.  -n,--name <gobblin job name>              Gobblin job name
  8.  -u,--storeurl <gobblin state store URL>   Gobblin state store root path
  9.                                            URL

For example, assume that the state store is located at file://gobblin/state-store/, to check the job state of the most recent run of a job named “Foo”, run the following command:

  1. statestore-checker.sh -u file://gobblin/state-store/ -n Foo

To check the job state of a particular run (say, with job ID job_Foo_123456) of job “Foo”, run the following command:

  1. statestore-checker.sh -u file://gobblin/state-store/ -n Foo -i job_Foo_123456

To check the job states of all past runs of job “Foo”, run the following command:

  1. statestore-checker.sh -u file://gobblin/state-store/ -n Foo -a

To include job configuration in the output Json document, add option -kc or --keepConfig in the command.

A sample output Json document is as follows:

  1. {
  2.     "job name": "GobblinMRTest",
  3.     "job id": "job_GobblinMRTest_1425622600239",
  4.     "job state": "COMMITTED",
  5.     "start time": 1425622600240,
  6.     "end time": 1425622601326,
  7.     "duration": 1086,
  8.     "tasks": 4,
  9.     "completed tasks": 4,
  10.     "task states": [
  11.         {
  12.             "task id": "task_GobblinMRTest_1425622600239_3",
  13.             "task state": "COMMITTED",
  14.             "start time": 1425622600383,
  15.             "end time": 1425622600395,
  16.             "duration": 12,
  17.             "high watermark": -1,
  18.             "retry count": 0
  19.         },
  20.         {
  21.             "task id": "task_GobblinMRTest_1425622600239_2",
  22.             "task state": "COMMITTED",
  23.             "start time": 1425622600354,
  24.             "end time": 1425622600374,
  25.             "duration": 20,
  26.             "high watermark": -1,
  27.             "retry count": 0
  28.         },
  29.         {
  30.             "task id": "task_GobblinMRTest_1425622600239_1",
  31.             "task state": "COMMITTED",
  32.             "start time": 1425622600325,
  33.             "end time": 1425622600344,
  34.             "duration": 19,
  35.             "high watermark": -1,
  36.             "retry count": 0
  37.         },
  38.         {
  39.             "task id": "task_GobblinMRTest_1425622600239_0",
  40.             "task state": "COMMITTED",
  41.             "start time": 1425622600405,
  42.             "end time": 1425622600421,
  43.             "duration": 16,
  44.             "high watermark": -1,
  45.             "retry count": 0
  46.         }
  47.     ]
  48. }