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

Merge main into 8.16 branch #44

Merged
merged 19 commits into from
Nov 4, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
minor changes before drafting PR
  • Loading branch information
eedugon committed Oct 22, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 2f94388da7370df60408ab9d178a323d760815e8
20 changes: 9 additions & 11 deletions docs/kubernetes/operator/instrumenting-applications.md
Original file line number Diff line number Diff line change
@@ -51,13 +51,7 @@ Before starting with application auto-instrumentation, ensure the following prer

## Auto-instrumentation basics

Zero-code instrumenation is handled by the operator through `Instrumenation` objects.

The process is common to all supported languages, and it follows the usual OTel Operator steps for [auto-instrumentation injection](https://github.com/open-telemetry/opentelemetry-operator#opentelemetry-auto-instrumentation-injection):

1. Install the OTel Operator into a k8s cluster.
2. Create a `kind: Instrumentation` object with the appropriate config.
3. Deploy a pod or deployment with the appropriate annotation.
Zero-code instrumenation is handled by the operator through `Instrumenation` objects, and it follows the usual OTel Operator steps for [auto-instrumentation injection](https://github.com/open-telemetry/opentelemetry-operator#opentelemetry-auto-instrumentation-injection).

If you followed the [getting started guide](./README.md) to install the operator, there should be an `Instrumentation` object with name `elastic-instrumentation` in namespace `opentelemetry-operator-system`. The `Instrumentation` object stores important parameters:

@@ -141,15 +135,19 @@ You can apply OTEL specific configuration to your applications at two different
- At Pod/container level, by using OTEL related environment variables.
- At `Instrumentation` object level, for example configuring different settings per language.

Use cases:
- Change the library to be injected.
- Change the exporter endpoint.
- Apply certain logging level settings (OTEL_LOG_LEVEL).

### Manual creation of Instrumentation objects

Consider also the creation of different `Instrumentation` objects for different purposes, such as:

- Different configuration options for certain languages.
- Trying out different versions of the SDKs.

Use cases:
- Change the library to be injected.
- Change the exporter endpoint.
- Apply certain logging level settings (OTEL_LOG_LEVEL).
(TBD: add instructions and references about Instrumentation objects)


## Manual instrumentation