How to Interpret the Job Queue¶
When FOSSology scans a file (for licenses, copyrights, etc) it can take anywhere from milliseconds to days. So we have created a job scheduler to run your scan (aka analysis) in the background, then email you when it is done.
The job queue is your status window showing what uploads are currently being scanned, which scans have been completed, and if there are any errors. You don't need to look at this page unless you want to see the status/progress of your queued jobs, or if something goes wrong.
Accessing the Job Queue¶
To access the job queue, click on Jobs > My Recent Jobs in the main menu.
This displays a list of all your jobs from the past 4 weeks. A job can be in one of a set of color-coded states:
|Queued||The job has been queued, but not yet scheduled/run|
|Started||The job is currently running|
|Completed||The job has completed successfully|
|Blocked||The job has been blocked by a job upon which it depends|
|Failed||The job did not complete successfully|
For example, here is a single job with a series of scans that have been queued because a user uploaded Cherokee version 1.2.101.
Scan 125 is the wget agent, responsible for retrieving the project's source code via the world wide web, and has finished.
Scan 126, the unpack agent, is responsible for unpacking the source code. Clearly, it cannot run until the wget agent has completed and downloaded the source code into the FOSSology repository. This relationship is indicated in the left-hand most column, which lists the scan number (126) followed by a slash, followed by the scan number it depends on (125). In cases where a scan has no dependency, only the scan number itself is listed.
The other scans (127-131) are other agents that are queued up but have yet to start. They will begin as soon as the unpack agent completes. They can be paused or canceled by selecting the links to the right of the table.
Clicking on the Jobs -> My Recent Jobs tab will refresh the job status page. Or simply click on your browser's refresh button.
Now a few moments have passed and the rest of the jobs originally seen in the Summary have run and completed.
Viewing detailed job information¶
By clicking on the scan number link in the Job/Dependency column, a more detailed view of the jobs can be seen:
In this case, the adj2nest agent (a special agent creating database links and unrelated to the information like licenses that you typically look for) has run on Cherokee 1.2.101. The detailed scan listing (aka Geeky Scan Details) shows additional information about this scan:
- jq_pk: The database id of the scan information in the job queue.
- job_pk: The database id of the job.
- Job|Agent Name: The name of the scan that helps identify which agent(s) are used.
- Queued: The time (in Hours:Minutes:Seconds) the job was received and put in the queue by the scheduler.
- Started: The time (in Hours:Minutes:Seconds) the job was started by the scheduler.
- Ended: The time (in Hours:Minutes:Seconds) the job was completed.
- Elapsed: The elapsed time (difference between Ended and Started).
- Status: Whether the job completed successfully or failed.
- Number of items processed: Most agents will report the number of files scanned as they are processing. So this number will be increasing until the scan is done.
- Submitter: name of the user who submitted the source code for analysis.
- Upload: The database id of the upload.
- Log: What the agent logged during the scan. This is where you will see any errors. Typically, with no errors, this will be blank. However, in the example above, debugging was turned on so even though adj2nest completed without errors, information is logged.
Unless a scan failed, which you can see on the main "Show Jobs" page, or you are just curious, or debugging, there is no reason to look at the Geeky Scan Details. If the job failed, then you would want to look at the reason why in the scan details log.