Skip to content

Commit

Permalink
Update operator integration statuses and feature gate options
Browse files Browse the repository at this point in the history
  • Loading branch information
@jvoravong
jvoravong committed Apr 15, 2024
1 parent eb8a328 commit d938caa
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 20 deletions.
28 changes: 12 additions & 16 deletions docs/auto-instrumentation-install.md
View file
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 Library | Distribution | Status | Splunk Support | Splunk Content Compatibility | Code Repository | Image Repository |
|-------------------------|----------------|--------------|------------------|------------------------------|---------------------------------------------------------------------|---------------------------------------------------------------------------------|
| Java | Splunk | Stable | Full | Fully Compatible | [Link](https://github.com/signalfx/splunk-otel-java) | ghcr.io/signalfx/splunk-otel-java/splunk-otel-java |
| NodeJS | Splunk | Stable | Full | Fully Compatible | [Link](https://github.com/signalfx/splunk-otel-js) | ghcr.io/signalfx/splunk-otel-java/splunk-otel-js |
| DotNet | Splunk | Stable | Full | Fully Compatible | [Link](https://github.com/signalfx/splunk-otel-dotnet) | ghcr.io/signalfx/splunk-otel-dotnet/splunk-otel-dotnet |
| Python | Splunk | Experimental | Best Effort | Partially Compatible | [Link](https://github.com/open-telemetry/opentelemetry-python) | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-python |
| ApacheHttpD | OpenTelemetry | Experimental | Best Effort | Partially Compatible | [Link](https://github.com/open-telemetry/opentelemetry-cpp-contrib) | ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd |
| Go | OpenTelemetry | Experimental | Best Effort | Partially Compatible | [Link](https://github.com/open-telemetry/opentelemetry-go) | ghcr.io/open-telemetry/opentelemetry-go-instrumentation/autoinstrumentation-go |
| Nginx | OpenTelemetry | Experimental | Best Effort | Partially Compatible | [Link](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
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] Auto-instrumentation is enabled (operator.enabled=true). This feature allows the operator to automatically instrument applications hosted in Kubernetes. Note that the maturity of integrations may vary based on the application language.
- Status: Maturity levels of language instrumentation vary. See the table below for details on each language's integration status and other relevant information.
- Usage: Some instrumentation languages are enabled by default, while others require manual activation using feature gates (`operator.manager.featureGates=+operator.autoinstrumentation.{language}`).
- Splunk Support: Full support is provided for Splunk distributions, and best-effort support is available for native OpenTelemetry instrumentation distributions. Consult `values.yaml` under `operator.instrumentation.spec` for details on the libraries used.
| Instrumentation Language | Feature Gate Name | Default Value | Status | Source URL |
|--------------------------|-----------------------------------------------------|---------------|----------------|-----------------------------------------------------------------|
| Java | `operator.autoinstrumentation.java` | Enabled | Stable | https://github.com/signalfx/splunk-otel-java/releases |
| NodeJS | `operator.autoinstrumentation.nodejs` | Enabled | Stable | https://github.com/signalfx/splunk-otel-js/releases |
| DotNet | `operator.autoinstrumentation.dotnet` | Enabled | Stable | https://github.com/signalfx/splunk-otel-dotnet/releases |
| Python | `operator.autoinstrumentation.python` | Enabled | Experimental | https://github.com/open-telemetry/opentelemetry-python/releases |
| ApacheHttpD | `operator.autoinstrumentation.apache-httpd` | Enabled | Experimental | https://github.com/open-telemetry/opentelemetry-cpp-contrib |
| 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
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:
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

0 comments on commit d938caa

Please sign in to comment.