Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into jhagan-add-memorable-icons-to-om-dg-guide
- Loading branch information
Showing
5 changed files
with
109 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
96 changes: 96 additions & 0 deletions
96
src/content/docs/style-guide/writing-strategies/install-docs-guidance.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
--- | ||
title: Choose from our install methods | ||
topics: | ||
- New Relic only | ||
- Basic style guide | ||
- Writing guidelines | ||
--- | ||
|
||
Installing New Relic is a crucial piece in our customer's experience, whether it's installing APM agents, the infrastructure agent, sending logs to New Relic, or installing CodeStream, among other things. | ||
|
||
This is intended to help you decide where to send your reader when they want to install something and get started sending data to New Relic. | ||
|
||
## Choose the best install method [#choose] | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th style={{ width: "300px" }}> | ||
[Guided install](/docs/new-relic-one/install-configure/new-relic-guided-install-overview/) | ||
</th> | ||
<th style={{ width: "300px" }}> | ||
[Add more data](https://one.newrelic.com/nr1-core?state=cab9400b-31f1-fab7-cd28-db21bd312951) | ||
</th> | ||
<th> | ||
Manual install | ||
</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td> | ||
* Infrastructure agent | ||
* Logs | ||
* APM agents (except C SDK, Go, PHP, and Ruby) | ||
* One or more of these [on-host integrations](/docs/new-relic-one/install-configure/new-relic-guided-install-overview/#ohi-recipes) | ||
</td> | ||
<td> | ||
* APM agents (especially C SDK, Go, PHP, and Ruby) | ||
* Browser monitoring | ||
* Cloud and on-host monitoring integrations | ||
* Distributed tracing | ||
* Infrastructure agent | ||
* Logs | ||
* Machine learning monitoring | ||
* Network performance monitoring | ||
* Open telemetry | ||
* Synthetics monitoring | ||
</td> | ||
<td> | ||
Anything not covered by guided install and add more data. | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
## An overview of installation methods [#overview] | ||
|
||
Currently, we have three methods our customers can use to install New Relic and start monitoring something: | ||
|
||
1. Guided install, our interactive command line tool for installing New Relic on different systems | ||
2. Manual installation via the “+ Add more data” page in the UI | ||
3. Manual installation via the docs site | ||
|
||
Instant observability (I/O) is **not** an installation method. It simply provides a catalog of all of the things that someone could potentially monitor via New Relic. An instant observability page simply points to one of these three methods, depending on what's available. | ||
|
||
CodeStream has its own installation method. | ||
|
||
## Guided install [#guided] | ||
|
||
[Guided install](/docs/new-relic-one/install-configure/new-relic-guided-install-overview/) provides a single command you can run on your system to install New Relic and start monitoring a variety of things. | ||
|
||
At present, guided install installs the infrastructure agent, configures a certain set of integrations, and enables sending logs. It also detects integrations on your system and prompts you to choose whether to monitor those integrations or not. | ||
|
||
For the docs, we should send people to guided install whenever it's appropriate to do so. That is, when guided install is likely to lead to a successful outcome. | ||
|
||
## Manual installation via add more data [#manual-add] | ||
|
||
The [Add more data](https://one.newrelic.com/nr1-core?state=cab9400b-31f1-fab7-cd28-db21bd312951) pages provide a simple and straightforward installation path for people wanting to install APM agents and who are using the most popular integrations and most common system settings for those integrations. | ||
|
||
**Add more data** populates installation configuration files with values like app name and API key so that a customer doesn't have to track down that information. They also provide the most straightforward installation path for standard use cases. | ||
|
||
This method is less effective for customers who have more complicated or obscure things they're trying to monitor or non-standard systems. | ||
|
||
**Add more data** also has the advantage of living in the UI. | ||
|
||
## Manual installation via the docs site [#manual-docs] | ||
|
||
Manual installation procedures, such as this [manual Java installation](/docs/apm/agents/java-agent/installation/install-java-agent), should be the method of last resort. The installation instructions on the docs site are most likely to be outdated. They are also presented in a fairly confusing way that may actually prevent people from installing New Relic. From the docs perspective, this is the default, because that's where our energy and attention are focused. It's also the place where we can easily make changes. | ||
|
||
That being said, the current state of the manual installation docs is inconsistent and, in some cases, like the APM agent docs, bewilderingly complicated. | ||
|
||
## Instant observability [#io] | ||
|
||
[Instant observability](https://newrelic.com/instant-observability) is catalog of things that can be monitored by New Relic and useful default dashboards and alerts. | ||
|
||
For any quickstart, the **Install quickstart** button takes you to guided install, an add more data page, or a manual installation docs page. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters