> ## Documentation Index
> Fetch the complete documentation index at: https://help.octoeverywhere.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How To Get Your Plugin Logs

Every installation of the OctoEverywhere has a log file that is useful for finding issues and debugging.

<Tip>
  **The plugin logs can contain private information - keep them private.**
</Tip>

## 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:

<AccordionGroup>
  <Accordion title="Linux CLI - Bambu Connect / Elegoo Connect / PrusaLink / Klipper Companion">
    If you installed Bambu Connect, Elegoo Connect, or the Klipper Companion via SSH, you must retrieve your logs from the device where the plugin is running.

    1. SSH into the device running the OctoEverywhere plugin.
    2. Go to your user home.
       1. `cd ~`
    3. Depending on your plugin type, look for the following directory. If you have multiple plugins, a `-#` will be appended to the directory name.
       1. Bambu Connect
          1. `~/.octoeverywhere-bambu/`
       2. Elegoo Connect
          1. `~/.octoeverywhere-elegoo/`
       3. Klipper Companion
          1. `~/.octoeverywhere`
    4. Edit the plugin config:
       1. `nano <plugin data root>/octoeverywhere.conf`
    5. Enable debug logging:
       1. Set `log_level` to `DEBUG`
    6. Exit the editor
       1. Press Ctrl + X to exit, press `Y` to save.
    7. Restart the plugin or restart the device.

    If you're using a terminal such as MobaXterm, you can use the tool UI to copy the file to your local device. If you're SSHing from the terminal, you can use a command like

    ```text theme={null}
    scp <linux user>@<device IP address>:~/.octoeverywhere-elegoo/log/octoeverywhere.log ~/octoeverywhere.log
    ```

    This SCP command copies the log file from the remote device at the specified IP address to your device's home directory.
  </Accordion>

  <Accordion title="Windows Desktop Plugin Manager App">
    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.
  </Accordion>

  <Accordion title="Docker Container">
    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.

    ```text theme={null}
    <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.
  </Accordion>

  <Accordion title="Klipper / Moonraker">
    **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.
  </Accordion>

  <Accordion title="OctoPrint">
    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
  </Accordion>
</AccordionGroup>

## 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.

<Tip>
  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.
</Tip>

<AccordionGroup>
  <Accordion title="Linux CLI - Bambu Connect / Elegoo Connect / PrusaLink / Klipper Companion">
    1. SSH into the device running the OctoEverywhere plugin.
    2. Go to your user home.
       1. `cd ~`
    3. Depending on your plugin type, look for the following directory. If you have multiple plugins, a -# will be appended to the directory name.
       1. Bambu Connect
          1. `~/.octoeverywhere-bambu/`
       2. Elegoo Connect
          1. `~/.octoeverywhere-elegoo/`
       3. Klipper Companion
          1. `~/.octoeverywhere`
    4. In the OctoEverywhere data root, the log path is:
       1. `<plugin data root>/log/octoeverywhere.log`

    If you're using a terminal such as MobaXterm, you can use the tool UI to copy the file to your local device. If you're SSHing from the terminal, you can use a command like

    ```text theme={null}
    scp <linux user>@<device IP address>:~/.octoeverywhere-elegoo/log/octoeverywhere.log ~/octoeverywhere.log
    ```

    This SCP command copies the log file from the remote device at the specified IP address to your device's home directory.
  </Accordion>

  <Accordion title="Windows Desktop Plugin Manager App">
    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.
  </Accordion>

  <Accordion title="Docker Container">
    If you're using the Docker container for any plugin type, your log files are located in the mapped Docker data folder root.

    ```text theme={null}
    <docker data roo>/log/octoeverywhere.log
    ```
  </Accordion>

  <Accordion title="Klipper / Moonraker">
    **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`.
  </Accordion>

  <Accordion title="OctoPrint">
    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.
  </Accordion>
</AccordionGroup>
