la-agent.1.0.2.source-code.reference.conf Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kanela-agent Show documentation
The Kamon Instrumentation Agent
There is a newer version: 1.0.18
# ===============================#
# Kanela reference configuration #
# ===============================#

kanela {
  # Enables an instrumentation listener that is informed about events that occur during an instrumentation process and
  # logs the events in console and a rolling file.
  debug-mode = false

  instrumentation-registry {
    enabled = true
  }
  # Enables the kanela banner at startup.
  show-banner = true
  # The log verbosity level: TRACE|DEBUG|INFO|WARNING|ERROR|OFF.
  log-level = "WARNING"
  # Just a place holder to ensure that the key is always available.
  modules {
    # module-name {
    #     # Name
    #     name = "descriptive-name"
    #     # If the module is enabled (optional).
    #     enabled = true|false (optional)
    #     # The execution order between modules (optional).
    #     order = 1
    #     #  Configuration of the bootstrap classloader injection feature (optional).
    #     bootstrap-injection {
    #       # If the bootstrap injection is enabled (optional).
    #       enabled = true|false
    #       # List of helper classes to be injected into bootstrap classloader.
    #       helper-class-names = []
    #     }
    #     # Enable class file version validator. By default only class files > to JAVA 5 are supported.
    #     enable-class-file-version-validator = true
    #     # Temporary directory for store the intrumentations to be injected into the bootstrap classloader (optional).
    #     temp-dir-prefix = "tmp"
    #     # If the module can be stopped in runtime.
    #     stoppable = true|false (optional)
    #     # Enable restrictions imposed by most VMs and also HotSpot..
    #     disable-class-format-changes = "true|false" (optional)
    #     # List of fully qualified name of the implementation of kanela.agent.api.instrumentation.InstrumentationBuilderr.
    #     instrumentations = []
    #     # Excludes all types that matches the list of patterns. e.g. org.apache. *
    #     exclude = []
    #     # Only instruments types that are within the list of patterns. e.g. javax.*
    #     within = []
    # }
  }
  # Listener that allows save the instrumented classes in a folder or jar.
  class-dumper {
    # Enables the class dumper.
    enabled = false
    # Default dir.
    dir = ${user.home}"/kanela-agent/dump"
    # By default build a jar containing all instrumented classes.
    create-jar = true
    # Default jar name.
    jar-name = "instrumented-classes"
  }
  # The circuit breaker takes two parameters into account (heap usage and cpu process percentage after an Old CG) to determine when it should trip.
  circuit-breaker {
    # Enables the circuit breaker.
    enabled = false
    # The default values for these thresholds are percentages
    # percentage of free memory after Old GC
    free-memory-threshold = 20.0
    # percentage of process cpu usage after Old GC
    gc-process-cpu-threshold = 10.0
  }
  # Listener that is subscribed to JMX GC events and gather information after a GC Event.
  gc-listener {
    # If the listener should log GC information afer a Old GC.
    log-after-gc-run = false
  }

  # Allows replacing the contents of a class with the contents of another. Since the replacer configuration is a list,
  # it must be specified on the following format:
  #
  #   kanela.class-replacer.replace = ${?kanela.class-replacer.replace} "Target=>Replacement"
  #
  # Where the "Target" section is the FQCN of the class to be replaced and "Replacement" is the FQCN of the class that
  # will take the Target's place.
  #
  class-replacer {
    replace = [] ${?kanela.class-replacer.replace}
  }
}