Knowledge Base Administration Guide

Live Job Tracking

Live Jobs are an optional feature in Simscope, which enable tracking of in-progress (ie running) jobs, by publishing Live Job JSON objects.

  • This can be a pending simulation, build, etc.

For example, a Live Job can indicate a simulation has started on a specific hostname, with a configuration.

  • Then this job can either turn into a pass or a fail, once it completes.

Live Job details

Purpose / Use Cases

The main usage of Live jobs is to answer the questions:

  • Which jobs are remaining in this Regression?
  • Which host machine is my build running on?
  • How long has my test been running?

→ Live jobs will show a list of the remaining jobs within each regression automatically.

Example Live Jobs within a Regression

This example shows a Regression with 1 Live job:

Regression Live Job

If you click on a Live Job in the table, it will show its details.

JSON: Live Job Indicator

Live jobs are indicated by "result": "live" field.

NOTE: Live jobs should not have a fail message, compute time, runtime, or cycle count (since the job has not finished).

After the job finishes, you can publish a Job Finish JSON (either pass or fail), and Simscope will: . Remove the Live JSON record. . Replace with a Finished JSON record.

Admin: Enable Live Job tracking in Simscope server

By default, Simscope does not enable live job tracking. To enable in the Simscope server, add the following to your simscope.config file:

[sigs]
# Enable "live" job tracking in Simscope
# > https://admin-docs.simscope.com/job/job-live-json.html
enablelivejobs = true

# If Live Jobs are enabled and regressions time out or finish with live jobs pending, migrate them to this fail signature.
# (Note: this also requires enablelivejobs = true)
livetimeoutsignature = "LIVE Job Timeout or Missing"