Vidispine logs

Extract logs from the system.

Retrieving log files

If your application has a custom form for reporting issues then you can collect the log files using the vidispine-logs resource.

Retrieve log files

GET /vidispine-logs

Retrieves a zip file with the various service log files.

Query Parameters:
 
  • starttime (string) – Required. ISO 8601 start time of time span.
  • endtime (string) – Required. ISO 8601 end time of time span.
  • comment (string) – Detailed description of what the problem is, to be written in zip file.
  • user (string) – Comma-separated list of user names to retrieve information about.
  • storage (string) – Comma-separated list of storage ids to retrieve information about.
  • item (string) – Comma-separated list of item ids to retrieve information about.
  • job (string) – Comma-separated list of job ids to retrieve information about.
  • selftest (boolean) – If true, includes the result of a self-test. Default is false.
Produces:
  • application/zip – A zip file with various log files collated.
  • multipart/form-data , multipart/mixed

    A multi-part response, with parts:

    • zip Containing the zip file.
    • message-text Containing CRLF-separated list of warnings.
    • message-json Containing JSON array list of warnings.

Log retrieval jobs

Instead of a synchronous call, Vidispine can also start a pseudo-job that creates the log report in the background. This is not a real Vidispine job, so there are no priorities, notifications, etc.

In case of a restart of Vidispine, the job is aborted. Finished jobs are stored in a temporary location, however.

Start a log report job

POST /vidispine-logs/job

Starts a log report job that collects service log files into a zip file.

Query Parameters:
 
  • starttime (string) – Required. ISO 8601 start time of time span.
  • endtime (string) – Required. ISO 8601 end time of time span.
  • comment (string) – Detailed description of what the problem is, to be written in zip file.
  • user (string) – Comma-separated list of user names to retrieve information about.
  • storage (string) – Comma-separated list of storage ids to retrieve information about.
  • item (string) – Comma-separated list of item ids to retrieve information about.
  • job (string) – Comma-separated list of job ids to retrieve information about.
  • selftest (boolean) – If true, includes the result of a self-test. Default is false.
Produces:
  • application/xml, application/json – A JobDocument that describes the job.

List all log report jobs

GET /vidispine-logs/job

Return information about all jobs that have not expired.

Produces:

Retrieve a log report job

GET /vidispine-logs/job/(job-id)

Return information about specified job.

Produces:

Retrieve job result

GET /APInoauth/vidispine-logs/job/(job-id).zip

Returns the zip file generated by a finished job.

Delete a log report job

DELETE /vidispine-logs/job/(job-id)

Deletes a job and the report created.

Upload of logs to Vidispine

If a log has been created by a job, Vidispine can upload it to vidispine.com. In addition, source files referenced by items entered in the log report can be attached. This is a two-phase operation, first query the API of what files there are, then start the job.

Status of upload is included in the log report job, see above.

Retrieve files in job

GET /vidispine-logs/job/(job-id)/uri

Return file information about specified job.

Produces:
  • application/json – An array of objects with keys name, displayUri, uri, and size.

Start an upload

POST /vidispine-logs/job/(job-id)/upload

Starts upload.

Accepts:
  • application/xml, application/json – A URIListDocument with URIs from the list of files in the log.

Abort an upload

DELETE /vidispine-logs/job/(job-id)/upload

Aborts upload process.