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

Questions on query string redaction #1852

Open
jeanbisutti opened this issue Jan 30, 2025 · 5 comments
Open

Questions on query string redaction #1852

jeanbisutti opened this issue Jan 30, 2025 · 5 comments
Labels
area:http question Further information is requested triage:needs-triage

Comments

@jeanbisutti
Copy link
Member

The specifications:

Image

https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md

  1. Should the percent-encoded parameter names be ignored?
    For example the percent-encoding of sig is %73%69%67. Should%73%69%67 be ignored?

  2. Should the parameter names be case-sensitive?
    For example, should x-goog-signature be ignored?

@arminru
Copy link
Member

arminru commented Feb 4, 2025

cc @open-telemetry/semconv-http-approvers

@joaopgrassi
Copy link
Member

My understanding is that the values of the keys are to be redacted, not the keys themselves.

@jeanbisutti
Copy link
Member Author

Let me clarify the first question from an example.

With percent-encoding, sig becomes %73%69%67.

If the url contains the %73%69%67 parameter name, has the parameter value of this parameter to be redacted?

For the second question, if the url contains the SIG parameter name, , has the parameter value of this parameter to be redacted?

@joaopgrassi
Copy link
Member

I see.

My opinion on casing would be to be case-insensitive.

As for the url-encoded of keys and if their values should be redacted, probably trickier but without giving too much thought I'd say its value should also be redacted.

@joaopgrassi joaopgrassi added question Further information is requested area:http labels Feb 5, 2025
@trask
Copy link
Member

trask commented Feb 5, 2025

my understanding is that query string parameter keys are case-sensitive

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:http question Further information is requested triage:needs-triage
Projects
Status: Need triage
Development

No branches or pull requests

4 participants