checks: Add various detections specific to Linux #161

mihawk90 · 2024-05-31T16:25:21Z

Description

This adds various detections aimed at helping us in linux-support to provide help quicker without having to dive deep into the log with every user. This should cover the most of the common questions and issues, and the myriad of possible combinations encountered on Discord.

Changes in detail:

renamed wayland.py to linux.py since this isn't just for Wayland anymore
moved the snap detection merged in core: Add Detection of unofficial Snap Package #137 to linux.py
for X11 vs. Wayland
- useful for advice on the various capture methods
- CRITICAL XWayland was already logged
- INFO Wayland was previously already detected, but not logged
- INFO X11 Logging + recommended captures
- WARNING Also logs PipeWire capture sources being used on X11. Currently this is only relevant for very recent GNOME versions and for recent(-ish) KDE versions. KDE doesn't actually support this either, but still advertises availability.
- CRITICAL On Wayland this also logs when no PipeWire captures are available
INFO Log usage of the Flatpak package
- helps to know this is an official package and is also relevant for plugin installation
INFO Distro + Version if available (unfortunately not on Flatpak)
- useful to advise on package managers and names for xdg-desktop-portals or plugin packages
INFO Desktop Environment
- useful for xdg-desktop-portals and the various limitations of specific DEs
INFO Missing default plugins
- currently checks for Browser, VLC, and WebSocket but can easily be extended if need be
- while AJA and BlackMagic plugins are technically a default functionality, these are essentially never asked for so I didn't see much reason to include them
INFO Missing v4l2loopback module for VCam functionality

Motivation and Context

The current lack of output by the OBS Bot requires us to manually check for the same information on every log we are getting in linux-support. The detections and help texts (suggestions welcome!) should give users some pointers to help themselves when there is currently no supporter around (since linux-support isn't as frequented as the others). Obviously it also helps supporters to give faster responses without having to check every log manually.

Of course Linux has an inherent multitude of possible setups, which I tried to cover as best as possible without checking for every eventuality. It should cover the most frequent issues and questions collected over quite some time.

How Has This Been Tested?

Grabbed a random assortment of logs from the Discord:

#!/bin/bash

echo "===== Snap ====="
./loganalyzer.py --url "https://obsproject.com/logs/a8VNcRHD4vjHol3P"

echo "===== Flatpak ====="
./loganalyzer.py --url "https://obsproject.com/logs/MXdrIL75xKFyPNom"

echo "===== Wayland ====="
./loganalyzer.py --url "https://obsproject.com/logs/MXdrIL75xKFyPNom"

echo "===== XWayland ====="
./loganalyzer.py --url "https://obsproject.com/logs/1FaZYJAAwOsKvUxX"

echo "===== Wayland + no pipewire ====="
./loganalyzer.py --url "https://obsproject.com/logs/CN9BBx9uPPjBcGlA"

echo "===== X11 ====="
./loganalyzer.py --url "https://obsproject.com/logs/jBUCYqPE5LRHMRHB"

echo "===== X11 + PipeWire sources ====="
./loganalyzer.py --url "https://obsproject.com/logs/MQhnzM1TFjBgdxrO"

Types of changes

New feature (non-breaking change which adds functionality)
Tweak (non-breaking change to improve existing functionality)
Documentation (a change to documentation pages)

Checklist:

My code has been run through clang-format.
I have read the contributing document.
My code is not on the master branch.
The code has been tested.
All commit messages are properly formatted and commits squashed where appropriate.
I have included updates to all appropriate documentation.

RytoEX

If a commit changes one file in checks/, the commit prefix is that file's name without the file extension.

Always capitalize the first word in the commit message subject after the prefix.

I don't use Linux, so I'll probably need someone else to comment on the substance of the changes themselves.

mihawk90 · 2024-06-08T07:05:12Z

Fixed up.

Also added a note regarding the missing default plugins in OP.

Edit:
Adjusted some wording in the PipeWire Source detection to make it more consistent.
Wondering if I should add a note on game captures too though?

mihawk90 · 2024-06-08T20:47:56Z

Adjustments for unified PipeWire source in 30.2:

Added new pipewire-screen-capture-source detection
renamed "Screen Capture" to "Display Capture" throughout the help texts

For the Wayland logging, I already put a note in there that Global Hotkeys won't work, would it make sense to add Browser docks to that note as well?

mihawk90 · 2024-09-10T02:35:03Z

Rebased to current master to keep it up to date.

Groundwork for future linux-specific checks similar to the Windows and MacOS specific checks.

mihawk90 · 2024-11-21T23:45:01Z

Rebased to current master and also fixed the name for the VLC plugin being wrong.

RytoEX · 2024-11-22T21:21:10Z

I still need someone familiar with Linux or Linux support to give some insight here.

checks/linux.py

RytoEX · 2024-11-22T21:42:49Z

checks/linux.py

+    if len(hasV4L2Module) > 0:
+        return [LEVEL_INFO, "VCam not available",
+                """Using the Virtual Camera requires the <code>v4l2loopback</code> kernel module to be installed.<br>
+                If required, please refer to our <a href="https://github.com/obsproject/obs-studio/wiki/install-instructions#prerequisites-for-all-versions">Install Instructions</a> on how to install this on your distribution.<br>


Perhaps we should link to https://obsproject.com/kb/virtual-camera-troubleshooting instead (which also links to https://github.com/obsproject/obs-studio/wiki/install-instructions#prerequisites-for-all-versions).

I figured the KB page doesn't really have useful information to actually get it running, so I linked to the Install Instructions instead to save a round trip.

I don't really mind either way, just figured going to the instructions directly is faster.

I don't have a strong opinion. This is better than no message.

checks/linux.py

Penwy

Besides the use of split and indices, I agree with all additions and can speak to their usefulness for linux support.

checks/linux.py

kkartaltepe · 2024-11-23T16:40:52Z

overall its fine, im not sure I agree with trying to explain which captures to use on your platform for every log uploaded but we can always change it later if it becomes distracting to users.

tiberium-v · 2024-11-23T17:24:45Z

I think also they are useful. Also I have the feeling that we have more user in #linux-support, they don't like to follow the instructions for uploading the log and paste it via pastebin or co in. For me, who is sometimes on mobile, it is a pain to access it. So a more verbose log analyzer output is here helpful.

In general, I have the feeling, that the windows side has always more useful information in the analyzer output. Like the windows version/build. So the additions here with info about the linux distro/flatpak and which Display-Server is running is on my side welcome as someone who give support there.

PS: And the possibility that users getting more info's, how a problem can be fixed by their own, is also a good thing.

RytoEX · 2024-11-23T20:36:08Z

overall its fine, im not sure I agree with trying to explain which captures to use on your platform for every log uploaded but we can always change it later if it becomes distracting to users.

That was the point I was trying to make in this review thread.

mihawk90 · 2024-12-10T07:45:16Z

Since there were no objections to the altered wording in the review thread above I went ahead and pushed it.

Let me know if you want further changes 😄

RytoEX · 2024-12-10T20:43:49Z

Can someone provide sample logs that would cause the INFO Wayland and INFO X11 items to be emitted?

I am tempted to ask that we remove the INFO Wayland and INFO X11 items from this PR so we can land everything else, and then we can consider those two INFO items in a separate PR.

checks/linux.py

mihawk90 · 2024-12-11T01:06:45Z

Can someone provide sample logs that would cause the INFO Wayland and INFO X11 items to be emitted?

Log examples are in the PR description, although pretty much all of them should emit it.
There are situations where neither one is logged but that is typically down to misconfigured desktop environments (at which point the info missing is already a hint that something is wrong).

I am tempted to ask that we remove the INFO Wayland and INFO X11 items from this PR so we can land everything else, and then we can consider those two INFO items in a separate PR.

I'm not opposed to removing one or both of the helptexts, however I would strongly advocate for keeping the bullet point itself. This is one of the things we need to check in almost every log, so having it in OBS bot's response on Discord would be a major time-saver. For most questions/issues users come into the support chat for the answer depends on whether the user is running on X11 or Wayland. It was one of the things that kicked off this PR in the first place.

tiberium-v · 2024-12-12T09:05:22Z

Can someone provide sample logs that would cause the INFO Wayland and INFO X11 items to be emitted?

I am tempted to ask that we remove the INFO Wayland and INFO X11 items from this PR so we can land everything else, and then we can consider those two INFO items in a separate PR.

If it is okay for my perspective, helping in #linux-support:
The Info a user is on Wayland or X11 is one of the most important from all. When a User asks why they don't see the connecting account button or why the hotkeys are only working when the obs window is in focus, why there is no window capture (on wayland the display and window capture source are combined, on x11 are separated)

Almost every log, I scan the log for two/three things: The build name of obs, sometimes the Distroname if the build name doesn't give me a clear answer (both to check if it is the official package) and if the session type is X11 or wayland.

We had also sometimes user, they know the difference but didn't realize that their session was changed to wayland. Especial on new Ubuntu versions, when they want the newest version, but the update path is not released from Canonical, they do a fresh install and forget, that ubuntu goes default to wayland on a fresh installation.

Since the feature set is quite different in X11 vs wayland and will be for the next couple of years, I think the info is in the log analyzer quite important.

mihawk90 · 2024-12-13T23:54:47Z

Removed the helptexts for now. If we decide we want them back we can just revert ~~03a2708~~ 7a9865a.

As noted above, I'm leaving the bulletpoints in as the display server is crucial information in linux-support.

Fenrirthviti

Added some verbiage changes and my opinion on the vcam stuff.

checks/linux.py

RytoEX requested changes Jun 8, 2024

View reviewed changes

mihawk90 force-pushed the linux-detections branch from 1642751 to 49891e9 Compare June 8, 2024 07:03

mihawk90 force-pushed the linux-detections branch 6 times, most recently from 2bdb5d6 to aa89b4d Compare June 8, 2024 20:46

mihawk90 force-pushed the linux-detections branch from aa89b4d to 80378f0 Compare September 10, 2024 02:32

checks: Rename wayland.py to linux.py

6d34839

Groundwork for future linux-specific checks similar to the Windows and MacOS specific checks.

mihawk90 force-pushed the linux-detections branch from 80378f0 to 823e84b Compare November 21, 2024 23:43

RytoEX requested changes Nov 22, 2024

View reviewed changes

mihawk90 force-pushed the linux-detections branch from 823e84b to f92ef0f Compare November 22, 2024 22:15

Penwy reviewed Nov 22, 2024

View reviewed changes

checks/linux.py Outdated Show resolved Hide resolved

checks/linux.py Outdated Show resolved Hide resolved

mihawk90 force-pushed the linux-detections branch 3 times, most recently from 9f35c5c to a169dc9 Compare November 23, 2024 00:24

mihawk90 force-pushed the linux-detections branch from a169dc9 to be1fcbe Compare December 10, 2024 07:43

RytoEX requested changes Dec 10, 2024

View reviewed changes

checks/linux.py Outdated Show resolved Hide resolved

mihawk90 force-pushed the linux-detections branch from be1fcbe to 615076a Compare December 11, 2024 01:25

mihawk90 force-pushed the linux-detections branch from 00ade95 to 03a2708 Compare December 13, 2024 23:53

Fenrirthviti requested changes Dec 27, 2024

View reviewed changes

checks/linux.py Outdated Show resolved Hide resolved

checks/linux.py Outdated Show resolved Hide resolved

checks/linux.py Outdated Show resolved Hide resolved

checks/linux.py Outdated Show resolved Hide resolved

checks/linux.py Outdated Show resolved Hide resolved

mihawk90 added 8 commits December 27, 2024 04:43

linux: Move Snap package detection from core

f1fdcc8

linux: Log Wayland usage

fd82f59

linux: Log Flatpak usage

256b972

linux: Detect unavailable PipeWire captures

2f75e0e

linux: Detect PipeWire capture sources under X11

aa6e148

linux: Log Distro info

8aa8db9

linux: Log Desktop Environment info

8feff3f

linux: List and count missing default plugins

13d68e8

mihawk90 force-pushed the linux-detections branch from 03a2708 to 6b4749d Compare December 27, 2024 04:02

mihawk90 added 3 commits December 27, 2024 05:17

linux: Detect unavailable Virtual Cam

c50a0a6

linux: Fix potential IndexError issues

da54405

linux: Remove helptexts for X11 and Wayland

7a9865a

mihawk90 force-pushed the linux-detections branch from 6b4749d to 7a9865a Compare December 27, 2024 04:17

Fenrirthviti approved these changes Dec 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

checks: Add various detections specific to Linux #161

checks: Add various detections specific to Linux #161

mihawk90 commented May 31, 2024 •

edited

Loading

RytoEX left a comment

mihawk90 commented Jun 8, 2024 •

edited

Loading

mihawk90 commented Jun 8, 2024 •

edited

Loading

mihawk90 commented Sep 10, 2024

mihawk90 commented Nov 21, 2024

RytoEX commented Nov 22, 2024

RytoEX Nov 22, 2024

mihawk90 Nov 22, 2024

RytoEX Nov 23, 2024

Penwy left a comment

kkartaltepe commented Nov 23, 2024

tiberium-v commented Nov 23, 2024 •

edited

Loading

RytoEX commented Nov 23, 2024

mihawk90 commented Dec 10, 2024

RytoEX commented Dec 10, 2024

mihawk90 commented Dec 11, 2024 •

edited

Loading

tiberium-v commented Dec 12, 2024

mihawk90 commented Dec 13, 2024 •

edited

Loading

Fenrirthviti left a comment

checks: Add various detections specific to Linux #161

Are you sure you want to change the base?

checks: Add various detections specific to Linux #161

Conversation

mihawk90 commented May 31, 2024 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

RytoEX left a comment

Choose a reason for hiding this comment

mihawk90 commented Jun 8, 2024 • edited Loading

mihawk90 commented Jun 8, 2024 • edited Loading

mihawk90 commented Sep 10, 2024

mihawk90 commented Nov 21, 2024

RytoEX commented Nov 22, 2024

RytoEX Nov 22, 2024

Choose a reason for hiding this comment

mihawk90 Nov 22, 2024

Choose a reason for hiding this comment

RytoEX Nov 23, 2024

Choose a reason for hiding this comment

Penwy left a comment

Choose a reason for hiding this comment

kkartaltepe commented Nov 23, 2024

tiberium-v commented Nov 23, 2024 • edited Loading

RytoEX commented Nov 23, 2024

mihawk90 commented Dec 10, 2024

RytoEX commented Dec 10, 2024

mihawk90 commented Dec 11, 2024 • edited Loading

tiberium-v commented Dec 12, 2024

mihawk90 commented Dec 13, 2024 • edited Loading

Fenrirthviti left a comment

Choose a reason for hiding this comment

mihawk90 commented May 31, 2024 •

edited

Loading

mihawk90 commented Jun 8, 2024 •

edited

Loading

mihawk90 commented Jun 8, 2024 •

edited

Loading

tiberium-v commented Nov 23, 2024 •

edited

Loading

mihawk90 commented Dec 11, 2024 •

edited

Loading

mihawk90 commented Dec 13, 2024 •

edited

Loading