docs: Flex log files description and download #19863
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Read the description in the PR.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## edge #19863 +/- ##
=======================================
Coverage 25.35% 25.35%
=======================================
Files 3523 3523
Lines 296771 296771
Branches 39620 39620
=======================================
Hits 75253 75253
Misses 221497 221497
Partials 21 21
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Proposed changes will break some links between pages. Checked mkdocs output for warnings and fixed broken links. Replaced "reference" style links with typical [ ]( ) style relative links.
There are 2 new log files: can_bus.log and update_server.log. I think I know what the former is, but not the update_server. checking on these to verify.
ecormany
reviewed
Oct 22, 2025
|
|
||
| In an idle state or during a protocol run, your Flex constantly writes data to several different log files. Each of these files tracks the activities specific to different parts of the robot and its attachments. The following table summarizes the data captured in each file. | ||
|
|
||
| | Log file | Description | |
There was a problem hiding this comment.
Make the first column wider so the file names fit without wrapping.
There was a problem hiding this comment.
I tried to be clever and apply a CSS rule to prevent line splitting on the first column:
.first-col-no-wrap th:first-child,
.first-col-no-wrap td:first-child {
white-space: nowrap;
}
This didn't work. Implemented an ugly-er fix. Might continue to test this separately.
There was a problem hiding this comment.
My other fix didn't work. Trying this instead. I think it is good enough.
| !!!note | ||
| Flex produces a single `.zip` file that contains the logs. The compressed file name includes the robot’s name followed by `_logs.zip`. For example, if your robot is called “Flex1," the log file will be named `Flex1_logs.zip`. | ||
|
|
||
| 5. _(Optional)_ To read the logs, double-click the downloaded file to decompress it. The individual logs will expand into a new folder in the same location as the downloaded file. Any simple text editor should be able to open these files. |
| Opentrons Flex gives you command-line access to its operating system through a Secure Shell (SSH) terminal connection. Terminal access lets you: | ||
|
|
||
| ## Command line operation over SSH | ||
| - Run protocols directly via the [Python API and command line](https://docs.opentrons.com/v2/new_advanced_running.html#command-line). |
There was a problem hiding this comment.
| !!!note | ||
| - SSH keys are required before you can connect to Flex and issue commands from a terminal. | ||
| - If you're unable to use a Wi-Fi network for SSH, see [Hardwired SSH Connections][hardwired-ssh-connections] below. | ||
| If you're unable to use a Wi-Fi network for SSH, see [Making a hardwired SSH connection][making-a-hardwired-ssh-connection] below. |
There was a problem hiding this comment.
Should this note go in the "Making a wireless SSH connection" section instead?
There was a problem hiding this comment.
Yes. That's odd. It should be in that section. Moving.
ecormany
reviewed
Oct 22, 2025
- update links - re-org TOC, put log files first. - fix table spacing - found errant trailing whitespace and missing closing } in CSS file, when working with a table rule
Trying to avoid line wrapping in the first col of the log file table. I do
ecormany
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Having more info about Flex log files in the manual is helpful. Also, and perhaps more important, having this in the Flex manual allows us to get rid of another bad Help Center article (How to download the logs on Opentrons Flex).
For this article, we'll repurpose the intro and file download instructions from the Flex service manual, but without all the extra details used by the service techs.
See also RTC-824
Sandbox docs:
Test Plan and Hands on Testing
Changelog
On the surface, a simple change or PR: add steps on log file download.
I'd recommend some reorganization. This belongs with the other "advanced" operations articles. I'd like to:
advanced-operations.mdadvanced-operations/index.mdto summarize the sections.Review requests
Consider the reorg. Is there another place to put this without changing the structure?
Risk assessment
Low, docs changes only.