Skip to content

Commit 40a5acc

Browse files
authored
Update docs for actuator changes from SteeltoeOSS/Steeltoe#1520 (#386)
1 parent 76819fa commit 40a5acc

File tree

4 files changed

+78
-12
lines changed

4 files changed

+78
-12
lines changed

docs/docs/v4/management/cloud-foundry.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ Each key must be prefixed with `Management:Endpoints:CloudFoundry`.
2727
| `ApplicationId` | The ID of the application used in permission checks | |
2828
| `CloudFoundryApi` | The URL of the Cloud Foundry API | |
2929

30+
> [!TIP]
31+
> The preceding settings apply only to the `/cloudfoundryapplication` hypermedia endpoint.
32+
> To turn off *all* management endpoints starting with this path, set `Management:CloudFoundry:Enabled` to `false`.
33+
3034
## Enable HTTP Access
3135

3236
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.
@@ -79,3 +83,65 @@ In addition, the endpoints may be secured by whatever security mechanism the app
7983
> [!CAUTION]
8084
> An authorization policy on `/actuator` also applies to `/cloudfoundryapplication`, which then breaks the integration with Apps Manager.
8185
> To prevent public access to `/actuator` when running on Cloud Foundry, consider configuring actuators to [use an alternate port](./using-endpoints.md#configure-global-settings).
86+
87+
## Sample Output
88+
89+
This endpoint returns a list of management endpoints, including itself.
90+
91+
The response is always returned as JSON:
92+
93+
```json
94+
{
95+
"type": "steeltoe",
96+
"_links": {
97+
"beans": {
98+
"href": "https://appname.cf-app.com/cloudfoundryapplication/beans",
99+
"templated": false
100+
},
101+
"dbmigrations": {
102+
"href": "https://appname.cf-app.com/cloudfoundryapplication/dbmigrations",
103+
"templated": false
104+
},
105+
"env": {
106+
"href": "https://appname.cf-app.com/cloudfoundryapplication/env",
107+
"templated": false
108+
},
109+
"health": {
110+
"href": "https://appname.cf-app.com/cloudfoundryapplication/health",
111+
"templated": true
112+
},
113+
"heapdump": {
114+
"href": "https://appname.cf-app.com/cloudfoundryapplication/heapdump",
115+
"templated": false
116+
},
117+
"httpexchanges": {
118+
"href": "https://appname.cf-app.com/cloudfoundryapplication/httpexchanges",
119+
"templated": false
120+
},
121+
"info": {
122+
"href": "https://appname.cf-app.com/cloudfoundryapplication/info",
123+
"templated": false
124+
},
125+
"loggers": {
126+
"href": "https://appname.cf-app.com/cloudfoundryapplication/loggers",
127+
"templated": true
128+
},
129+
"mappings": {
130+
"href": "https://appname.cf-app.com/cloudfoundryapplication/mappings",
131+
"templated": false
132+
},
133+
"refresh": {
134+
"href": "https://appname.cf-app.com/cloudfoundryapplication/refresh",
135+
"templated": false
136+
},
137+
"threaddump": {
138+
"href": "https://appname.cf-app.com/cloudfoundryapplication/threaddump",
139+
"templated": false
140+
},
141+
"self": {
142+
"href": "https://appname.cf-app.com/cloudfoundryapplication",
143+
"templated": false
144+
}
145+
}
146+
}
147+
```

docs/docs/v4/management/health.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,6 @@ When `ShowComponents` and `ShowDetails` are set to `Always`, or when set to `Whe
129129
{
130130
"status": "UP",
131131
"components": {
132-
"ping": {
133-
"status": "UP"
134-
},
135132
"diskSpace": {
136133
"status": "UP",
137134
"details": {
@@ -141,6 +138,9 @@ When `ShowComponents` and `ShowDetails` are set to `Always`, or when set to `Whe
141138
"path": "C:\\source\\Repository\\src\\Project",
142139
"exists": true
143140
}
141+
},
142+
"ping": {
143+
"status": "UP"
144144
}
145145
}
146146
}
@@ -170,7 +170,7 @@ If you want to check application health based on a subset of health contributors
170170
}
171171
```
172172

173-
While group names are case-sensitive, the entries in `Include` are case-insensitive and activate only health contributors with a matching `Id`, and/or ASP.NET health check registrations with a matching name.
173+
Group names and the entries in `Include` are case-insensitive and activate only health contributors with a matching `Id`, and/or ASP.NET health check registrations with a matching name.
174174

175175
For any group that has been defined, you can access health information from the group by appending the group name to the HTTP request URL. For example: `/actuator/health/example-group`.
176176

@@ -348,9 +348,6 @@ When `ShowComponents` and `ShowDetails` are set to `Always`, or when set to `Whe
348348
"status": "WARNING",
349349
"description": "This health check does not check anything"
350350
},
351-
"ping": {
352-
"status": "UP"
353-
},
354351
"diskSpace": {
355352
"status": "UP",
356353
"details": {
@@ -360,6 +357,9 @@ When `ShowComponents` and `ShowDetails` are set to `Always`, or when set to `Whe
360357
"path": "C:\\source\\Repository\\src\\Project",
361358
"exists": true
362359
}
360+
},
361+
"ping": {
362+
"status": "UP"
363363
}
364364
}
365365
}

docs/docs/v4/management/httpexchanges.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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, which stores HTTP request/response information in memory. This endpoint provides access to that information.
5+
When you activate this endpoint, HTTP request/response information is captured and stored in memory. This endpoint provides access to that information.
66

77
## Configure Settings
88

docs/docs/v4/management/hypermedia.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ The response is always returned as JSON:
7171
{
7272
"type": "steeltoe",
7373
"_links": {
74-
"info": {
75-
"href": "https://localhost:7105/actuator/info",
76-
"templated": false
77-
},
7874
"health": {
7975
"href": "https://localhost:7105/actuator/health",
76+
"templated": true
77+
},
78+
"info": {
79+
"href": "https://localhost:7105/actuator/info",
8080
"templated": false
8181
},
8282
"self": {

0 commit comments

Comments
 (0)