What is a Systeminfo Bundle and how can I obtain one?

Since OctoPrint 1.6.0, you can download a Systeminfo Bundle from the System Information dialog that you'll be asked to provide for support requests and bug reports.

:exclamation: Always provide a Systeminfo Bundle when requesting support here on these forums or when opening a bug report on GitHub. Without the information in your Systeminfo Bundle we won't be able to help you!

You can upload these bundles on the forums and attach them to GitHub Issues.

How to download a Systeminfo Bundle

You have a number of options to access the System Information dialog and the bundle download link on it:

  • If you are logged in as a user with the "System" permission you can open the System Information dialog from the Settings dialog, through the big "System info" button in its footer:

  • If you are logged in as a user with the "System" permission you can click on "System" right at the very bottom of the OctoPrint UI:

  • It's part of the recovery page that you can access by appending /recovery to your OctoPrint URL, e.g. http://octopi.local/recovery (you need Admin permissions for this).

  • If all else fails you can also access a smaller system information dump right from the command line:

    $ octoprint systeminfo
    connectivity.connection_check: 8.8.8.8:53
    connectivity.connection_ok: True
    connectivity.enabled: True
    connectivity.online: True
    connectivity.resolution_check: octoprint.org
    connectivity.resolution_ok: True
    env.hardware.cores: 4
    env.hardware.freq: 1200.0
    env.hardware.ram: 915722240
    env.os.bits: 32
    env.os.id: linux
    env.os.platform: linux
    env.plugins.pi_support.model: Raspberry Pi 3 Model B Rev 1.2
    env.plugins.pi_support.octopi_version: 0.18.0
    env.plugins.pi_support.throttle_state: 0x0
    env.python.pip: 20.3.3
    env.python.version: 3.7.3
    env.python.virtualenv: True
    octoprint.version: 1.5.2
    

    and also generate a Systeminfo Bundle this way by providing a target path for it:

    $ octoprint systeminfo .
    Writing systeminfo bundle to /home/pi/octoprint-systeminfo-20210427141433.zip...
    Done!
    /home/pi/octoprint-systeminfo-20210427141433.zip
    

    Make sure to provide the correct path to the octoprint executable for this to work. On OctoPi that will be

    ~/oprint/bin/octoprint systeminfo
    

    for the quick overview and

    ~/oprint/bin/octoprint systeminfo .
    

    for the bundle dump.

How to share a Systeminfo Bundle?

Please upload it directly to the forum post or the GitHub issue. Do not put it on some cloud host. Do not unpack it. Do not extract parts from it. Share it in full and unmodified.

What's in a Systeminfo Bundle?

The Systeminfo Bundle currently collects the following information:

  • System Information as visible in the corresponding dialog. This includes OctoPrint version, OS, Python and Pip versions, OctoPi version (if installed on OctoPi), information about your underlying hardware, and if connected to a printer also information about the firmware.
  • octoprint.log
  • serial.log
  • If connected to a printer, the current contents of your terminal tab.
  • plugin_softwareupdate_console.log
  • plugin_pluginmanager_console.log

How can I view what's in my Systeminfo Bundle?

There's a Systeminfo Bundle viewer available at bundleviewer.octoprint.org. You can upload your bundle there to view it. The app runs only in your browser, your bundle will not be stored anywhere.

I have a problem with a version that doesn't yet support Systeminfo Bundles!

First of all, upgrade to OctoPrint 1.6.0 or later. While there's some support for old versions, it doesn't make much sense trying to debug problems that might already be fixed in newer versions.

If upgrading is not an option for whatever reason, then please make sure to manually provide octoprint.log, serial.log, the contents of your terminal tab, your version of OctoPrint, the operating system & version of operating system that OctoPrint is running under, OctoPi version and Pi model (if running OctoPi and/or on a Pi), information on your environment (what hardware, what printer, what firmware on the printer, ...) -- in short, as much information as possible.

Click here to find out where to find the logs, and here where to find the relevant version numbers.

3 Likes