Skip to content

Commit

Permalink
Merge pull request #130 from paketo-buildpacks/dmikusa-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
dmikusa authored May 20, 2024
2 parents 9c93485 + f3a8390 commit a8f2190
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,20 @@ connect to the service.
[y]: https://www.yourkit.com

## Behavior

This buildpack will participate if all the following conditions are met

* `$BP_YOURKIT_ENABLED` is set

The buildpack will do the following:
The buildpack will do the following at build time:

* Contributes a Java agent to a layer
* Contributes a helper that configures the agent at runtime

* Contributes a Java agent to a layer and configures `$JAVA_TOOL_OPTIONS` to use it
The helper binary runs at launch time and executes before your application. It reads the `BPL_*` configuration settings and uses them to configure the YourKit agent.

## Configuration

| Environment Variable | Description
| -------------------- | -----------
| `$BP_YOURKIT_ENABLED` | Whether to contribute YourKit support
Expand All @@ -22,14 +27,17 @@ The buildpack will do the following:
| `$BPL_YOURKIT_SESSION_NAME` | Configure the session's name.

## Bindings

The buildpack optionally accepts the following bindings:

### Type: `dependency-mapping`

|Key | Value | Description
|----------------------|---------|------------
|`<dependency-digest>` | `<uri>` | If needed, the buildpack will fetch the dependency with digest `<dependency-digest>` from `<uri>`

## Publishing the Port

When starting an application with the YourKit Profiler enabled, a port must be published. To publish the port in Docker, use the following command:

```bash
Expand Down

0 comments on commit a8f2190

Please sign in to comment.