Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation note about in-process features are only supported in Listen mode. #6755

Merged
merged 5 commits into from
Jun 3, 2024
Merged

Add documentation note about in-process features are only supported in Listen mode. #6755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2d235d3
Add documentation note about in-process features are only supported i…
AntonPalyok Jun 1, 2024
81cab59
Update 'github-action-markdown-link-check' to latest version to fix m…
AntonPalyok Jun 3, 2024
5a779de
Merge branch 'dotnet:main' into main
AntonPalyok Jun 3, 2024
b738b33
Fix wrong links in documentation/api/definitions.md
AntonPalyok Jun 3, 2024
bf6ef83
Ignore 'hub.docker.com' in markdown link checker because it returns S…
AntonPalyok Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/linters/check-markdown-links-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
},
{
"pattern": "^https://www\\.dotnetfoundation.org/.*"
},
{
"pattern": "^https://hub\\.docker\\.com/.*"
}
],
"aliveStatusCodes": [
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-markdown-links.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
persist-credentials: false

- name: Check markdown links
uses: gaurav-nelson/github-action-markdown-link-check@5c5dfc0ac2e225883c0e5f03a85311ec2830d368
AntonPalyok marked this conversation as resolved.
Show resolved Hide resolved
uses: gaurav-nelson/github-action-markdown-link-check@7d83e59a57f3c201c76eed3d33dff64ec4452d27
with:
config-file: .github/linters/check-markdown-links-config.json
use-quiet-mode: 'yes'
Expand Down
4 changes: 2 additions & 2 deletions documentation/api/definitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Object describing the basic state of a collection rule for the executing instanc

| Name | Type | Description |
|---|---|---|
| State | [CollectionRuleState](#collectionrulestate-63) | Indicates what state the collection rule is in for the current process. |
| State | [CollectionRuleState](#collectionrulestate) | Indicates what state the collection rule is in for the current process. |
| StateReason | string | Human-readable explanation for the current state of the collection rule. |

## CollectionRuleDetailedDescription
Expand All @@ -65,7 +65,7 @@ Object describing the detailed state of a collection rule for the executing inst

| Name | Type | Description |
|---|---|---|
| State | [CollectionRuleState](#collectionrulestate-63) | Indicates what state the collection rule is in for the current process. |
| State | [CollectionRuleState](#collectionrulestate) | Indicates what state the collection rule is in for the current process. |
| StateReason | string | Human-readable explanation for the current state of the collection rule. |
| LifetimeOccurrences | int | The number of times the trigger has executed for a process in its lifetime. |
| SlidingWindowOccurrences | int | The number of times the trigger has executed within the current sliding window. |
Expand Down
4 changes: 2 additions & 2 deletions documentation/api/stacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Allowed schemes:
### Sample Request

```http
GET /stack?pid=21632 HTTP/1.1
GET /stacks?pid=21632 HTTP/1.1
Host: localhost:52323
Authorization: Bearer fffffffffffffffffffffffffffffffffffffffffff=
Accept: application/json
Expand Down Expand Up @@ -100,7 +100,7 @@ Location: localhost:52323/operations/67f07e40-5cca-4709-9062-26302c484f18
### Sample Request

```http
GET /stack?pid=21632 HTTP/1.1
GET /stacks?pid=21632 HTTP/1.1
Host: localhost:52323
Authorization: Bearer fffffffffffffffffffffffffffffffffffffffffff=
Accept: text/plain
Expand Down
4 changes: 4 additions & 0 deletions documentation/configuration/in-process-features-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

First Available: 8.0 Preview 7

> [!NOTE]
> 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:

- [Call Stacks](#call-stacks)
Expand Down