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.

Sign up for GitHub

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

Update operator integration statuses and cli arg options #1251

Closed
wants to merge 13 commits into from
Closed

Update operator integration statuses and cli arg options #1251

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b99a3d8
Update operator integration statuses and feature gate options
jvoravong Apr 15, 2024
2df16a4
patch, remove column
jvoravong Apr 15, 2024
cfbfd92
temp: add simple feature gate fix
jvoravong Apr 17, 2024
27ca4dc
patch update docs
jvoravong Apr 17, 2024
b81b9a8
patch
jvoravong Apr 29, 2024
e4a19e5
patch, fix space
jvoravong Apr 30, 2024
40244e3
patch, refactor operator feature gates to be cli args, add customer n…
jvoravong Apr 30, 2024
e00d4a9
patch, update Notes.txt
jvoravong Apr 30, 2024
128f36e
ghwf fix
jvoravong May 17, 2024
e4b4506
Update operator to v0.99.0 while keeping operator chart at v0.49.1 du…
jvoravong May 17, 2024
3b78d27
Update nodejs functional tests due to v0.99.0 operator upgrade
jvoravong May 17, 2024
9576dd3
Update changelogs and rendered content
jvoravong May 17, 2024
132ad4e
Update feature gate references to command line arg references
jvoravong May 17, 2024
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
28 changes: 12 additions & 16 deletions docs/auto-instrumentation-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,22 +371,18 @@ Below is a breakdown of the main and related components involved in auto-instrum

### Instrumentation Libraries

In the table below current instrumentation libraries are listed, if they are supported, and how compatible they are
with Splunk customer content.
_The native OpenTelemetry instrumentation libraries are owned and maintained by the OpenTelemetry Community, Splunk
provides best effort support with issues related to native OpenTelemetry instrumentation libraries._

| Instrumentation Library | Distribution | Status | Supported | Splunk Content Compatability | Code Repo | Image Repo |
|-------------------------|---------------|-------------|------------------|------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
| java | Splunk | Available | Yes | Completely | [Link](github.com/signalfx/splunk-otel-java) | ghcr.io/signalfx/splunk-otel-java/splunk-otel-java |
| dotnet | Splunk | Coming Soon | | | [Link](github.com/signalfx/splunk-otel-dotnet) | |
| nodejs | Splunk | Available | Yes | Completely | [Link](github.com/signalfx/splunk-otel-nodejs) | ghcr.io/signalfx/splunk-otel-java/splunk-otel-js |
| python | Splunk | Coming Soon | | | [Link](github.com/signalfx/splunk-otel-python) | |
| java | OpenTelemetry | Available | Yes | Mostly | [Link](https://github.com/open-telemetry/opentelemetry-java-instrumentation) | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-java |
| dotnet | OpenTelemetry | Available | Yes | Mostly | [Link](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation) | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-dotnet |
| nodejs | OpenTelemetry | Available | Yes | Mostly | [Link](https://github.com/open-telemetry/opentelemetry-nodejs-instrumentation) | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-nodes |
| python | OpenTelemetry | Available | Needs Validation | | [Link](https://github.com/open-telemetry/opentelemetry-java-instrumentation) | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-java |
| apache-httpd | OpenTelemetry | Available | Needs Validation | | [Link](https://github.com/open-telemetry/opentelemetry-apache-httpd-instrumentation) | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd |
The table below lists the current instrumentation libraries, their availability, and their compatibility with Splunk customer content.
_Note: Native OpenTelemetry instrumentation libraries are owned and maintained by the OpenTelemetry Community. Splunk provides best effort support for issues related to these libraries._

| Instrumentation Language | Distribution | Feature Gate Name | Feature Gate Default Value | Status | Splunk Content Compatibility | Code Repository | Source URL | Image Repository |
|--------------------------|----------------|-------------------------------------------------------|----------------------------|----------------|------------------------------|---------------------------------------------------------------------|-------------------------------------------------------------|--------------------------------------------------------------------------------|
| Java | Splunk | `operator.autoinstrumentation.java` | Enabled | Stable | Fully Compatible | [Link](https://github.com/signalfx/splunk-otel-java) | https://github.com/signalfx/splunk-otel-java | ghcr.io/signalfx/splunk-otel-java/splunk-otel-java |
| NodeJS | Splunk | `operator.autoinstrumentation.nodejs` | Enabled | Stable | Fully Compatible | [Link](https://github.com/signalfx/splunk-otel-js) | https://github.com/signalfx/splunk-otel-js | ghcr.io/signalfx/splunk-otel-java/splunk-otel-js |
| DotNet | Splunk | `operator.autoinstrumentation.dotnet` | Enabled | Stable | Fully Compatible | [Link](https://github.com/signalfx/splunk-otel-dotnet) | https://github.com/signalfx/splunk-otel-dotnet | ghcr.io/signalfx/splunk-otel-java/splunk-otel-dotnet |
| Python | Splunk | `operator.autoinstrumentation.python` | Enabled | Experimental | Partially Compatible | [Link](https://github.com/open-telemetry/opentelemetry-python) | https://github.com/open-telemetry/opentelemetry-python | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-python |
jvoravong marked this conversation as resolved.
Show resolved Hide resolved
| ApacheHttpD | OpenTelemetry | `operator.autoinstrumentation.apache-httpd` | Enabled | Experimental | Partially Compatible | [Link](https://github.com/open-telemetry/opentelemetry-cpp-contrib) | https://github.com/open-telemetry/opentelemetry-cpp-contrib | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd |
jvoravong marked this conversation as resolved.
Show resolved Hide resolved
| Go | OpenTelemetry | `operator.autoinstrumentation.go` | Disabled | Experimental | Partially Compatible | [Link](https://github.com/open-telemetry/opentelemetry-go) | https://github.com/open-telemetry/opentelemetry-go | ghcr.io/open-telemetry/opentelemetry-go-instrumentation/autoinstrumentation-go |
| Nginx | OpenTelemetry | `operator.autoinstrumentation.nginx` | Disabled | Experimental | Partially Compatible | [Link](https://github.com/open-telemetry/opentelemetry-cpp-contrib) | https://github.com/open-telemetry/opentelemetry-cpp-contrib | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd |

### Documentation Resources

Expand Down
17 changes: 13 additions & 4 deletions helm-charts/splunk-otel-collector/templates/NOTES.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,17 @@ Splunk OpenTelemetry Collector is installed and configured to send data to Splun
Upgrade guidelines: https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#0670-to-0680
{{ end }}
{{- if .Values.operator.enabled }}
[INFO] You've enabled the operator's auto-instrumentation feature (operator.enabled=true), currently considered ALPHA.
- Instrumentation library maturity varies (e.g., Java is more mature than Go). For library stability, visit: https://opentelemetry.io/docs/instrumentation/#status-and-releases
- Some libraries may be enabled by default. For current status, see: https://github.com/open-telemetry/opentelemetry-operator#controlling-instrumentation-capabilities
- Splunk provides best-effort support for native OpenTelemetry libraries, and full support for Splunk library distributions. For used libraries, refer to the values.yaml under "operator.instrumentation.spec".
[INFO] You've enabled the operator's auto-instrumentation feature (operator.enabled=true)! The operator can automatically instrument Kubernetes hosted applications, the integration maturity can vary per application language.
- Status: Instrumentation language maturity varies. Below is a table detailing each integration language's status and relevant information.
- Usage: Certain instrumentation languages are enabled by default while other must be enabled manually using feature gates (operator.manager.featureGates=+operator.autoinstrumentation.{language}).
- Splunk Support: We offer full support for Splunk distributions and best-effort support for native OpenTelemetry instrumentation distributions of instrumentation language libraries. See `values.yaml` under `operator.instrumentation.spec` for more information on what libraries are utilized.
| Instrumentation Language | Feature Gate Name | Feature Gate Default Value | Status | Source URL |
|--------------------------|-------------------------------------------------------|----------------------------|--------------|-----------------------------------------------------------------|
| Java | `operator.autoinstrumentation.java` | Enabled | Stable | https://github.com/signalfx/splunk-otel-java |
| NodeJS | `operator.autoinstrumentation.nodejs` | Enabled | Stable | https://github.com/signalfx/splunk-otel-js |
| DotNet | `operator.autoinstrumentation.dotnet` | Enabled | Stable | https://github.com/signalfx/splunk-otel-dotnet |
| Python | `operator.autoinstrumentation.python` | Enabled | Experimental | https://github.com/open-telemetry/opentelemetry-python |
| ApacheHttpD | `operator.autoinstrumentation.apache-httpd` | Enabled | Experimental | https://github.com/open-telemetry/opentelemetry-cpp-contrib |
jvoravong marked this conversation as resolved.
Show resolved Hide resolved
| Go | `operator.autoinstrumentation.go` | Disabled | Experimental | https://github.com/open-telemetry/opentelemetry-go |
| Nginx | `operator.autoinstrumentation.nginx` | Disabled | Experimental | https://github.com/open-telemetry/opentelemetry-cpp-contrib |
{{- end }}
2 changes: 2 additions & 0 deletions helm-charts/splunk-otel-collector/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1206,6 +1206,7 @@ operator:
env:
- name: OTEL_DOTNET_AUTO_PLUGINS
value: Splunk.OpenTelemetry.AutoInstrumentation.Plugin, Splunk.OpenTelemetry.AutoInstrumentation
# Instrumentation for go is disabled by default, enable it with `operator.manager.featureGates=+operator.autoinstrumentation.go”`
go:
repository: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-go
tag: v0.10.1-alpha
Expand All @@ -1215,6 +1216,7 @@ operator:
python:
jvoravong marked this conversation as resolved.
Show resolved Hide resolved
repository: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-python
tag: 0.44b0
# Instrumentation for nginx is disabled by default, enable it with `operator.manager.featureGates=+operator.autoinstrumentation.nginx”`
nginx:
repository: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd
tag: 1.0.4
Expand Down
Loading