From 410181542f647c23a689cf22ee2a20667380225a Mon Sep 17 00:00:00 2001 From: Steve Rao Date: Fri, 7 Mar 2025 10:46:47 +0800 Subject: [PATCH 1/4] Add distro's introduction to README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 9a64fa312efe..1bb7b22cda2a 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,10 @@ having to create a separate distribution or to fork this repository. For example custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a single jar file. +## Creating agent distribution + +[Distro](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. + ## Manually instrumenting For most users, the out-of-the-box instrumentation is completely sufficient and nothing more has to From 03ce59647749b3c686422f7384513b7198a3ee05 Mon Sep 17 00:00:00 2001 From: Steve Rao Date: Fri, 7 Mar 2025 20:42:52 +0800 Subject: [PATCH 2/4] Update README.md Co-authored-by: Jay DeLuca --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1bb7b22cda2a..ac7fa429323d 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ having to create a separate distribution or to fork this repository. For example custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a single jar file. -## Creating agent distribution +## Creating an agent distribution [Distro](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. From df341c19391db0663db5abf9f825d08d9f2d8fe4 Mon Sep 17 00:00:00 2001 From: Steve Rao Date: Fri, 7 Mar 2025 20:49:09 +0800 Subject: [PATCH 3/4] Address review comment --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ac7fa429323d..9a0db57c7651 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ single jar file. ## Creating an agent distribution -[Distro](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. +[Distribution](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. ## Manually instrumenting From 0db262ab59380dcb2cac1b93f04e0d1220055c0a Mon Sep 17 00:00:00 2001 From: Steve Rao Date: Thu, 13 Mar 2025 16:52:05 +0800 Subject: [PATCH 4/4] Update README.md Co-authored-by: Trask Stalnaker --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9a0db57c7651..ef7213155e86 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,7 @@ single jar file. ## Creating an agent distribution [Distribution](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. +[Agent extensions](#creating-agent-extensions) are recommended instead for most users as they are simpler and do not require rebuilding with each OpenTelemetry Java agent release. ## Manually instrumenting