How to create debug logs - oe-mirrors/e2iplayer GitHub Wiki

How to create debug logs in E2iPlayer

When something doesn't work (a host shows no list, a video won't play, a download fails), the E2iPlayer debug log shows what happened. Please attach it to every bug report.

Quick version:

  1. Turn on Debug logs → "Yes, to file ..." in the E2iPlayer settings (category Debug Configuration).
  2. Reproduce the problem without restarting E2iPlayer in between.
  3. Get the log through the web interface (http://<box-ip>/iptvplayer/logs → Download log file), the Info screen (BLUE → Info → page Log → GREEN Save) or via FTP.
  4. Attach it to your GitHub issue or your forum post.

⚠️ By default the log file is cleared every time E2iPlayer starts. If you close and reopen E2iPlayer after the error, the log of the error is gone. Either save the log first, or switch off Clear the log file at plugin start (see below).


1. Enable the debug log

1. Open the E2iPlayer settings: press MENU on the E2iPlayer home screen.

screenshot_20250824171147

2. Open the last category, Debug Configuration (the settings open in the category view by default). (With Settings screen layout set to Long list, scroll all the way down to the last section, ----- DEBUG CONFIGURATION -----. Or press BLUE (Search) and type debug.)

3. Set Debug logs to one of the file options:

Option What it does
No No debug output at all (default).
Yes, to console Output goes to the enigma2 console / enigma2 debug log only. No E2iPlayer log file is written, so the Info screen and the web interface have nothing to show. Only useful for developers watching the console via telnet/SSH.
Yes, to file /hdd/iptv.dbg Log file on the hard disk / main storage. Recommended when your box has an HDD, USB stick or other storage mounted at /hdd.
Yes, to file /tmp/iptv.dbg Log file in RAM. Works on every box, even without storage, but the file is lost on reboot and a big log uses RAM. Good for a quick test.
Yes, to file /home/root/logs/iptv.dbg Log file in the flash memory, next to the enigma2 logs. Survives a reboot, but keep it small on boxes with little flash (use Maximum log file size).

screenshot_20250824171650

4. As soon as a file option is selected, more options appear below it. They are all explained in the section Debug options explained. For a normal bug report the defaults are fine.

5. Press the GREEN button Save.

6. Leave the settings and do everything needed to reproduce your problem (open the host, the category, start the video, …).


2. Get the log file

There are three ways. Use whichever is easiest for you.

a) Web interface (easiest, no FTP needed)

Needs the WebInterface / OpenWebif plugin on your box (installed on almost every image).

  1. On your PC, open http://<box-ip>/iptvplayer/logs in a browser, or open http://<box-ip>/iptvplayer and click Logs.
  2. The page shows the last 1000 lines of the log and its current size.
  3. Click Download log file. Your browser saves the complete log as iptv_dbg.txt.
  4. Delete log file deletes the log. The button only appears when the log is larger than 1 MB; to start with a clean log otherwise, use BLUE Clear log on the Info screen.

Tip: in the web interface, Settings shows the same settings as on the box, including the debug options. You can turn the debug log on from your PC as well.

b) Info screen on the box

  1. On the E2iPlayer home screen press INFO, or BLUE (More) and choose Info. (In the E2iPlayer settings, INFO opens the same screen.)
  2. Use LEFT / RIGHT to switch between the three pages:
    • About: version, project link, credits.
    • System: E2iPlayer, Python, image and box version, every external tool E2iPlayer uses (ffmpeg, hlsdl, wget, curl, curl-impersonate, f4mdump, rtmpdump, exteplayer3, gstplayer, duktape, QuickJS) with its version (for curl-impersonate also the sites that were opened as Chrome in this session), free space of the storage folders, and the current debug-log setting with its file size.
    • Log: the end of the debug log, updated live every 2 seconds while you watch.
  3. Buttons:
    • GREEN — Save: saves the current page to a file:
      • on the About / System page → /tmp/e2iplayer_sysinfo.txt
      • on the Log page → /tmp/e2iplayer_debug.txt (the last ~768 KB of the log; for the complete file use the web interface or FTP)
    • YELLOW — Auto refresh on/off (Log page): stops the live update so you can scroll through the log in peace.
    • BLUE — Clear log (Log page): empties the debug log.
    • UP / DOWN: scroll page by page. OK / EXIT: close.

The System information is also written automatically near the top of the debug log each time E2iPlayer starts, so a log you share already contains your box/image/tool versions. Adding a copy of e2iplayer_sysinfo.txt to an issue is still welcome.

c) FTP / SCP

Copy the file from the path you chose in step 3 (/hdd/iptv.dbg, /tmp/iptv.dbg or /home/root/logs/iptv.dbg) to your PC with WinSCP, FileZilla or similar. With rotation enabled you will also find older files named iptv-<date>-<time>.dbg next to it.

dbgfile

3. Debug options explained

All options are in the Debug Configuration category. Some of them only appear when they make sense.

Shown when the debug log is enabled (console or file)

Keep FFmpeg command files (.iptv.cmd) — default: Yes When a download runs through FFmpeg, E2iPlayer writes the complete FFmpeg command line into a small file named <video>.iptv.cmd next to the downloaded video. Normally this file is deleted after the download. With this option on (and debug logging active), it is kept, so a failed or broken download can be reproduced exactly. Turn it off if the extra files in your download folder bother you.

Keep temporary JS scripts — default: Yes Some hosts and hosters need JavaScript to be run (deobfuscation, player code). E2iPlayer writes these scripts to temporary files in the temporary data folder and runs them with its JS engine. With this option on (and debug logging active), the scripts are not deleted afterwards, so a developer can see exactly what was run. Turn it off to save space.

Both options only have an effect while the debug log is on. With Debug logs = No, these files are always cleaned up.

Shown when the debug log goes to a file

Clear the log file at plugin start — default: Yes Every time E2iPlayer starts, the log file (and rotated copies of it, see below) is deleted, so each session starts with a clean, small log.

  • Yes is right for most reports: open E2iPlayer, reproduce the error, then save/download the log before you close and reopen E2iPlayer.
  • Set it to No when the problem only appears after a restart, or happens rarely and you want to collect it over several sessions. Then also set a Maximum log file size, otherwise the file grows forever.

Maximum log file size — default: unlimited Choices: unlimited, 2, 5, 10, 20, 50, 100 MB. The log size is checked regularly while E2iPlayer writes to it. When the limit is reached, what happens next depends on the following option. Recommended when the log is in RAM (/tmp) or flash (/home/root/logs), or when Clear the log file at plugin start is off.

When the maximum is reached — only shown when a maximum size is set; default: truncate the file

  • truncate the file: the log is emptied and starts again from zero. Simple and saves space, but everything logged before is lost.
  • rotate (keep the old one as iptv-<date>.dbg): the full log is renamed to e.g. iptv-20260926-143012.dbg and a new, empty iptv.dbg is started. Nothing is lost until the number of kept files is exceeded.

Number of rotated files to keep — only shown with rotate; default: 3 Choices: 1, 2, 3, 5, 10. How many old iptv-<date>.dbg files to keep. When there are more, the oldest are deleted. Disk usage is roughly (number + 1) × maximum size.

Recommended setups

Situation Settings
Normal bug report Debug logs: /hdd/iptv.dbg (or /tmp/iptv.dbg without storage), everything else default.
Error only appears after a restart / rarely Clear the log file at plugin start = No, Maximum log file size = 10 MB, rotate, keep 3.
Box with little flash / RAM Use /hdd if possible, otherwise Maximum log file size = 2–5 MB.
Download problem (FFmpeg) Leave Keep FFmpeg command files on and attach the .iptv.cmd file from the download folder too.

When you are done, set Debug logs back to No. A permanently active debug log costs some performance and, when written to flash, wears it out.



How to create debug logs in Enigma2

For further assistance, it may be necessary to provide an enigma2 debug log in addition to the iptv.dbg log. I will briefly explain how to create this here.

This example shows how to activate the log in the current openATV image. This may look slightly different in other images, but should be similar in principle.

1. --> Menu

2. --> Setup

3. --> System

4. --> Logs Settings

5. --> Setting Enable debug logs set to Enabled

NOTE: ⚠️ After activating the debuglog you must restart the box.

The Log can be found in /home/root or /home/root/logs. You can copy the created Log via FTP (WinSCP or FileZilla) to your PC.

1.

debug1

2.

debug2

3.

debug3

4. + 5.

debug4

⚠️ **GitHub.com Fallback** ⚠️