spring-cloud / spring-cloud/spring-cloud-gateway
Add another actuator endpoint in example of exposing gateway actuator endpoint
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 4.9k
- Forks
- 3.5k
- Avg merge
- 20h 57m
- Merged PRs (30d)
- 8
Description
Question
Actuator endpoints priority against custom routes should be documented. For instance, if I have a route for /** configured in my application
- id: frontend
uri: ${frontend.base.url}
predicates:
- Path=/**
and have
management.endpoints.web.exposure.include=gateway,health
I will get actuator health report on /actiator/health as I want, but it is not so obvious when reading https://cloud.spring.io/spring-cloud-gateway/reference/html/#_actuator_api.
Actually I am not sure if this is expected behavior (I mean that I am getting actuator response and not my UI response for /**)
So could you please explicitly mention this aspect in documentation?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Spring Cloud Gateway reference section linked as “Actuator API” and review the route example using Path=/** plus management.endpoints.web.exposure.include=gateway,health. Update the documentation to explain actuator endpoint priority against custom routes and clarify the expected response for /actuator/health; done when this behavior is explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring, spring-boot
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100