Document handling of empty OperationId in logs#128629
Open
syukumoto wants to merge 1 commit into
Open
Conversation
Added information about empty OperationId in application logs and how to instrument logging with Application Insights agent. Background When a Java Azure Functions app enables the OpenTelemetry integration (`telemetryMode: "OpenTelemetry"` in host.json), application logs written by the function code can be ingested into Application Insights with an empty `operation_Id`. As already noted in the "Duplicate OperationId" entry, `operation_Id` is derived from the incoming `traceparent` and is applied only to telemetry emitted within the invocation context. Application logs that are forwarded by the Functions host (rather than emitted within the invocation context) are therefore recorded without an `operation_Id`, so they don't correlate with the invocation's request and trace in the end-to-end transaction view.
Contributor
|
@syukumoto : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
Contributor
|
Learn Build status updates of commit 3f265a4:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| articles/azure-functions/opentelemetry-howto.md | Details |
articles/azure-functions/opentelemetry-howto.md
- Line 626, Column 191: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 626, Column 191: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
|
|
||
| As described in Duplicate OperationId, the operation_Id is applied to telemetry that is emitted within the invocation context. Application logs emitted outside that context—for example, logs that the Functions host forwards—are recorded without an operation_Id. | ||
|
|
||
| If you need OperationId in your application logs, use the Application Insights agent to instrument your logging framework instead of the OpenTelemetry mode: enable the agent as described in [Enable Azure Monitor OpenTelemetry for .NET, Node.js, Python, and Java applications](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java). The agent stamps the trace context (operation_Id = trace ID) on the logs it emits within the invocation context. |
Contributor
There was a problem hiding this comment.
Suggested change
| If you need OperationId in your application logs, use the Application Insights agent to instrument your logging framework instead of the OpenTelemetry mode: enable the agent as described in [Enable Azure Monitor OpenTelemetry for .NET, Node.js, Python, and Java applications](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java). The agent stamps the trace context (operation_Id = trace ID) on the logs it emits within the invocation context. | |
| If you need OperationId in your application logs, use the Application Insights agent to instrument your logging framework instead of the OpenTelemetry mode: enable the agent as described in [Enable Azure Monitor OpenTelemetry for .NET, Node.js, Python, and Java applications](/azure/azure-monitor/app/opentelemetry-enable?tabs=java). The agent stamps the trace context (operation_Id = trace ID) on the logs it emits within the invocation context. |
Contributor
|
Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
Bot
added
the
aq-pr-triaged
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Documents why Java Azure Functions logs can show an empty operation_Id when telemetryMode: "OpenTelemetry" is enabled, and provides guidance on using the Application Insights agent to get correlated log context.
Changes:
- Adds a new troubleshooting section explaining empty
operation_Idfor application logs forwarded by the Functions host. - Provides mitigation guidance: instrument logging via the Application Insights agent and remove
telemetryMode: "OpenTelemetry"fromhost.json.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+622
to
+626
| Application logs written by your function code can appear in the traces table with an empty operation_Id. As a result, they don't correlate with the invocation's request and trace in the end-to-end transaction view. | ||
|
|
||
| As described in Duplicate OperationId, the operation_Id is applied to telemetry that is emitted within the invocation context. Application logs emitted outside that context—for example, logs that the Functions host forwards—are recorded without an operation_Id. | ||
|
|
||
| If you need OperationId in your application logs, use the Application Insights agent to instrument your logging framework instead of the OpenTelemetry mode: enable the agent as described in [Enable Azure Monitor OpenTelemetry for .NET, Node.js, Python, and Java applications](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java). The agent stamps the trace context (operation_Id = trace ID) on the logs it emits within the invocation context. |
|
|
||
| Application logs written by your function code can appear in the traces table with an empty operation_Id. As a result, they don't correlate with the invocation's request and trace in the end-to-end transaction view. | ||
|
|
||
| As described in Duplicate OperationId, the operation_Id is applied to telemetry that is emitted within the invocation context. Application logs emitted outside that context—for example, logs that the Functions host forwards—are recorded without an operation_Id. |
|
|
||
| If you need OperationId in your application logs, use the Application Insights agent to instrument your logging framework instead of the OpenTelemetry mode: enable the agent as described in [Enable Azure Monitor OpenTelemetry for .NET, Node.js, Python, and Java applications](https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=java). The agent stamps the trace context (operation_Id = trace ID) on the logs it emits within the invocation context. | ||
|
|
||
| Make sure telemetryMode isn't set to OpenTelemetry in your `host.json`. If you added `"telemetryMode": "OpenTelemetry"`, remove it. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added information about empty OperationId in application logs and how to instrument logging with Application Insights agent.
Background
When a Java Azure Functions app enables the OpenTelemetry integration (
telemetryMode: "OpenTelemetry"in host.json), application logs written by the function code can be ingested into Application Insights with an emptyoperation_Id. As already noted in the "Duplicate OperationId" entry,operation_Idis derived from the incomingtraceparentand is applied only to telemetry emitted within the invocation context. Application logs that are forwarded by the Functions host (rather than emitted within the invocation context) are therefore recorded without anoperation_Id, so they don't correlate with the invocation's request and trace in the end-to-end transaction view.