Skip to content
This repository was archived by the owner on Feb 1, 2024. It is now read-only.

Commit 51a03e0

Browse files
authored
Update Muzzle docs to describe VirtualField dependency (open-telemetry#9789)
1 parent e8ef8ba commit 51a03e0

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

docs/contributing/muzzle.md

+4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ symbols on the application classpath.
99

1010
Muzzle will prevent loading an instrumentation if it detects any mismatch or conflict.
1111

12+
Muzzle's dependency graph and class injection are encountered especially during the writing of
13+
[`instrumentation modules`](writing-instrumentation-module.md). This functionality is required if
14+
the packaged instrumentation utilizes `VirtualField`.
15+
1216
## How it works
1317

1418
Muzzle has two phases:

docs/contributing/writing-instrumentation-module.md

+3
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,9 @@ limited: the `VirtualField#get()` method must receive class references as its pa
341341
work with variables, method params, etc. Both the owner class and the field class must be known at
342342
compile time for it to work.
343343

344+
Use of `VirtualField` requires the `muzzle-generation` gradle plugin. Failing to use the plugin will result in
345+
ClassNotFoundException when trying to access the field.
346+
344347
### Why we don't use ByteBuddy @Advice.Origin Method
345348

346349
Instead of

0 commit comments

Comments
 (0)