Skip to content

Commit b14a510

Browse files
anita-flegganita-flegg
committed
full edit management topics(2) + bulk Note wording change
1 parent 013ffde commit b14a510

File tree

15 files changed

+126
-123
lines changed

15 files changed

+126
-123
lines changed

‎api/v4/management/cloud-foundry.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ builder.Services.AddCloudFoundryActuator();
4848
```
4949

5050
> [!NOTE]
51-
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
52-
> which enables individually turning them on/off at runtime via configuration.
51+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
52+
> this enables individually turning them on/off at runtime via configuration.
5353
5454
### Cross Origin Resource Sharing
5555

‎api/v4/management/dbmigrations.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ builder.Services.AddDbMigrationsActuator();
3737
```
3838

3939
> [!NOTE]
40-
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
41-
> which enables individually turning them on/off at runtime via configuration.
40+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
41+
> this enables individually turning them on/off at runtime via configuration.
4242
4343
## Sample Output
4444

‎api/v4/management/env.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ builder.Services.AddEnvironmentActuator();
3737
```
3838

3939
> [!NOTE]
40-
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
41-
> which enables individually turning them on/off at runtime via configuration.
40+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
41+
> this enables individually turning them on/off at runtime via configuration.
4242
4343
## Sample Output
4444

‎api/v4/management/health.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ builder.Services.AddHealthActuator();
8383
```
8484

8585
> [!NOTE]
86-
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
87-
> which enables individually turning them on/off at runtime via configuration.
86+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
87+
> this enables individually turning them on/off at runtime via configuration.
8888
8989
By default, the health status is reflected in the HTTP response status code.
9090
For example, when a health check fails, the response status code is `503 Service Unavailable`.

‎api/v4/management/heapdump.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,5 @@ builder.Services.AddHeapDumpActuator();
4646
```
4747

4848
> [!NOTE]
49-
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
50-
> which enables individually turning them on/off at runtime via configuration.
49+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
50+
> this enables individually turning them on/off at runtime via configuration.

‎api/v4/management/httpexchanges.md‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,39 @@
11
# HTTP Exchanges
22

3-
The Steeltoe HTTP Exchanges endpoint provides the ability to view the last several requests made of your application.
3+
The Steeltoe HTTP Exchanges endpoint provides the ability to view the last several requests sent to your application.
44

5-
When you activate this endpoint, an `IHttpExchangesRepository` implementation is registered that stores HTTP request/response information in memory, that can be retrieved by using the endpoint.
5+
When you activate this endpoint, an `IHttpExchangesRepository` implementation is registered; it stores HTTP request/response information in memory, and can be retrieved by using the endpoint.
66

77
## Configure Settings
88

99
The following table describes the configuration settings that you can apply to the endpoint.
1010
Each key must be prefixed with `Management:Endpoints:HttpExchanges:`.
1111

1212
| Key | Description | Default |
13-
| --- | --- | --- |
14-
| `Enabled` | Whether the endpoint is enabled. | `true` |
15-
| `ID` | The unique ID of the endpoint. | `httpexchanges` |
16-
| `Path` | The relative path at which the endpoint is exposed. | same as `ID` |
17-
| `RequiredPermissions` | Permissions required to access the endpoint, when running on Cloud Foundry. | `Restricted` |
18-
| `AllowedVerbs` | An array of HTTP verbs the endpoint is exposed at. | `GET` |
19-
| `Capacity` | Size of the circular buffer of exchanges. | 100 |
20-
| `IncludeRequestHeaders` | Whether to return headers from the HTTP request. | `true` |
21-
| `RequestHeaders` | An array of HTTP request headers to return unredacted, in addition to the default set. | |
22-
| `IncludeResponseHeaders` | Whether to return headers from the HTTP response. | `true` |
23-
| `ResponseHeaders` | An array of HTTP response headers to return unredacted, in addition to the default set. | |
24-
| `IncludePathInfo` | Whether to return the path from the HTTP request URL. | `true` |
25-
| `IncludeQueryString` | Whether to return the query string parameters from the request URL. | `true` |
26-
| `IncludeUserPrincipal` | Whether to return the username from [`HttpContext.User`](https://learn.microsoft.com/dotnet/api/system.security.claims.claimsprincipal). | `false` |
27-
| `IncludeRemoteAddress` | Whether to return the IP address from the sender. | `false` |
28-
| `IncludeSessionId` | Whether to return the user's session ID. | `false` |
29-
| `IncludeTimeTaken` | Whether to return the request duration. | `true` |
30-
| `Reverse` | Whether to return exchanges in reverse order (newest first). | `true` |
13+
| --- | ----------- | ------- |
14+
| `Enabled` | Whether the endpoint is enabled | `true` |
15+
| `ID` | The unique ID of the endpoint | `httpexchanges` |
16+
| `Path` | The relative path at which the endpoint is exposed | same as `ID` |
17+
| `RequiredPermissions` | Permissions required to access the endpoint when running on Cloud Foundry | `Restricted` |
18+
| `AllowedVerbs` | An array of HTTP verbs at which the endpoint is exposed | `GET` |
19+
| `Capacity` | Size of the circular buffer of exchanges | 100 |
20+
| `IncludeRequestHeaders` | Whether to return headers from the HTTP request | `true` |
21+
| `RequestHeaders` | An array of HTTP request headers to return unredacted, in addition to the default set | |
22+
| `IncludeResponseHeaders` | Whether to return headers from the HTTP response | `true` |
23+
| `ResponseHeaders` | An array of HTTP response headers to return unredacted, in addition to the default set | |
24+
| `IncludePathInfo` | Whether to return the path from the HTTP request URL | `true` |
25+
| `IncludeQueryString` | Whether to return the query string parameters from the request URL | `true` |
26+
| `IncludeUserPrincipal` | Whether to return the username from [`HttpContext.User`](https://learn.microsoft.com/dotnet/api/system.security.claims.claimsprincipal) | `false` |
27+
| `IncludeRemoteAddress` | Whether to return the IP address from the sender | `false` |
28+
| `IncludeSessionId` | Whether to return the user's session ID | `false` |
29+
| `IncludeTimeTaken` | Whether to return the request duration | `true` |
30+
| `Reverse` | Whether to return exchanges in reverse order (newest first) | `true` |
3131

3232
All request and response header values are redacted by default, except for the whitelisted entries below.
3333
To return additional headers unredacted, add them to the `RequestHeaders` or `ResponseHeaders` arrays.
3434

3535
Whitelist of HTTP request headers:
36+
3637
- Accept
3738
- Accept-Charset
3839
- Accept-Encoding
@@ -61,6 +62,7 @@ Whitelist of HTTP request headers:
6162
- X-UA-Compatible
6263

6364
Whitelist of HTTP response headers:
65+
6466
- Accept-Ranges
6567
- Age
6668
- Allow
@@ -86,10 +88,10 @@ Whitelist of HTTP response headers:
8688
8789
## Enable HTTP Access
8890

89-
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting together with the `Path` setting described in the preceding section.
91+
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting with the `Path` setting described in the preceding section.
9092
The default path is `/actuator/httpexchanges`.
9193

92-
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the overall steps required to enable HTTP access to endpoints in an ASP.NET Core application.
94+
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.
9395

9496
To add the actuator to the service container and map its route, use the `AddHttpExchangesActuator` extension method.
9597

@@ -103,14 +105,14 @@ builder.Services.AddHttpExchangesActuator();
103105
```
104106

105107
> [!NOTE]
106-
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
107-
> which enables individually turning them on/off at runtime via configuration.
108+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
109+
> this enables individually turning them on/off at runtime via configuration.
108110
109111
## Sample Output
110112

111113
This endpoint returns an array of exchanges.
112114

113-
The response is always returned as JSON, like this:
115+
The response is always returned as JSON:
114116

115117
```json
116118
{

‎api/v4/management/hypermedia.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ The following table describes the configuration settings that you can apply to t
99
Each key must be prefixed with `Management:Endpoints:Actuator:`. Note this key differs from the convention used by other actuators.
1010

1111
| Key | Description | Default |
12-
| --- | --- | --- |
13-
| `Enabled` | Whether the endpoint is enabled. | `true` |
14-
| `ID` | The unique ID of the endpoint. | `""` |
15-
| `Path` | The relative path at which the endpoint is exposed. | same as `ID` |
16-
| `RequiredPermissions` | Permissions required to access the endpoint, when running on Cloud Foundry. | `Restricted` |
17-
| `AllowedVerbs` | An array of HTTP verbs the endpoint is exposed at. | `GET` |
12+
| --- | ----------- | ------- |
13+
| `Enabled` | Whether the endpoint is enabled | `true` |
14+
| `ID` | The unique ID of the endpoint | `""` |
15+
| `Path` | The relative path at which the endpoint is exposed | same as `ID` |
16+
| `RequiredPermissions` | Permissions required to access the endpoint when running on Cloud Foundry | `Restricted` |
17+
| `AllowedVerbs` | An array of HTTP verbs at which the endpoint is exposed | `GET` |
1818

1919
> [!NOTE]
2020
> This endpoint is exposed automatically because its ID is empty. To reference this actuator in exposure settings,
21-
> first configure a non-empty ID. Because the Path is the same as ID unless specified, set it to empty explicitly:
21+
> start by configuring a non-empty ID. Because the Path is the same as ID unless otherwise specified, set it to empty explicitly:
2222
> ```json
2323
> {
2424
> "Management": {
@@ -37,14 +37,14 @@ Each key must be prefixed with `Management:Endpoints:Actuator:`. Note this key d
3737
3838
## Enable HTTP Access
3939
40-
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting together with the `Path` setting described in the preceding section.
40+
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting with the `Path` setting described in the preceding section.
4141
The default path is `/actuator`.
4242
4343
> [!NOTE]
44-
> When running on Cloud Foundry, the [Cloud Foundry Actuator](./cloud-foundry.md) should be used instead,
45-
> whose default path is `/cloudfoundryapplication`.
44+
> When running on Cloud Foundry, the [Cloud Foundry Actuator](./cloud-foundry.md) should be used instead.
45+
> Its default path is `/cloudfoundryapplication`.
4646
47-
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the overall steps required to enable HTTP access to endpoints in an ASP.NET Core application.
47+
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.
4848
4949
To add the actuator to the service container and map its route, use the `AddHypermediaActuator` extension method.
5050
@@ -58,14 +58,14 @@ builder.Services.AddHypermediaActuator();
5858
```
5959
6060
> [!NOTE]
61-
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
62-
> which enables individually turning them on/off at runtime via configuration.
61+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
62+
> this enables individually turning them on/off at runtime via configuration.
6363
6464
## Sample Output
6565

6666
This endpoint returns a list of management endpoints, including itself.
6767

68-
The response will always be returned as JSON, like this:
68+
The response is always returned as JSON:
6969

7070
```json
7171
{

‎api/v4/management/info.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
# Info
22

3-
The Steeltoe Info endpoint exposes information about the running application, such as its version and the Steeltoe version in use.
3+
The Steeltoe Info endpoint exposes information about the running application, such as its version and the version of Steeltoe in use.
44

55
Information is collected from all `IInfoContributor` implementations registered in the application.
6-
Steeltoe includes a couple contributor implementations out of the box that you can use.
7-
Also, and perhaps more importantly, you can write your own.
6+
Steeltoe includes a couple of contributor implementations out of the box that you can use.
7+
You can also write your own implementations.
88

99
## Configure Settings
1010

1111
The following table describes the configuration settings that you can apply to the endpoint.
1212
Each key must be prefixed with `Management:Endpoints:Info:`.
1313

1414
| Key | Description | Default |
15-
| --- | --- | --- |
16-
| `Enabled` | Whether the endpoint is enabled. | `true` |
17-
| `ID` | The unique ID of the endpoint. | `info` |
18-
| `Path` | The relative path at which the endpoint is exposed. | same as `ID` |
19-
| `RequiredPermissions` | Permissions required to access the endpoint, when running on Cloud Foundry. | `Restricted` |
20-
| `AllowedVerbs` | An array of HTTP verbs the endpoint is exposed at. | `GET` |
15+
| --- | ----------- | ------- |
16+
| `Enabled` | Whether the endpoint is enabled | `true` |
17+
| `ID` | The unique ID of the endpoint | `info` |
18+
| `Path` | The relative path at which the endpoint is exposed | same as `ID` |
19+
| `RequiredPermissions` | Permissions required to access the endpoint, when running on Cloud Foundry | `Restricted` |
20+
| `AllowedVerbs` | An array of HTTP verbs at which the endpoint is exposed | `GET` |
2121

2222
## Enable HTTP Access
2323

24-
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting together with the `Path` setting described in the preceding section.
24+
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting with the `Path` setting described in the preceding section.
2525
The default path is `/actuator/info`.
2626

27-
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the overall steps required to enable HTTP access to endpoints in an ASP.NET Core application.
27+
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.
2828

2929
To add the actuator to the service container and map its route, use the `AddInfoActuator` extension method.
3030

@@ -38,8 +38,8 @@ builder.Services.AddInfoActuator();
3838
```
3939

4040
> [!NOTE]
41-
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
42-
> which enables individually turning them on/off at runtime via configuration.
41+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
42+
> this enables individually turning them on/off at runtime via configuration.
4343
4444
## Built-in Contributors
4545

@@ -50,6 +50,7 @@ This contributor exposes file/version info for both the application and the incl
5050
### Configuration
5151

5252
This contributor exposes any values below the `Info` configuration key. For example:
53+
5354
```json
5455
{
5556
"Info": {
@@ -68,15 +69,15 @@ This contributor exposes any values below the `Info` configuration key. For exam
6869
6970
### Git properties
7071

71-
Exposes information from the `git.properties` Spring Boot file, if available.
72-
Shows information from git, such as branch/tag name, commit hash, and remote.
72+
* Exposes information from the `git.properties` Spring Boot file, if available
73+
* Shows information from git, such as branch/tag name, commit hash, and remote
7374

7475
> [!NOTE]
7576
> For an example of how to use this contributor within MSBuild using [GitInfo](https://github.com/devlooped/GitInfo), see the [Steeltoe Management sample](https://github.com/SteeltoeOSS/Samples/tree/main/Management/src).
7677
7778
## Sample Output
7879

79-
Depending on the registered contributors, this endpoint returns JSON such as this:
80+
Depending on the registered contributors, this endpoint returns JSON similar to this:
8081

8182
```json
8283
{

0 commit comments

Comments
 (0)