Skip to content

Commit d2914cc

Browse files
Remove documentation survey links (#7265)
1 parent 8c3a7f4 commit d2914cc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+95
-327
lines changed

.github/actions/update-releases-md/index.js

+1-4
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,7 @@ function generateReleasesMdContent(releasesData, repoOwner, repoName) {
3737
previewReleasesTable += `${generateTableRow(releasesData.releases[releaseKey], repoOwner, repoName, false)}\n`;
3838
}
3939

40-
let content =`
41-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Freleases)
42-
43-
# Releases
40+
let content =`# Releases
4441
4542
`;
4643

documentation/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FREADME)
3-
41
# 📖 `dotnet monitor` documentation
52

63
`dotnet monitor` is a tool that makes it easier to get access to diagnostics information in a dotnet process.

documentation/api-key-format.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi-key-format)
3-
41
# API Key Format
52
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).
63
> [!IMPORTANT]

documentation/api-key-setup.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi-key-setup)
3-
41
# Configuring API Key Authentication
52

63
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.

documentation/api/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2FREADME)
3-
41
# HTTP API Documentation
52

63
The HTTP API enables on-demand extraction of diagnostic information and artifacts from discoverable processes.

documentation/api/collectionrules-get.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules-get)
3-
41
# Collection Rules - Get
52

63
First Available: 6.3

documentation/api/collectionrules-list.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules-list)
3-
41
# Collection Rules - List
52

63
First Available: 6.3

documentation/api/collectionrules.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules)
3-
41
# Collection Rules
52

63
First Available: 6.3

documentation/api/defaultprocess.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdefaultprocess)
3-
41
# Default Process
52

63
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.

documentation/api/definitions.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdefinitions)
3-
41
# Definitions
52

63
> [!NOTE]

documentation/api/dump.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdump)
3-
41
# Dump - Get
52

63
Captures a managed dump of a specified process without using a debugger.

documentation/api/exceptions-custom.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%exceptions-custom)
2-
31
# Exceptions History - Custom
42

53
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.

documentation/api/exceptions.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%exceptions)
3-
41
# Exceptions History - Get
52

63
Captures a history of first chance exceptions that were thrown in the specified process.

documentation/api/gcdump.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fgcdump)
3-
41
# GC Dump - Get
52

63
Captures a GC dump of a specified process. These dumps are useful for several scenarios:

documentation/api/info.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Finfo)
3-
41
# Info - Get
52

63
Gets information about the `dotnet monitor` version, the runtime version, and the diagnostic port settings.

documentation/api/livemetrics-custom.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics-custom)
3-
41
# Livemetrics - Get Custom
52

63
Captures metrics for a process, with the ability to specify custom metrics.

documentation/api/livemetrics-get.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics-get)
3-
41
# Livemetrics - Get
52

63
Captures metrics for a chosen process for a duration of time.

documentation/api/livemetrics.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics)
3-
41
# Live Metrics
52

63
| Operation | Description |

documentation/api/logs-custom.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs-custom)
3-
41
# Logs - Get Custom
52

63
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).

documentation/api/logs-get.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs-get)
3-
41
# Logs - Get
52

63
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).

documentation/api/logs.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs)
3-
41
# Logs
52

63
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.

documentation/api/metrics.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fmetrics)
3-
41
# Metrics - Get
52

63
Gets a snapshot of metrics in the Prometheus exposition format of a single process.

documentation/api/operations-delete.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-delete)
3-
41
# Operations - Delete
52

63
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).

documentation/api/operations-get.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-get)
3-
41
# Operations - Get
52

63
Gets detailed information about a specific operation.

documentation/api/operations-list.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-list)
3-
41
# Operations - List
52

63
Lists all operations that have been created, as well as their status.

documentation/api/operations-stop.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-stop)
3-
41
# Operations - Stop (7.1+)
52

63
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.

documentation/api/operations.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations)
3-
41
# Operations
52

63
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).

documentation/api/parameters.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fparameters)
3-
41
# Parameters (experimental feature)
52

63
Captures parameters for one or more methods each time they are called.

documentation/api/pidvsuid.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fpidvsuid)
3-
41
# Process ID `pid` vs Unique ID `uid`
52

63
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.

documentation/api/process-env.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocess-env)
3-
41
# Processes - Get Environment
52

63
Gets the environment block of a specified process.

documentation/api/process-get.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocess-get)
3-
41
# Processes - Get
52

63
Gets detailed information about a specified process.

documentation/api/processes-list.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocesses-list)
3-
41
# Processes - List
52

63
Lists the processes that are available from which diagnostic information can be obtained.

documentation/api/processes.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocesses)
3-
41
# Processes
52

63
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).

documentation/api/stacks.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fstacks)
3-
41
# Stacks - Get
52

63
Captures the call stacks of a target process. Note that only managed frames are collected.

documentation/api/trace-custom.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=trace-customdocumentation%2Fapi%2F)
3-
41
# Trace - Get Custom
52

63
Captures a diagnostic trace of a process using the given set of event providers specified in the request body.

documentation/api/trace-get.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Ftrace-get)
3-
41
# Trace - Get
52

63
Captures a diagnostic trace of a process based on a predefined set of trace profiles.

documentation/api/trace.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Ftrace)
3-
41
# Traces
52

63
The Traces API enables collecting `.nettrace` formatted traces without using a profiler.

documentation/authentication.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fauthentication)
3-
41
# Authentication
52

63
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:

documentation/building.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fbuilding)
3-
41
# Clone, build and test the repo
52
------------------------------
63

@@ -29,4 +26,4 @@ If you prefer to use *Visual Studio*, *Visual Studio Code*, or *Visual Studio fo
2926

3027
# Updating native build support
3128

32-
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.
29+
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.

0 commit comments

Comments
 (0)