Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added github bug report button and copy debug information button, Closes #2120 #3461

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

w00000dy
Copy link
Contributor

Hi!

This adds a Submit bug report button and Copy debug information button to the security settings at the bottom.
grafik

When you click on the button, it opens a new issue with the bug report template and the field What version of WLED? is already filled out. In the field Relevant log/trace output you can find debug information like this:

## Debug information ##

WLED version: 0.14.0 (build 2310130)
LEDs:
	Count: 144
	Power: 1111
	FPS: 5
	Max power: 2000
	Max segment: 32
UDP Port: 21324
WiFi:
	RSSI: -77
	Signal: 46
	Channel: 1
Architecture: esp32
Core version: v3.3.6-16-gcc5440f6a2
Free heap: 199124
Uptime: 221
Time: 2023-10-19, 00:51:42
Opt: 79
Brand: WLED
Product: FOSS
MAC Address: c8c9a3cb9f10
IP Address: 172.16.16.169

This is also the debug information you get when clicking on the Copy debug information button.

grafik

This closes #2120

@blazoncek
Copy link
Collaborator

I would prefer sending entire cfg.json and/or presets.json instead of parsed partial data.
Parsing adds quite a few bytes to total image size and may lack important information.

I'll let @Aircoookie decide.

@softhack007
Copy link
Collaborator

I would prefer sending entire cfg.json and/or presets.json instead of parsed partial data.

Agreed, cfg.json and pesets.json are needed in many cases to make a problem reproducible.

From the data proposed by @WoodyLetsCode, I think that architecture, core and heap (free heap?) could be useful. MAC adress and ip address however are very sensitive, and most user would not share them for good reason.

@softhack007 softhack007 added this to the 0.14.2 candidate milestone Nov 11, 2023
@w00000dy
Copy link
Contributor Author

I think you're right, it would be better sending entire cfg.json and presets.json.
Another thing I've just thought about: Should wledUiCfg from the localStorage also be sent?

And should I wait for @Aircoookie 's feedback or should I change it now?

@w00000dy
Copy link
Contributor Author

@blazoncek Since @Aircoookie is not responding, what do you think about just changing it to send the entire cfg.json and presets.json and then merging this pull request? If @Aircoookie does not like it that way, we can always change it later.

But in general, he should like this PR since he added #2120 to the 1.0.0 milestone.

@w00000dy w00000dy changed the base branch from main to 0_15 January 31, 2024 22:50
@w00000dy
Copy link
Contributor Author

w00000dy commented Feb 1, 2024

I ended up not sending presets.json because if you have 3-5 presets it is too much for GitHub:
Screenshot 2024-02-01 at 00-57-49 Bad request · GitHub

Now i trimmed it down to:

WLED version: 0.15.0-a0 (build 2401270)
Architecture: esp32
Core: v3.3.6-16-gcc5440f6a2
Free heap: 183648



cfg.json:
{"rev":[1,0],"vid":2401270, ...

@blazoncek blazoncek added the keep This issue will never become stale/closed automatically label May 21, 2024
@softhack007 softhack007 removed this from the 0.15.0-alpha candidate milestone Sep 29, 2024
@netmindz netmindz changed the base branch from 0_15 to main December 20, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion keep This issue will never become stale/closed automatically
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a github report feature
3 participants