Skip to content

Commit

Permalink
Merge pull request #18249 from newrelic/tabatha/fix-indentation
Browse files Browse the repository at this point in the history 
fix: fix indentation to resolve i18n serialization errors
  • Loading branch information
@tabathadelane
tabathadelane authored Aug 2, 2024
2 parents a334f24 + 41cbdf7 commit edfc8dc
Show file tree
Hide file tree
Showing 7 changed files with 681 additions and 681 deletions.
238 changes: 119 additions & 119 deletions ...content/docs/apm/agents/go-agent/configuration/distributed-tracing-go-agent.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,75 +35,75 @@ This is the best approach to set up [standard distributed tracing](/docs/distrib

<Steps>
<Step>
### Identify services [#identify]
### Identify services [#identify]

Figure out which services touch your request so you can instrument each of them to send trace data to New Relic.
Figure out which services touch your request so you can instrument each of them to send trace data to New Relic.
</Step>
<Step>
### Instrument each service with an APM agent [#update-agents]
### Instrument each service with an APM agent [#update-agents]

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.
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. You'll learn about this when you start the installation below.
</Callout>
<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. You'll learn about this when you start the installation below.
</Callout>

To start the installation routine, click the tile below. When you're finished installing each agent, return here to see tips for [viewing your traces](#view-traces).
To start the installation routine, click the tile below. When you're finished installing each agent, return here to see tips for [viewing your traces](#view-traces).

<TechTileGrid>
<TechTile
name="Start installation"
to="https://one.newrelic.com/launcher/nr1-core.settings?pane=eyJuZXJkbGV0SWQiOiJ0dWNzb24ucGxnLWluc3RydW1lbnQtZXZlcnl0aGluZyJ9&cards[0]=eyJuZXJkbGV0SWQiOiJzZXR1cC1uZXJkbGV0cy5zZXR1cC1nby1pbnRlZ3JhdGlvbiIsImFjY291bnRJZCI6MjY0MDQwOX0=&platform[accountId]=2498654&platform[timeRange][duration]=1800000&platform[$isFallbackTimeRange]=true"
icon={<img variant="TechTile" src={apmGoLogo} alt="Golang"/>}
/>
</TechTileGrid>
<TechTileGrid>
<TechTile
name="Start installation"
to="https://one.newrelic.com/launcher/nr1-core.settings?pane=eyJuZXJkbGV0SWQiOiJ0dWNzb24ucGxnLWluc3RydW1lbnQtZXZlcnl0aGluZyJ9&cards[0]=eyJuZXJkbGV0SWQiOiJzZXR1cC1uZXJkbGV0cy5zZXR1cC1nby1pbnRlZ3JhdGlvbiIsImFjY291bnRJZCI6MjY0MDQwOX0=&platform[accountId]=2498654&platform[timeRange][duration]=1800000&platform[$isFallbackTimeRange]=true"
icon={<img variant="TechTile" src={apmGoLogo} alt="Golang"/>}
/>
</TechTileGrid>
</Step>
<Step>
### View traces [#view-traces]
### View traces [#view-traces]

After you instrument each of your services with APM agents, generate some traffic in your application so we can capture some traces. Here are some ways to view your traces in the UI:
After you instrument each of your services with APM agents, generate some traffic in your application so we can capture some traces. Here are some ways to view your traces in the UI:

<CollapserGroup>
<Collapser
id="entity-explorer"
title="View traces that include a specific service"
>
Here's one way you can see traces for a particular service:
<CollapserGroup>
<Collapser
id="entity-explorer"
title="View traces that include a specific service"
>
Here's one way you can see traces for a particular service:

1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > APM & services**</DNT>.
2. Click your entity (service).
3. In the left pane's <DNT>**Monitor**</DNT> section, click <DNT>**Distributed tracing**</DNT>.
4. For details, click on an individual trace. If <DNT>**Group similar traces**</DNT> is on in the top menu, click on a trace group, and then click on an individual trace.
5. If you don't see the traces you want, you can filter by the `trace.id`.
</Collapser>
<Collapser
id="cross-acct-traces"
title="View traces across accounts"
>
To see traces that cross accounts:
1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > APM & services**</DNT>.
2. Click your entity (service).
3. In the left pane's <DNT>**Monitor**</DNT> section, click <DNT>**Distributed tracing**</DNT>.
4. For details, click on an individual trace. If <DNT>**Group similar traces**</DNT> is on in the top menu, click on a trace group, and then click on an individual trace.
5. If you don't see the traces you want, you can filter by the `trace.id`.
</Collapser>
<Collapser
id="cross-acct-traces"
title="View traces across accounts"
>
To see traces that cross accounts:

1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Traces**</DNT>.
2. Select your entity (service) in the left pane.
3. For details, click on an individual trace. If <DNT>**Group similar traces**</DNT> is on in the top menu, click on a trace group, and then click on an individual trace.
4. If you don't see the traces you want, you can filter by the `trace.id`.
</Collapser>
<Collapser
id="logs-context"
title="Examine logs related to traces"
>
You can bring your logs and tracing details together to make troubleshooting easier and faster. With [logs in context](/docs/logs/logs-context/configure-logs-context-apm-agents/), you can see log messages alongside traces in the New Relic UI.
1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Traces**</DNT>.
2. Select your entity (service) in the left pane.
3. For details, click on an individual trace. If <DNT>**Group similar traces**</DNT> is on in the top menu, click on a trace group, and then click on an individual trace.
4. If you don't see the traces you want, you can filter by the `trace.id`.
</Collapser>
<Collapser
id="logs-context"
title="Examine logs related to traces"
>
You can bring your logs and tracing details together to make troubleshooting easier and faster. With [logs in context](/docs/logs/logs-context/configure-logs-context-apm-agents/), you can see log messages alongside traces in the New Relic UI.

After you've located an interesting trace using the steps in [View traces that include a specific service](#entity-explorer) or [View traces across accounts](#cross-acct-traces), do the following:
After you've located an interesting trace using the steps in [View traces that include a specific service](#entity-explorer) or [View traces across accounts](#cross-acct-traces), do the following:

1. If you've enabled logs in context, click on the <DNT>**Logs**</DNT> tab (next to <DNT>**Trace details**</DNT>).
2. To view details related to an individual log, click directly on the message.
</Collapser>
</CollapserGroup>
1. If you've enabled logs in context, click on the <DNT>**Logs**</DNT> tab (next to <DNT>**Trace details**</DNT>).
2. To view details related to an individual log, click directly on the message.
</Collapser>
</CollapserGroup>

For more help finding your traces in the UI:
For more help finding your traces in the UI:

* [Understand and use the distributed tracing UI](/docs/distributed-tracing/ui-data/understand-use-distributed-tracing-ui)
* [Query distributed trace data](/docs/understand-dependencies/distributed-tracing/ui-data/query-distributed-trace-data)
* [Understand and use the distributed tracing UI](/docs/distributed-tracing/ui-data/understand-use-distributed-tracing-ui)
* [Query distributed trace data](/docs/understand-dependencies/distributed-tracing/ui-data/query-distributed-trace-data)

</Step>
</Steps>
Expand All @@ -117,84 +117,84 @@ Before you start, first ensure you meet [the requirements](/docs/understand-depe
<Steps>

<Step>
### Complete the setup for standard distributed tracing [#install-agents-first]
### Complete the setup for standard distributed tracing [#install-agents-first]

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.
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]
### 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 [Set up trace observer](/docs/understand-dependencies/distributed-tracing/infinite-tracing/set-trace-observer). When you're done, return here with your trace observer information and continue with the next step to configure the agent.
The trace observer is a New Relic AWS-based service that collects and analyzes all your traces. Follow the instructions in [Set up trace observer](/docs/understand-dependencies/distributed-tracing/infinite-tracing/set-trace-observer). When you're done, return here with your trace observer information and continue with the next step to configure the agent.
</Step>
<Step>
### Configure the agent for Infinite Tracing [#configure-agent-inf]
### Configure the agent for Infinite Tracing [#configure-agent-inf]

Infinite Tracing configuration settings include the standard distributed tracing plus information about the trace observer:
Infinite Tracing configuration settings include the standard distributed tracing plus information about the trace observer:

<CollapserGroup>
<Collapser
id="go-config"
title="Go Infinite Tracing configuration"
>
Here's an overview of the settings.

<table>
<thead>
<tr>
<th style={{ width: "200px" }}>
Type
</th>

<th>
Required configuration
</th>
</tr>
</thead>

<tbody>
<tr>
<td>
Infinite Tracing
</td>

<td>
Configuration options:

* `newrelic.Config` structure:

```go
app, err := newrelic.NewApplication(
newrelic.ConfigAppName(YOUR_APP_NAME),
newrelic.ConfigLicense(YOUR_LICENSE_KEY),
func(cfg *newrelic.Config) {
cfg.InfiniteTracing.TraceObserver.Host = YOUR_TRACE_OBSERVER_HOST
},
)
```
* Environment variable:

```
NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST=<a href="/docs/understand-dependencies/distributed-tracing/infinite-tracing/set-trace-observer#ui-endpoints">YOUR_TRACE_OBSERVER_HOST</a>
```
</td>
</tr>
</tbody>
</table>
</Collapser>
</CollapserGroup>
<CollapserGroup>
<Collapser
id="go-config"
title="Go Infinite Tracing configuration"
>
Here's an overview of the settings.

<table>
<thead>
<tr>
<th style={{ width: "200px" }}>
Type
</th>

<th>
Required configuration
</th>
</tr>
</thead>

<tbody>
<tr>
<td>
Infinite Tracing
</td>

<td>
Configuration options:

* `newrelic.Config` structure:

```go
app, err := newrelic.NewApplication(
newrelic.ConfigAppName(YOUR_APP_NAME),
newrelic.ConfigLicense(YOUR_LICENSE_KEY),
func(cfg *newrelic.Config) {
cfg.InfiniteTracing.TraceObserver.Host = YOUR_TRACE_OBSERVER_HOST
},
)
```
* Environment variable:

```
NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST=<a href="/docs/understand-dependencies/distributed-tracing/infinite-tracing/set-trace-observer#ui-endpoints">YOUR_TRACE_OBSERVER_HOST</a>
```
</td>
</tr>
</tbody>
</table>
</Collapser>
</CollapserGroup>

<Callout variant="tip">
If you need help with proxy configuration, see [Proxy support](/docs/understand-dependencies/distributed-tracing/other-requirements/infinite-tracing-proxy-support).
</Callout>
</Step>
<Step>
### (Optional) Customize Infinite Tracing [#customize-inf-tracing]
<Callout variant="tip">
If you need help with proxy configuration, see [Proxy support](/docs/understand-dependencies/distributed-tracing/other-requirements/infinite-tracing-proxy-support).
</Callout>
</Step>
<Step>
### (Optional) Customize Infinite Tracing [#customize-inf-tracing]

After you add the agent configuration settings, you should start seeing data in the New Relic UI. After you spend some time analyzing your data, you may want to adjust some of the features of Infinite Tracing:
After you add the agent configuration settings, you should start seeing data in the New Relic UI. After you spend some time analyzing your data, you may want to adjust some of the features of Infinite Tracing:

* [Configure trace observer monitoring](/docs/distributed-tracing/infinite-tracing/infinite-tracing-configure-trace-observer-monitoring)
* [Configure span attribute trace filter](/docs/distributed-tracing/infinite-tracing/infinite-tracing-configure-span-attribute-trace-filter)
* [Configure random trace filter](/docs/distributed-tracing/infinite-tracing/infinite-tracing-configure-random-trace-filter)
* [Configure trace observer monitoring](/docs/distributed-tracing/infinite-tracing/infinite-tracing-configure-trace-observer-monitoring)
* [Configure span attribute trace filter](/docs/distributed-tracing/infinite-tracing/infinite-tracing-configure-span-attribute-trace-filter)
* [Configure random trace filter](/docs/distributed-tracing/infinite-tracing/infinite-tracing-configure-random-trace-filter)
</Step>
</Steps>

Expand Down
Loading

0 comments on commit edfc8dc

Please sign in to comment.