README.md

Table of contents

• 🧑🏫 Index
• ❓ Why Sidekick?
• 🏃♂ Get Started With Sidekick
  • Sidekick for Visual Studio Code users
  • Sidekick for IntelliJ IDEA users
  • Sidekick for PyCharm users
  • Sidekick for WebStorm users
• 🥞 Use Cases
  • Production Debugging
  • Remote Debugging Kubernetes Cluster, Pods, and Containers
  • Dynamic Logging
  • Pinpointing Causes of Errors
  • Conditional Stack & Log Collection
  • Identifying Stack Changes & Stack Comparison
  • Using Trace Data to Find Root Cause of an Error
  • Cut Monitoring Costs with Dynamic Logging
  • Developer on-boarding
  • Error stack collection & stack-based backend tests in E2E tests
    • Cypress plugin
• 🚀 Deployment Examples

Sidekick Actions

• 🔎 Tracepoint
• 🪵 Logpoint
• 🚨 Error Stack Collection
• 💾 Reference Events & Probe Tags

Agents

• 🐍 Python
  • Installation
  • Docker Configuration
  • Data Redaction
  • Error Stack Collection
• ☕ Java
  • Installation
  • Source Bundling
• 🟢 Node.js
  • Installation
  • Docker Configuration
  • Data Redaction
  • Error Stack Collection
  • Troubleshooting

Installation

• 🖋 Sign up for Sidekick
• 🗝 Get API Key & Token

IDEs & Extensions

• 🌐 Sidekick Web IDE
  • 🏃♀ Quick Start: To-Do App
  • Introduction to Web Application
    • Sources Panel
    • Code Panel
    • Apps and Sidekick Actions Panels
    • Events Panel
  • How to
    • Connect Source Code
    • Put Tracepoints & Logpoints
    • Take Snapshots (a.k.a Tracepoint Events)
    • Enable TraceMap for Debugging
    • Enable/Disable Collaborative Debugging
    • 🎇 Remote Config
• Visual Studio Code Extension (Python & Node.js)
  • Set up VSCode extension
  • Login & On-boarding
  • Select Workspace & Application
  • Tracepoints & Logpoints
    • Set Tracepoint
    • Remove Tracepoint
    • Edit Tracepoint
    • Enable/Disable Tracepoint
    • Conditional tracepoints
    • Expiration Settings
  • Browsing Tracepoint Events
  • Self-hosted Settings
  • Common Problems
• IntelliJ IDEA Plugin (Java)
  • Set up IntelliJ Plugin
  • Login and Connecting Broker
  • Tracepoints
    • Set Tracepoint
    • Remove Tracepoint
    • Edit Tracepoint
    • Enable/Disable Tracepoint
    • Distributed Tracing Integration
    • Conditional Tracepoints
    • Expiration Settings
  • Browsing Tracepoint Events
    • Tracepoint Event Detail
  • Self-hosted Settings
  • Common Errors
• PyCharm Plugin (Python)
• WebStorm Plugin (Node.js)

📖 Open-source

• ⚡ Quick Start
• 🕵 Agent Settings
• Client Settings
• Repository

INTEGRATIONS

• Integrations
  • Slack Integration
  • Logz.io Integration
  • Sumo Logic Integration
  • SolarWinds Loggly Integration
  • New Relic Integration
  • Elasticsearch Integration
  • Loki Integration
  • Coralogix Integration
  • Webhook Integration
• REST API
• Node.js Client
• Cypress Plugin for E2E tests
• Grafana Plugin for remote controlling Sidekick Actions
• 🔌 Open-Telemetry Tracing Integration
• 🔌 Thundra APM Tracing Integration

REFERENCE

• ⁉ FAQ
• Logpoint Expressions
• Conditional Expressions