-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Fix broken link references in Azure App Service Windows Code docs #32475
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lucaspimentel
wants to merge
4
commits into
master
Choose a base branch
from
lpimentel/apm-dotnet-fix-windows-link
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
0cb2fdd
Fix broken link references in Azure App Service Windows Code docs
lucaspimentel 3c4d490
Remove duplicate dogstatsd link and renumber references
lucaspimentel 72e11a5
Fix link references in Azure App Service Windows Code docs
lucaspimentel 4312573
add some whitespace for readability
lucaspimentel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -21,7 +21,7 @@ | |
|
|
||
| ## Overview | ||
|
|
||
| The Datadog extension for Azure App Service provides monitoring capabilities in addition to the [Datadog-Azure integration][7], which provides metrics and logs. | ||
| The Datadog extension for Azure App Service provides monitoring capabilities in addition to the [Datadog-Azure integration][5], which provides metrics and logs. | ||
|
|
||
| - Full distributed APM tracing using automatic instrumentation. | ||
| - Customized APM service and trace views showing relevant Azure App Service metrics and metadata. | ||
|
|
@@ -48,24 +48,28 @@ | |
|
|
||
| {{< tabs >}} | ||
| {{% tab ".NET" %}} | ||
|
|
||
| Datadog's automatic instrumentation relies on the .NET CLR Profiling API. This API allows only one subscriber (for example, Datadog's .NET Tracer with Profiler enabled). To ensure maximum visibility, run only one APM solution within your application environment. | ||
|
|
||
| Additionally, if you are using the Azure Native integration, you can use the Datadog resource in Azure to add the extension to your .NET apps. For instructions, see the [App Service extension section][1] of Datadog's [Azure Native integration guide][2]. | ||
|
|
||
| [1]: /integrations/guide/azure-native-integration/#app-service-extension | ||
| [2]: /integrations/guide/azure-native-integration/ | ||
|
|
||
| {{% /tab %}} | ||
| {{% tab "Java" %}} | ||
| Support for Java Web Apps is in Preview for extension v2.4+. | ||
|
|
||
| There are no billing implications for tracing Java Web Apps during this period. | ||
|
|
||
| {{% /tab %}} | ||
| {{< /tabs >}} | ||
|
|
||
| ## Installation | ||
|
|
||
| Datadog recommends doing regular updates to the latest version of the extension to ensure optimal performance, stability, and availability of features. Note that both the initial install and subsequent updates require your web app to be fully stopped in order to install/update successfully. | ||
|
|
||
| If you haven't already, set up the [Datadog-Azure integration][5]. You can verify that your Azure integration is configured correctly by ensuring that you see the `azure.app_services.count` or `azure.functions.count` metrics in Datadog. | ||
| If you haven't already, set up the [Datadog-Azure integration][3]. You can verify that your Azure integration is configured correctly by ensuring that you see the `azure.app_services.count` or `azure.functions.count` metrics in Datadog. | ||
|
|
||
| <div class="alert alert-info">This step is critical for metric/trace correlation and functional trace panel views and improves the overall experience of using Datadog with Azure App Services. | ||
| </div> | ||
|
|
@@ -182,7 +186,7 @@ | |
|
|
||
| {{< img src="infrastructure/serverless/azure_app_services/choose_extension.png" alt="Example of Extensions page in Azure portal, showing .NET Datadog APM extension." style="width:100%;" >}} | ||
|
|
||
| 6. Accept the legal terms, click **OK**, and wait for the installation to complete. | ||
| 6. Accept the legal terms, click **OK**, and wait for the installation to complete. | ||
| <div class="alert alert-danger">This step requires that your application be in a stopped state.</div> | ||
|
|
||
| 7. Start the main application, click **Start**: | ||
|
|
@@ -201,17 +205,17 @@ | |
| {{% /tab %}} | ||
| {{< /tabs >}} | ||
|
|
||
|
|
||
| ## Custom metrics | ||
|
|
||
| The Azure App Service extension includes an instance of [DogStatsD][3], Datadog's metrics aggregation service. This enables you to submit custom metrics, service checks, and events directly to Datadog from Azure Web Apps and Functions with the extension. | ||
| The Azure App Service extension includes an instance of [DogStatsD][1], Datadog's metrics aggregation service. This enables you to submit custom metrics, service checks, and events directly to Datadog from Azure Web Apps and Functions with the extension. | ||
|
|
||
| Writing custom metrics and checks in Azure App Service is similar to the process for doing so with an application on a host running the Datadog Agent. **Unlike** the [standard DogStatsD config process][3], there is no need to set ports or a server name when initializing the DogStatsD configuration. There are ambient environment variables in Azure App Service that determine how the metrics are sent (requires v6.0.0+ of the DogStatsD client). | ||
| Writing custom metrics and checks in Azure App Service is similar to the process for doing so with an application on a host running the Datadog Agent. **Unlike** the [standard DogStatsD config process][1], there is no need to set ports or a server name when initializing the DogStatsD configuration. There are ambient environment variables in Azure App Service that determine how the metrics are sent (requires v6.0.0+ of the DogStatsD client). | ||
|
|
||
| To submit custom metrics to Datadog from Azure App Service using the extension: | ||
|
|
||
| {{< tabs >}} | ||
| {{% tab ".NET" %}} | ||
|
|
||
| 1. Add the [DogStatsD NuGet package](https://www.nuget.org/packages/DogStatsD-CSharp-Client) to your Visual Studio project. | ||
| 2. Initialize DogStatsD and write custom metrics in your application. | ||
| 3. Deploy your code to Azure App Service. | ||
|
|
@@ -255,9 +259,10 @@ | |
|
|
||
| {{% /tab %}} | ||
| {{% tab "Node.js" %}} | ||
|
|
||
| 1. [Initialize DogStatsD and write custom metrics][1] in your application. | ||
| 1. Deploy your code to a supported Azure Web App. | ||
| 1. If you have not already, install Datadog's Azure App Service Node.js extension. | ||
| 2. Deploy your code to a supported Azure Web App. | ||
| 3. If you have not already, install Datadog's Azure App Service Node.js extension. | ||
|
|
||
| <div class="alert alert-info">You do not need to install a Node.js DogStatsD client, as it is included in the Node.js tracer (<code>dd-trace</code>) packaged in the Azure App Service extension.</div> | ||
|
|
||
|
|
@@ -282,11 +287,12 @@ | |
| - Set `DD_TRACE_ENABLED` to `false`. | ||
| - Set `DD_AAS_ENABLE_CUSTOM_METRICS` to `true`. | ||
|
|
||
| Learn more about [custom metrics][4]. | ||
| Learn more about [custom metrics][2]. | ||
|
|
||
| ## Logging | ||
|
|
||
| ### Application logging | ||
|
|
||
| {{< tabs >}} | ||
| {{% tab ".NET" %}} | ||
|
|
||
|
|
@@ -299,6 +305,7 @@ | |
|
|
||
| [1]: /logs/log_collection/csharp/#agentless-logging-with-apm | ||
| [2]: /logs/log_collection/csharp/#agentless-logging-with-serilog-sink | ||
|
|
||
| {{% /tab %}} | ||
| {{% tab "Java" %}} | ||
|
|
||
|
|
@@ -334,6 +341,7 @@ | |
|
|
||
| {{< tabs >}} | ||
| {{% tab ".NET" %}} | ||
|
|
||
| **Code Example: Microsoft Native Logging** | ||
|
|
||
| An example of how to set up logging in a .NET application using Microsoft.Extensions.Logging: | ||
|
|
@@ -354,12 +362,12 @@ | |
| public IActionResult Get() | ||
| { | ||
| _logger.LogInformation("Processing weather forecast request"); | ||
|
|
||
| // Your business logic here | ||
| var forecast = GetWeatherForecast(); | ||
|
|
||
| _logger.LogInformation("Weather forecast retrieved for user: {UserId}", userId); | ||
|
|
||
| return Ok(forecast); | ||
| } | ||
| } | ||
|
|
@@ -537,7 +545,7 @@ | |
|
|
||
| 1. Go to the Azure integration tile. | ||
|
|
||
| 2. Ensure you have installed the [Azure integration][5] for the Azure subscription where your application is running. | ||
| 2. Ensure you have installed the [Azure integration][3] for the Azure subscription where your application is running. | ||
|
|
||
| 3. Ensure that any App Service plan filtering rules you have applied include the App Service plan where the app is running. If an App Service plan is not included, all apps and functions hosted on it are also not included. Tags on the app itself are not used for filtering by Datadog. | ||
|
|
||
|
|
@@ -551,16 +559,14 @@ | |
|
|
||
| **Note**: To expedite the process of investigating application errors with the support team, set `DD_TRACE_DEBUG:true` and add the content of the Datadog logs directory (`%AzureAppServiceHomeDirectory%\LogFiles\datadog`) to your email. | ||
|
|
||
| Still need help? Contact [Datadog support][6]. | ||
| Still need help? Contact [Datadog support][4]. | ||
|
|
||
| ### Further Reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [1]: /developers/dogstatsd | ||
| [2]: /tracing/setup/dotnet/ | ||
| [3]: /developers/dogstatsd | ||
|
Comment on lines
-561
to
-562
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These are the main changes in this PR:
|
||
| [4]: /metrics/ | ||
| [5]: /integrations/azure/ | ||
| [6]: /help | ||
| [7]: https://app.datadoghq.com/integrations/azure | ||
| [2]: /metrics/custom_metrics/ | ||
| [3]: /integrations/azure/ | ||
| [4]: /help | ||
| [5]: https://app.datadoghq.com/integrations/azure | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.