def _assertScrubbed(self,
params_to_scrub,
start,
expected,
scrub_username=False,
scrub_password=True,
redact_char='-',
skip_id_check=False):
scrubber = ScrubUrlTransform(suffixes=[],
params_to_scrub=params_to_scrub,
scrub_username=scrub_username,
scrub_password=scrub_password,
redact_char=redact_char,
randomize_len=False)
result = transforms.transform(start, [scrubber])
"""
print(start)
print(result)
print(expected)
"""
if not skip_id_check:
self.assertNotEqual(id(result), id(expected))
self.assertEqual(type(expected), type(result))
self.assertIsInstance(result, string_types)
self._compare_urls(expected, result)
def test_scrub_dict_val_isnt_string(self):
# This link will *not* be scrubbed because the value isn't a string or bytes
obj = {'url': ['cory:[email protected]/asdf?password=secret&clear=text']}
scrubber = ScrubUrlTransform(suffixes=[('url', )],
params_to_scrub=['password'],
randomize_len=False)
result = transforms.transform(obj, [scrubber])
expected = copy.deepcopy(obj)
self.assertDictEqual(expected, result)
def test_scrub_dict_val_isnt_string(self):
url = 'cory:[email protected]/asdf?password=secret&clear=text'
# Every string which is a URL should be scrubbed
obj = {'url': [url]}
scrubber = ScrubUrlTransform(suffixes=[('url', )],
params_to_scrub=['password'],
randomize_len=False)
result = transforms.transform(obj, scrubber)
expected = url.replace('secr3t', '------').replace('secret', '------')
self._assertScrubbed(['password'], result['url'][0], expected)
def test_scrub_dict_nested_key_match_with_circular_ref(self):
# If a URL is a circular reference then let's make sure to
# show the scrubbed, original URL
url = 'cory:[email protected]/asdf?password=secret&clear=text'
obj = {'url': [{'link': url}], 'link': [{'url': url}]}
scrubber = ScrubUrlTransform(suffixes=[('url', ), ('link', )],
params_to_scrub=['password'],
randomize_len=False)
result = transforms.transform(obj, scrubber)
self.assertNotIn('secr3t', result['url'][0]['link'])
self.assertNotIn('secret', result['url'][0]['link'])
self.assertNotIn('secr3t', result['link'][0]['url'])
self.assertNotIn('secret', result['link'][0]['url'])
self.assertNotRegex(result['url'][0]['link'], r'^-+$')
self.assertNotRegex(result['link'][0]['url'], r'^-+$')
def init(access_token, environment='production', **kw):
"""
Saves configuration variables in this module's SETTINGS.
access_token: project access token. Get this from the Rollbar UI:
- click "Settings" in the top nav
- click "Projects" in the left nav
- copy-paste the appropriate token.
environment: environment name. Can be any string; suggestions: 'production', 'development',
'staging', 'yourname'
**kw: provided keyword arguments will override keys in SETTINGS.
"""
global SETTINGS, agent_log, _initialized, _transforms, _serialize_transform, _threads
# Merge the extra config settings into SETTINGS
SETTINGS = dict_merge(SETTINGS, kw)
if _initialized:
# NOTE: Temp solution to not being able to re-init.
# New versions of pyrollbar will support re-initialization
# via the (not-yet-implemented) configure() method.
if not SETTINGS.get('suppress_reinit_warning'):
log.warning('Rollbar already initialized. Ignoring re-init.')
return
SETTINGS['access_token'] = access_token
SETTINGS['environment'] = environment
if SETTINGS.get('allow_logging_basic_config'):
logging.basicConfig()
if SETTINGS.get('handler') == 'agent':
agent_log = _create_agent_log()
# We will perform these transforms in order:
# 1. Serialize the payload to be all python built-in objects
# 2. Scrub the payloads based on the key suffixes in SETTINGS['scrub_fields']
# 3. Scrub URLs in the payload for keys that end with 'url'
# 4. Optional - If local variable gathering is enabled, transform the
# trace frame values using the ShortReprTransform.
_serialize_transform = SerializableTransform(safe_repr=SETTINGS['locals']['safe_repr'],
whitelist_types=SETTINGS['locals']['whitelisted_types'])
_transforms = [
ScrubRedactTransform(),
_serialize_transform,
ScrubTransform(suffixes=[(field,) for field in SETTINGS['scrub_fields']], redact_char='*'),
ScrubUrlTransform(suffixes=[(field,) for field in SETTINGS['url_fields']], params_to_scrub=SETTINGS['scrub_fields'])
]
# A list of key prefixes to apply our shortener transform to. The request
# being included in the body key is old behavior and is being retained for
# backwards compatibility.
shortener_keys = [
('request', 'POST'),
('request', 'json'),
('body', 'request', 'POST'),
('body', 'request', 'json'),
]
if SETTINGS['locals']['enabled']:
shortener_keys.append(('body', 'trace', 'frames', '*', 'code'))
shortener_keys.append(('body', 'trace', 'frames', '*', 'args', '*'))
shortener_keys.append(('body', 'trace', 'frames', '*', 'kwargs', '*'))
shortener_keys.append(('body', 'trace', 'frames', '*', 'locals', '*'))
shortener_keys.extend(SETTINGS['shortener_keys'])
shortener = ShortenerTransform(safe_repr=SETTINGS['locals']['safe_repr'],
keys=shortener_keys,
**SETTINGS['locals']['sizes'])
_transforms.append(shortener)
_threads = queue.Queue()
events.reset()
filters.add_builtin_filters(SETTINGS)
_initialized = True