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.

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 another actuator endpoint in example of exposing gateway actuator endpoint #1265

Open
mygordienko opened this issue Aug 26, 2019 · 4 comments

Comments

@mygordienko
Copy link

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?

@spencergibb
Copy link
Member

I'm not sure what you are asking for. management.endpoints.web.exposure.include is a boot property. Do you mean update the example of that property? If so, that would be fine.

@spencergibb spencergibb changed the title Actuator paths routing priority Add another actuator endpoint in example of exposing gateway actuator endpoint Sep 16, 2019
@mygordienko
Copy link
Author

My point is that the documentation of the gateway should explicitly explain whether actuator endpoints are affected by route definitions or not. For instance, if I have actuator base path configured to be '/' and in the same time I have a route for '/**'. What happen? Am I supposed to not use actuator basepath '/' for gateway? Or it is absolutely fine and those two things (actuator endpoints and routes) do not hinder each other.

@spencergibb
Copy link
Member

So a note or warning about root routes?

@mygordienko
Copy link
Author

Yes, something like that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants