Refactor distributed tracing instructions #17928

rhetoric101 · 2024-07-08T22:19:58Z

This is for NR-283802. For all APM agents:

Remove section for old agents.
Remove headings about old an new agents.
Replace old manual steps with the <Steps> component.

github-actions · 2024-07-08T22:20:09Z

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).

netlify · 2024-07-08T22:20:16Z

✅ Deploy Preview for docs-website-netlify ready!

Name	Link
🔨 Latest commit	`3e782d6`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-website-netlify/deploys/66aaae1fed3edd0008fc3757
😎 Deploy Preview	https://deploy-preview-17928--docs-website-netlify.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

…finite Tracing step

…ents.

nbaenam

Hey @rhetoric101, wow, you did a lot of work here! I seem to have added a lot of comments, but they are more or less the same for all files, but I've repeated them so as not to forget them. Feel free to take them or leave them🙂

src/content/docs/apm/agents/go-agent/configuration/distributed-tracing-go-agent.mdx

nbaenam · 2024-07-23T10:13:47Z

src/content/docs/apm/agents/python-agent/configuration/distributed-tracing-python-agent.mdx


-### Set up Infinite Tracing [#infinite-tracing]
+## Infinite Tracing [#infinite-tracing]

 Standard distributed tracing for APM agents ([above](#quick-start-apm)) captures up to 10% of your traces, but if you want us to analyze all your data and find the most relevant traces, you can set up Infinite Tracing.


I'd remove the above link and added to the Standard distributed tracing for APM agents text.

@nbaenam I fixed this!

nbaenam · 2024-07-23T10:13:54Z

src/content/docs/apm/agents/ruby-agent/configuration/distributed-tracing-ruby-agent.mdx


-### Set up Infinite Tracing [#infinite-tracing]
+## Infinite Tracing [#infinite-tracing]

 Standard distributed tracing for APM agents ([above](#quick-start-apm)) captures up to 10% of your traces, but if you want us to analyze all your data and find the most relevant traces, you can set up Infinite Tracing.


I'd remove the above link and added to the Standard distributed tracing for APM agents text.

@nbaenam I fixed this!

nbaenam · 2024-07-23T10:15:41Z

src/content/docs/apm/agents/php-agent/configuration/distributed-tracing-php-agent.mdx

@@ -125,17 +120,21 @@ Standard distributed tracing for APM agents ([above](#quick-start-apm)) captures
 To learn more about this feature, see [Infinite Tracing](/docs/understand-dependencies/distributed-tracing/infinite-tracing/introduction-infinite-tracing).


The same as the others. I'd remove this tip and add the link directly to Infinite Tracing.

@nbaenam I fixed this!

nbaenam · 2024-07-23T10:29:30Z

src/content/docs/apm/agents/php-agent/configuration/distributed-tracing-php-agent.mdx

+The Infinite Tracing setup builds on standard distributed tracing. So, make sure you've completed the [steps above](#quick-start-apm), and then continue with the trace observer setup.
+  </Step>
+  <Step>
+### Set up the trace observer [#provision-trace-observer]

 The trace observer is a New Relic AWS-based service that collects and analyzes all your traces. Follow the instructions in <a href="/docs/understand-dependencies/distributed-tracing/infinite-tracing/set-trace-observer" target="_blank">Set up trace observer</a>. When you're done, return here with your trace observer information and continue with the next step to configure the agent.


Here there is another HTML structure for URL.

@nbaenam Good catch! I fixed this!

nbaenam · 2024-07-23T10:33:44Z

src/content/docs/apm/agents/python-agent/configuration/distributed-tracing-python-agent.mdx

@@ -54,8 +47,9 @@ To start the installation routine, click the tile below. When you're finished in
    icon={<img src={apmPython} alt="Python"/>}
  />


The same as the other with the Start installation text below the tile.

paperclypse · 2024-07-31T14:26:47Z

src/content/docs/apm/agents/go-agent/configuration/distributed-tracing-go-agent.mdx

@@ -45,7 +45,7 @@ Figure out which services touch your request so you can instrument each of them
 For each service involved in your transactions, you'll perform separate installations of the agent. If some of your services use other languages, simply repeat the [installation steps](/docs/distributed-tracing/enable-configure/quick-start) for those languages.

 <Callout variant="tip">
-  The Go agent requires you to manually instrument your Go services, unlike the auto-instrumentation of the other New Relic agents. This means you need to add some lines to your code to use the Go agent.
+  The Go agent requires you to manually instrument your Go services, unlike the auto-instrumentation of the other New Relic agents. This means you need to add some lines to your code to use the Go agent. You'll learn about this when you start the installation below.


@rhetoric101 Do we want to clarify how or why they'll learn more about this? Is there something in the installation process itself that helps people learn more? Do we just describe more fully later in this doc? I think it might be good to clarify.

The more I think about this tip, the more skeptical I am that we need it at all. Wouldn't it make more sense to put this with the Go installation steps directly?

My baseline assumption here is that someone is starting with a Go application that they want to monitor, not that they're trying to decide what language to use to build an app to monitor.

@paperclypse the goal here is to just give users a heads-up in case they expect auto-instrumentation. They'll find out soon enough when they start, but I'd like to leave this in.

OK, I'll defer to you here

paperclypse

I just looked at your last commit, post @nbaenam's review. I left a comment there. Basically, I'm wondering if that's the best place to leave the tip or even if we need it at all.

paperclypse

Links all look good

rhetoric101 added 2 commits July 8, 2024 15:13

fix(Go agent): Refactor DT page

39a2a84

fix(Go agent): Shorten headings

8ed27df

rhetoric101 added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Jul 8, 2024

rhetoric101 self-assigned this Jul 8, 2024

rhetoric101 added 3 commits July 8, 2024 17:06

fix(APM): Pushing more changes for other agents

f703e24

fix(APM agents): Insert tip about how to turn off DT and fix first In…

a901c27

…finite Tracing step

fix(Go agent): Re-add the caveat about auto-instrumentation for Go.

8d64f1a

fix(APM): Change wording around Infinite Tracing in all seven agents.

39f921d

rhetoric101 marked this pull request as ready for review July 16, 2024 22:26

rhetoric101 marked this pull request as draft July 16, 2024 22:27

rhetoric101 added 2 commits July 16, 2024 15:46

Merge branch 'develop' into rhs-remove-old-dt-sections

2502549

fix(APM .NET): Remove literal "Step 4" that's replaced by step compon…

7f3c17e

…ents.

rhetoric101 marked this pull request as ready for review July 16, 2024 22:51

github-actions bot requested a review from akristen July 16, 2024 22:51

paperclypse requested review from nbaenam and removed request for akristen July 22, 2024 15:14

nbaenam previously approved these changes Jul 23, 2024

View reviewed changes

fix(Distributed tracing): Add clarification for Go.

e4ea925

rhetoric101 dismissed nbaenam’s stale review via e4ea925 July 30, 2024 23:31

rhetoric101 requested a review from paperclypse July 30, 2024 23:33

paperclypse reviewed Jul 31, 2024

View reviewed changes

paperclypse previously approved these changes Jul 31, 2024

View reviewed changes

fix(DT): Add more feedback comments from peer review.

3e782d6

rhetoric101 dismissed paperclypse’s stale review via 3e782d6 July 31, 2024 21:35

paperclypse approved these changes Aug 1, 2024

View reviewed changes

rhetoric101 merged commit d0c63bc into develop Aug 1, 2024
20 checks passed

rhetoric101 deleted the rhs-remove-old-dt-sections branch August 1, 2024 18:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor distributed tracing instructions #17928

Refactor distributed tracing instructions #17928

rhetoric101 commented Jul 8, 2024

github-actions bot commented Jul 8, 2024

netlify bot commented Jul 8, 2024 •

edited

Loading

nbaenam left a comment •

edited

Loading

nbaenam Jul 23, 2024

rhetoric101 Jul 31, 2024

nbaenam Jul 23, 2024

rhetoric101 Jul 31, 2024

nbaenam Jul 23, 2024

rhetoric101 Jul 31, 2024

nbaenam Jul 23, 2024

rhetoric101 Jul 31, 2024

nbaenam Jul 23, 2024

paperclypse Jul 31, 2024 •

edited

Loading

rhetoric101 Jul 31, 2024

paperclypse Jul 31, 2024

paperclypse left a comment

paperclypse left a comment

		@@ -125,17 +120,21 @@ Standard distributed tracing for APM agents ([above](#quick-start-apm)) captures
		To learn more about this feature, see [Infinite Tracing](/docs/understand-dependencies/distributed-tracing/infinite-tracing/introduction-infinite-tracing).

		@@ -54,8 +47,9 @@ To start the installation routine, click the tile below. When you're finished in
		icon={<img src={apmPython} alt="Python"/>}
		/>

Refactor distributed tracing instructions #17928

Refactor distributed tracing instructions #17928

Conversation

rhetoric101 commented Jul 8, 2024

github-actions bot commented Jul 8, 2024

netlify bot commented Jul 8, 2024 • edited Loading

✅ Deploy Preview for docs-website-netlify ready!

nbaenam left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paperclypse Jul 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paperclypse left a comment

Choose a reason for hiding this comment

paperclypse left a comment

Choose a reason for hiding this comment

netlify bot commented Jul 8, 2024 •

edited

Loading

nbaenam left a comment •

edited

Loading

paperclypse Jul 31, 2024 •

edited

Loading