newrelic / newrelic/newrelic-java-agent
Java Agent - Obfuscate url path
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 240
- Forks
- 170
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 21
Description
Description
Customer is requesting the capability to mask certain portions of the urls that the java agent collects OOTB. The reason is that some segments are deemed sensitive, and should therefore not "leave the customer's network".
This is a concept that is currently being added to the browser and mobile agents, where a list of regexes can be defined to search and replace certain patterns in the URLs.
While there ideally should not be sensitive information in web app URLs, sometimes there are legacy applications, highly business critical, and changing them is currently not an option. This will be especially important to those affected customers that are moving from an on-prem solution to the NR SaaS platform.
Acceptance Criteria
Telemetry containing configured masking show up in NR as masked.
Design Consideration/Limitations
N/A
Dependencies
N/A
Additional context
Node documentation: https://docs.newrelic.com/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration/#url-obfuscation
Node discussion: https://newrelic.slack.com/archives/C0511B24H/p1644846700641119
Legacy Jira with additional background : https://issues.newrelic.com/browse/NR-6791
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked Node.js URL-obfuscation documentation and the Java agent's existing URL telemetry configuration and collection paths. Determine how configured regex masking should apply to collected URLs. Done means telemetry with configured masking appears masked in New Relic; no Java files or tests are named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- observability-sre
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100