Self test

The Vidispine self test will generate a brief report about the system infrastructure for simple troubleshooting.

Tests

The tests are:

api - The API test. Verifies both api and apinoauth resources.
solr - Verifies the Solr configuration.
database - Verifies that the database can be reached.
transcoder - Verifies that the transcoder can be reached.
jms - Verifies that the JMS queues are well configured.
tools - Verify the existence of various external tools.
simplejob - Verifies that the transcoder can execute a simple transcode job.
thumbnail - Verifies the thumbnail configuration.
dbstats - Returns some statistics from the database schema.
ldap - Verifies the LDAP configuration.
fileaccesstest - Verifies write access of application server files.
cluster - Verifies the status of cluster instances and lists its members.

Test results

There are four possible outcomes of a test:

OK Vidispine is well configured and running properly.
Warning Some configuration is not valid.
Failed There are tools missing, which could lead to failures of some functions.
Critical Important configuration or tools are missing or invalid, Vidispine will not run properly.

Running the test

Running the tests can take a while, depending on the size of the system. The dbstats is typically the slowest as it examines the number of rows in the database among other things. Hence, it sometimes can be beneficial to only run certain specific tests.

Use the self test resource to execute the tests. For example:

GET API/selftest

<SelfTestDocument xmlns="http://xml.vidispine.com/schema/vidispine" status="failed" took="38170ms">
  <test name="api" status="warning" took="408ms">
    <test name="adminApi" status="warning">
      <message>API is 4.2</message>
      <message>Transcoder VX-1 is ERROR: Could not connect</message>
      <message>Transcoder VX-2 is 4.1.4-gea8cc32-12511</message>
    </test>
    <test name="apiNoAuth" status="ok">
      <message>Base uri: http://localhost:8089/</message>
    </test>
  </test>
  ...
</SelfTestDocument>

Error log report

The error log report is used to collect information about the Vidispine installation, and contains information about certain jobs or items. A log report should always be included if you encounter an issue that you wish to report to us .

Usage

This tool is located at [your server]:8080/LogReport. After filling in all the information, press Extract and collect logs and wait while the system extract the needed logs; this might take a while. Then press on ‘Save report’ and save the created .zip-file on your computer. Then send this file to your Vidispine reseller.

Required fields

Error report informationThis is where you describe your problem. Be specific on what the problem is, what you did when it appeared.Time spanWhat time did the error occurred? Set start time and end timeCredentialsYour Vidispine user-name and passwordOptional fieldsFill in this information if any is applicable on the particular problem you are having..Job-IDThe id of the job that failed, if applicable to the issue.Item-IDThe id of the item that the issue relates to, if applicable.Storage-IDThe id of the storage that the issue relates to, if applicable.UserName of the Vidispine user that was used when this problem occurred.

Programmatically retrieving log files

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

For example, to retrieve a log report for a specific job:

GET API/vidispine-logs?job=VX-32&comment=Incorrect%20aspect%20ratio%20of%20transcoded%20image
Accept: application/zip

200 OK
Content-Type: application/zip
Transfer-Encoding: chunked

...

Customer Knowledge Base

Troubleshooting and Obtaining Information [VC 5.6 INT]

Analytics