Sending logs

You are reading the documentation for version 1.1.8. Go to the current version (1.2.0)

When a problem must be explained, the log usually contains the explanation. This page shows where to find the log and what to send with it.

Where the log is

C:Program FilesUltimate Playoutengineconfigobs-studiologs

There is one file for each session, with the date and time in its name. You need the file of the session in which the problem occurred. Send it before you restart the program many times, because the correct file is then harder to find.

What the log contains

The log contains everything the program did, in order:

  • Which modules were found, and which are active.
  • Which outputs were set up, on which device, and whether they started.
  • Every GO, with the cue, its type and its transition.
  • Warnings about files, devices and encoders.
  • If the window froze: where the program was waiting.

This is usually enough to answer the question, so nobody needs to reproduce the problem.

What to send with it

Send these four items. Collecting them takes about one minute:

SendWhere to find it
The log of the session with the problemThe folder above
The program version and the engine versionSettings → Info
What you saw, in your own words—
The time, to the minute if possible—

The time is more important than it seems, because with a time, the twenty relevant lines can be found in a file of thousands of lines.

What the log does not contain

The log does not contain your rundown or your media. If the question is about a specific list, also send the .playout file, which is only a few kilobytes.

The log does not contain passwords. Stream keys and the password for remote control are in the settings, and not in the log.

The log does contain file paths. These often include the Windows user name, so check the log before you post it in public.

The report after a crash

After the program closed unexpectedly, it asks at the next start whether you want to send a report to the developer. See it froze or closed unexpectedly. That report does not reach the person who supports your installation, so send the log to that person as well.

Before you send

If you can reproduce the problem, do so once more and write down the time. A log with a known time is more useful than three logs of similar sessions.

If you cannot reproduce the problem, send what you have. The line that shows which outputs started, and the GO lines around the time of the problem, are often enough.