newrelic / newrelic/newrelic-java-agent
Add public-facing documentation for clear_return_stacks flag
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 240
- Forks
- 170
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 21
Description
Description
Alongside the release containing the Ktor 3.x instrumentation (TBD), it would be beneficial to publicly document what the clear_return_stacks flag does and how it's properly applied in case customers/support personnel afflicted by the AIOOBE (array index out of bounds exception) issue need a point of reference outside of release notes.
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 locating the existing clear_return_stacks configuration and any references to the Ktor 3.x instrumentation or AIOOBE issue. Add public-facing documentation explaining what the flag does and how to apply it; done means customers and support personnel can use the documentation without relying on release notes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100