Treebeard Python Log Debugger

A VS Code extension that connects to the Treebeard logging service, allowing you to view and explore Python logs right next to your code.

Features

• Authentication: Securely connect to your Treebeard account
• Log Viewing: Browse logs with highlighting based on log level
• Properties Inspection: Explore structured JSON log data
• Direct File Navigation: Jump to the exact line of code that generated a log
• Deep Linking: Open traces directly from browser links with the format vscode://treebeard.treebeard-debugger/trace?id=<trace-id>

Requirements

• VS Code version 1.98.0 or higher
• Python with the treebeardhq package installed in your project

Installation

VS Code Marketplace

Install directly from the Visual Studio Code Marketplace:

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "Treebeard Python Log Debugger"
4. Click Install

Manual Installation

Install from the .vsix file:

1. Download the latest .vsix file from releases
2. In VS Code, go to Extensions (Ctrl+Shift+X)
3. Click the ... menu (top-right) and select "Install from VSIX..."
4. Select the downloaded file

Getting Started

1. Sign In: Command + Shift + P: Treebeard: Sign in
2. Register Your Repository: Your current workspace will be registered with Treebeard automatically
3. Enter a Trace ID: Paste a trace ID from your Python application to view logs
4. Explore Logs: Click on log entries to navigate to the source code
5. View Properties: Examine structured JSON data for each log entry

Using Deep Links

The extension supports opening traces directly from browser links:

vscode://treebeard.treebeard-debugger/trace?id=your-trace-id-here

Extension Settings

• treebeard-debugger.environment: Set to "development" or "production" to switch environments

Commands

• treebeard-debugger.signIn: Sign in to your Treebeard account
• treebeard-debugger.signOut: Sign out from your Treebeard account
• treebeard-debugger.showTreebeardView: Show the Treebeard dashboard
• treebeard-debugger.openTrace: Open a specific trace by ID

Development

1. Clone the repository
2. Run npm install to install dependencies
3. Press F5 to open a new window with the extension loaded
4. Make changes to the extension in the source files
5. Reload the extension: Press Ctrl+R (or Cmd+R on Mac)

Known Issues

Please report issues on our GitHub repository.

Release Notes

0.0.1

• Initial release of Treebeard Python Log Debugger
• Authentication with Treebeard
• Repository registration
• Log viewing with syntax highlighting
• Properties viewing
• Source file navigation
• Deep links to open traces

Privacy and Data Handling

The extension connects to the Treebeard service to retrieve log data. Your authentication token is stored securely in the VS Code Secret Storage. No code or logs are sent to any third parties.

License

This extension is released under the MIT License. See the LICENSE file for details.

About Treebeard

Treebeard is a logging service designed to make debugging Python applications easier by providing structured log data with context and navigation capabilities.