-
Notifications
You must be signed in to change notification settings - Fork 156
Add troubleshooting guide for missing app telemetry in Kibana #2784
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
32d5962
Add "missing app telemetry" page
alexandra5000 7177405
Tidy up the tip, minor tweaks
alexandra5000 de90e92
Apply comments
alexandra5000 bfec03f
Apply SME comments
alexandra5000 c2da71c
Merge remote-tracking branch 'upstream/main' into sdk-disabled
alexandra5000 885c5df
Minor wording updates
alexandra5000 2c495c3
Merge branch 'main' into sdk-disabled
alexandra5000 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
176 changes: 176 additions & 0 deletions
176
troubleshoot/ingest/opentelemetry/edot-sdks/missing-app-telemetry.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,176 @@ | ||
--- | ||
navigation_title: No app-level telemetry in Kibana | ||
description: Diagnose lack of telemetry flow due to issues with EDOT SDKs. | ||
applies_to: | ||
stack: | ||
serverless: | ||
observability: | ||
product: | ||
edot_sdk: ga | ||
products: | ||
- id: cloud-serverless | ||
- id: observability | ||
- id: edot-sdk | ||
--- | ||
|
||
# No application-level telemetry visible in Kibana | ||
|
||
This page helps you diagnose why application-level telemetry doesn’t appear when using {{edot}} (EDOT) SDKs: | ||
|
||
* [The SDK is turned off (`OTEL_SDK_DISABLED`)](#sdk-disabled) | ||
* [Auto-instrumentation or SDK initialization runs at the wrong time](#auto-instrumentation-not-attached) | ||
* [The runtime or framework isn’t supported, or is only partially supported](#framework-not-supported) | ||
|
||
|
||
## Quick triage checklist | ||
|
||
Use this table to quickly spot the usual causes and fixes. | ||
|
||
| What you see | Check | Likely fix | | ||
|----------------------------------|-----------------------------------------------|------------| | ||
| No telemetry at all | `OTEL_SDK_DISABLED`, exporters = `none`, sampler `always_off` | Unset `OTEL_SDK_DISABLED`, pick an exporter, use a non-zero sampler | | ||
| No/partial data from web requests | Loader order (preload/agent flags early) | Move loader earlier and restart the process | | ||
| Only custom code shows spans | Framework not supported/recognized | Align versions or add manual instrumentation | | ||
| Works locally, not on prod | Different environment/flags in container or service | Match prod environment settings and restart | | ||
| Still unsure | Enable debug logging | Inspect logs for disabled/unsupported/delayed initialization hints | | ||
|
||
### EDOT central configuration toggles at a glance | ||
|
||
If you use central configuration using OpAMP, these options can mute or change signals even when local `OTEL_*` looks correct. | ||
|
||
| Toggle | Effect | Typical symptom | | ||
|-----------------------------------------------|---------------------------------------------------------|-----------------| | ||
| `deactivate_all_instrumentations` | Disables all auto-instrumentations | No spans/metrics/logs from instrumented libraries | | ||
| `deactivate_instrumentations` | Disables selected instrumentation packages | Missing spans from specific frameworks/libraries | | ||
| `send_traces` / `send_metrics` / `send_logs` | Per-signal send switch | Only some signals arrive | | ||
| `elastic_otel_context_propagation_only` (Node.js) | Propagates context, doesn’t send it to the Collector | Cross-service context but nothing in Elastic | | ||
| `sampling_rate` | Adjusts trace sampling ratio | Fewer/more spans than expected | | ||
| `logging_level` | Changes SDK log verbosity | Affects debugging output only | | ||
|
||
|
||
## No telemetry and logs mention `SDK disabled` [sdk-disabled] | ||
|
||
If the logs mention `SDK disabled` or nothing at all, the SDK is likely deactivated in the configuration. | ||
|
||
Check the following: | ||
|
||
* **Environment variable** | ||
|
||
Many SDKs honor `OTEL_SDK_DISABLED=true`, or the equivalent in configuration files or flags. You can print the current value of the variable, for example: `printenv OTEL_SDK_DISABLED`. | ||
|
||
For SDK-specific details, see: | ||
* [Java](opentelemetry://reference/edot-sdks/java/setup/index.md) | ||
* [.NET](opentelemetry://reference/edot-sdks/dotnet/setup/index.md) | ||
* [Node.js](opentelemetry://reference/edot-sdks/nodejs/setup/index.md) | ||
* [Python](opentelemetry://reference/edot-sdks/python/setup/index.md) | ||
* [PHP](opentelemetry://reference/edot-sdks/php/setup/index.md) | ||
|
||
* **Exporter settings that effectively turn off signals** | ||
|
||
* `OTEL_TRACES_EXPORTER=none`, `OTEL_METRICS_EXPORTER=none`, or `OTEL_LOGS_EXPORTER=none` | ||
* Sampler turned off: `OTEL_TRACES_SAMPLER=always_off` or sampling probability set to `0.0` | ||
|
||
* **Multiple configuration sources** | ||
|
||
CI/CD pipelines or container manifests, such as Kubernetes `env:` blocks, might override local settings. These environments often require setting variables at deployment time. | ||
|
||
### Resolution [res-sdk-disabled] | ||
|
||
To fix the issue, try the following: | ||
|
||
* **Enable the SDK** | ||
|
||
Unset `OTEL_SDK_DISABLED` or set it to `false`. | ||
|
||
* **Enable exporters/sampler** | ||
|
||
Choose a valid exporter (for example `otlp`) and a sampling strategy with a non-zero probability (for example, `parentbased_traceidratio` with a ratio > 0). | ||
|
||
* **Restart the process** | ||
|
||
Restart after changing any configuration. Some SDKs only read environment variables at startup. | ||
|
||
If telemetry is still missing, you can enable debug logging. Refer to [Enable debug logging for EDOT SDKs](enable-debug-logging.md) for guidance. Make sure to [verify that you're looking at the right logs](enable-debug-logging.md#verify-youre-looking-at-the-right-logs). | ||
|
||
## Auto-instrumentation isn’t attaching [auto-instrumentation-not-attached] | ||
|
||
If auto-instrumentation isn’t attaching, or only partial data appears, the SDK or loader might be initializing too late, after the app or framework has already started. | ||
|
||
Check the following: | ||
|
||
* **What runs first** | ||
|
||
Ensure the SDK or auto-instrumentation loader runs before your app code, web server, or worker framework. | ||
|
||
**Using the OpenTelemetry Operator?** | ||
|
||
If you deploy using the OpenTelemetry Operator, verify that auto-instrumentation is injected correctly: | ||
|
||
1. **Instrumentation resource**: Confirm the `Instrumentation` CR matches your runtime (Java/.NET/Node/Python/PHP) and sets the intended options (for example `java.javaAgent`, `dotnet.env`, or `node.env`). | ||
2. **Pod injection**: Check that your workload has the expected annotations (or namespace injection enabled) and that new Pods were rolled to pick up injection. | ||
3. **Environment variables and startup flags present**: Run `kubectl describe pod/<pod>`. In the output, under Containers, the Environment section should list the expected loader flags (for example `JAVA_TOOL_OPTIONS`, `DOTNET_*`, or `NODE_OPTIONS`) and volume mounts for agents. | ||
4. **Webhook and injector logs**: Inspect the Operator and injector webhook logs for errors or skipped injections. | ||
5. **Restart and rollout**: After changing the `Instrumentation` or annotations, perform a rollout so containers start with the updated environment variables and startup flags. | ||
|
||
If you use EDOT-specific images or settings, align the Instrumentation configuration with EDOT’s SDK guidance for that language (see links below). | ||
|
||
|
||
* **Start-up mechanism by language** | ||
hegerchr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* **Java:** Use the `-javaagent:` flag as early as possible so it loads before `main()`. Refer to [Java SDK setup](opentelemetry://reference/edot-sdks/java/setup/index.md). | ||
|
||
* **.NET:** Set the profiler/auto-instrumentation environment variables before starting the process. Refer to [.NET SDK setup](opentelemetry://reference/edot-sdks/dotnet/setup/index.md). | ||
|
||
* **Node.js:** Use a preloader (for example `NODE_OPTIONS=--require <entry>`) or import the SDK before bootstrapping the app. Refer to [Node.js SDK setup](opentelemetry://reference/edot-sdks/nodejs/setup/index.md). | ||
|
||
* **Python:** Use the launcher (for example `opentelemetry-instrument …`) or import/initialize the SDK before the framework starts. Refer to [Python SDK setup](opentelemetry://reference/edot-sdks/python/setup/index.md). | ||
|
||
* **PHP:** Ensure the extension is loaded and restart PHP-FPM/Apache so bootstrap hooks are active. Refer to [PHP SDK setup](opentelemetry://reference/edot-sdks/php/setup/index.md). | ||
|
||
If using Docker or Kubernetes confirm preloading flags or environment variables are placed where the actual process starts. | ||
|
||
### Resolution [res-instrumentation] | ||
|
||
To fix the issue, try the following steps: | ||
|
||
1. Move agent/loader flags to the earliest possible point in your startup chain. | ||
2. Confirm the loader runs. Debug logs should show detected instrumentations or patched modules. | ||
3. Fully restart the service, as reloads are often insufficient for preloaders/agents. | ||
|
||
:::{tip} | ||
In debug logs, look for lines that mention `installing instrumentation for …` or `detected framework … version …`. Lack of these hints usually means the loader didn’t run early enough. | ||
::: | ||
|
||
## App starts, SDK loads, but no telemetry for your framework [framework-not-supported] | ||
alexandra5000 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
If the app and SDK load correctly but no spans, metrics, or logs appear for your framework, the runtime, framework, or library may not be supported or are only partially instrumented. | ||
|
||
Check the following: | ||
|
||
* **Compatibility tables** | ||
|
||
Verify that your runtime and frameworks are supported by the SDK. Refer to the [EDOT SDK compatibility reference](opentelemetry://reference/compatibility/sdks.md) for more information. | ||
|
||
* **Major version mismatches** | ||
|
||
New major versions of frameworks may not yet be supported and can break auto-instrumentation. | ||
|
||
* **Partial coverage** | ||
|
||
Some scenarios may require manual instrumentation. | ||
|
||
### Resolution [res-framework] | ||
|
||
To fix the issue, try the following: | ||
|
||
* **Align versions** | ||
|
||
Upgrade or downgrade the SDK or framework to a supported combination. | ||
|
||
* **Add manual instrumentation** | ||
|
||
Instrument code paths not covered by the agent. | ||
|
||
* **Retest with a minimal app** | ||
|
||
Strip down to core dependencies to rule out issues introduced by third-party libraries. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.