documentation
documentation copied to clipboard
DOCS-7436 - Serverless | Azure App Service - Node.js extension for Windows
What does this PR do? What is the motivation?
- Adds windows node support to table on Azure App Service index page
- Adds install instructions to Azure App Service - Windows page
Merge instructions
- [ ] Please merge after reviewing
Additional notes
questions for duncan or other reviewer
- for step 8, it just says "select the Datadog APM Node extension". is there an official name for this? will users have to search for it?
- for the dogstatsd instructions, I copied over what was in the java instructions. in step 1, the "DogStatsD client" linked to a maven package so for node, i have this linking to hot-shots—is this correct?
- the dogstatsd instructions put installing the extension at step 4, which suggests it is mandatory to only install the extension AFTER you set up dogstatsd. is this actually the case? if not, i'll update it to "If you have not already, install the extension" for all three languages.
Preview links (active after the build_preview check completes)
Modified Files
- https://docs-staging.datadoghq.com/cswatt/aas-node/serverless/azure_app_services/
- https://docs-staging.datadoghq.com/cswatt/aas-node/serverless/azure_app_services/azure_app_services_windows
Addressing your questions in the description
- for step 8, it just says "select the Datadog APM Node extension". is there an official name for this? will users have to search for it?
Here's a screenshot of what users seen in Azure when adding a site extension. The exact name of the extension is Node Datadog APM(<version>)--Datadog.
- for the dogstatsd instructions, I copied over what was in the java instructions. in step 1, the "DogStatsD client" linked to a maven package so for node, i have this linking to hot-shots—is this correct?
A dogstatsd client was recently added to the Node.js tracer so we are actually using the dd-trace library to submit custom metrics via DogStatsD. Since dd-trace is included as a package in the extension and is appended to the NODE_PATH, it does not need to be added as a dependency in the user's project.
However, since the extension can't be used for local testing we'll need to update these instructions slightly. What do you think of this? Feel free to reword as needed!
The Azure App Service extension includes an instance of DogStatsD (Datadog’s metrics aggregation service). This enables you to submit custom metrics, service checks, and events directly to Datadog from Azure Web Apps with the extension.
Writing custom metrics and checks in this environment is similar to the process for doing so with an application on a standard host running the Datadog Agent. To submit custom metrics to Datadog from Azure App Service using the extension:
- Initialize DogStatsD and write custom metrics in your application.
- Deploy your code to a supported Azure web app.
- If you have not already, install the Datadog App Service extension.
Note that the Node DogStatsD client is part of the Node.js tracer that is packaged in the extension and is automatically appended to the NODE_PATH. As such, the Node DogStatsD client does not need to be added as a dependency to your project except in the case of local testing. Reference the release notes to find the version of the Node.js tracer that is packaged with a specific version of the extension.
- the dogstatsd instructions put installing the extension at step 4, which suggests it is mandatory to only install the extension AFTER you set up dogstatsd. is this actually the case? if not, i'll update it to "If you have not already, install the extension" for all three languages.
I agree it makes sense to add If you have not already since there could be a scenario where users set up and used an extension with their app then add custom metrics at a later date.
The rest of the doc looks good 👍
LGTM!