8000 Add a Windows section in SSI docs by bmermet · Pull Request #29395 · DataDog/documentation · GitHub
[go: up one dir, main page]

Skip to content

Add a Windows section in SSI docs #29395

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
wants to merge 11 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,16 @@ Click on one of the following tiles to learn how to set up SSI for your deployme

<div class="alert alert-info">To see requirements for compatible languages, operating systems, and architectures, see <a href="https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/single-step-apm/compatibility/">Single Step Instrumentation compatibility.</a></div>

<div class="alert alert-info"> Single Step APM Instrumentation on Windows is in Preview.</div>

## Configure Unified Service Tags

Unified Service Tags (USTs) connect traces, metrics, and logs by applying consistent tags across your telemetry. This makes it easier to navigate your observability data.

Learn how to set USTs for:
- [Linux][14]
- [Docker][15]
- [Windows][18]
- [Kubernetes][16]

**Note**: In Kubernetes, USTs must be set on both the Deployment object and the Pod template spec.
Expand Down Expand Up @@ -86,6 +89,16 @@ The available setup methods depend on your platform:
[9]: /tracing/trace_collection/automatic_instrumentation/single-step-apm/kubernetes/?tab=installingwithdatadogoperator#configure-instrumentation-for-namespaces-and-pods
[10]: /tracing/trace_collection/library_config/

{{% /tab %}}

{{% tab "Windows" %}}

| Configuration method | Description | Supported platforms |
|:---|:---|:---|
| [Set environment variables][10] | Enable products by setting environment variables directly in your application configuration. | Linux, Kubernetes, Windows, Docker |

[10]: /tracing/trace_collection/library_config/

{{% /tab %}}
{{< /tabs >}}

Expand Down Expand Up @@ -117,3 +130,4 @@ Single Step Instrumentation automatically disables when it detects [custom instr
[15]: /getting_started/tagging/unified_service_tagging/?tab=docker#containerized-environment
[16]: /getting_started/tagging/unified_service_tagging/?tab=kubernetes
[17]: /tracing/trace_collection/automatic_instrumentation/configure_apm_features_linux/
[18]: /integrations/windows_service/#tags
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Single Step APM Instrumentation on Windows
code_lang: windows
type: multi-code-lang
code_lang_weight: 30
further_reading:
- link: /tracing/metrics/runtime_metrics/
tag: Documentation
text: Enable Runtime Metrics
---

<div class="alert alert-info"> Single Step APM Instrumentation on Windows is in Preview.</div>

## Overview

With Single Step Instrumentation (SSI), you can automatically enable APM for your .NET Framework and .NET Core applications running on Windows IIS, using a single MSI command during the Datadog Agent installation. No separate SDK installation or code changes are required.

## Enable APM on Windows

**Note:** Only .NET applications running in IIS are supported for Single Step Instrumentation on Windows.

To enable APM with Single Step Instrumentation on Windows:

1. In Datadog, go to the Install Datadog [Windows Agent page][1] .
1. In the **Customize your observability coverage** section, toggle **Application Performance Monitoring (APM)**.
1. Copy and run the provided MSI install command on your Windows host.
1. Restart the IIS applications you want instrumented. (You do not need to restart the entire IIS server.)

After installation, the Agent automatically loads the Datadog .NET SDK into supported application processes to enable distributed tracing.

## Set SDK Tracer Versions

By default, Single Step Instrumentation installs the latest supported version of the Datadog .NET Tracer.

If you need to pin a specific version:

1. From the Windows Agent install page, after toggling **Application Performance Monitoring (APM)** instrumentation, select Customize library versions.
1. Under .NET, choose the version you want to use.
1. Copy the updated MSI command and run it on your host.

## Remove Single Step APM instrumentation from your Agent


To disable SSI for .NET on your host, run:

```shell
&"C:\Program Files\Datadog\Datadog Agent\bin\datadog-installer.exe" remove datadog-apm-library-dotnet
```

## Further reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: https://app.datadoghq.com/fleet/install-agent/latest?platform=windows
9 changes: 8 additions & 1 deletion layouts/partials/apm/apm-single-step.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{ $dot := . }}
<div class="apm-languages">
<div class="container cards-dd">
<div class="row row-cols-1 row-cols-sm-3 g-2 g-xl-3 justify-content-sm-center">
<div class="row row-cols-1 row-cols-sm-4 g-2 g-xl-3 justify-content-sm-center">
<div class="col">
<a class="card h-100" href="linux">
<div class="card-body text-center py-2 px-1">
Expand All @@ -23,6 +23,13 @@
</div>
</a>
</div>
<div class="col">
<a class="card h-100" href="windows">
<div class="card-body text-center py-2 px-1">
{{ partial "img.html" (dict "root" . "src" "integrations_logos/windows_iis_large.svg" "class" "img-fluid" "alt" "windows" "width" "200") }}
</div>
</a>
</div>
</div>
</div>
</div>
Loading
0