-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added documentation and cross-link for Azure site extension
Signed-off-by: mrickard <[email protected]>
- Loading branch information
Showing
2 changed files
with
65 additions
and
0 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
57 changes: 57 additions & 0 deletions
57
...-agent/installation-configuration/install-nodejs-agent-azure-site-extension.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,57 @@ | ||
--- | ||
title: Install the Node.js agent with our Azure site extension | ||
tags: | ||
- Agents | ||
- Nodejs agent | ||
- Installation and configuration | ||
- Azure Site Extension | ||
translate: | ||
- jp | ||
- kr | ||
metaDescription: Procedures and resources to install New Relic's Node.js agent for Azure web apps using the New Relic Azure Site Extension for Node. | ||
freshnessValidatedDate: never | ||
--- | ||
|
||
<Callout variant="important"> | ||
Azure Site Extensions are available only for Windows-based App Service apps deployed as Code. | ||
</Callout> | ||
|
||
g the site extension will install the New Relic Node agent. | ||
|
||
From the Azure Home page, do the following: | ||
- Click the App Services tile | ||
- Click the name of the target application in the displayed list | ||
- On the options listed on the left, scroll down to "Extensions" located under the Development Tools category | ||
- Click on + Add at the top of the page | ||
- From the extension drop down, select New Relic Node Agent. | ||
- Check the box for accepting the legal terms | ||
- Click Add on the bottom of the page. This will begin installation of the extension. | ||
|
||
Once installed, the extension creates the following artifacts: | ||
|
||
- Folder: `C:\home\SiteExtensions\NewRelic.Azure.Websites.Extension.NodeAgent` | ||
- XDT: `applicationHost.xdt` that will add the necessary `NODE_OPTIONS` environment variable on application startup | ||
- The New Relic Node agent and dependencies will be installed into `C:\home\site\wwwroot\node_modules` | ||
|
||
If the extension fails to install, a log file is created at `C:\home\SiteExtensions\NewRelic.Azure.Websites.Extension.NodeAgent\install.log`. | ||
|
||
If the New Relic agent has been installed successfully and logging has been enabled, the agent will append its logs to a file at `C:\home\site\wwwroot\newrelic_agent.log`. | ||
|
||
### Compatibility note: | ||
|
||
For applications running on Win 32, full Code Level Metrics support (file path, line, column) is not available, and profiling will fall back to function name only. | ||
|
||
## Configuration | ||
The New Relic Node agent is configured with the `newrelic.js` file, or via environment variables. [See our documentation for more detailed configuration](https://docs.newrelic.com/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration/). | ||
|
||
Once the site extension is installed, you'll need to manually enter one configuration item before restarting your application. | ||
- On the options listed on the left, scroll down to "Environment variables" located under the "Settings" category and add the following: | ||
- `NEW_RELIC_LICENSE_KEY` - Your New Relic license key value | ||
|
||
The Node agent automatically adds the `NODE_OPTIONS` environment variable with a value of `-r newrelic` which starts the agent. | ||
- Note: Any previously `NODE_OPTIONS` will be removed and reset with `-r newrelic`. | ||
|
||
<Callout variant="important"> | ||
We recommend installing or removing this Azure site extension while your web application is stopped. | ||
</Callout> | ||
|