Skip to main content

BitDive Quick Start Guide

New to BitDive? Start with SaaS​

If you're new to BitDive, we recommend starting with our free SaaS version:

  1. Register for free - Get instant access to BitDive SaaS
  2. Follow the setup instructions - We'll provide everything you need: credentials, configuration, library setup, and complete onboarding through the dashboard

The SaaS version gives you immediate access to all BitDive features without any infrastructure setup.

On-Premise Deployment Guide​

⚠️ Enterprise Deployment: For enterprise on-premise deployments, please request a quote from our pricing page to get started with the appropriate license and support.

This guide covers on-premise deployment for organizations that need to run BitDive in their own infrastructure.

Step 1: Deploy the Backend​

Deploy the backend using our bitdive/infrastructure repository (don't forget the final step with Keycloak - see instructions).

For detailed infrastructure deployment instructions, see our Infrastructure Deployment Guide. You can also watch our Infrastructure Deployment Tutorial for step-by-step guidance.

Important: Make sure to complete the Keycloak configuration step after deploying the infrastructure - this is crucial for the BitDive frontend to work properly.

Step 2: Add the BitDive Agent​

Add the BitDive agent to your application by configuring your pom.xml (see configuration details below) and adding a configuration file — we've included an example (config-profiling.yml, place it under src/main/resources). You just need to replace the IP/URL with your server address.

For a detailed walkthrough, check out our Application Configuration Tutorial.

Configure pom.xml​

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>[1.0,)</version> <!-- Check Maven Central for the latest version -->
</dependency>

To get the latest version, visit Maven Central and use the most recent version number shown.

Minimal Configuration​

Create config-profiling.yml in your src/main/resources directory:

application:
  moduleName: web-app             # Name of your module, can be any name you choose
  serviceName: report             # Name of your service, can be any name you choose
  packedScanner: [com.yourcompany.yourapp.controller, com.yourcompany.yourapp.dto, com.yourcompany.yourapp.service]  # Replace with the main packages of your project

monitoringConfigs:
  - logLevel: DEBUG                      # Use DEBUG only for test runs
    monitoringArgumentMethod: true
    monitoringReturnMethod: true
    monitoringStaticMethod: true
    monitoringOnlySpringComponent: true
    sendFiles:
      serverConsumer:
        url: https://sandbox.bitdive.io/file-acceptor
        vault:
          url: https://sandbox.bitdive.io/vault
          login: your_username
          password: your_password

For additional configuration options and advanced settings, see our Configuration Guide.

AI Integration Prompt - Copy this prompt for Cursor or other AI tools
tip

You can copy the following prompt and give it to AI tools like Cursor to help you implement BitDive integration automatically. Make sure to provide your actual BitDive server URL and credentials when using this prompt.

Please help me integrate BitDive distributed tracing into my Spring Boot 3 application. Here's what needs to be done:

1. Add the BitDive Maven dependency to my pom.xml:
<dependency>
    <groupId>io.bitdive</groupId>
    <artifactId>bitdive-producer-spring-3</artifactId>
    <version>[1.0,)</version>
</dependency>

2. Create a config-profiling.yml file in src/main/resources with this content:
application:
  moduleName: web-app             # Name of your module, can be any name you choose
  serviceName: report             # Name of your service, can be any name you choose
  packedScanner: [com.yourcompany.yourapp.controller, com.yourcompany.yourapp.dto, com.yourcompany.yourapp.service]  # Replace with the main packages of your project

monitoringConfigs:
  - logLevel: DEBUG                      # Use DEBUG only for test runs
    monitoringArgumentMethod: true
    monitoringReturnMethod: true
    monitoringStaticMethod: true
    monitoringOnlySpringComponent: true
    sendFiles:
      serverConsumer:
        url: https://sandbox.bitdive.io/file-acceptor
        vault:
          url: https://sandbox.bitdive.io/vault
          login: your_username
          password: your_password

Please:
- Replace "com.yourcompany.yourapp" with the actual main packages of my project
- Update the moduleName and serviceName to match my application
- Replace the server URLs with my actual BitDive server address if different
- Replace the login credentials with my actual BitDive credentials

For additional configuration options and advanced settings, refer to: https://bitdive.io/docs/configuration/

Step 3: Test It Out​

After implementation, you should be able to start your application, make test requests, and see traces in the BitDive interface after 30-40 seconds.

  1. Start your application
  2. Trigger a test request to your application (e.g., call any endpoint/URL)
  3. After about 30–40 seconds, the trace should appear in the BitDive interface at https://your-server-ip
AI Help for Testing - Copy this prompt to get AI assistance with testing your integration
tip

You can copy the following prompt and give it to AI tools like Cursor to help you generate test commands for BitDive integration. Note that AI doesn't always work correctly - this is mostly for example. You can also use your favorite tools like Postman to make simple requests, use your application's UI, or run existing tests.

Please help me test my BitDive integration by creating simple curl requests to my existing application endpoints. Here's what I need:

1. Identify 1-2 existing user-facing endpoints in my application (like /api/users, /products, /orders, or any business logic endpoint)

2. Create simple curl commands to test these endpoints:

   For Linux/Mac/WSL:
   curl -X GET http://localhost:8080/api/users
   curl -X GET http://localhost:8080/api/products

   For Windows PowerShell:
   Invoke-WebRequest -Uri http://localhost:8080/api/users -Method GET
   Invoke-WebRequest -Uri http://localhost:8080/api/products -Method GET

   Or use curl.exe directly in PowerShell:
   curl.exe -X GET http://localhost:8080/api/users
   curl.exe -X GET http://localhost:8080/api/products

3. After running these curl requests, I should be able to see traces in my BitDive interface at my server URL within 30-40 seconds.

Please just provide the curl commands - no need to create or modify any application code.

MCP Setup​

For setting up MCP, you can follow the instructions here.

To use BitDive MCP tools, connect your client or observability UI to the MCP server using this configuration:

{
  "mcpServers": {
    "bitdive": {
      "url": "http://your-server-ip:8089/sse",
      "name": "BitDive MCP Server"
    }
  }
}

Replace your-server-ip with your actual server address.

Need Help?​

Both steps are covered in our detailed docs, with video instructions included. Check the links above for more comprehensive guides.

If you need assistance or have questions, please contact us at: welcome@bitdive.io