Skip to content
This repository has been archived by the owner on Oct 17, 2024. It is now read-only.

feat: Prevent agent from talking to New Relic (but preserve instrumentation) #1

Merged
merged 5 commits into from
Jun 26, 2024
Merged

feat: Prevent agent from talking to New Relic (but preserve instrumentation) #1

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f32f673
Prevent agent from talking to New Relic (canned responses)
timmc-edx Jun 26, 2024
c9382e0
Ignore more agent method calls, and only warn on first attempt for each
timmc-edx Jun 26, 2024
0ee104c
Add all remaining known agent request methods
timmc-edx Jun 26, 2024
b970bc8
Gate the no-report feature behind Django setting EDX_NEWRELIC_NO_REPORT
timmc-edx Jun 26, 2024
a6c47c9
Remove temporary print statements
timmc-edx Jun 26, 2024
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
139 changes: 139 additions & 0 deletions newrelic/core/agent_protocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,131 @@
_logger = logging.getLogger(__name__)


# {return_value: ...} wrapper has been removed from each of these
FAKE_AGENT_RESPONSE = {
'preconnect': {"redirect_host": "collector.newrelic.com"},
'connect': json_decode(r"""
Copy link
Member Author

Choose a reason for hiding this comment

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

We may want to move the connect response to a Django setting so we can iterate on it if needed. But I suspect it's fine as is while we do the experiment.

{
"agent_run_id": "xxx1",
Copy link
Member Author

Choose a reason for hiding this comment

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

I removed everything that looked like an identifier or key and replaced it with xxxN.

"data_report_period": 60,
"application_id": "xxx10",
"browser_key": "xxx2",
"beacon": "bam.nr-data.net",
"apdex_t": 0.5,
"url_rules": [
{
"ignore": false,
"match_expression": ".*\\.(ace|arj|ini|txt|udl|plist|css|gif|ico|jpe?g|js|png|swf|woff|caf|aiff|m4v|mpe?g|mp3|mp4|mov)$",
"replacement": "/*.\\1",
"eval_order": 1000,
"terminate_chain": true,
"replace_all": false,
"each_segment": false
},
{
"ignore": false,
"match_expression": "^[0-9][0-9a-f_,.-]*$",
"replacement": "*",
"eval_order": 1001,
"terminate_chain": false,
"replace_all": false,
"each_segment": true
},
{
"ignore": false,
"match_expression": "^(.*)/[0-9][0-9a-f_,-]*\\.([0-9a-z][0-9a-z]*)$",
"replacement": "\\1/.*\\2",
"eval_order": 1002,
"terminate_chain": false,
"replace_all": false,
"each_segment": false
}
],
"data_methods": {
"error_event_data": {
"report_period_in_seconds": 60,
"max_samples_stored": 10000
},
"span_event_data": {
"report_period_in_seconds": 60,
"max_samples_stored": 10000
},
"custom_event_data": {
"report_period_in_seconds": 60,
"max_samples_stored": 10000
},
"analytic_event_data": {
"report_period_in_seconds": 60,
"max_samples_stored": 10000
}
},
"event_harvest_config": {
"report_period_ms": 5000,
"harvest_limits": {
"error_event_data": 8,
"log_event_data": 0,
"analytic_event_data": 100,
"custom_event_data": 300
}
},
"span_event_harvest_config": {
"report_period_ms": 60000,
"harvest_limit": 2000
},
"transaction_naming_scheme": "legacy",
"product_level": 0,
"max_payload_size_in_bytes": 1000000,
"sampling_rate": 0,
"entity_guid": "xxx3",
"collect_error_events": true,
"collect_analytics_events": true,
"collect_span_events": true,
"collect_errors": true,
"collect_traces": true,
"sampling_target_period_in_seconds": 60,
"sampling_target": 10,
"primary_application_id": "xxx6",
"account_id": "xxx7",
"messages": [],
"cross_process_id": "xxx4",
"encoding_key": "xxx5",
"trusted_account_ids": [],
"trusted_account_key": "xxx8",
"request_headers_map": {},
"browser_monitoring.distributed_tracing.enabled": true,
"js_agent_file": "",
"episodes_url": "https://js-agent.newrelic.com/nr-100.js",
"error_beacon": "bam.nr-data.net",
"browser_monitoring.loader_version": "1.260.1",
"browser_monitoring.loader": "spa",
"js_agent_loader_version": "bogus-loader-sorry",
"feature_flags": [],
"episodes_file": "js-agent.newrelic.com/nr-100.js",
"browser_monitoring.privacy.cookies_enabled": true,
"js_agent_loader": "xxx9"
}
"""),
'agent_settings': None,

# From data_collector.py
'agent_command_results': {},
'analytic_event_data': {},
'custom_event_data': {},
'dimensional_metric_data': {},
'error_data': {},
'error_event_data': {},
'get_agent_commands': {},
'log_event_data': {},
'metric_data': {},
'ml_event_data': {},
'profile_data': {},
'shutdown': {},
'span_event_data': {},
'sql_trace_data': {},
'transaction_sample_data': {},
}


class AgentProtocol(object):
VERSION = 17

Expand Down Expand Up @@ -158,6 +283,12 @@ class AgentProtocol(object):
}

def __init__(self, settings, host=None, client_cls=ApplicationModeClient):
try:
from django.conf import settings as django_settings
self._no_report = bool(getattr(django_settings, "EDX_NEWRELIC_NO_REPORT", False))
except ImportError:
self._no_report = False

if settings.audit_log_file:
audit_log_fp = open(settings.audit_log_file, "a")
else:
Expand Down Expand Up @@ -225,6 +356,14 @@ def send(
payload=(),
path="/agent_listener/invoke_raw_method",
):
if self._no_report:
if method in FAKE_AGENT_RESPONSE:
return FAKE_AGENT_RESPONSE[method]
else:
_logger.warning(f"NR agent wanted to send unrecognized {method=} -- denied, and will ignore future instances.")
FAKE_AGENT_RESPONSE[method] = {}
return {}

params, headers, payload = self._to_http(method, payload)

try:
Expand Down