Skip to content

Latest commit

 

History

History
105 lines (78 loc) · 3.96 KB

DEVELOPMENT.md

File metadata and controls

105 lines (78 loc) · 3.96 KB

Development Guide

This guide provides advanced instructions for contributors and maintainers, covering topics such as debugging specific components, analyzing performance profiles, and working with internal tools. It complements the CONTRIBUTING.md by offering insights into advanced development workflows and optimization techniques.

CPU and Memory Profiling for the Collectors

Step 1: Port Forward the Gateway or Data Collection Pod

Forward the relevant pod to your local machine to enable profiling access:

kubectl port-forward pod/<pod-name> -n odigos-system 1777:1777

Step 2: Collect Profiling Data

  • CPU Profile
    Captures data about the time your application spends executing functions. Use this profile to identify performance bottlenecks, optimize CPU-intensive operations, and analyze which parts of the code consume the most CPU resources.

    curl -o cpu_profile.prof http://localhost:1777/debug/pprof/profile?seconds=30

  • Heap Memory Profile
    Captures a snapshot of memory currently in use by your application after the latest garbage collection. Use this profile to identify memory leaks, track high memory usage, and analyze memory consumption by specific parts of the code.

    curl -o heap.out http://localhost:1777/debug/pprof/heap

  • Historical Memory Allocation
    Provides insights into all memory allocations made by the program since it started running, including memory that has already been freed by the garbage collector (GC). This is useful for understanding memory allocation patterns and optimizing allocation behavior.

    curl -o allocs.out http://localhost:1777/debug/pprof/allocs

Step 3: Analyze the Profiles

After collecting the profiling data, use the go tool pprof command to analyze the profiles visually in your web browser. Replace <output file> with the appropriate file (cpu_profile.prof, heap.out, or allocs.out):

go tool pprof -http=:8080 <output file>

This opens an interactive interface in your browser where you can:

  • Visualize Hotspots: View flame graphs or directed graphs for easy identification of bottlenecks.
  • Drill Down: Explore specific functions or memory allocations for detailed insights.

Debugging CLI Commands

Debugging the cli pro Command

To debug the cli pro command in Visual Studio Code, use the following configuration in your .vscode/launch.json file:

{
  "name": "cli pro",
  "type": "go",
  "request": "launch",
  "mode": "debug",
  "program": "${workspaceFolder}/cli",
  "cwd": "${workspaceFolder}/cli",
  "args": ["pro", "--onprem-token", "${input:onprem_token}"],
  "buildFlags": "-tags=embed_manifests"
}

How to Use

  1. Open the Run and Debug view in Visual Studio Code:
    • Press Ctrl+Shift+D (Windows/Linux) or Cmd+Shift+D (macOS).
  2. Select the cli pro configuration from the dropdown menu.
  3. Click the green Play button to start debugging.
  4. When prompted, enter your onprem-token value.
  5. The debugger will start the cli pro command with the provided token and attach to the process for debugging.

Debugging the cli install Command

To debug the cli install command in Visual Studio Code, use the following configuration in your launch.json file:

{
  "name": "cli install",
  "type": "go",
  "request": "launch",
  "mode": "debug",
  "program": "${workspaceFolder}/cli",
  "cwd": "${workspaceFolder}/cli",
  "args": ["install", "--version", "ODIGOS_VERSION"],
  "buildFlags": "-tags=embed_manifests"
}

How to Use

  1. Open the Run and Debug view in Visual Studio Code:
    • Press Ctrl+Shift+D (Windows/Linux) or Cmd+Shift+D (macOS).
  2. Select the cli install configuration from the dropdown menu.
  3. Replace "ODIGOS_VERSION" in the args section with the desired version number.
  4. Click the green Play button to start debugging.
  5. The debugger will start the cli install command with the specified version.