Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: customized auto-instrumentation #762

Merged
merged 6 commits into from
Mar 15, 2022

Conversation

cuichenli
Copy link
Contributor

fixes #752

@cuichenli cuichenli requested a review from a team March 7, 2022 09:51
@cuichenli
Copy link
Contributor Author

i can not add reviewer, so ping @svrnm directly

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member

svrnm commented Mar 7, 2022

Thank you @cuichenli !

kind: Instrumentation
metadata:
name: my-instrumentation
spec:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please change the CR and keep only the image configuration?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use customized or vendor instrumentation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By default, the operator uses upstream auto-instrumentation libraries. Custom auto-instrumentation can be configured by overriding the image field in a CR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`
Copy link
Member

@pavolloffay pavolloffay Mar 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Copy link
Member

@pavolloffay pavolloffay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@pavolloffay pavolloffay merged commit 65c2bec into open-telemetry:main Mar 15, 2022
ItielOlenick pushed a commit to ItielOlenick/opentelemetry-operator that referenced this pull request May 1, 2024
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Using custom auto-instrumentation distributions/images
3 participants