Skip to main content

BitDive Advanced Configuration Guide

This page provides an overview of the default configuration settings for config-profiling.yml in BitDive. The settings in this file determine how Bitdive monitors your application, including which methods and components to track, logging levels, and file handling. This configuration can be modified to fit your application’s needs.

Default Configuration File​

Below is the default configuration for config-profiling.yml:

application:
  moduleName: module1
  serviceName: config-profiling
  packedScanner: default

monitoring:
  logLevel: INFO
  monitoringArgumentMethod: false
  monitoringReturnMethod: false
  monitoringStaticMethod: false
  monitoringOnlySpringComponent: true
  sendMonitoringFiles:
    serverConsumer:
      url: http://localhost:8080
      proxy:
        url: http://localhost:8080
        login: admin
        password: admin
    schedulerTimer: 10000
  pathMonitoringFilesSave: /monitoringFiles

authorisation:
  token: 34geg54gb4

Explanation of Settings​

Application Settings​

  • moduleName: The name of your module. This identifier can be customized to fit your module structure.
  • serviceName: Name of the service being monitored. This can also be customized based on your service architecture.
  • packedScanner: Defines the main package to scan for profiling. Set this to the root package of your application, or keep it as default if not specified.

Monitoring Settings​

  • logLevel: Sets the verbosity of logs. Options include:
    • ERRORS: Logs only errors
    • INFO: Logs general information (default)
    • DEBUG: Logs detailed debugging information
  • monitoringArgumentMethod: When set to true, tracks method arguments for enhanced debugging. Default is false.
  • monitoringReturnMethod: Enables tracking of return values from methods. Default is false.
  • monitoringStaticMethod: Controls monitoring of static methods. Default is false.
  • monitoringOnlySpringComponent: When set to true, only Spring-annotated components are monitored, which helps reduce log noise. Default is true.

Sending Monitoring Files​

  • sendMonitoringFiles.serverConsumer.url: URL endpoint where monitoring files are sent. The default is http://localhost:8080.
  • proxy: Optional proxy settings for file transfer. This includes:
    • url: Proxy URL.
    • login and password: Credentials for the proxy server.
  • schedulerTimer: Specifies the time interval (in milliseconds) for the scheduler to save and send monitoring files. Default is 10000 ms (10 seconds).
  • pathMonitoringFilesSave: Path where monitoring files are saved locally. Default is /monitoringFiles.

Authorization Settings​

  • token: Token used for authorizing monitoring data access. Default token: 34geg54gb4.

Log Levels Explained​

The logLevel setting determines the detail level of logs. Here’s a quick overview of each level:

public enum LogLevelEnum {
    ERRORS, INFO, DEBUG
}
  • ERRORS: Logs only error messages.
  • INFO: Logs general events and operations, suitable for most monitoring.
  • DEBUG: Provides detailed logs, useful for in-depth analysis and troubleshooting.

Use this default configuration as a starting point and adjust settings based on your monitoring needs.