Job history

Checking a job status

With the API

You can see the current job states of all datasources for the app myApp by calling the Jobs API:

curl -u USERNAME:PASSWORD http://proxy-url:6764/api/apps/myApp/jobs?type=datasource

If a job has never run, a Jobs API call returns the following:

[
  {
    "resource": "datasource:myDatasource",
    "enabled": true,
    "startedBy": "09765f1d-2f1c-4c3b-ba22-887e3886d8aa",
    "status": "ready",
    "extra": {}
  }
]

The value datasource:myDatasource indicates a datasource, myDatasource, is present. The line "status": "ready" indicates the current state of the job, which has never run.

After a job successfully completes, the following is returned:

[
  {
    "resource": "datasource:myDatasource",
    "enabled": true,
    "startedBy": "09765f1d-2f1c-4c3b-ba22-887e3886d8aa",
    "status": "success",
    "extra": {
      "counter.failed": 0,
      "counter.other.pipeline.in": 58242,
      "counter.stage.field-mapping::d3ebd921-6065-479e-9d45-0bfed819346b.processed": 58241,
      "counter.deleted": 0,
      "counter.stage.solr-dynamic-field-name-mapping::e6aa9c51-2867-40a0-97fd-34d909098a20.processed": 58241,
      "counter.new": 2268,
      "counter.output": 58241,
      "counter.other.pipeline.complete": 58242,
      "datasourceId": "myDatasource",
      "counter.input": 60435,
      "startTime": 1586298855843,
      "endTime": 1586299313433,
      "counter.skipped": 2194,
      "counter.stage.solr-index::01e1c561-0440-44b2-afb4-d6ff471f646c.processed": 58241,
      "counter.other.pipeline.out": 58242
    },
    "lastStartTime": "2020-04-07T22:34:15.852Z",
    "lastEndTime": "2020-04-07T22:41:59.271Z"
  }
]

To see the complete job history, use the following Jobs API call:

curl -u USERNAME:PASSWORD http://proxy-url:6764/api/jobs/datasource:myDatasource/history

The following is returned:

[
  {
    "resource": "datasource:myDatasource",
    "runId": "fXfKTQNSKM",
    "startTime": "2020-04-07T22:34:15.852Z",
    "endTime": "2020-04-07T22:41:59.271Z",
    "status": "success",
    "extra": {
      "counter.failed": 0,
      "counter.other.pipeline.in": 58242,
      "counter.stage.field-mapping::d3ebd921-6065-479e-9d45-0bfed819346b.processed": 58241,
      "counter.deleted": 0,
      "counter.stage.solr-dynamic-field-name-mapping::e6aa9c51-2867-40a0-97fd-34d909098a20.processed": 58241,
      "counter.new": 2268,
      "counter.output": 58241,
      "counter.other.pipeline.complete": 58242,
      "datasourceId": "myDatasource",
      "counter.input": 60435,
      "startTime": 1586298855843,
      "endTime": 1586299313433,
      "counter.skipped": 2194,
      "counter.stage.solr-index::01e1c561-0440-44b2-afb4-d6ff471f646c.processed": 58241,
      "counter.other.pipeline.out": 58242
    },
    "startedBy": "09765f1d-2f1c-4c3b-ba22-887e3886d8aa"
  },
  {
    "resource": "datasource:myDatasource",
    "runId": "XxrxochVOB",
    "startTime": "2020-04-07T20:06:25.819Z",
    "endTime": "2020-04-07T20:14:01.686Z",
    "status": "success",
    "extra": {
      "counter.failed": 0,
      "counter.other.pipeline.in": 59090,
      "counter.stage.field-mapping::d3ebd921-6065-479e-9d45-0bfed819346b.processed": 59089,
      "counter.deleted": 0,
      "counter.stage.solr-dynamic-field-name-mapping::e6aa9c51-2867-40a0-97fd-34d909098a20.processed": 59089,
      "counter.new": 2268,
      "counter.output": 59089,
      "counter.other.pipeline.complete": 59090,
      "datasourceId": "myDatasource",
      "counter.input": 61283,
      "startTime": 1586289985809,
      "endTime": 1586290440433,
      "counter.skipped": 2194,
      "counter.stage.solr-index::01e1c561-0440-44b2-afb4-d6ff471f646c.processed": 59089,
      "counter.other.pipeline.out": 59090
    },
    "startedBy": "09765f1d-2f1c-4c3b-ba22-887e3886d8aa"
  },
  {
    "resource": "datasource:myDatasource",
    "runId": "2jy3UemLTp",
    "startTime": "2020-04-07T19:23:39.576Z",
    "endTime": "2020-04-07T19:31:26.694Z",
    "status": "success",
    "extra": {
      "counter.failed": 0,
      "counter.other.pipeline.in": 58906,
      "counter.stage.field-mapping::d3ebd921-6065-479e-9d45-0bfed819346b.processed": 58905,
      "counter.deleted": 0,
      "counter.stage.solr-dynamic-field-name-mapping::e6aa9c51-2867-40a0-97fd-34d909098a20.processed": 58905,
      "counter.new": 2268,
      "counter.output": 58905,
      "counter.other.pipeline.complete": 58906,
      "datasourceId": "myDatasource",
      "counter.input": 61099,
      "startTime": 1586287419556,
      "endTime": 1586287883825,
      "counter.skipped": 2194,
      "counter.stage.solr-index::01e1c561-0440-44b2-afb4-d6ff471f646c.processed": 58905,
      "counter.other.pipeline.out": 58906
    },
    "startedBy": "09765f1d-2f1c-4c3b-ba22-887e3886d8aa"
  }
]

The section How does the Jobs API work? below gives additional details on how the Jobs API retrieves information from Lucidworks Search. See the Jobs API reference for more information.

Job history results field definitions

Job history counters vary between V1 (classic) connectors and V2 (plugin) connectors. V1 connectors use the counter.* prefix, while V2 connectors use different counter names without the prefix. To determine if a datasource uses a V1 or V2 connector, check the connectorType field in the job history response. V1 connectors use types like lucid.anda or lucid.fs. V2 connectors use types like lucidworks.*, such as lucidworks.file-upload or lucidworks.jdbc. V1 Connector Counters

Field	Definition
counter.deleted	Total number of documents deleted or removed from the Solr index.
counter.failed	Total number of documents not indexed due to failure. The errors are written to the log.
counter.input	Total number of fetched documents passed to the index pipeline.
counter.new	Total number of documents fetched for the first time.
counter.output	Documents successfully sent to the Fusion indexing pipeline.
counter.skipped	Total number of documents skipped due to rules such as max, min, and file size.
counter.other.pipeline.in	Total number of documents entering the index pipeline. This includes parsed items.
counter.other.pipeline.out	Total number of documents exiting the index pipeline.
counter.other.pipeline.complete	Total number of documents that completed processing in the pipeline.
endTime	Time the job concluded, aborted, or was manually stopped.
resource: datasource	Name of the datasource.
startTime	Time the job started.
status	Job status such as SUCCESS, RUNNING, or ABORTED.
runId	Unique identifier for the specific job run.
datasourceId	The datasource configuration ID.

V2 Connector Counters V2 connectors (Java SDK-based) use a different counter format with more granular metrics. In addition, V2 connectors may include additional connector-specific counters depending on the connector type and implementation.

Pro connectors use the same framework as V2 connectors. For more information, see What are Pro connectors?.

The following fields apply to V2 connectors and Pro connectors.

Field	Definition
fetch.request	Total number of fetch requests initiated by the connector.
fetch.plugin-response	Total number of fetch responses received from the connector plugin.
fetch.plugin-response.document	Total number of documents returned in fetch responses.
pipeline.in	Total number of documents entering the index pipeline.
pipeline.out	Total number of documents exiting the index pipeline.
pipeline.complete	Total number of documents that completed processing in the pipeline.
pipeline.stages.STAGE_ID.processed	Number of documents processed by a specific pipeline stage, where `STAGE_ID` is the stage identifier.
content-indexer.document.received.count	Total number of documents received by the content indexer.
content-indexer.completed.count	Total number of documents that completed indexing.
content-indexer.result.success.counter	Total number of documents successfully indexed.
start.request	Indicates the job start was requested.
start.plugin-response	Indicates the connector plugin acknowledged the start request.
stop.request	Indicates the job stop was requested.
stop.plugin-response	Indicates the connector plugin acknowledged the stop request.
endTime	Time the job concluded, aborted, or was manually stopped.
resource: datasource	Name of the datasource.
startTime	Time the job started.
state	Job state such as FINISHED, RUNNING, or ABORTED.
runId	Unique identifier for the specific job run.
configId	The datasource configuration ID.

The specific counters available in job history depend on the connector type, version, and configuration. Some connectors may provide additional metrics. Use the Connector Jobs API to inspect the actual counters for your datasource.

With the UI

In the Lucidworks Search UI, navigate to Indexing > Datasources. Click a datasource to open the datasource panel.

Note that the Last run start and Last run stop values are equivalent to the lastStartTime and lastEndTime values from the Jobs API call. (These values are only present if a job has been run at least once.)

Icon	Description
	The Run button opens a panel containing various run options and information.
	The Start button starts a job.
	The New Schedule button displays a dropdown with several scheduling options: ● cron. Schedule a job based on a Crontab expression. See Cron Trigger documentation for more info. ● interval. Schedule a job to run on an interval after a set starting point. For example, you can schedule a job to run every day at 1:00AM. Job schedule interval ● job_completion. Schedule a job to run after another job has completed. You can schedule the job to run if the job succeeds, fails, or regardless of the job’s success. Job schedule job_completion
	The Stop button stops a running job. This results in a status of `"status" : "aborted"`.
	The Job History button opens the Job History panel. Click one of the job entries to see additional details. Expand the job details for more information. Click Open Logs in Dashboard for complete information.
	The Clear Datasource removes documents from your collection that are indexed from that datasource. The job history will not be deleted.

In the job history panel, there is an icon on each datasource indicating its latest run history. The possible statuses are:

Icon	Description
	The job has been created but has not been run.
	The job is currently running. Depending on the number of documents being processed, the job can take a long time to complete. Stop the job with the Stop button.
	The job was completed successfully.
	The job was not able to successfully run. Expand the job details for more information. Click Open Logs in Dashboard for complete information.
	The job was manually stopped before it could finish.

The image above shows all possible job statuses.

How does the Jobs API work?

In Checking a job status with the API above, two Jobs API endpoints were used to call the datasource myDatasource:

myApp/jobs?type=datasource - Retrieves the current datasource job states for all datasources of a specified app. In this case, the app is specified as myApp.
You can also use type=spark to retrieve all Spark jobs and type=task for task jobs.
/jobs/datasource:myDatasource/history - Retrieves a specific object’s job history. In this case, the object type is a datasource, as selected with datasource:.
Datasources are not the only object type for jobs. There are also Spark jobs (spark:) and task jobs (task:).

Both of the API calls above send a request to Lucidworks Search’s API application, which serves the Jobs API. The API application contains two main components related to job history data, JobController and SolrJobHistoryStore.

The Job Controller

The Job Controller is responsible for getting any active job’s run status, if an active job is running. In the case of V1 connectors classic datasource jobs, it will reach out to Lucidworks Search’s connectors-classic application’s connectors API. When the API application calls the connectors-classic Jobs API, it will first use Zookeeper to identify the IP address of the connector-classic node that is assigned to this datasource, if one exists. When the connectors-classic node IP assigned to the job is identified, the API application will call out to the connectors-classic node via http://<connectors-node-ip>:8984/connectors/v1/connectors/jobs/myDatasource. The call reaches the component ConnectorsManagerController to query the job status of currently running jobs with the ID myDatasource.

Latest changes

UI tour

Index data

Query data

Metrics and analytics

Improve your queries

Administration

Developer documentation

Machine learning

Neural Hybrid Search

FAQs

Checking a job status

With the API

Job history results field definitions

With the UI

How does the Jobs API work?

The Job Controller

​Checking a job status

​With the API

​Job history results field definitions

​With the UI

​How does the Jobs API work?

​The Job Controller

Checking a job status

With the API

Job history results field definitions

With the UI

How does the Jobs API work?

The Job Controller