feat(.NET): Consolidating APIs #17266
Conversation
jeff-colucci
added
content
|
Hi @jeff-colucci 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). |
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jeff-colucci
changed the title
jeff-colucci
changed the title
removing superfluous callout
|
Preview built and available at: https://deploy-preview-17266--docs-website-netlify.netlify.app/docs/apm/agents/net-agent/net-agent-api/net-agent-api/ |
austin-schaefer
requested review from
austin-schaefer
and removed request for
bradleycamacho
There was a problem hiding this comment.
Hey Jeff, just finished a review. I found three types of things to address:
- Various rendering / structural things (visible anchor ID, missing collapser tags, tables-in-tables) that should be fixed before merge
- We need to account for existing links to these pages. Some of those are links w/in the page, but we should also account for existing links to individual methods in other docs that will break. We can create a separate Jira for that sweep but let's ensure we don't let it fall thru the cracks.
- Non-fatals: I found a lot of style/grammar/formattng errors and inconsistencies. I suspect many of those were pre-existing in the source docs, and I don't think we need to get these to 100%. But I'd like to fix the low-hanging fruit while we're working on this
| - Agents | ||
| - NET agent | ||
| - API guides | ||
| metaDescription: 'A goal-focused guide to the New Relic .NET agent API.' |
There was a problem hiding this comment.
This meta-description feels outdated for the current scope of the doc.
| - /docs/agents/net-agent/net-agent-api/tracemetadata-net-agent-api-0 | ||
| - /docs/apm/agents/net-agent/net-agent-api/tracemetadata-net-agent-api-0 | ||
|
|
||
| freshnessValidatedDate: never |
There was a problem hiding this comment.
This should be updated
|
|
||
| New Relic's .NET agent includes an API that allows you to extend the agent's standard functionality. For example, you can use the .NET agent API for: | ||
|
|
||
| * Customizing your app name |
There was a problem hiding this comment.
Unnecessary -ing verbs
| freshnessValidatedDate: never | ||
| --- | ||
|
|
||
| New Relic's .NET agent includes an API that allows you to extend the agent's standard functionality. For example, you can use the .NET agent API for: |
There was a problem hiding this comment.
| New Relic's .NET agent includes an API that allows you to extend the agent's standard functionality. For example, you can use the .NET agent API for: | |
| New Relic's .NET agent includes an API that allows you to extend the agent's standard functionality. For example, you can use the .NET agent API to: |
| To use the .NET agent API, make sure you have the [latest .NET agent release](/docs/release-notes/agent-release-notes/net-release-notes). Then, add a reference to the agent in your project using one of the two options below: | ||
|
|
||
| * Add a reference to `NewRelic.Api.Agent.dll` to your project. | ||
| OR |
There was a problem hiding this comment.
I think this needs an extra line break or something to show up on its own line, in preview it shows up on same line
| </tbody> | ||
| </table> | ||
|
|
||
| ### NoticeError(String, IDictionary, bool) [#string-idictionary-bool-overload] |
There was a problem hiding this comment.
should this be its own collapser?
| <Callout variant="important"> | ||
| * Sending a lot of events can increase the memory overhead of the agent. | ||
| * Additionally, posts greater than 1MB (10^6 bytes) in size will not be recorded regardless of the maximum number of events. | ||
| * Custom Events are limited to 64-attributes. |
There was a problem hiding this comment.
| * Custom Events are limited to 64-attributes. | |
| * Custom events are limited to 64 attributes. |
Caps and hyphen here are weird
|
|
||
| ### Requirements | ||
|
|
||
| * Agent version 5.0.136.0 or higher. |
There was a problem hiding this comment.
5.0.136.0 is EOL ( https://deploy-preview-17266--docs-website-netlify.netlify.app/docs/apm/agents/net-agent/getting-started/net-agent-eol-policy/ ), shouldn't this be all agent versions?
|
|
||
| This API call is compatible with: | ||
|
|
||
| * Agent versions >= 10.9.0 |
There was a problem hiding this comment.
Other calls say "or higher" rather than use puncutation
|
|
||
| ### Requirements | ||
|
|
||
| * Agent version 5.0.136.0 or higher. |
There was a problem hiding this comment.
Same version comment as previous, this is EOl version
No description provided.