https://github.com/alejandrohdezma/sbt-yourkit

Adds YourKit agent to Docker SBT apps
https://github.com/alejandrohdezma/sbt-yourkit

docker sbt-plugin scala yourkit

Last synced: 2 months ago
JSON representation

Adds YourKit agent to Docker SBT apps

• Host: GitHub
• URL: https://github.com/alejandrohdezma/sbt-yourkit
• Owner: alejandrohdezma
• License: apache-2.0
• Created: 2021-10-15T18:23:28.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-15T05:22:40.000Z (2 months ago)
• Last Synced: 2024-11-15T06:23:09.490Z (2 months ago)
• Topics: docker, sbt-plugin, scala, yourkit
• Language: Scala
• Homepage:
• Size: 208 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Adds YourKit agent to Docker SBT apps

This plugin copies the [YourKit](https://www.yourkit.com) Docker agent into the image created by [sbt-native-packager](https://sbt-native-packager.readthedocs.io/en/latest/formats/docker.html) and attaches it to the running app.

## Installation

Add the following line to your `plugins.sbt` file:

```sbt

addSbtPlugin("com.alejandrohdezma" % "sbt-yourkit" % "0.3.0")

```

## Usage

By default, the plugin enables automatically if the `yourKitEnabled` setting is set to `true`:

```scala

ThisBuild / yourKitEnabled := true

```

However, if you want to enable this on a single SBT shell session, you can use the aliases `yourKit` or `yourKitOn`, for setting it to `true` and `yourKitOff`, for setting it to `false`.

### Changing the YourKit version

The [YourKit](https://www.yourkit.com) installed version can be customized with the `yourKitVersion` setting:

```scala

yourKitVersion := "2024.3"

```

Also remember to re-build your Docker image using `sbt "Docker / publishLocal"`.

### Profiler options

The profiler startup options can be customized using the `yourKitOptions` setting:

```scala

yourKitOptions += "port" -> "10002"

```

You can get more information about available options [here](https://www.yourkit.com/docs/java/help/startup_options.jsp).

By default these options are set to:

```

port=10001,listen=all,sessionname={normalizedName.value}

```