Skip to main content
Every installation of the OctoEverywhere has a log file that is useful for finding issues and debugging.
The plugin logs can contain private information - keep them private.

​
Step 1: Put Your Plugin In Debug Mode

First, you need to put your plugin into debug mode and restart it. Based on your plugin install type, choose an option:
If you’re using the Windows Plugin Manager App:
  1. Open the app
  2. Click the “Open Data Folder” button next to the plugin you want.
  3. Use a text editor to edit the octoeverywhere.conf file
  4. Set log_level to DEBUG
  5. Restart the plugin or restart your computer.
If you’re using the Docker container for any plugin type, your config file is located in the mapped root of the Docker data folder.
<docker data roo>/octoeverywhere.conf
Use a text editor to open the file and set the value of log_level to DEBUG. Be sure to restart the Docker container or reboot the computer.
Mainsail:
  1. Open the Mainsail web UI
  2. Click Machine in the left navigational menu
  3. In the Config Files section, find the file named octoeverywhere.cfg
  4. Click octoeverywhere.cfg to open it for editing.
  5. Change log_level = INFO to log_level = DEBUG
  6. Click Save & Restart at the top right.
Fluidd:
  1. Open the Fluidd web UI
  2. Click Configuration in the left navigational menu
  3. In the Config Files section, find the file named octoeverywhere.cfg
  4. Click octoeverywhere.cfg to open it for editing.
  5. Change log_level = INFO to log_level = DEBUG
  6. Click the disk save icon at the top right.
  7. Click the X to close the config editor.
  8. Restart the device to ensure the new logging level takes effect.
Here’s how to get your logs:
  1. Open your OctoPrint web portal.
  2. Open the OctoPrint settings
  3. Go to “Logging” in the settings
  4. Delete your current logs:
    1. Find the log row that says “octoprint.log”
    2. Click the trash can icon to delete it.
  5. Set Logging Level:
    1. Under “Logging Levels” find “octoprint” and make sure the value is DEBUG
  6. Press “Save” to close the settings UI

​
Step 2: Reduce The Issue

Once you have the plugin in debug mode and have started the plugin, reproduce the issue, ideally a few times. After you have reproduced it, give the plugin about a minute to fully output the logs.

​
Step 3: Get The Plugin Log

Now you need to get the log file and send it to our support team.
You can share the file directly into the on-page chat window using the paper clip icon. You can also send it as a file attachment via email.
If you’re using the Windows Plugin Manager App:
  1. Open the app
  2. Click the “Open Data Folder” button next to the plugin you want.
  3. Open the logs folder
  4. Share the octoeverywhere.log file in the folder.
If you’re using the Docker container for any plugin type, your log files are located in the mapped Docker data folder root.
<docker data roo>/log/octoeverywhere.log
Mainsail:
  1. Open the Mainsail web UI
  2. Click Machine in the left navigational menu
  3. In the Config Files section, find the box labeled root. The box defaults to the value config as the root.
  4. Change the root drop-down to logs.
  5. Find the most recent octoeverywhere.log file.
  6. Right-click the log file and select Download.
Fluidd:
  1. Open the Fluidd web UI
  2. Click Configuration in the left navigational menu
  3. Scroll down to the box labeled Other Files
  4. Be sure the LOGS tab is selected; it should be by default.
  5. Find the most recent octoeverywhere.log file.
  6. Click the log file and select Download.
Here’s how to get your logs:
  1. Open your OctoPrint web portal.
  2. Open the OctoPrint settings
  3. Go to “Logging” in the settings
  4. Find the “octoprint.log” file row and click the download icon.