From d2914cc350cb40d0217b67b9796e197b6873e9ba Mon Sep 17 00:00:00 2001 From: Joe Schmitt <1146681+schmittjoseph@users.noreply.github.com> Date: Fri, 6 Sep 2024 08:51:49 -0700 Subject: [PATCH] Remove documentation survey links (#7265) --- .github/actions/update-releases-md/index.js | 5 +-- documentation/README.md | 3 -- documentation/api-key-format.md | 3 -- documentation/api-key-setup.md | 3 -- documentation/api/README.md | 3 -- documentation/api/collectionrules-get.md | 3 -- documentation/api/collectionrules-list.md | 3 -- documentation/api/collectionrules.md | 3 -- documentation/api/defaultprocess.md | 3 -- documentation/api/definitions.md | 3 -- documentation/api/dump.md | 3 -- documentation/api/exceptions-custom.md | 2 - documentation/api/exceptions.md | 3 -- documentation/api/gcdump.md | 3 -- documentation/api/info.md | 3 -- documentation/api/livemetrics-custom.md | 3 -- documentation/api/livemetrics-get.md | 3 -- documentation/api/livemetrics.md | 3 -- documentation/api/logs-custom.md | 3 -- documentation/api/logs-get.md | 3 -- documentation/api/logs.md | 3 -- documentation/api/metrics.md | 3 -- documentation/api/operations-delete.md | 3 -- documentation/api/operations-get.md | 3 -- documentation/api/operations-list.md | 3 -- documentation/api/operations-stop.md | 3 -- documentation/api/operations.md | 3 -- documentation/api/parameters.md | 3 -- documentation/api/pidvsuid.md | 3 -- documentation/api/process-env.md | 3 -- documentation/api/process-get.md | 3 -- documentation/api/processes-list.md | 3 -- documentation/api/processes.md | 3 -- documentation/api/stacks.md | 3 -- documentation/api/trace-custom.md | 3 -- documentation/api/trace-get.md | 3 -- documentation/api/trace.md | 3 -- documentation/authentication.md | 3 -- documentation/building.md | 5 +-- .../collectionrules/collectionruleexamples.md | 39 ++++++++-------- .../collectionrules/collectionrules.md | 3 -- documentation/collectionrules/templates.md | 9 ++-- .../collectionrules/triggershortcuts.md | 15 +++---- documentation/compatibility/7.0/README.md | 3 -- documentation/compatibility/8.0/README.md | 3 -- documentation/compatibility/README.md | 3 -- documentation/configuration/README.md | 3 -- .../azure-ad-authentication-configuration.md | 3 -- .../collection-rule-configuration.md | 3 -- .../configuration/configuration-sources.md | 9 ++-- .../default-process-configuration.md | 19 ++++---- .../diagnostic-port-configuration.md | 19 ++++---- .../configuration/egress-configuration.md | 3 -- .../in-process-features-configuration.md | 28 ++++++------ .../configuration/metrics-configuration.md | 45 +++++++++---------- .../configuration/storage-configuration.md | 3 -- .../view-merged-configuration.md | 3 -- documentation/docker.md | 3 -- documentation/egress.md | 3 -- documentation/kubernetes.md | 5 +-- documentation/learningPath/README.md | 3 -- documentation/learningPath/aks.md | 3 -- documentation/learningPath/api.md | 3 -- documentation/learningPath/architecture.md | 3 -- documentation/learningPath/basic-usage.md | 2 - documentation/learningPath/collectionrules.md | 9 ++-- documentation/learningPath/configuration.md | 4 +- documentation/learningPath/egress.md | 11 ++--- .../learningPath/sample-pull-request.md | 3 -- documentation/learningPath/testing.md | 5 +-- documentation/localmachine.md | 7 +-- documentation/official-build-instructions.md | 3 -- documentation/openapi.md | 4 +- documentation/release-process.md | 3 -- documentation/releases.md | 3 -- documentation/setup.md | 3 -- documentation/troubleshooting.md | 3 -- documentation/videos-and-tutorials.md | 4 -- samples/Grafana/README.md | 2 - 79 files changed, 95 insertions(+), 327 deletions(-) diff --git a/.github/actions/update-releases-md/index.js b/.github/actions/update-releases-md/index.js index 7cd3cc82098..2290832036f 100644 --- a/.github/actions/update-releases-md/index.js +++ b/.github/actions/update-releases-md/index.js @@ -37,10 +37,7 @@ function generateReleasesMdContent(releasesData, repoOwner, repoName) { previewReleasesTable += `${generateTableRow(releasesData.releases[releaseKey], repoOwner, repoName, false)}\n`; } - let content =` -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Freleases) - -# Releases + let content =`# Releases `; diff --git a/documentation/README.md b/documentation/README.md index e287d4b3d6a..16e3c065f85 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FREADME) - # 📖 `dotnet monitor` documentation `dotnet monitor` is a tool that makes it easier to get access to diagnostics information in a dotnet process. diff --git a/documentation/api-key-format.md b/documentation/api-key-format.md index 00c44e2a6e9..11c02d280c0 100644 --- a/documentation/api-key-format.md +++ b/documentation/api-key-format.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi-key-format) - # API Key Format API Keys or MonitorApiKeys used in `dotnet monitor` are JSON Web Tokens or JWTs as defined by [RFC 7519: JSON Web Token (JWT)](https://datatracker.ietf.org/doc/html/rfc7519). > [!IMPORTANT] diff --git a/documentation/api-key-setup.md b/documentation/api-key-setup.md index cef2044995b..6ce8f51b1e0 100644 --- a/documentation/api-key-setup.md +++ b/documentation/api-key-setup.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi-key-setup) - # Configuring API Key Authentication The API Key you use to secure `dotnet monitor` is a secret Json Web Token (JWT), cryptographically signed by a public/private key algorithm. You can **[Recommended]** use the integrated command to generate a key or you can generate the key yourself following the [format, documented here](./api-key-format.md). This guide will use the integrated command. diff --git a/documentation/api/README.md b/documentation/api/README.md index f42e96577e3..2ed122b1c8b 100644 --- a/documentation/api/README.md +++ b/documentation/api/README.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2FREADME) - # HTTP API Documentation The HTTP API enables on-demand extraction of diagnostic information and artifacts from discoverable processes. diff --git a/documentation/api/collectionrules-get.md b/documentation/api/collectionrules-get.md index 268ba4199cd..5075313b68e 100644 --- a/documentation/api/collectionrules-get.md +++ b/documentation/api/collectionrules-get.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules-get) - # Collection Rules - Get First Available: 6.3 diff --git a/documentation/api/collectionrules-list.md b/documentation/api/collectionrules-list.md index d924220370d..d6a9fe9190c 100644 --- a/documentation/api/collectionrules-list.md +++ b/documentation/api/collectionrules-list.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules-list) - # Collection Rules - List First Available: 6.3 diff --git a/documentation/api/collectionrules.md b/documentation/api/collectionrules.md index f262c812a65..28894b55cb7 100644 --- a/documentation/api/collectionrules.md +++ b/documentation/api/collectionrules.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules) - # Collection Rules First Available: 6.3 diff --git a/documentation/api/defaultprocess.md b/documentation/api/defaultprocess.md index b2b5863f2ce..d0fd2840757 100644 --- a/documentation/api/defaultprocess.md +++ b/documentation/api/defaultprocess.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdefaultprocess) - # Default Process When using APIs to capture diagnostic artifacts, typically a `pid`, `uid`, or `name` is provided to perform the operation on a specific process. However, these parameters may be omitted if `dotnet monitor` is able to resolve a default process. diff --git a/documentation/api/definitions.md b/documentation/api/definitions.md index d382edaa6e9..92a3f8c5c33 100644 --- a/documentation/api/definitions.md +++ b/documentation/api/definitions.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdefinitions) - # Definitions > [!NOTE] diff --git a/documentation/api/dump.md b/documentation/api/dump.md index 68f6fda380e..28ac779bc43 100644 --- a/documentation/api/dump.md +++ b/documentation/api/dump.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdump) - # Dump - Get Captures a managed dump of a specified process without using a debugger. diff --git a/documentation/api/exceptions-custom.md b/documentation/api/exceptions-custom.md index e5c1af06e6c..3afcf9d2cee 100644 --- a/documentation/api/exceptions-custom.md +++ b/documentation/api/exceptions-custom.md @@ -1,5 +1,3 @@ -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%exceptions-custom) - # Exceptions History - Custom Captures a history of first chance exceptions that were thrown in the specified process, with the ability to filter which exceptions are included in the response. diff --git a/documentation/api/exceptions.md b/documentation/api/exceptions.md index 904e83f2733..9a056528a78 100644 --- a/documentation/api/exceptions.md +++ b/documentation/api/exceptions.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%exceptions) - # Exceptions History - Get Captures a history of first chance exceptions that were thrown in the specified process. diff --git a/documentation/api/gcdump.md b/documentation/api/gcdump.md index b592ffe12a7..9be712b4922 100644 --- a/documentation/api/gcdump.md +++ b/documentation/api/gcdump.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fgcdump) - # GC Dump - Get Captures a GC dump of a specified process. These dumps are useful for several scenarios: diff --git a/documentation/api/info.md b/documentation/api/info.md index acb35043b9c..ffc71cf3aa9 100644 --- a/documentation/api/info.md +++ b/documentation/api/info.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Finfo) - # Info - Get Gets information about the `dotnet monitor` version, the runtime version, and the diagnostic port settings. diff --git a/documentation/api/livemetrics-custom.md b/documentation/api/livemetrics-custom.md index 9c3f70ae48d..66c35718ee1 100644 --- a/documentation/api/livemetrics-custom.md +++ b/documentation/api/livemetrics-custom.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics-custom) - # Livemetrics - Get Custom Captures metrics for a process, with the ability to specify custom metrics. diff --git a/documentation/api/livemetrics-get.md b/documentation/api/livemetrics-get.md index a7bc8a7de7f..9d67ac181c0 100644 --- a/documentation/api/livemetrics-get.md +++ b/documentation/api/livemetrics-get.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics-get) - # Livemetrics - Get Captures metrics for a chosen process for a duration of time. diff --git a/documentation/api/livemetrics.md b/documentation/api/livemetrics.md index f3172f986cc..24b20fa25e7 100644 --- a/documentation/api/livemetrics.md +++ b/documentation/api/livemetrics.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics) - # Live Metrics | Operation | Description | diff --git a/documentation/api/logs-custom.md b/documentation/api/logs-custom.md index bd71d9d9cb3..667c3b5c08b 100644 --- a/documentation/api/logs-custom.md +++ b/documentation/api/logs-custom.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs-custom) - # Logs - Get Custom Captures log statements that are logged to the [ILogger<> infrastructure](https://docs.microsoft.com/aspnet/core/fundamentals/logging) within a specified process, as described in the settings specified in the request body. By default, logs are collected at the levels as specified by the [application-defined configuration](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/#configure-logging). diff --git a/documentation/api/logs-get.md b/documentation/api/logs-get.md index 8b3ffe5e573..bec3632a43b 100644 --- a/documentation/api/logs-get.md +++ b/documentation/api/logs-get.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs-get) - # Logs - Get Captures log statements that are logged to the [ILogger<> infrastructure](https://docs.microsoft.com/aspnet/core/fundamentals/logging) within a specified process. By default, logs are collected at the levels as specified by the [application-defined configuration](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/#configure-logging). diff --git a/documentation/api/logs.md b/documentation/api/logs.md index 8f7283c09b1..388d6c58b71 100644 --- a/documentation/api/logs.md +++ b/documentation/api/logs.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs) - # Logs The Logs API enables collecting logs that are logged to the [ILogger<> infrastructure](https://docs.microsoft.com/aspnet/core/fundamentals/logging) within a specified process. diff --git a/documentation/api/metrics.md b/documentation/api/metrics.md index 6ffd1d717a1..c4f90c3d788 100644 --- a/documentation/api/metrics.md +++ b/documentation/api/metrics.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fmetrics) - # Metrics - Get Gets a snapshot of metrics in the Prometheus exposition format of a single process. diff --git a/documentation/api/operations-delete.md b/documentation/api/operations-delete.md index 49c1f4558f6..071e2129fee 100644 --- a/documentation/api/operations-delete.md +++ b/documentation/api/operations-delete.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-delete) - # Operations - Delete Cancel a running operation. Only valid against operations in the `Running` or `Stopping` state. Transitions the operation to `Cancelled` state. Cancelling an operation may result in an incomplete or unreadable artifact. To stop an operation early while still producing a valid artifact, use the [Stop Operation](operations-stop.md). diff --git a/documentation/api/operations-get.md b/documentation/api/operations-get.md index ce48190d06c..effd8ab7f67 100644 --- a/documentation/api/operations-get.md +++ b/documentation/api/operations-get.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-get) - # Operations - Get Gets detailed information about a specific operation. diff --git a/documentation/api/operations-list.md b/documentation/api/operations-list.md index 004d044e4aa..58cdf7ff3b3 100644 --- a/documentation/api/operations-list.md +++ b/documentation/api/operations-list.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-list) - # Operations - List Lists all operations that have been created, as well as their status. diff --git a/documentation/api/operations-stop.md b/documentation/api/operations-stop.md index 1f7cd686b72..39556bc0a99 100644 --- a/documentation/api/operations-stop.md +++ b/documentation/api/operations-stop.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-stop) - # Operations - Stop (7.1+) Gracefully stops a running operation. Only valid against operations with the `isStoppable` property set to `true`, not all operations support being gracefully stopped. Transitions the operation to `Succeeded` or `Failed` state depending on if the operation was successful. diff --git a/documentation/api/operations.md b/documentation/api/operations.md index 3f41fa1eae0..9d1903bdfd4 100644 --- a/documentation/api/operations.md +++ b/documentation/api/operations.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations) - # Operations Operations are used to track long running operations in dotnet-monitor, specifically egressing data via egressProviders instead of directly to the client. This api is very similar to [Azure asynchronous operations](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/async-operations#url-to-monitor-status). diff --git a/documentation/api/parameters.md b/documentation/api/parameters.md index 93891024716..347da631cc7 100644 --- a/documentation/api/parameters.md +++ b/documentation/api/parameters.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fparameters) - # Parameters (experimental feature) Captures parameters for one or more methods each time they are called. diff --git a/documentation/api/pidvsuid.md b/documentation/api/pidvsuid.md index 37cfdf90ca9..832e94637bc 100644 --- a/documentation/api/pidvsuid.md +++ b/documentation/api/pidvsuid.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fpidvsuid) - # Process ID `pid` vs Unique ID `uid` Many of the HTTP routes allow specifying either the process ID `pid` or the unique ID `uid`. Which one to use depends on the target process and the environment in which the process is running. diff --git a/documentation/api/process-env.md b/documentation/api/process-env.md index 2a3523ddfb3..5b3ab49b696 100644 --- a/documentation/api/process-env.md +++ b/documentation/api/process-env.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocess-env) - # Processes - Get Environment Gets the environment block of a specified process. diff --git a/documentation/api/process-get.md b/documentation/api/process-get.md index 6e9dce184dd..48b512e3807 100644 --- a/documentation/api/process-get.md +++ b/documentation/api/process-get.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocess-get) - # Processes - Get Gets detailed information about a specified process. diff --git a/documentation/api/processes-list.md b/documentation/api/processes-list.md index ede92025a31..907e1348526 100644 --- a/documentation/api/processes-list.md +++ b/documentation/api/processes-list.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocesses-list) - # Processes - List Lists the processes that are available from which diagnostic information can be obtained. diff --git a/documentation/api/processes.md b/documentation/api/processes.md index 357e7a60738..669f8f12404 100644 --- a/documentation/api/processes.md +++ b/documentation/api/processes.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocesses) - # Processes The Processes API enables enumeration of the processes that `dotnet monitor` can detect and allows for obtaining their metadata (such as their names and environment variables). diff --git a/documentation/api/stacks.md b/documentation/api/stacks.md index eeec2510332..776cd0bd1a2 100644 --- a/documentation/api/stacks.md +++ b/documentation/api/stacks.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fstacks) - # Stacks - Get Captures the call stacks of a target process. Note that only managed frames are collected. diff --git a/documentation/api/trace-custom.md b/documentation/api/trace-custom.md index 07e11a19c89..678b382d525 100644 --- a/documentation/api/trace-custom.md +++ b/documentation/api/trace-custom.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=trace-customdocumentation%2Fapi%2F) - # Trace - Get Custom Captures a diagnostic trace of a process using the given set of event providers specified in the request body. diff --git a/documentation/api/trace-get.md b/documentation/api/trace-get.md index f070ac2dc72..e631683d5e7 100644 --- a/documentation/api/trace-get.md +++ b/documentation/api/trace-get.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Ftrace-get) - # Trace - Get Captures a diagnostic trace of a process based on a predefined set of trace profiles. diff --git a/documentation/api/trace.md b/documentation/api/trace.md index 6bae7f6f817..38fad653bc9 100644 --- a/documentation/api/trace.md +++ b/documentation/api/trace.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Ftrace) - # Traces The Traces API enables collecting `.nettrace` formatted traces without using a profiler. diff --git a/documentation/authentication.md b/documentation/authentication.md index aa58a757870..e3c0a03152d 100644 --- a/documentation/authentication.md +++ b/documentation/authentication.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fauthentication) - # Authentication Authenticated requests to `dotnet monitor` help protect sensitive diagnostic artifacts from unauthorized users and lower privileged processes. `dotnet monitor` can be configured to use any one of the following authentication modes: diff --git a/documentation/building.md b/documentation/building.md index 43da0d623d6..75019fddc47 100644 --- a/documentation/building.md +++ b/documentation/building.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fbuilding) - # Clone, build and test the repo ------------------------------ @@ -29,4 +26,4 @@ If you prefer to use *Visual Studio*, *Visual Studio Code*, or *Visual Studio fo # Updating native build support -Part of the dotnet/runtime repo has been copied into this repo in order to facilitate building of native code. When needing to update the native build support, take a look at [runtime-version.txt](../src/external/runtime-version.txt) for what files should be synchronized from the dotnet/runtime repo. Synchronizing these files is currently done as a manual process. Update the version file with the new commit and file information if a new synchronization occurs. \ No newline at end of file +Part of the dotnet/runtime repo has been copied into this repo in order to facilitate building of native code. When needing to update the native build support, take a look at [runtime-version.txt](../src/external/runtime-version.txt) for what files should be synchronized from the dotnet/runtime repo. Synchronizing these files is currently done as a manual process. Update the version file with the new commit and file information if a new synchronization occurs. diff --git a/documentation/collectionrules/collectionruleexamples.md b/documentation/collectionrules/collectionruleexamples.md index 309fe52b6d0..1936bbf81d1 100644 --- a/documentation/collectionrules/collectionruleexamples.md +++ b/documentation/collectionrules/collectionruleexamples.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fcollectionrules%2Fcollectionruleexamples) - # Collection Rule Examples The following examples provide sample scenarios for using a collection rule. These templates can be copied directly into your configuration file with minimal adjustments to work with your application (for more information on configuring an egress provider, see [egress providers](../configuration/egress-configuration.md)), or they can be adjusted for your specific use-case. [Learn more about configuring collection rules](collectionrules.md). @@ -37,7 +34,7 @@ The following examples provide sample scenarios for using a collection rule. The
Kubernetes ConfigMap - + ```yaml CollectionRules__AssemblyLoadTraceOnStartup__Trigger__Type: "Startup" CollectionRules__AssemblyLoadTraceOnStartup__Actions__0__Type: "CollectTrace" @@ -51,7 +48,7 @@ The following examples provide sample scenarios for using a collection rule. The
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_CollectionRules__AssemblyLoadTraceOnStartup__Trigger__Type value: "Startup" @@ -105,7 +102,7 @@ This rule, named "AssemblyLoadTraceOnStartup", will trigger on a process's start
Kubernetes ConfigMap - + ```yaml CollectionRules__LargeGCHeapSize__Trigger__Type: "EventCounter" CollectionRules__LargeGCHeapSize__Trigger__Settings__ProviderName: "System.Runtime" @@ -118,7 +115,7 @@ This rule, named "AssemblyLoadTraceOnStartup", will trigger on a process's start
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_CollectionRules__LargeGCHeapSize__Trigger__Type value: "EventCounter" @@ -173,12 +170,12 @@ This rule, named "LargeGCHeapSize", will trigger when the GC Heap Size exceeds 1 ] } } - ``` + ```
Kubernetes ConfigMap - + ```yaml CollectionRules__HighCpuUsage__Trigger__Type: "EventCounter" CollectionRules__HighCpuUsage__Trigger__Settings__ProviderName: "System.Runtime" @@ -195,7 +192,7 @@ This rule, named "LargeGCHeapSize", will trigger when the GC Heap Size exceeds 1
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_CollectionRules__HighCpuUsage__Trigger__Type value: "EventCounter" @@ -299,7 +296,7 @@ First Available: 7.1 - name: DotnetMonitor_CollectionRules__HighHistogramValues__Actions__0__Settings__UseAppFilters value: "false" - name: DotnetMonitor_CollectionRules__HighHistogramValues__Actions__0__Settings__Duration - value: "00:00:30" + value: "00:00:30" ```
@@ -344,7 +341,7 @@ This rule, named "HighHistogramValues", will trigger when the custom histogram's
Kubernetes ConfigMap - + ```yaml CollectionRules__BadResponseStatus__Trigger__Type: "AspNetResponseStatus" CollectionRules__BadResponseStatus__Trigger__Settings__ResponseCount: "5" @@ -359,7 +356,7 @@ This rule, named "HighHistogramValues", will trigger when the custom histogram's
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_CollectionRules__BadResponseStatus__Trigger__Type value: "AspNetResponseStatus" @@ -427,7 +424,7 @@ This rule, named "BadResponseStatus", will trigger when 5 4xx status codes are e
Kubernetes ConfigMap - + ```yaml CollectionRules__HighRequestCount__Filters__0__Key: "ProcessId" CollectionRules__HighRequestCount__Filters__0__Value: "12345" @@ -446,7 +443,7 @@ This rule, named "BadResponseStatus", will trigger when 5 4xx status codes are e
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_CollectionRules__HighRequestCount__Filters__0__Key value: "ProcessId" @@ -478,7 +475,7 @@ This rule, named "BadResponseStatus", will trigger when 5 4xx status codes are e ### Explanation This rule, named "HighRequestCount", will trigger when a process with a `ProcessId` of 12345 has 10 requests within a 1 minute sliding window. If the rule is triggered, error level logs will be collected for one minute and egressed to the specified `Egress` provider (in this case, `artifacts` has been configured to save the logs to the local filesystem). There is a limit that states that this may only be triggered for one hour (to prevent an excessive number of logs from being collected), and there is a default `ActionCount` limit stating that this rule may only be triggered 5 times. - + ## Collect Trace - Too Many Long Requests (`AspNetRequestDuration` Trigger)
@@ -508,12 +505,12 @@ This rule, named "HighRequestCount", will trigger when a process with a `Process ] } } - ``` + ```
Kubernetes ConfigMap - + ```yaml CollectionRules__LongRequestDuration__Trigger__Type: "AspNetRequestDuration" CollectionRules__LongRequestDuration__Trigger__Settings__RequestCount: "5" @@ -529,7 +526,7 @@ This rule, named "HighRequestCount", will trigger when a process with a `Process
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_CollectionRules__LongRequestDuration__Trigger__Type value: "AspNetRequestDuration" @@ -598,7 +595,7 @@ This rule, named "LongRequestDuration", will trigger when 5 requests each take g
Kubernetes ConfigMap - + ```yaml CollectionRules__CollectDumpAndExecute__Trigger__Type: "AspNetResponseStatus" CollectionRules__CollectDumpAndExecute__Trigger__Settings__ResponseCount: "3" @@ -616,7 +613,7 @@ This rule, named "LongRequestDuration", will trigger when 5 requests each take g
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_CollectionRules__CollectDumpAndExecute__Trigger__Type value: "AspNetResponseStatus" diff --git a/documentation/collectionrules/collectionrules.md b/documentation/collectionrules/collectionrules.md index d3330734f15..84f8b1552a3 100644 --- a/documentation/collectionrules/collectionrules.md +++ b/documentation/collectionrules/collectionrules.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fcollectionrules%2Fcollectionrules) - # Collection Rules `dotnet monitor` can be [configured](../configuration/collection-rule-configuration.md#collection-rule-configuration) to automatically collect diagnostic artifacts based on conditions within the discovered processes. diff --git a/documentation/collectionrules/templates.md b/documentation/collectionrules/templates.md index 5481759fa10..6db863b9ba4 100644 --- a/documentation/collectionrules/templates.md +++ b/documentation/collectionrules/templates.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fcollectionrules%2Ftemplates) - # Templates Templates allow users to design reusable collection rule components to decrease configuration verbosity, reduce duplication between rules, and speed up the process of writing complex scenarios. @@ -41,7 +38,7 @@ You can easily translate existing configuration to Templates using the format in "Trigger": "NameOfTriggerTemplate", "Actions": [ "NameOfActionTemplate" - ] + ] } } } @@ -159,7 +156,7 @@ The following example creates a template trigger named "HighRequestCount", two t "Filters": [ "AppName" ], - "Limits": "ShortDuration" + "Limits": "ShortDuration" } }, "TraceWhenHighCPU": { @@ -207,7 +204,7 @@ The following example creates a template trigger named "HighRequestCount", two t Templates__CollectionRuleLimits__ShortDuration__RuleDuration: "00:05:00" Templates__CollectionRuleLimits__ShortDuration__ActionCount: "1" Templates__CollectionRuleLimits__ShortDuration__ActionCountSlidingWindowDuration: "00:00:30" - + CollectionRules__LogAndDumpWhenHighRequestCount__Trigger: "HighRequestCount" CollectionRules__LogAndDumpWhenHighRequestCount__Actions__0: "ErrorLogs" CollectionRules__LogAndDumpWhenHighRequestCount__Actions__1__Type: "CollectDump" diff --git a/documentation/collectionrules/triggershortcuts.md b/documentation/collectionrules/triggershortcuts.md index c594872ead0..6ee800f27a6 100644 --- a/documentation/collectionrules/triggershortcuts.md +++ b/documentation/collectionrules/triggershortcuts.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fcollectionrules%2Ftriggershortcuts) - # Trigger Shortcuts These triggers simplify configuration for several common trigger use-cases. All of these shortcuts can be expressed as `EventCounter` triggers; however, these shortcuts provide improved defaults, range validation, and a simpler syntax. There are currently three built-in default triggers; additional trigger shortcuts may be added in future versions of `dotnet monitor`. @@ -38,7 +35,7 @@ Execute a trigger when the target application's CPU Usage is continuously greate
Kubernetes ConfigMap - + ```yaml CollectionRules__RuleName__Trigger__Type: "EventCounter" CollectionRules__RuleName__Trigger__Settings__ProviderName: "System.Runtime" @@ -80,7 +77,7 @@ Usage that is satisfied when the CPU usage of the application is higher than 50%
Kubernetes ConfigMap - + ```yaml CollectionRules__RuleName__Trigger__Type: "CPUUsage" ``` @@ -128,7 +125,7 @@ Execute a trigger when the target application's GC Heap Size is continuously gre
Kubernetes ConfigMap - + ```yaml CollectionRules__RuleName__Trigger__Type: "EventCounter" CollectionRules__RuleName__Trigger__Settings__ProviderName: "System.Runtime" @@ -170,7 +167,7 @@ Usage that is satisfied when the GC Heap Size of the application is greater than
Kubernetes ConfigMap - + ```yaml CollectionRules__RuleName__Trigger__Type: "GCHeapSize" ``` @@ -218,7 +215,7 @@ Execute a trigger when the target application's threadpool queue length is conti
Kubernetes ConfigMap - + ```yaml CollectionRules__RuleName__Trigger__Type: "EventCounter" CollectionRules__RuleName__Trigger__Settings__ProviderName: "System.Runtime" @@ -260,7 +257,7 @@ Usage that is satisfied when the threadpool queue length of the application is h
Kubernetes ConfigMap - + ```yaml CollectionRules__RuleName__Trigger__Type: "ThreadpoolQueueLength" ``` diff --git a/documentation/compatibility/7.0/README.md b/documentation/compatibility/7.0/README.md index a111867a79f..917e6277260 100644 --- a/documentation/compatibility/7.0/README.md +++ b/documentation/compatibility/7.0/README.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fcompatibility%2F7.0%2FREADME) - # Breaking Changes in 7.0 If you are migrating your usage to `dotnet monitor` 7.0, the following changes might affect you. Changes are grouped together by areas within the tool. diff --git a/documentation/compatibility/8.0/README.md b/documentation/compatibility/8.0/README.md index 8db521e5953..a6156a1ba91 100644 --- a/documentation/compatibility/8.0/README.md +++ b/documentation/compatibility/8.0/README.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fcompatibility%2F8.0%2FREADME) - # Breaking Changes in 8.0 If you are migrating your usage to `dotnet monitor` 8.0, the following changes might affect you. Changes are grouped together by areas within the tool. diff --git a/documentation/compatibility/README.md b/documentation/compatibility/README.md index acdf9334feb..390dc4e2138 100644 --- a/documentation/compatibility/README.md +++ b/documentation/compatibility/README.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fcompatibility%2FREADME) - # Breaking Changes - [Breaking Changes in 7.0](./7.0/README.md) diff --git a/documentation/configuration/README.md b/documentation/configuration/README.md index 0b225d640cf..36d6eab747f 100644 --- a/documentation/configuration/README.md +++ b/documentation/configuration/README.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration) - # Configuration `dotnet monitor` has extensive configuration to control various aspects of its behavior. Ordinarily, you are not required to specify most of this configuration and only exists if you wish to change the default behavior in `dotnet monitor`. diff --git a/documentation/configuration/azure-ad-authentication-configuration.md b/documentation/configuration/azure-ad-authentication-configuration.md index 6cae163ab41..604b6e30917 100644 --- a/documentation/configuration/azure-ad-authentication-configuration.md +++ b/documentation/configuration/azure-ad-authentication-configuration.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fazure-ad-authentication-configuration) - # Azure Active Directory Authentication Configuration First Available: 7.1 diff --git a/documentation/configuration/collection-rule-configuration.md b/documentation/configuration/collection-rule-configuration.md index 01675815277..496c4f6ac28 100644 --- a/documentation/configuration/collection-rule-configuration.md +++ b/documentation/configuration/collection-rule-configuration.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fcollection-rule-configuration) - # Collection Rule Configuration `dotnet monitor` can be configured to automatically collect diagnostic artifacts based on conditions within the discovered processes. diff --git a/documentation/configuration/configuration-sources.md b/documentation/configuration/configuration-sources.md index b73319ced95..494d78973c6 100644 --- a/documentation/configuration/configuration-sources.md +++ b/documentation/configuration/configuration-sources.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fconfiguration-sources) - # Configuration Sources `dotnet monitor` can read and combine configuration from multiple sources. The configuration sources are listed below in the order in which they are read (first is lowest precedence, last is highest precedence): @@ -65,7 +62,7 @@ kubectl create secret generic apikey \ You can then use a Kubernetes volume mount to supply the secret to the container at runtime. -```yaml +```yaml spec: volumes: - name: config @@ -92,7 +89,7 @@ data: You can then use a Kubernetes volume mount to supply the configuration map to the container at runtime -```yaml +```yaml spec: volumes: - name: config @@ -108,7 +105,7 @@ spec: If using multiple configuration maps, secrets, or some combination of both, you need to use a [projected volume](https://kubernetes.io/docs/concepts/storage/volumes/#projected) to map several volume sources into a single directory -```yaml +```yaml spec: volumes: - name: config diff --git a/documentation/configuration/default-process-configuration.md b/documentation/configuration/default-process-configuration.md index 721c35c4759..51ff9cf4bd6 100644 --- a/documentation/configuration/default-process-configuration.md +++ b/documentation/configuration/default-process-configuration.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fdefault-process-configuration) - # Default Process Configuration Default process configuration is used to determine which process is used for metrics and in situations where the process is not specified in the query to retrieve an artifact. A process must match all the specified filters. If a `Key` is not specified, the default is `ProcessId`. @@ -41,7 +38,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
Kubernetes ConfigMap - + ```yaml DefaultProcess__Filters__0__Key: "ProcessName" DefaultProcess__Filters__0__Value: "iisexpress" @@ -50,7 +47,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_DefaultProcess__Filters__0__Key value: "ProcessName" @@ -77,7 +74,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
Kubernetes ConfigMap - + ```yaml DefaultProcess__Filters__0__ProcessName: "iisexpress" ``` @@ -85,7 +82,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_DefaultProcess__Filters__0__ProcessName value: "iisexpress" @@ -111,7 +108,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
Kubernetes ConfigMap - + ```yaml DefaultProcess__Filters__0__Key: "ProcessId" DefaultProcess__Filters__0__Value: "1" @@ -120,7 +117,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_DefaultProcess__Filters__0__Key value: "ProcessId" @@ -147,7 +144,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
Kubernetes ConfigMap - + ```yaml DefaultProcess__Filters__0__ProcessId: "1" ``` @@ -155,7 +152,7 @@ Optionally, a shorthand format allows you to omit the `Key` and `Value` terms an
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_DefaultProcess__Filters__0__ProcessId value: "1" diff --git a/documentation/configuration/diagnostic-port-configuration.md b/documentation/configuration/diagnostic-port-configuration.md index 07c1fe325df..acf20f10680 100644 --- a/documentation/configuration/diagnostic-port-configuration.md +++ b/documentation/configuration/diagnostic-port-configuration.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fdiagnostic-port-configuration) - # Diagnostic Port Configuration `dotnet monitor` communicates via .NET processes through their diagnostic port. In the default configuration, .NET processes listen on a platform native transport (named pipes on Windows/Unix-domain sockets on \*nix) in a well-known location. @@ -21,7 +18,7 @@ It is possible to change this behavior and have .NET processes connect to `dotne
Kubernetes ConfigMap - + ```yaml DiagnosticPort: "/diag/port.sock" ``` @@ -29,7 +26,7 @@ It is possible to change this behavior and have .NET processes connect to `dotne
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_DiagnosticPort value: "/diag/port.sock" @@ -53,7 +50,7 @@ Alternatively, `dotnet monitor` can be set to `Listen` mode using the expanded f
Kubernetes ConfigMap - + ```yaml DiagnosticPort__ConnectionMode: "Listen" DiagnosticPort__EndpointName: "/diag/port.sock" @@ -62,7 +59,7 @@ Alternatively, `dotnet monitor` can be set to `Listen` mode using the expanded f
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_DiagnosticPort__ConnectionMode value: "Listen" @@ -96,7 +93,7 @@ When operating in `Listen` mode, you can also specify the maximum number of inco
Kubernetes ConfigMap - + ```yaml DiagnosticPort__MaxConnections: "10" ``` @@ -104,7 +101,7 @@ When operating in `Listen` mode, you can also specify the maximum number of inco
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_DiagnosticPort__MaxConnections value: "10" @@ -117,9 +114,9 @@ When operating in `Listen` mode, you can also specify the maximum number of inco ### `dotnet monitor` in `Connect` mode -As noted the default configuration for `dotnet monitor` is `Connect` mode. This assumes your .NET apps does not have any additional diagnostics configurations enabled and as a result is communicating with `dotnet monitor` via the diagnostics port in the default location. +As noted the default configuration for `dotnet monitor` is `Connect` mode. This assumes your .NET apps does not have any additional diagnostics configurations enabled and as a result is communicating with `dotnet monitor` via the diagnostics port in the default location. -The following tables highlight that triggers and most of the advanced collection scenarios are not supported in this mode. +The following tables highlight that triggers and most of the advanced collection scenarios are not supported in this mode. | API | Supported | | :-------- | :-------: | diff --git a/documentation/configuration/egress-configuration.md b/documentation/configuration/egress-configuration.md index 1deef3a6cdc..3a41ed90fb2 100644 --- a/documentation/configuration/egress-configuration.md +++ b/documentation/configuration/egress-configuration.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fegress-configuration) - # Egress Configuration When `dotnet-monitor` is used to produce artifacts such as dumps or traces, an egress provider enables the artifacts to be stored in a manner suitable for the hosting environment rather than streamed back directly. diff --git a/documentation/configuration/in-process-features-configuration.md b/documentation/configuration/in-process-features-configuration.md index b8503cc1215..3c9f864f712 100644 --- a/documentation/configuration/in-process-features-configuration.md +++ b/documentation/configuration/in-process-features-configuration.md @@ -1,11 +1,9 @@ -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fin-process-features-configuration) - # In-Process Features Configuration First Available: 8.0 Preview 7 > [!NOTE] -> In-process features are only supported when running dotnet-monitor in `Listen` mode. +> In-process features are only supported when running dotnet-monitor in `Listen` mode. > See [Diagnostic Port](./diagnostic-port-configuration.md) configuration for details. Some features of `dotnet monitor` require loading libraries into target applications. These libraries ship with `dotnet monitor` and are provisioned to be available to target applications using the `DefaultSharedPath` option in the [storage configuration](./storage-configuration.md) section. The following features require these in-process libraries to be used: @@ -33,7 +31,7 @@ To enable all available in-process features, use the following configuration:
Kubernetes ConfigMap - + ```yaml InProcessFeatures__Enabled: "true" ``` @@ -41,7 +39,7 @@ To enable all available in-process features, use the following configuration:
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_InProcessFeatures__Enabled value: "true" @@ -68,7 +66,7 @@ The call stacks feature is individually enabled by setting the `Enabled` propert
Kubernetes ConfigMap - + ```yaml InProcessFeatures__CallStacks__Enabled: "true" ``` @@ -76,7 +74,7 @@ The call stacks feature is individually enabled by setting the `Enabled` propert
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_InProcessFeatures__CallStacks__Enabled value: "true" @@ -102,7 +100,7 @@ Similarly, the call stacks feature can be individually disabled by setting the s
Kubernetes ConfigMap - + ```yaml InProcessFeatures__Enabled: "true" InProcessFeatures__CallStacks__Enabled: "false" @@ -111,7 +109,7 @@ Similarly, the call stacks feature can be individually disabled by setting the s
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_InProcessFeatures__Enabled value: "true" @@ -140,7 +138,7 @@ The exceptions history feature is individually enabled by setting the `Enabled`
Kubernetes ConfigMap - + ```yaml InProcessFeatures__Exceptions__Enabled: "true" ``` @@ -148,7 +146,7 @@ The exceptions history feature is individually enabled by setting the `Enabled`
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_InProcessFeatures__Exceptions__Enabled value: "true" @@ -174,7 +172,7 @@ Similarly, the exceptions history feature can be individually disabled by settin
Kubernetes ConfigMap - + ```yaml InProcessFeatures__Enabled: "true" InProcessFeatures__Exceptions__Enabled: "false" @@ -183,7 +181,7 @@ Similarly, the exceptions history feature can be individually disabled by settin
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_InProcessFeatures__Enabled value: "true" @@ -231,7 +229,7 @@ In this example, a user is choosing to only collect exceptions where the top fra
Kubernetes ConfigMap - + ```yaml InProcessFeatures__Exceptions__Enabled: "true" InProcessFeatures__Exceptions__CollectionFilters__Include__0__TypeName: "MyClassName" @@ -242,7 +240,7 @@ In this example, a user is choosing to only collect exceptions where the top fra
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_InProcessFeatures__Exceptions__Enabled value: "true" diff --git a/documentation/configuration/metrics-configuration.md b/documentation/configuration/metrics-configuration.md index aa4b55befc5..49c85fd44e0 100644 --- a/documentation/configuration/metrics-configuration.md +++ b/documentation/configuration/metrics-configuration.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fmetrics-configuration) - # Metrics Configuration ## Default Providers @@ -33,7 +30,7 @@ Prometheus metrics, livemetrics, triggers, traces, and trigger actions that coll
Kubernetes ConfigMap - + ```yaml GlobalCounter__IntervalSeconds: "10" ``` @@ -41,7 +38,7 @@ Prometheus metrics, livemetrics, triggers, traces, and trigger actions that coll
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_GlobalCounter__IntervalSeconds value: "10" @@ -73,7 +70,7 @@ It is possible to override the global interval on a per provider basis. Note thi
Kubernetes ConfigMap - + ```yaml GlobalCounter__IntervalSeconds: "5" GlobalCounter__Providers__System.Runtime__IntervalSeconds: "10" @@ -82,7 +79,7 @@ It is possible to override the global interval on a per provider basis. Note thi
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_GlobalCounter__IntervalSeconds value: "5" @@ -94,7 +91,7 @@ It is possible to override the global interval on a per provider basis. Note thi ## Metrics Urls -In addition to the ordinary diagnostics urls that `dotnet monitor` binds to, it also binds to metric urls that only expose the `/metrics` endpoint. Unlike the other endpoints, the metrics urls do not require authentication. Unless you enable collection of custom providers that may contain sensitive business logic, it is generally considered safe to expose metrics endpoints. +In addition to the ordinary diagnostics urls that `dotnet monitor` binds to, it also binds to metric urls that only expose the `/metrics` endpoint. Unlike the other endpoints, the metrics urls do not require authentication. Unless you enable collection of custom providers that may contain sensitive business logic, it is generally considered safe to expose metrics endpoints.
Command Line @@ -118,7 +115,7 @@ In addition to the ordinary diagnostics urls that `dotnet monitor` binds to, it
Kubernetes ConfigMap - + ```yaml Metrics__Endpoints: "http://*:52325" ``` @@ -126,7 +123,7 @@ In addition to the ordinary diagnostics urls that `dotnet monitor` binds to, it
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_Metrics__Endpoints value: "http://*:52325" @@ -153,7 +150,7 @@ You can customize the number of data points stored per metric via the following
Kubernetes ConfigMap - + ```yaml Metrics__MetricCount: "3" ``` @@ -161,7 +158,7 @@ You can customize the number of data points stored per metric via the following
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_Metrics__MetricCount value: "3" @@ -172,7 +169,7 @@ See [Global Counter Interval](#global-counter-interval) to change the metrics fr ## Custom Metrics -Additional metrics providers and counter names to return from this route can be specified via configuration. +Additional metrics providers and counter names to return from this route can be specified via configuration.
JSON @@ -196,7 +193,7 @@ Additional metrics providers and counter names to return from this route can be
Kubernetes ConfigMap - + ```yaml Metrics__Providers__0__ProviderName: "Microsoft-AspNetCore-Server-Kestrel" Metrics__Providers__0__CounterNames__0: "connections-per-second" @@ -206,7 +203,7 @@ Additional metrics providers and counter names to return from this route can be
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_Metrics__Providers__0__ProviderName value: "Microsoft-AspNetCore-Server-Kestrel" @@ -225,7 +222,7 @@ When `CounterNames` are not specified, all the counters associated with the `Pro [8.0+] `System.Diagnostics.Metrics` is now supported for custom metrics. At this time, there are the following known limitations: * `dotnet monitor` may fail to collect `System.Diagnostics.Metrics` if it begins collecting the metric before the target app creates the Meter ([note that this is fixed for .NET 8+ apps](https://github.com/dotnet/runtime/pull/76965)). - + ### Adding Meters/Instruments for `System.Diagnostics.Metrics` Specifying a `Meter` is done differently than for `EventCounter` providers. The following example uses `MyCounter1` and `MyCounter2` on an `EventCounter` named `MyProvider`, as well as the `MyInstrument` instrument on `MyCustomMeter` and all instruments on the `AnotherMeter` meter: @@ -258,7 +255,7 @@ Specifying a `Meter` is done differently than for `EventCounter` providers. The
Kubernetes ConfigMap - + ```yaml Metrics__Providers__0__ProviderName: "MyProvider" Metrics__Providers__0__CounterNames__0: "MyCounter1" @@ -271,7 +268,7 @@ Specifying a `Meter` is done differently than for `EventCounter` providers. The
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_Metrics__Providers__0__ProviderName value: "MyProvider" @@ -306,7 +303,7 @@ For System.Diagnostics.Metrics, `dotnet monitor` allows you to set the maximum n
Kubernetes ConfigMap - + ```yaml GlobalCounter__MaxHistograms: "5" ``` @@ -314,7 +311,7 @@ For System.Diagnostics.Metrics, `dotnet monitor` allows you to set the maximum n
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_GlobalCounter__MaxHistograms value: "5" @@ -339,7 +336,7 @@ For System.Diagnostics.Metrics, `dotnet monitor` allows you to set the maximum n
Kubernetes ConfigMap - + ```yaml GlobalCounter__MaxTimeSeries: "500" ``` @@ -347,7 +344,7 @@ For System.Diagnostics.Metrics, `dotnet monitor` allows you to set the maximum n
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_GlobalCounter__MaxTimeSeries value: "500" @@ -372,7 +369,7 @@ In addition to enabling custom providers, `dotnet monitor` also allows you to di
Kubernetes ConfigMap - + ```yaml Metrics__IncludeDefaultProviders: "false" ``` @@ -380,7 +377,7 @@ In addition to enabling custom providers, `dotnet monitor` also allows you to di
Kubernetes Environment Variables - + ```yaml - name: DotnetMonitor_Metrics__IncludeDefaultProviders value: "false" diff --git a/documentation/configuration/storage-configuration.md b/documentation/configuration/storage-configuration.md index 9aff9a309ee..93e80ab1582 100644 --- a/documentation/configuration/storage-configuration.md +++ b/documentation/configuration/storage-configuration.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fstorage-configuration) - # Storage Configuration Some diagnostic features (e.g. memory dumps, stack traces) require that a directory is shared between the `dotnet monitor` tool and the target applications. The `Storage` configuration section allows specifying these directories to facilitate this sharing. diff --git a/documentation/configuration/view-merged-configuration.md b/documentation/configuration/view-merged-configuration.md index 60d04c7f97d..ab848d8719e 100644 --- a/documentation/configuration/view-merged-configuration.md +++ b/documentation/configuration/view-merged-configuration.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fconfiguration%2Fview-merged-configuration) - # View Merged Configuration `dotnet monitor` includes a diagnostic command that allows you to output the resulting configuration after merging the configuration from all the various sources. diff --git a/documentation/docker.md b/documentation/docker.md index 5bcd9a0914d..6470fa01ff8 100644 --- a/documentation/docker.md +++ b/documentation/docker.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fdocker) - # Running in Docker In addition to its availability as a .NET CLI tool, the `dotnet monitor` tool is available as a prebuilt Docker image that can be run in container runtimes and orchestrators. See [Releases](releases.md) for information on how long each image version will be supported. diff --git a/documentation/egress.md b/documentation/egress.md index 1980d3326fb..9634a11f7b8 100644 --- a/documentation/egress.md +++ b/documentation/egress.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fegress) - # Egress Providers `dotnet monitor` supports configuration of [egress providers](./configuration/egress-configuration.md) that can be used to egress artifacts externally, instead of to the client. This is supported for dumps, gcdumps, traces, logs, and live metrics. Currently supported providers are Azure blob storage and filesystem. diff --git a/documentation/kubernetes.md b/documentation/kubernetes.md index 8db13094a45..5acd9ba825d 100644 --- a/documentation/kubernetes.md +++ b/documentation/kubernetes.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fkubernetes) - # Running in Kubernetes In addition to its availability as a .NET CLI tool, the `dotnet monitor` tool is available as a prebuilt Docker image that can be run in container runtimes and orchestrators, such as Kubernetes. @@ -261,7 +258,7 @@ resources: cpu: "250m" ``` -How much memory and CPU is consumed by dotnet-monitor is dependent on which scenarios are being executed: +How much memory and CPU is consumed by dotnet-monitor is dependent on which scenarios are being executed: - Metrics consume a negligible amount of resources, although using custom metrics can affect this. - Operations such as traces and logs may require memory in the main application container that will automatically be allocated by the runtime. - Resource consumption by trace operations is also dependent on which providers are enabled, as well as the [buffer size](./api/definitions.md#eventprovidersconfiguration) allocated in the runtime. diff --git a/documentation/learningPath/README.md b/documentation/learningPath/README.md index 6398bbdbe98..76539ab70aa 100644 --- a/documentation/learningPath/README.md +++ b/documentation/learningPath/README.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2FREADME) - > [!NOTE] > All documents in this directory are a work in progress. diff --git a/documentation/learningPath/aks.md b/documentation/learningPath/aks.md index 2b86ca2901b..da22f3e657a 100644 --- a/documentation/learningPath/aks.md +++ b/documentation/learningPath/aks.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Faks) - # AKS In addition to its availability as a .NET CLI tool, the `dotnet monitor` tool is available as a prebuilt Docker image that can be run in container runtimes and orchestrators, such as Kubernetes. To learn more about using `dotnet monitor` with Kubernetes, you can check out our [example deployment](https://github.com/dotnet/dotnet-monitor/blob/main/documentation/kubernetes.md) and our [video tutorial](https://github.com/dotnet/dotnet-monitor/tree/main/samples/AKS_Tutorial). This section covers how to test your development version of `dotnet monitor` in AKS; however, we recommend having some basic experience with AKS before following this workflow. diff --git a/documentation/learningPath/api.md b/documentation/learningPath/api.md index 5dca3fce3dc..acc5a669cf9 100644 --- a/documentation/learningPath/api.md +++ b/documentation/learningPath/api.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Fapi) - # API dotnet-monitor exposes functionality through both [collection rules](./collectionrules.md) and a web API surface. The web api is built using [ASP.NET Core](https://dotnet.microsoft.com/learn/aspnet/what-is-aspnet-core) and enables on-demand extraction of diagnostic information and artifacts from discoverable processes. diff --git a/documentation/learningPath/architecture.md b/documentation/learningPath/architecture.md index 38476ca861c..c79bec1ac69 100644 --- a/documentation/learningPath/architecture.md +++ b/documentation/learningPath/architecture.md @@ -1,4 +1 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Farchitecture) - # Architecture diff --git a/documentation/learningPath/basic-usage.md b/documentation/learningPath/basic-usage.md index c50ee6c4f39..b94215fb74f 100644 --- a/documentation/learningPath/basic-usage.md +++ b/documentation/learningPath/basic-usage.md @@ -1,5 +1,3 @@ -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Fbasic-usage) - # Basic Usage Before you start developing for `dotnet-monitor`, it's a good idea to know how the tool works and how to run it. If you've never used `dotnet-monitor` before, you can find a basic tutorial [here](https://www.youtube.com/watch?v=pG0t19bEYJw) that will show you how to use it locally on Windows. diff --git a/documentation/learningPath/collectionrules.md b/documentation/learningPath/collectionrules.md index f5e29700d73..991f4a76db0 100644 --- a/documentation/learningPath/collectionrules.md +++ b/documentation/learningPath/collectionrules.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Fcollectionrules) - # Collection Rules ## How To Use Collection Rules @@ -18,7 +15,7 @@ graph LR subgraph ide1 [Set-Up] A[Configuration] --> N{.NET Monitor} N --> |1| O[Load Configuration and Bind Options] - N --> |2| P[Connect to Processes in Reverse Mode] + N --> |2| P[Connect to Processes in Reverse Mode] N --> |3| Q[Start Pipelines For Processes That Match Filters] end subgraph ide2 [Repeat until Rule Limits Reached] @@ -26,7 +23,7 @@ graph LR N ---> |5| V[Check For Throttling] N ---> |6| W[Execute Action List] end - + class ide2 altColor ``` @@ -41,7 +38,7 @@ graph LR ### Triggers -A trigger will monitor for a specific condition in the target application and raise a notification when that condition has been observed. Options for triggers can be found [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/CollectionRules/Options/CollectionRuleTriggerOptions.cs); the type of `Settings` is determined by which trigger is being used (possible trigger types can be found [here](https://github.com/dotnet/dotnet-monitor/tree/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/CollectionRules/Options/Triggers)). The interface for all triggers can be found [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/CollectionRules/Triggers/ICollectionRuleTrigger.cs) - this allows `dotnet monitor` to start and stop triggers, regardless of the trigger's properties. The collection rule pipeline creates instances of triggers [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/CollectionRules/CollectionRulePipeline.cs#L99) before waiting for the trigger to [satisfy its conditions](https://github.com/dotnet/diagnostics/blob/v6.0.351802/src/Microsoft.Diagnostics.Monitoring.EventPipe/Triggers/Pipelines/TraceEventTriggerPipeline.cs#L107) - each trigger has its own set of criteria that determines when a trigger has been satisfied. +A trigger will monitor for a specific condition in the target application and raise a notification when that condition has been observed. Options for triggers can be found [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/CollectionRules/Options/CollectionRuleTriggerOptions.cs); the type of `Settings` is determined by which trigger is being used (possible trigger types can be found [here](https://github.com/dotnet/dotnet-monitor/tree/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/CollectionRules/Options/Triggers)). The interface for all triggers can be found [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/CollectionRules/Triggers/ICollectionRuleTrigger.cs) - this allows `dotnet monitor` to start and stop triggers, regardless of the trigger's properties. The collection rule pipeline creates instances of triggers [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/CollectionRules/CollectionRulePipeline.cs#L99) before waiting for the trigger to [satisfy its conditions](https://github.com/dotnet/diagnostics/blob/v6.0.351802/src/Microsoft.Diagnostics.Monitoring.EventPipe/Triggers/Pipelines/TraceEventTriggerPipeline.cs#L107) - each trigger has its own set of criteria that determines when a trigger has been satisfied. ### Actions diff --git a/documentation/learningPath/configuration.md b/documentation/learningPath/configuration.md index 78ba66a1dfe..9c1932cb228 100644 --- a/documentation/learningPath/configuration.md +++ b/documentation/learningPath/configuration.md @@ -1,5 +1,3 @@ -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Fconfiguration) - # Configuration `dotnet monitor` has extensive configuration to control various aspects of its behavior. Here, we'll walk through the basics of how configuration works and keeping the documentation up to date. @@ -10,7 +8,7 @@ To see the merged configuration, the user can run the `config show` command (see [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/Program.cs#L71) and [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/Commands/ConfigShowCommandHandler.cs)); the `--show-sources` flag can be used to reveal which configuration source is responsible for each property. The `config show` command's output is [written out as JSON](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/ConfigurationJsonWriter.cs); this section must be manually updated whenever new options are added (or existing options are changed). -Once configuration has been merged, any singletons that have been added to the `IServiceCollection` (see [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/ServiceCollectionExtensions.cs) and [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/Commands/CollectCommandHandler.cs#L84)), such as `IConfigureOptions`, `IPostConfigureOptions`, and `IValidateOptions`, are called when an object of that type is first used, **not on startup**. This step is often used to incorporate defaults for properties that were not explicitly set by configuration, or to validate that options were set correctly. +Once configuration has been merged, any singletons that have been added to the `IServiceCollection` (see [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/ServiceCollectionExtensions.cs) and [here](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tools/dotnet-monitor/Commands/CollectCommandHandler.cs#L84)), such as `IConfigureOptions`, `IPostConfigureOptions`, and `IValidateOptions`, are called when an object of that type is first used, **not on startup**. This step is often used to incorporate defaults for properties that were not explicitly set by configuration, or to validate that options were set correctly. Any changes to the configuration need to be propagated to the [schema](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/documentation/schema.json). **The updated schema should be generated automatically; you should never need to manually edit the JSON.** To update the schema in Visual Studio: * Set [Microsoft.Diagnostics.Monitoring.ConfigurationSchema](https://github.com/dotnet/dotnet-monitor/tree/b5bf953026d47318e521e5580524866ef0aab764/src/Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema) as the startup project diff --git a/documentation/learningPath/egress.md b/documentation/learningPath/egress.md index b402301bfa3..f357b00a639 100644 --- a/documentation/learningPath/egress.md +++ b/documentation/learningPath/egress.md @@ -1,9 +1,6 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Fegress) - # Egress -`dotnet monitor` includes functionality to egress (send) artifacts to permanent storage locations, such as `Azure Blob Storage`. For .NET Monitor 8, the tool has converted to using an extensible egress model that allows developers to author their own egress providers that aren't built into the `dotnet monitor` product. This section covers how the egress extensibility model works, and provides information about how to develop an egress extension (using the `AzureBlobStorage` egress provider as an example). +`dotnet monitor` includes functionality to egress (send) artifacts to permanent storage locations, such as `Azure Blob Storage`. For .NET Monitor 8, the tool has converted to using an extensible egress model that allows developers to author their own egress providers that aren't built into the `dotnet monitor` product. This section covers how the egress extensibility model works, and provides information about how to develop an egress extension (using the `AzureBlobStorage` egress provider as an example). ## How Egress Works @@ -14,7 +11,7 @@ graph LR subgraph ide1 [.NET Monitor] A[Configuration] --> N{.NET Monitor} N --> 1 - N --> 2 + N --> 2 N --> 3 end subgraph ide2 [Extensions] @@ -22,7 +19,7 @@ graph LR R --> 4 R --> 5 end - + class ide2 altColor ``` @@ -50,7 +47,7 @@ There are 3 [locations](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026 - On Windows, `%USERPROFILE%\.dotnet-monitor\settings.json` - On *nix,`$XDG_CONFIG_HOME/dotnet-monitor/settings.json` - If `$XDG_CONFIG_HOME` isn't defined, we fall back to `$HOME/.config/dotnet-monitor/settings.json` -### Manually Acquiring An Egress Provider +### Manually Acquiring An Egress Provider #### TODO The distribution/acquisition model for third-party egress providers is determined by the author of the extension. diff --git a/documentation/learningPath/sample-pull-request.md b/documentation/learningPath/sample-pull-request.md index 8df406d5588..351ea85659e 100644 --- a/documentation/learningPath/sample-pull-request.md +++ b/documentation/learningPath/sample-pull-request.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Fsample-pull-request) - # Sample Pull Request To contribute to the `dotnet monitor` repo, you'll need to create a [pull request](https://github.com/dotnet/dotnet-monitor/pulls). When you submit a pull request, you'll receive feedback on your changes from the `dotnet monitor` team. Before your code can be merged, you'll need the following: diff --git a/documentation/learningPath/testing.md b/documentation/learningPath/testing.md index 647b014d238..68029be18a2 100644 --- a/documentation/learningPath/testing.md +++ b/documentation/learningPath/testing.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FlearningPath%2Ftesting) - # Testing ## Running Tests @@ -15,7 +12,7 @@ The framework of the test assemblies is controlled by [TestTargetFrameworks](htt - [Microsoft.Diagnostics.Monitoring.WebApi.UnitTests](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tests/Microsoft.Diagnostics.Monitoring.WebApi.UnitTests/) - [CollectionRuleActions.UnitTests](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tests/CollectionRuleActions.UnitTests/) -Unit test assemblies directly reference types from various dotnet-monitor assemblies. However, since most of dotnet-monitor heavily relies on code injection, there are utility classes to simplify unit test creation. +Unit test assemblies directly reference types from various dotnet-monitor assemblies. However, since most of dotnet-monitor heavily relies on code injection, there are utility classes to simplify unit test creation. - [TestHostHelper](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTestCommon/TestHostHelper.cs) can be used to setup a basic unit test scenario using dependency injection. - [CollectionRuleOptionsExtensions](https://github.com/dotnet/dotnet-monitor/blob/b5bf953026d47318e521e5580524866ef0aab764/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTestCommon/Options/CollectionRuleOptionsExtensions.cs) can be used to easily create collection rules from configuration. diff --git a/documentation/localmachine.md b/documentation/localmachine.md index f719e8fe3c3..0ab0491f154 100644 --- a/documentation/localmachine.md +++ b/documentation/localmachine.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Flocalmachine) - # Running on a local machine `dotnet monitor` can be installed as a global tool providing observability, diagnostics artifact collection, and triggering in local development and testing scenarios. You can run `dotnet tool install -g dotnet-monitor` to install the latest version, see the full details [here](./setup.md#net-core-global-tool). @@ -37,11 +34,11 @@ To start using `dotnet monitor`, run the following command from a PowerShell or dotnet-monitor collect ``` -Assuming your default process is running, you can use the endpoints exposed by `dotnet monitor` to view metrics and logs or to download traces and memory dumps. When using Windows Authentication, your browser will automatically handle the Windows authentication challenge, allowing you to navigate to these endpoints directly. +Assuming your default process is running, you can use the endpoints exposed by `dotnet monitor` to view metrics and logs or to download traces and memory dumps. When using Windows Authentication, your browser will automatically handle the Windows authentication challenge, allowing you to navigate to these endpoints directly. [HTTP /dump API](./api/dump.md) ```http -/dump +/dump ``` [HTTP /trace API](./api/trace-get.md) diff --git a/documentation/official-build-instructions.md b/documentation/official-build-instructions.md index b23d9a45bc6..c75c93f2bd4 100644 --- a/documentation/official-build-instructions.md +++ b/documentation/official-build-instructions.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fofficial-build-instructions) - # Official Build Instructions > **Warning**: These instructions will only work internally at Microsoft. diff --git a/documentation/openapi.md b/documentation/openapi.md index 9cdccf9c05f..9b1238f5976 100644 --- a/documentation/openapi.md +++ b/documentation/openapi.md @@ -1,7 +1,5 @@ -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fopenapi) - ## OpenAPI documentation The OpenAPI definition for the dotnet-monitor API can be found at [openapi.json](openapi.json). This can be used to generate a client stub for calling the API from your own tools. -Additionally, the document can be accessed from the root route ("/" path) when dotnet-monitor is running. This version of the document includes security scheme information if authentication has been configured. \ No newline at end of file +Additionally, the document can be accessed from the root route ("/" path) when dotnet-monitor is running. This version of the document includes security scheme information if authentication has been configured. diff --git a/documentation/release-process.md b/documentation/release-process.md index 3ca42e2c65b..e9927a8f089 100644 --- a/documentation/release-process.md +++ b/documentation/release-process.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Frelease-process) - # Release Process ## Prepare the release branch diff --git a/documentation/releases.md b/documentation/releases.md index 6961c5ddc9f..ed412b7357e 100644 --- a/documentation/releases.md +++ b/documentation/releases.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Freleases) - # Releases ## Supported versions diff --git a/documentation/setup.md b/documentation/setup.md index a9c88e10416..1ee016fd5c5 100644 --- a/documentation/setup.md +++ b/documentation/setup.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fsetup) - # Setup `dotnet monitor` is available via two different distribution mechanisms: diff --git a/documentation/troubleshooting.md b/documentation/troubleshooting.md index b4804761288..f1f68cf6fb2 100644 --- a/documentation/troubleshooting.md +++ b/documentation/troubleshooting.md @@ -1,6 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Ftroubleshooting) - # Troubleshooting Guide Here is our guide for diagnosing specific issues with `dotnet monitor`. This is an ongoing effort to add issues and solutions to this guide; you can help us by letting us know in the [Issues](https://github.com/dotnet/dotnet-monitor/issues) section if we should add something here. diff --git a/documentation/videos-and-tutorials.md b/documentation/videos-and-tutorials.md index cdec6f451c4..6fb4b3bbc76 100644 --- a/documentation/videos-and-tutorials.md +++ b/documentation/videos-and-tutorials.md @@ -1,7 +1,3 @@ - -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fvideos-and-tutorials) - - ### Dotnet Monitor Fundamentals [![Video Tutorial For Getting Started Locally With Dotnet Monitor](https://i.ytimg.com/vi/pG0t19bEYJw/hq720.jpg)](https://www.youtube.com/watch?v=pG0t19bEYJw) diff --git a/samples/Grafana/README.md b/samples/Grafana/README.md index e5a502b77d3..264e08e40c5 100644 --- a/samples/Grafana/README.md +++ b/samples/Grafana/README.md @@ -1,5 +1,3 @@ -### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fgrafana) - # Configure `dotnet monitor` in an AKS cluster for Managed Grafana `dotnet monitor` provides [snapshots of .NET metrics in the Prometheus exposition format](https://github.com/dotnet/dotnet-monitor/blob/main/documentation/api/metrics.md). The [Prometheus](https://prometheus.io/docs/introduction/overview/) agent in turn collects metrics from targets by scraping metrics HTTP endpoints.