Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
* xref:index.adoc[Introduction]
* xref:spring-cloud-netflix.adoc[]
* xref:endpoints.adoc[]
* xref:appendix.adoc[]
** xref:configprops.adoc[]

45 changes: 45 additions & 0 deletions docs/modules/ROOT/pages/endpoints.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
[[actuator-endpoints]]
= Actuator Endpoints

Spring Cloud Netflix does not register extra Spring Boot Actuator endpoint IDs.
Use the https://docs.spring.io/spring-boot/reference/actuator/endpoints.html[Spring Boot actuator endpoints] for `health`, `info`, and the rest.
Earlier releases exposed extra IDs such as `archaius`; those Netflix OSS clients are no longer part of this project.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this sentence, it is not relevant


This project contributes the following production-ready HTTP paths.

== Eureka Client

Eureka instance metadata points at Actuator by default:

[cols="3,2"]
|===
| Property | Default

| `eureka.instance.statusPageUrlPath`
| `/actuator/info`

| `eureka.instance.healthCheckUrlPath`
| `/actuator/health`
|===

If you change the servlet context path or `management.endpoints.web.base-path`, set those properties so Eureka publishes the correct URLs.
See xref:spring-cloud-netflix.adoc#status-page-and-health-indicator[Status Page and Health Indicator].

The `eureka` contributor on `/actuator/health` is auto-configured (`management.health.eureka.enabled`, default `true`).
It reports the remote instance status from the Eureka server.

== Eureka Server

[cols="2,5"]
|===
| Path | Description

| `/` (`eureka.dashboard.path`)
| Dashboard UI. Disable with `eureka.dashboard.enabled=false`.

| `{dashboard}/lastn`
| Last registered and canceled instances.

| `/eureka/*`
| Eureka HTTP API (registration, renewal, and registry).
|===
13 changes: 8 additions & 5 deletions docs/modules/ROOT/pages/spring-cloud-netflix.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -131,21 +131,24 @@ public class RestClientConfiguration {
}
----

[[status-page-and-health-indicator]]
=== Status Page and Health Indicator

The status page and health indicators for a Eureka instance default to `/info` and `/health` respectively, which are the default locations of useful endpoints in a Spring Boot Actuator application.
The status page and health indicators for a Eureka instance default to `/actuator/info` and `/actuator/health` respectively, which are the default locations of useful endpoints in a Spring Boot Actuator application.
You need to change these, even for an Actuator application if you use a non-default context path or servlet path (such as `server.servletPath=/custom`). The following example shows the default values for the two settings:

.application.yml
----
eureka:
instance:
statusPageUrlPath: ${server.servletPath}/info
healthCheckUrlPath: ${server.servletPath}/health
statusPageUrlPath: ${server.servletPath}/actuator/info
healthCheckUrlPath: ${server.servletPath}/actuator/health
----

These links show up in the metadata that is consumed by clients and are used in some scenarios to decide whether to send requests to your application, so it is helpful if they are accurate.

A list of production-ready HTTP paths is in xref:endpoints.adoc[Actuator Endpoints].

NOTE: In Dalston it was also required to set the status and health check URLs when changing
that management context path. This requirement was removed beginning in Edgware.

Expand All @@ -167,8 +170,8 @@ You can use placeholders to configure the eureka instance URLs, as shown in the
----
eureka:
instance:
statusPageUrl: https://${eureka.hostname}/info
healthCheckUrl: https://${eureka.hostname}/health
statusPageUrl: https://${eureka.hostname}/actuator/info
healthCheckUrl: https://${eureka.hostname}/actuator/health
homePageUrl: https://${eureka.hostname}/
----

Expand Down
Loading