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

fix: dropped support for x-instana-service header #1355

Merged
merged 1 commit into from
Oct 10, 2024

Conversation

aryamohanan
Copy link
Contributor

@aryamohanan aryamohanan commented Oct 3, 2024

The capture of the X-Instana-Service header value as span.data.service has been removed from the tracer. According to the public documentation here:

By setting the X-Instana-Service HTTP header on a call, the destination service (the one receiving the HTTP request) is tagged with the value provided in the header.

Note: The X-Instana-Service HTTP header is not collected automatically. To use it, the Instana agent must be configured, as explained in "Capturing custom HTTP headers".

By default, Instana does not capture HTTP headers during tracing. However, you can configure HTTP header capture by modifying the agent's configuration file (/etc/instana/configuration.yaml) as follows:

com.instana.tracing:
  extra-http-headers:
    - 'X-Instana-Service'

The backend extracting the service name from the captured header.
Therefore, implementing this directly within our tracer by inspecting the X-Instana-Service header and adding the annotation is redundant. For this reason, the Instana tracer community has chosen not to capture the X-Instana-Service header within the tracer.

@aryamohanan aryamohanan force-pushed the deprecate-x-instana-service branch from 9dcffab to 1b52cc2 Compare October 9, 2024 03:23
@aryamohanan aryamohanan removed the WIP label Oct 9, 2024
@aryamohanan aryamohanan marked this pull request as ready for review October 9, 2024 03:25
@aryamohanan aryamohanan requested a review from a team as a code owner October 9, 2024 03:25
@aryamohanan aryamohanan requested a review from kirrg001 October 10, 2024 06:08
Copy link
Contributor

@kirrg001 kirrg001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Note: The X-Instana-Service HTTP header is not automatically collected. For it to work, the Instana agent must be configured , see "Capturing custom HTTP headers".

FYI Docs links are broken.

This is the correct link:
https://www.ibm.com/docs/en/instana-observability/current?topic=cha-configuring-host-agents-by-using-agent-configuration-file#capturing-custom-http-headers

We will fix it soon!

@kirrg001
Copy link
Contributor

Suggestion for commit body:

  • BREAKING CHANGE: ...
  • Migration: Please define the header in the agent config...blabla

@aryamohanan aryamohanan merged commit f2f2f73 into v4 Oct 10, 2024
1 check passed
@aryamohanan aryamohanan deleted the deprecate-x-instana-service branch October 10, 2024 07:45
@aryamohanan aryamohanan mentioned this pull request Oct 10, 2024
20 tasks
aryamohanan added a commit that referenced this pull request Oct 14, 2024
BREAKING CHANGE: 
- Migration: Please configure the Instana agent to capture the X-Instana-Service header in the agent's configuration file. 
- For details, see: https://www.ibm.com/docs/en/instana-observability/current?topic=applications-services#specify-the-x-instana-service-http-header.
aryamohanan added a commit that referenced this pull request Oct 14, 2024
BREAKING CHANGE: 
- Migration: Please configure the Instana agent to capture the X-Instana-Service header in the agent's configuration file. 
- For details, see: https://www.ibm.com/docs/en/instana-observability/current?topic=applications-services#specify-the-x-instana-service-http-header.
aryamohanan added a commit that referenced this pull request Oct 14, 2024
BREAKING CHANGE: 
- Migration: Please configure the Instana agent to capture the X-Instana-Service header in the agent's configuration file. 
- For details, see: https://www.ibm.com/docs/en/instana-observability/current?topic=applications-services#specify-the-x-instana-service-http-header.
aryamohanan added a commit that referenced this pull request Oct 14, 2024
BREAKING CHANGE: 
- Migration: Please configure the Instana agent to capture the X-Instana-Service header in the agent's configuration file. 
- For details, see: https://www.ibm.com/docs/en/instana-observability/current?topic=applications-services#specify-the-x-instana-service-http-header.
aryamohanan added a commit that referenced this pull request Oct 18, 2024
BREAKING CHANGE: 
- Migration: Please configure the Instana agent to capture the X-Instana-Service header in the agent's configuration file. 
- For details, see: https://www.ibm.com/docs/en/instana-observability/current?topic=applications-services#specify-the-x-instana-service-http-header.
aryamohanan added a commit that referenced this pull request Oct 21, 2024
BREAKING CHANGE: 
- Migration: Please configure the Instana agent to capture the X-Instana-Service header in the agent's configuration file. 
- For details, see: https://www.ibm.com/docs/en/instana-observability/current?topic=applications-services#specify-the-x-instana-service-http-header.
aryamohanan added a commit that referenced this pull request Oct 22, 2024
BREAKING CHANGE: 
- Migration: Please configure the Instana agent to capture the X-Instana-Service header in the agent's configuration file. 
- For details, see: https://www.ibm.com/docs/en/instana-observability/current?topic=applications-services#specify-the-x-instana-service-http-header.
aryamohanan added a commit that referenced this pull request Oct 23, 2024
BREAKING CHANGE: 
- Migration: Please configure the Instana agent to capture the X-Instana-Service header in the agent's configuration file. 
- For details, see: https://www.ibm.com/docs/en/instana-observability/current?topic=applications-services#specify-the-x-instana-service-http-header.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants