sdk icon indicating copy to clipboard operation
sdk copied to clipboard

Feature: Option to obfuscate URL path if any part is sensitive

Open aaronsteers opened this issue 3 years ago • 2 comments
trafficstars

Feature scope

Taps (catalog, state, stream maps, etc.)

Description

In #785, we began printing the entire URL path when an error occurs, where previously we had only printed a symbolic representation such as https://mysite.com/project/{project_id}/customers instead of https://mysite.com/project/123/customers.

The cases where the full URL is not safe to print should be very rare, and the full URL is only printed on failure, but nevertheless some developers may benefit from a boolean mask_url=true or similar, to prevent the path from being printed.

In absence of a toggle of some sort, developers should override the method and print only a symbolic or obfuscated URL upon failure. (Docstring and the respective docs have been updated with this guidance.)

aaronsteers avatar Jul 22 '22 06:07 aaronsteers