Quickstart

Quickstart Guide

Get up and running with GalataJ in just a few minutes.

You won't need the terminal

Most users never need the CLI. The IDE plugin handles setup, profiling, and everything else automatically. Just install, click, and see your metrics.

---

Step 1: Install the Plugin

IntelliJ IDEA

1. Open File → Settings → Plugins
2. Search for “GalataJ”
3. Click Install and restart the IDE

VS Code / Cursor

1. Open Extensions (Ctrl+Shift+X)
2. Search for “GalataJ”
3. Click Install

---

Step 2: Start Profiling

IntelliJ IDEA

1. Run your Java application normally
2. Go to Run → Start GalataJ Profiling
3. Select the JVM you want to profile
4. Click Start

That’s it! The plugin automatically:

• ✅ Starts the controller (if needed)
• ✅ Discovers running JVMs
• ✅ Attaches the profiler agent
• ✅ Begins collecting metrics

VS Code / Cursor

1. Run your Java application
2. Open Command Palette (Ctrl+Shift+P)
3. Run “GalataJ: Start Profiling”
4. Select the JVM from the list

---

Step 3: View Metrics

Once profiling is active, you’ll see performance metrics directly in your code:

What you’ll see:

• Execution time - Average and max time per method call
• Call count - How many times the method was called
• Trend - Performance change compared to previous measurements
• Memory allocations - Bytes allocated per call

Profiler Panel

Open the Profiler panel for detailed statistics:

Inline Hints

Performance metrics appear directly above each method in your code editor

Profiler Panel

Detailed view with sorting, filtering, and historical data

---

Step 4: Stop Profiling

When you’re done:

IntelliJ: Go to Run → Stop GalataJ Profiling

VS Code: Command Palette → “GalataJ: Stop Profiling”

---

Next Steps

Explore more features and integrations.

IntelliJ Integration

Deep dive into IntelliJ features and settings.

IntelliJ Guide

VS Code Integration

Learn about VS Code extension features.

VS Code Guide

Docker Profiling

Profile Java apps running in Docker containers.

Docker Guide

Configuration

Customize profiling behavior and settings.

Configuration

---

Something Not Working?

Quick Fix: Run Doctor

If the IDE can’t find your JVM or profiling doesn’t start, open a terminal and run:

galataj doctor

This checks your system setup and tells you exactly what’s wrong.

Common issues:

• JVM not showing up? Make sure your Java app is running, then try Refresh JVMs in the plugin
• No metrics appearing? Check that the Profiler panel is open and profiling is active
• Plugin not working? Restart the IDE after installation

For more help, see the Troubleshooting Guide.