doc: customized auto-instrumentation #762
Conversation
|
i can not add reviewer, so ping @svrnm directly |
|
Thank you @cuichenli ! |
| kind: Instrumentation | ||
| metadata: | ||
| name: my-instrumentation | ||
| spec: |
There was a problem hiding this comment.
could you please change the CR and keep only the image configuration?
README.md
Outdated
| - Java | ||
| - Download your customized `javaagent.jar` to `/javaagent.jar`. This is required as when instrumenting the pod, | ||
| one init container will be created to copy the jar to your app's container. | ||
| - To customize the instrumentation library, you may need fork https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/javaagent |
There was a problem hiding this comment.
We can remove this line, there are different ways how the java agent can be modified or extended. Most users won't probably do it anyways.
README.md
Outdated
| @@ -215,6 +215,61 @@ The possible values for the annotation can be | |||
| * `"my-instrumentation"` - name of `Instrumentation` CR instance. | |||
| * `"false"` - do not inject | |||
|
|
|||
| #### Use Customized Image for auto-instrumentation injection | |||
There was a problem hiding this comment.
Use customized or vendor instrumentation
README.md
Outdated
| @@ -215,6 +215,61 @@ The possible values for the annotation can be | |||
| * `"my-instrumentation"` - name of `Instrumentation` CR instance. | |||
| * `"false"` - do not inject | |||
|
|
|||
| #### Use Customized Image for auto-instrumentation injection | |||
|
|
|||
| Although the default auto-instrumentation image can handle some mostly used libraries, it may still | |||
There was a problem hiding this comment.
By default, the operator uses upstream auto-instrumentation libraries. Custom auto-instrumentation can be configured by overriding the image field in a CR.
README.md
Outdated
|
|
||
| To build your customized image, you can start by reusing the default dockerfiles. They are stored in the `autoinstrumentation` | ||
| directory. In general, you should comply with the guidelines below. | ||
| - Python |
There was a problem hiding this comment.
I actually don't like to have this detailed information in the root readme.
Could we move this doc to auto-instrumentation dockefiles and describe there what to do if a custom image needs to be build?
There was a problem hiding this comment.
moved to dockerfiles
README.md
Outdated
| image: your-customized-auto-instrumentation-image:python | ||
| ``` | ||
|
|
||
| To build your customized image, you can start by reusing the default dockerfiles. They are stored in the `autoinstrumentation` |
There was a problem hiding this comment.
The Dockerfiles for auto-instrumentation can be found in [autoinstrumentation directory](./autoinstrumentation). Follow the instructions in the Dockerfiles on how to build a custom container image.
There was a problem hiding this comment.
Thanks for the PR @cuichenli. This is good enough to go in. We could iterate and improve by making the makefiles more extensible and minimize (e.g. define env vars with URLs for auto-instrumentation libs) the comments in there.
…tion (open-telemetry#762) * doc: customized auto-instrumentation * doc: update based on comments * doc: wording * doc: update based on comments * doc: update based on comments
fixes #752