BitDive Quick Start Guide

Welcome to BitDive! This guide will help you get started quickly and efficiently. BitDive is a powerful distributed tracing platform designed for Java applications, providing continuous profiling and performance insights.

Prerequisites

Before starting, ensure you have:

Docker and Docker Compose installed
Java 8 or higher
Maven or Gradle for dependency management

Getting Started

Step 1: Deploy the Infrastructure

For detailed infrastructure deployment instructions, see our Infrastructure Deployment Guide. This guide covers setting up:

Vault for secrets management
PostgreSQL database
MinIO object storage
Keycloak for authentication
Monitoring services
Frontend application

Step 2: Configure Your Application

Add the BitDive agent to your Java application. Open your pom.xml file and add one of these dependencies based on your project type (View on Maven Central):

For Spring Boot 3 applications:
```
<dependency>
    <groupId>io.bitdive</groupId>
    <artifactId>bitdive-producer-spring-3</artifactId>
    <version>x.x.x</version>
</dependency>
```

Create a configuration file named config-profiling.yml in your src/main/resources directory with the following content:

application:
  moduleName: MyApp                    # Name of your module
  serviceName: MyService               # Name of your service
  packedScanner: ["com.your.package"]  # Replace with your main package name

monitoringConfigs:
  - # Default configuration (no profile)
    logLevel: DEBUG
    monitoringArgumentMethod: true
    monitoringReturnMethod: true
    sendFiles:
      serverConsumer:
        url: https://your-server-ip:8082
        vault:
          url: https://your-server-ip:8200
          login: your_vault_login
          password: your_vault_password

  - forSpringProfile: ["test"]         # Test profile specific configuration
    logLevel: DEBUG
    monitoringArgumentMethod: true
    monitoringReturnMethod: true
    monitoringStaticMethod: true
    sendFiles:
      serverConsumer:
        url: https://your-server-ip:8082
        vault:
          url: https://your-server-ip:8200
          login: your_vault_login
          password: your_vault_password

The configuration above provides two monitoring setups:

A default configuration for regular use
A specific configuration for the "test" profile with additional monitoring options

For advanced configuration options, see our Configuration Guide.

Step 3: Start Monitoring

Run your application as normal - BitDive will automatically start monitoring based on your configuration
Access the BitDive dashboard at https://your-server-ip to view your application's performance data
Monitor method execution, trace requests, and analyze performance in real-time

Troubleshooting

Check application logs for BitDive agent initialization messages
Verify network connectivity between your application and BitDive services
For infrastructure-related issues, refer to the Infrastructure Deployment Guide

Prerequisites​

Getting Started​

Step 1: Deploy the Infrastructure​

Step 2: Configure Your Application​

Step 3: Start Monitoring​

Troubleshooting​