Skip to content

Commit

Permalink
Merge branch 'doc-7562-welcome-docs' of https://github.com/newrelic/d…
Browse files Browse the repository at this point in the history
…ocs-website into doc-7562-welcome-docs
  • Loading branch information
paperclypse committed Dec 8, 2021
2 parents 487d688 + 7dc2c5d commit fec9a55
Show file tree
Hide file tree
Showing 57 changed files with 416 additions and 133 deletions.
29 changes: 20 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,32 +151,43 @@ To submit a [Draft PR](https://github.blog/2019-02-14-introducing-draft-pull-req
### Using Conventional Commits

Please help the maintainers by leveraging the following [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)
standards in your pull request title and commit messages.
standards in your commit messages. You don't need to apply this format to the pull request title–just to commits.

As a reminder, here's the format for a single-line commit, but you are welcome to add the optional body and footer messages.

```
<type>(optional scope): <description>
```

When choosing a type, you can pick from any of the standard types (feat, fix, style, test, or chore) or you can add your own.
**Note**: There is a `documentation` type, but please refrain from using it for general documentation changes since it is intended for changes to the repository's documentation (such as `README.md` and `CONTRIBUTING.md`)

As far as scope, we recommend that you include this because it helps us identify relevant commits. For the docs project, the scope might refer to the part of the docs you are editing (for example, APM or errors inbox). If you are suggesting a code change to the docs site, insert the section of the codebase you worked on.

Here are some examples:

#### Use `chore`

- for minor changes / additions / corrections to content.
- for minor changes / additions / corrections to images.
- for minor non-functional changes / additions to github actions, github templates, package or config updates, etc
Chores are best for changes that users don't see directly, such as improving unit tests or reducing technical debt. You might use them for minor non-functional changes/additions to github actions, github templates, package or config updates, etc.

```bash
git commit -m "chore: adjusting config and content"
git commit -m "chore(translation): extend translation unit test coverage"
```

#### Use `fix`

- for minor functional corrections to code.
Fix is used for minor functional corrections to code.

```bash
git commit -m "fix: typo and prop error in the code of conduct"
git commit -m "fix(Log management): repair broken link in introduction"
```

#### Use `feat`

- for major functional changes or additions to code.
Feat is for major functional changes or additions to code.

```bash
git commit -m "feat(media): creating a video landing page"
git commit -m "feat(errors inbox): add new documents"
```

### Deploy previews with Gatsby Cloud
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The features described here are early access. You won't be able to use these fea
For more information on related features, see our docs on [Alerts notification channels](/docs/alerts-applied-intelligence/new-relic-alerts/alert-notifications/notification-channels-control-where-send-alerts/), [Incident Intelligence destinations](/docs/alerts-applied-intelligence/applied-intelligence/incident-intelligence/incident-intelligence-destination-examples/), and [Proactive Detection notifications](https://docs.newrelic.com/docs/alerts-applied-intelligence/applied-intelligence/proactive-detection/proactive-detection-applied-intelligence/#set-up).
</Callout>

Notification message templates enable you to customize your notification event data before it's sent to your third-party destination. The templates map your custom values to the values used by your third-party destination.
Notification message templates enable you to customize your notification event data before it's sent to your third-party destination. The templates map your custom values to the values used by your third-party destination.

This gives you full control over what data will be sent and where, as well as being able to fully engage with the services you use.

Expand All @@ -30,7 +30,7 @@ Message templates are written in a simple templating language called [Handlebars

## The variables menu [#variables-menu]

All of the New Relic variable names are listed in the message template variables menu. The variables are grouped into subcategories.
All of the New Relic variable names are listed in the message template variables menu. The variables are grouped into subcategories.

In the variables menu, type `{{` to select from a list of variables. As you type, variable names appear via autocomplete. The variable type is written on the right-hand side. You can add enriched data to these variables.

Expand Down Expand Up @@ -112,8 +112,82 @@ Render 'y' or 'n':
{{eq a b yes='y' no='n'}}
```

</Collapser>
</CollapserGroup>
</Collapser>

<Collapser
className="freq-link"
id="replace"
title="Replace"
>

The `replace` helper replaces instances of the first parameter in the second parameter with the child block.

Use `else` clause to specify what happens when no instance of the first parameter is found. If it is omitted an empty string will be generated.

Example #1: replace the word `dog` with `cat` in the sentence `The dog likes to eat`:

```handlebars
{{#replace "dog" "The dog likes to eat"}}cat{{/replace}}
```
to get:

```
The cat likes to eat
```

Example #2: replace the word `cat` with `mouse` in the sentence `The dog likes to eat`:

```handlebars
{{#replace "cat" "The dog likes to eat"}}mouse{{/replace}}
```
to get an empty string:

```
```

Example #3: replace the word `cat` with `mouse` in the sentence `The dog likes to eat`, using the `else` clause:

```handlebars
{{#replace "cat" "The dog likes to eat"}}mouse{{else}}There is no cat to replace{{/replace}}
```
to get:

```
There is no cat to replace
```


Example #4: replace the word `dog` with `cat` in the sentence `The DOG likes to eat` while ignoring case:

```handlebars
{{#replace "/dog/i" "The DOG likes to eat"}}cat{{/replace}}
```
to get:

```
The cat likes to eat
```

Example #5: replace the variable `{{needle}}` with the variable `{{replacement}}` in the variable `{{haystack}}`:

```handlebars
{{#replace needle haystack }}{{replacement}}{{/replace}}
```
using this data:
```json
{
"needle": "/dog/i",
"haystack": "The DOG likes to eat",
"replacement": "cat"
}
```
to get:

```
The cat likes to eat
```
</Collapser>
</CollapserGroup>

## Usage examples [#usage-examples]

Expand Down Expand Up @@ -220,7 +294,7 @@ In some cases, an attribute may be missing from the [variables menu](/docs/alert
We can use the `#if` statement to set a fallback, such as:

```handlebars
{{#if data.type}} {{ json data.type }} {{else}}"N/A"{{/if}}
{{#if data.type}} {{ json data.type }} {{else}}"N/A"{{/if}}
```

would return the string `"N/A"`.
would return the string `"N/A"`.
Original file line number Diff line number Diff line change
Expand Up @@ -149,11 +149,10 @@ To enable high security, you must update both the local configuration on your se
</td>

<td>
To set high security in the UI: Go to [one.newrelic.com](https://one.newrelic.com), click the [account dropdown](/docs/using-new-relic/welcome-new-relic/get-started/glossary#account-dropdown) and select **Account settings**. On that page, select **High security mode**.
* For users on our [original user model](/docs/accounts/original-accounts-billing/original-product-based-pricing/overview-changes-pricing-user-model/#user-model): Only the account owner can configure this. Go to [one.newrelic.com](https://one.newrelic.com), click the [account dropdown](/docs/using-new-relic/welcome-new-relic/get-started/glossary#account-dropdown) and select **Account settings**. On that page, select **High security mode**.
* For users on the [New Relic One user model](/docs/accounts/original-accounts-billing/original-product-based-pricing/overview-changes-pricing-user-model/#user-model): Get the [account ID](/docs/accounts/accounts-billing/account-structure/account-id) for the account you want to enable. Then use that to go to this URL: `https://rpm.newrelic.com/accounts/YOUR_ACCOUNT_ID`. On that page, you can configure high security mode.

If you are on our [original pricing model](/docs/accounts/original-accounts-billing/original-product-based-pricing/overview-changes-pricing-user-model), only the account owner can view this option.

If the agent is configured for high security via the UI but not locally, then the agent connections will be rejected, and the agent will shut down. However, this won't shut down your application.
If the agent is configured for high security via the UI but not locally, then the agent connections are rejected, and the agent will shut down. However, this won't shut down your application.
</td>
</tr>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,4 @@ The PHP agent receives metrics for the following:

## Integration with New Relic partners [#integration]

By integrating your WordPress application with APM, you can view performance directly from your WordPress app's **Administration** page. For example, [W3 Total Cache](http://newrelic.com/connect/details#w3-total-cache) is one of New Relic's [Connect partners](/docs/new-relic-partnerships/partner-integration-guide/new-relic-products-features/new-relic-connect) that specializes in WordPress apps.

## WordPress plugin for browser monitoring [#browser]

Signing up for a New Relic account and adding [browser monitoring](/docs/browser/new-relic-browser/getting-started/introduction-new-relic-browser) to your WordPress site is fast and easy with the [browser monitoring plugin for WordPress](https://wordpress.org/plugins/rt-newrelic-browser/). The plugin and our browser monitoring do not require the special access required to install our PHP agent.

This makes them generally compatible with **all** WordPress hosting providers. In addition, the WordPress plugin is supported by the authors and the WordPress community.
By integrating your WordPress application with APM, you can view performance directly from your WordPress app's **Administration** page. For example, [W3 Total Cache](https://newrelic.com/blog/best-practices/web-performance-optimization-automation) is one of New Relic's partners that specializes in WordPress apps.
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ redirects:

To view a summary of browser performance for an app:

1. Go to [**[one.newrelic.com](https://one.newrelic.com) > Explorer > Browser applications**. Use the [Explorer](/docs/new-relic-one/use-new-relic-one/core-concepts/new-relic-explorer-view-performance-across-apps-services-hosts/) to access all your [entities](/docs/new-relic-one/use-new-relic-one/core-concepts/what-entity-new-relic/), that is, anything we can identify that reports data, from applications and hosts to custom groupings of any elements.
1. Go to **[one.newrelic.com](https://one.newrelic.com) > Explorer > Browser applications**. Use the [Explorer](/docs/new-relic-one/use-new-relic-one/core-concepts/new-relic-explorer-view-performance-across-apps-services-hosts/) to access all your [entities](/docs/new-relic-one/use-new-relic-one/core-concepts/what-entity-new-relic/), that is, anything we can identify that reports data, from applications and hosts to custom groupings of any elements.
2. Alternatively, go to [one.newrelic.com](https://one.newrelic.com), click Browser, and select an app from the [Browser index](/docs/browser/new-relic-browser/getting-started/browser-apps-index).
3. From the app's **Summary** page, use [standard New Relic page functions](/docs/data-analysis/user-interface-functions/view-your-data/standard-page-functions) to drill down into detailed information.

![Here is a screen capture showing the browser summary screen.](./images/browser_summary_page.png "browser_summary.png")
![Screenshot of browser monitoring summary page](./images/browser_summary_page.png "Screenshot of browser monitoring summary page")

<figcaption>
**[one.newrelic.com](https://one.newrelic.com) > Browser > (select an app) > Summary:** After you select an application from the browser apps index, the **Summary** page shows a summary of browser performance for that app.
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ We monitor and collect [metrics](http://docs.newrelic.com/docs/integrations/kube

## Compatibility and requirements [#compatibility]

* Control plane monitoring requires [Kubernetes integration version 1.11.0 or higher](/docs/release-notes/platform-release-notes/host-integrations-release-notes/new-relic-integration-kubernetes-1110).
* Control plane monitoring requires [Kubernetes integration version 1.16.0 or higher](/docs/release-notes/infrastructure-release-notes/kubernetes-integration-release-notes/).
* Control plane monitoring support is not enabled for managed clusters. This is because providers (EKS, GKE, AKS, etc.) abstract away the concept of master nodes and control plane components, so that access to them is limited or non-existent.
* External control planes are not supported.
* The [unprivileged version of the Kubernetes integration](/docs/integrations/kubernetes-integration/installation/kubernetes-installation-configuration#unprivileged) does not support control plane monitoring.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ redirects:
- /docs/integrations/kubernetes-integration/installation/configure-kubernetes-proxy
---

If you are running our Kuberenetes integration with a proxy, you need to configure each component (the [infrastructure agent](/docs/infrastructure/install-infrastructure-agent), logging, Kubernetes events, etc.) to correctly work with your proxy.
If you are running our Kubernetes integration with a proxy, you need to configure each component (the [infrastructure agent](/docs/infrastructure/install-infrastructure-agent), logging, Kubernetes events, etc.) to correctly work with your proxy.

## Install the infrastructure agent with a proxy [#infrastructure-agent]

Expand All @@ -32,7 +32,7 @@ There are three options to install the infrastructure agent with a proxy:

If you’re using [log forwarding for the Kubernetes integration](/docs/logs/enable-log-management-new-relic/enable-log-monitoring-new-relic/kubernetes-plugin-log-forwarding), the plugin automatically detects the `HTTP_PROXY` and `HTTPS_PROXY` environment variables, and automatically uses them to set up the proxy configuration. For more information, see [how to customize the proxy, or bypass it](https://github.com/newrelic/newrelic-fluent-bit-output#proxy-support).

## Install Kubernetes events [#Kubernetes-events]
## Install Kubernetes events with a proxy [#Kubernetes-events]

There are three options to install the [Kubernetes events integration](/docs/integrations/kubernetes-integration/kubernetes-events/install-kubernetes-events-integration) with a proxy:

Expand All @@ -48,7 +48,7 @@ There are three options to install the [Kubernetes events integration](/docs/int
* When installing [through the manifest](https://download.newrelic.com/infrastructure_agent/integrations/kubernetes/nri-kube-events-latest.yaml), to configure the proxy set the `NRIA_PROXY` in the environment variable section of the infra container.
* Check the [deployment template](https://github.com/newrelic/helm-charts/blob/556d7d970d65ac1a9dcd30d6b7093b1e163cb281/charts/nri-kube-events/templates/deployment.yaml#L70) of the chart as an example of environment variable configuration.

## Install the Prometheus OpenMetrics integration [#prometheus-openmetrics]
## Install the Prometheus OpenMetrics integration with a proxy [#prometheus-openmetrics]

There are three options to install the [Prometheus OpenMetric integration](/docs/integrations/prometheus-integrations/get-started/send-prometheus-metric-data-new-relic) with a proxy:

Expand All @@ -73,6 +73,20 @@ There are three options to install the [Prometheus OpenMetric integration](/docs
# emitter_proxy: "<a href="http://localhost:8888/">http://localhost:8888</a>"
```

## Set the synthetics minion [#synthetics]
## Set the synthetics minion to use a proxy [#synthetics]

Check this README [on how to set the proxy](https://github.com/newrelic/helm-charts/tree/master/charts/synthetics-minion) for the [Synthetics minions](/docs/synthetics/synthetic-monitoring/private-locations/install-containerized-private-minions-cpms).

## Install the Pixie integration with a proxy [#pixie]

There are two options to install the Pixie integration with a proxy:

* Installing with chart `newrelic-pixie`:
* The proxy can be configured setting the configuration option `proxy` as described in the [values.yaml](https://github.com/newrelic/helm-charts/blob/334ce7ae4e9753acea9e35c5b923a6795cea262e/charts/newrelic-pixie/values.yaml#L32) of the chart.

* Installing with chart `nri-bundle` as a dependency:
* The proxy can be configured setting the configuration option `newrelic-pixie.proxy`. The configuration option is passed [down to the dependency](https://github.com/newrelic/helm-charts/tree/master/charts/nri-bundle#configure-dependencies) `newrelic-pixie` modifying the `values.yaml` of `nri-bundle`:

```
newrelic-pixie.proxy: https://user:password@hostname:port
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Translation disclaimer
tags:
- Licenses
- License information
- Translation
metaDescription: 'Information about translations of New Relic documents'
---

The official version of the Documentation is in English. Portions of the New Relic Documentation may be translated for your convenience as shown on this site.

Translated content may contain errors, discrepancies, or differences created in the translation, are not binding, and have no legal effect for enforcement or compliance purposes. New Relic does not make any warranty, express or implied, as to the accuracy, reliability, or correctness of any translated Documentation from the English original to any other language.

Any guarantees or commitments in your Agreement with New Relic that the Services, products, or other offerings conform or are consistent with the Documentation do not apply to the extent to which the Documentation has been translated.
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ You can also use NerdGraph, our GraphQL-format API, to request the exact data yo
Ready to get started with our log management solutions?

1. If you don't have one already, [create a New Relic account](https://newrelic.com/signup). It's free, forever.
2. [Forward your logs](/docs/logs/forward-logs/enable-log-management-new-relic/) to New Relic. **Recommendation:** Use our [infrastructure agent](/docs/logs/forward-logs/forward-your-logs-using-infrastructure-agent/) as your log forwarder, so you can get logs in context of your platform and services directly in our UI.
2. Enable log management by [forwarding your logs](/docs/logs/forward-logs/enable-log-management-new-relic/) to New Relic. **Recommendation:** Use our [infrastructure agent](/docs/logs/forward-logs/forward-your-logs-using-infrastructure-agent/) as your log forwarder, so you can get logs in context of your platform and services directly in our UI.
3. For apps monitored by a New Relic APM agent, configure [logs in context](/docs/logs/logs-context/configure-logs-context-apm-agents/).
4. Explore the logging data across your platform with our [Logs UI](/docs/logs/ui-data/use-logs-ui/) in New Relic One, where you can add alerts, query your data, and create dashboards.

0 comments on commit fec9a55

Please sign in to comment.