Simple way to fetch logs

[sebas77]

The unity support is demanding some logs and I am having a hard time to understand how to fetch them from a github action. I need these logs

Unity Editor Logs
Windows: %LOCALAPPDATA%\Unity\Editor\Editor.log
macOS: ~/Library/Logs/Unity/Editor.log
Linux: ~/.config/unity3d/Editor.log
Licensing Client Logs
Windows: %LOCALAPPDATA%\Unity\Unity.Licensing.Client.log
macOS: ~/Library/Logs/Unity/Unity.Licensing.Client.log
Linux: ~/.config/unity3d/Unity/Unity.Licensing.Client.log
Licensing Audits
Windows: %LOCALAPPDATA%\Unity\Unity.Entitlements.Audit.log
macOS: ~/Library/Logs/Unity/Unity.Entitlements.Audit.log
Linux: ~/.config/unity3d/Unity/Unity.Entitlements.Audit.log
Services Configuration
Windows: %PROGRAMDATA%\Unity\config\services-config.json
macOS: /Library/Application Support/Unity/config/services-config.json
Linux: /usr/share/unity3d/config/services-config.json

chatgpt is not helping and I couldn't find it in the documentation, help?

this is a self-hosted runner, it would be useful to have a way to fetch the log out of the box. even -logFile is not clear to me, I suppose I can use a local absolute path tho?

[webbertakken]

We could probably make a flag that outputs those files from builder action, since we now known the exact locations of where they are supposed to be :)

[sebas77]

Ok thanks meanwhile if you know how I could get them (I am not a docker expert) I could do some experiments, but it's not as important as before as I don't need the logs anymore Best Regards, *Sebastiano Mandalà*

…

On Thu, Oct 2, 2025, 11:41 Webber Takken ***@***.***> wrote: *webbertakken* left a comment (game-ci/unity-builder#740) <#740 (comment)> We could probably make a flag that outputs those files from builder action, since we now known the exact locations of where they are supposed to be :) — Reply to this email directly, view it on GitHub <#740 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHGZY3ZX2SSYAP3P3LCT7T3VT6L3AVCNFSM6AAAAACIBUJ7QCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTGNRQGQ2DOOBQGM> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[ChristianTellefsen]

Hi, Unity asked me exactly the same thing, in order to debug a license server issue. I could not find the files either, which makes sense if they do not exist 😅 !

So, as I understand it - currently there is no way to get the files, but in the future it might be possible?

[sebas77]

Christian, I explained the license issue in another issue, you need to specify the toolset as the default one doesn't work. Since game ci doesn't provide the option, I had to revert to local installation of unity Best Regards, *Sebastiano Mandalà*

…

On Tue, 21 Oct 2025, 09:11 Christian Tellefsen, ***@***.***> wrote: *ChristianTellefsen* left a comment (game-ci/unity-builder#740) <#740 (comment)> Hi, Unity asked me exactly the same thing. I could not find the files either. — Reply to this email directly, view it on GitHub <#740 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHGZY6KB5N6CWPKOIRKXKL3YXTEPAVCNFSM6AAAAACIBUJ7QCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTIMRVGMZTMOBUGM> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[ChristianTellefsen]

Christian, I explained the license issue in another issue, you need to specify the
toolset as the default one doesn't work. Since game ci doesn't provide the
option, I had to revert to local installation of unity

Best Regards,

Sebastiano Mandalà
…

Hi Sebastiano,

Unity tells me that they have an unresolved issue with the licensing client on the 6000.0 LTS stream. They would like me to send them the logs to help them debug. This is the issue:

Builds failing with the Error Code 404

Cheers,
Christian

[sebas77]

there is defo some issue ,but you cannot solve it with game-ci...

#739

if you have the problem 100%, it's due to the toolset issue that I explain in that t hread (badly, but I was investigating while writing)

if you have it randomly, then yes, it's unity issue

[frostebite]

You're correct that there's currently no built-in way to extract Unity's internal log files from the Docker container. This is a legitimate gap when Unity support requests these files for troubleshooting.

Current Workarounds

For self-hosted runners, you can collect these logs after the build completes by mounting the Unity directories and copying files out:

- name: Build with Unity
  uses: game-ci/unity-builder@v4
  with:
    targetPlatform: YourPlatform
    # ... your normal build parameters

- name: Collect Unity Logs (Linux)
  if: runner.os == 'Linux'
  run: |
    mkdir -p ./unity-logs
    docker run --rm -v $(pwd)/unity-logs:/logs your-unity-container \
      bash -c "cp -r /root/.config/unity3d /logs/ 2>/dev/null || true"

- name: Upload Unity Logs
  uses: actions/upload-artifact@v4
  with:
    name: unity-logs
    path: unity-logs/

This approach mounts a volume to copy Unity's internal files out of the container after the build.

Log File Locations

The logs you mentioned have these paths inside the Docker containers:

Linux containers:

• Unity Editor Logs: /root/.config/unity3d/Editor.log
• Licensing Client: /root/.config/unity3d/Unity/Unity.Licensing.Client.log
• Licensing Audits: /root/.config/unity3d/Unity/Unity.Entitlements.Audit.log
• Services Config: /usr/share/unity3d/config/services-config.json

Feature Request Status

@webbertakken already indicated that adding a parameter to automatically output these files would be useful. This would be similar to how other CI systems provide log collection features.

A potential solution would be a new parameter like collectUnityLogs: true that automatically copies these files to the GitHub workspace as artifacts.

This issue appears related to #739 where you're experiencing other Unity licensing/build issues. Unity support logs would indeed help diagnose whether the BuildTarget problem is related to licensing configuration.

[frostebite]

Hey @sebas77 — thanks for the report and the detailed list of paths. We've taken this on as a first-class feature, and it now ships across three layers of API surface. PRs:

PRs

• Orchestrator (primary): feat(logs): collect Unity diagnostic logs + live-tail (refs unity-builder#740) orchestrator#23 — UnityLogCollectorService + UnityLogTailService + a Logs facade for library consumers. Wired into the plugin lifecycle so collectUnityLogs: true Just Works in the GHA flow you already use.
• CLI: feat(cli): collectUnityLogs + streamUnityLogs flags (refs unity-builder#740) cli#48 — adds a discoverable game-ci logs command group (collect, tail, plus reserved pull / fetch) so you don't need to drive orchestrate for ad-hoc bundles.
• Documentation: docs: Unity diagnostic log collection (refs unity-builder#740) documentation#568 — full docs page (per-platform path table, sample manifest.json, sensitive-files guidance, multi-engine note).

Three ways to get the bundle

1. End-to-end during a CI build (the original ask)

- name: Build with Unity
  uses: game-ci/unity-builder@v4
  with:
    targetPlatform: StandaloneLinux64
    collectUnityLogs: true
    streamUnityLogs: true   # optional - tails Editor.log live in the GHA log

- name: Upload Unity diagnostic logs
  if: always()
  uses: actions/upload-artifact@v4
  with:
    name: unity-diagnostics
    path: ${{ github.workspace }}/Logs/UnityDiagnostics/

Result: a unity-diagnostics artifact with one folder per category plus a manifest.json describing what was found and what was missing on this runner. Attach to the Unity ticket.

2. Ad-hoc on a runner you can SSH into (no workflow edit, no re-run)

# on the self-hosted runner, after the failing job
game-ci logs collect --unityLogsOutputDir ./unity-support-bundle

# pick a subset
game-ci logs collect \
  --unityLogCategories editor-log,licensing-client,entitlements-audit,services-config \
  --unityLogsOutputDir ./unity-support-bundle

# live-tail Editor.log on a hung build
game-ci logs tail --streamUnityLogPaths /github/workspace/Builds/Logs/Editor.log

The collector reads the canonical Unity paths (%LOCALAPPDATA%\Unity\…, ~/.config/unity3d/…, ~/Library/Logs/Unity/…, /usr/share/unity3d/config/…) so as long as the runner still has the files Unity wrote during the failing build, you can grab them retroactively.

3. Programmatic (Node / TypeScript)

import { Logs } from '@game-ci/orchestrator';

const result = await Logs.collect({ outputDir: './unity-support-bundle' });
console.log(`${result.collected.length} items, manifest at ${result.manifestPath}`);

const tail = Logs.tail({ files: ['/github/workspace/Builds/Logs/Editor.log'] });
// ...later
tail.stop();

// Introspect categories (e.g. for a UI)
for (const def of Logs.categories()) {
  console.log(def.category, def.description, def.sensitive ?? false);
}

The underlying UnityLogCollectorService, UnityLogTailService, and UNITY_LOG_PATHS registry are also exported from @game-ci/orchestrator if you need fuller control.

What collectUnityLogs: true captures

Category	Files
editor-log / editor-prev-log	Editor.log, Editor-prev.log
licensing-client	Unity.Licensing.Client.log
entitlements-audit	Unity.Entitlements.Audit.log
services-config	services-config.json
unity-hub-info / unity-hub-error	info-log.json, error-log.json
editor-crash	Editor Crash / Crashes directory
build-report	Library/LastBuild.buildreport
bee-backend	Library/Bee/bee_backend.log
player-log	Player.log
test-results	TestResults/*.xml
il2cpp-output	Temp/StagingArea/Data/il2cppOutput/
project-version	ProjectSettings/ProjectVersion.txt
package-manifest	Packages/manifest.json + packages-lock.json
macos-crash-report	~/Library/Logs/DiagnosticReports/Unity-*.crash
windows-event-log	Get-WinEvent -ProviderName 'Unity' slice (200 lines)
license-file	Unity_lic.ulf (sensitive — opt-in only via unityLogsIncludeSensitive: true)

Linux, macOS, and Windows runners are all handled — the registry resolves $HOME, %LOCALAPPDATA%, %APPDATA%, %PROGRAMDATA%, %USERPROFILE%, and ~/Library/... per platform. Sensitive files (license .ulf) are excluded by default; opting in is one explicit flag (unityLogsIncludeSensitive: true) because publishing them as a public CI artifact is equivalent to publishing your seat.

On -logFile

You can pass an absolute path inside the Docker workspace mount (e.g. customParameters: "-logFile /github/workspace/Editor.log"), but with collectUnityLogs: true you don't need to wrangle -logFile manually — the orchestrator copies the canonical Unity location to the artifact directory regardless of where -logFile ends up.

Roadmap (follow-ups we're scoping)

• game-ci logs pull --providerStrategy <aws|k8s|ssh> — same collector, executed inside an active remote runner / pod / VM via the provider interface, so you don't have to SSH manually. The CLI subcommand is already wired (prints a friendly "not yet implemented, here's the workaround" message); the provider exec wiring is the follow-up PR.
• game-ci logs fetch --build-guid <id> — retroactive fetch for past orchestrator builds, by always persisting Logs/UnityDiagnostics/ to the orchestrator cache root (last N builds, opt-out flag).
• game-ci logs tail --build-guid <id> — live Editor.log stream against an in-flight remote build, reusing UnityLogTailService + provider exec.

Happy to help

• Drop your full workflow file in this thread once the PR lands and I'll review the wiring with you.
• If you'd like to test against the PR branch before merge, you can pin game-ci/unity-builder@v4 and add INPUT_COLLECTUNITYLOGS=true as an env var on the job — works without a release.
• Want a one-shot bundle from your self-hosted runner right now? Run game-ci logs collect against it — no workflow changes needed.
• If anything's missing from the category list above for your Unity support case, comment here and we'll roll it into the PR before merge.

CC @webbertakken — flagging for your review since you'd already greenlit the parameter in the earlier discussion.