Skip to content

[FormRecognizer] Whitelist redacted headers for logging #12285

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.

Sign up for GitHub

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
kinelski merged 2 commits into from
May 27, 2020
Merged

[FormRecognizer] Whitelist redacted headers for logging #12285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04c365c
Add safe headers
kinelski May 26, 2020
c2884b9
docs
kinelski May 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

- `FormRecognizerClient` and `FormTrainingClient` support authentication with Azure Active Directory.
- Support to copy a custom model from one Form Recognizer resource to another.
- Headers that were marked as `REDACTED` in error messages and logs are now exposed by default.

### Fixes

Expand Down
15 changes: 15 additions & 0 deletions sdk/formrecognizer/Azure.AI.FormRecognizer/src/FormRecognizerClientOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ public class FormRecognizerClientOptions : ClientOptions
public FormRecognizerClientOptions(ServiceVersion version = LatestVersion)
{
Version = version;
AddLoggedHeaders();
}

/// <summary>
Expand Down Expand Up @@ -50,5 +51,19 @@ internal static string GetVersionString(ServiceVersion version)
_ => throw new NotSupportedException($"The service version {version} is not supported."),
};
}

/// <summary>
/// Add headers that are considered safe for logging or including in error messages
/// by default.
/// </summary>
private void AddLoggedHeaders()
{
Diagnostics.LoggedHeaderNames.Add("apim-request-id");
Diagnostics.LoggedHeaderNames.Add("Location");
Diagnostics.LoggedHeaderNames.Add("Operation-Location");
Diagnostics.LoggedHeaderNames.Add("Strict-Transport-Security");
Diagnostics.LoggedHeaderNames.Add("X-Content-Type-Options");
Diagnostics.LoggedHeaderNames.Add("x-envoy-upstream-service-time");
}
}
}