Skip to content

Commit

Permalink
More tweaks and images
Browse files Browse the repository at this point in the history
  • Loading branch information
planteater committed May 5, 2022
1 parent b5fba0a commit 70ec3a3
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ import codeLevelCharts from 'images/code-level-charts.png'

import pixieDynamicLogging from 'images/pixie_dynamic_logging.png'

import associateRepos from 'images/associate_repos.png'

import entitySelection from 'images/entity_selection.png'

New Relic CodeStream allows developers to see how the code they're responsible
for is performing in production by bringing observability into the IDE and
making it part of their daily routine.
Expand All @@ -39,8 +43,6 @@ key](https://one.newrelic.com/launcher/api-keys-ui.api-keys-launcher) (learn
more about [New Relic user
keys](/docs/apis/intro-apis/new-relic-api-keys/#user-api-key)).

SCREENSHOT update

<img
title="Connecting CodeStream to New Relic with your New Relic user key."
alt="A screenshot of connecting CodeStream to New Relic with your New Relic user key"
Expand Down Expand Up @@ -74,7 +76,11 @@ repository, CodeStream will ask you to identify the appropriate repository. The
Observability section of the the CodeStream pane will also prompt you take make
associations for all of the repositories you have open in your IDE.

SCREENSHOT of Obs section with some unassoc repos
<img
title="Associate repositories in your IDE with entities."
alt="A screenshot of associating repositories in your IDE with entities."
src={associateRepos}
/>

Making these associations on the fly when prompted is a great way to get
started, however we recommend one of the following methods since they require
Expand Down Expand Up @@ -254,8 +260,6 @@ to errors assigned to you, recent errors will be listed for each repository you
have open in your IDE (assuming you've associated it with an entity on New
Relic).

SCREENSHOT update with new UI

<img
title="The observability section shows recent errors and errors assigned to you."
alt="A screenshot of the observability section showing recent errors and errors assigned to you."
Expand All @@ -270,10 +274,18 @@ Click on any error to view the details and [start collaborating](#collaborate).

It's possible that you may have a repository associated with mutliple entities
on New Relic. For example, you may have entities that correspond to staging and
production environments. In these cases a dropdown list is display to the right
production environments. In these cases a dropdown list is displayed to the right
of the repository name so that you easily switch between entities/environments.

SCREENSHOT of entity dropdown
<img
title="Select the entity for which you'd like to see errors."
alt="A screenshot of the selection of the entity for which you'd like to see errors."
src={entitySelection}
/>

<figcaption>
Select the entity for which you'd like to see errors.
</figcaption>

<Callout variant="tip">
If your project isn't monitored by New Relic, you can
Expand Down Expand Up @@ -331,13 +343,13 @@ avg duration: ${averageDuration} | throughput: ${throughput} | error rate: ${err

You can also turn CodeLenses off altogether by unchecking the **CodeStream: Show Golden Signals In Editor** setting.

## Investigating errors [#Investigating-errors]
## Investigating errors [#investigating-errors]

While CodeStream will show you recent errors happening in the code you have open
in your IDE, you can see a more comprehensive list of APM errors via the [errors
inbox](/docs/errors-inbox/errors-inbox/) on New Relic. When you're ready to dig
into the root cause of a specific error with a stack trace, click **Open in
IDE** to go directly to the code in your IDE.
CodeStream will show you recent errors happening in the code you have open in
your IDE, but you can see a more comprehensive list of APM errors via the
[errors inbox](/docs/errors-inbox/errors-inbox/) on New Relic. When you're ready
to dig into the root cause of a specific error with a stack trace, click **Open
in IDE** to go directly to the code in your IDE.

<img
title="A stack trace error in errors inbox with the &quot;Open in IDE button"
Expand All @@ -350,8 +362,8 @@ IDE** to go directly to the code in your IDE.
A typical collaboration session could include developers commenting on code in
their IDEs, a DevOps engineer assigning errors in errors inbox, and a
development manager following along in Slack. By meeting people in the tools
they're already using, New Relic CodeStream shortens the amount of time between
error discovery and error resolution.
they're already using, CodeStream shortens the amount of time between error
discovery and error resolution.

Watch this short YouTube video (approx. 2:27 minutes) to see this in action.

Expand Down Expand Up @@ -442,9 +454,11 @@ For more on how to set these variables, here are specific configuration details
* [PHP](/docs/agents/php-agent/configuration/php-agent-configuration/)
* [Python](/docs/agents/python-agent/configuration/python-agent-configuration/)

If you do have git references configured, but the version of the code you're on
locally doesn't contain that reference, CodeStream will let you know so that you
can more effectively investigate and resolve the error.
If you do have git references configured, CodeStream will let you know if the
version of the code you're on locally doesn't contain the reference associated
with the error. In this case, you may want to check out the version of the code
that does contain that reference so that you can more effectively investigate
and resolve the error.

<img
title="The git reference not found warning message."
Expand All @@ -464,17 +478,17 @@ out on New Relic.

Dynamic logging with Pixie allows you to debug Go applications in production
without the need to instrument the source code with additional log statements,
recompile, and redeploy. Dynamically capture function arguments, return values
and latency right from your IDE.
recompile, and redeploy. You can dynamically capture function arguments, return
values and latency right from your IDE.

<Callout variant="caution">
Dynamic logging is currently only available for applications written in Go, and requires a [Kubernetes cluster monitored by Pixie](/docs/auto-telemetry-pixie/install-auto-telemetry-pixie/).
</Callout>

To start a logging session, right-click on any method name in your Go project
and select **Dynamic Logging Using Pixie**. After selecting your New Relic
account some Kubernetes information (Cluster, Namespace, Pod), you can then
start a logging session ranging anywhere from one to ten minutes in duration.
account and Kubernetes information (Cluster, Namespace, Pod), you can then start
a logging session ranging anywhere from one to ten minutes in duration.

<img
title="A dynamic logging session using Pixie."
Expand Down
Binary file modified src/images/ObservabilitySection-connect1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ObservabilitySection-connected1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/associate_repos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/code-level-charts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/code-level-metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/entity_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 70ec3a3

Please sign in to comment.