From f3a839098d3c3a46f2d8b41a22a2537e13ce12d2 Mon Sep 17 00:00:00 2001 From: Daniel Mikusa Date: Mon, 20 May 2024 10:17:56 -0400 Subject: [PATCH] Update README.md Clarify behavior. --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7e94f22..68100b7 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 |----------------------|---------|------------ |`` | `` | If needed, the buildpack will fetch the dependency with digest `` from `` ## 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