Skip to content

List invalid routes via support listener #3488

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

Open
AlexanderYastrebov opened this issue Apr 29, 2025 · 1 comment
Open

List invalid routes via support listener #3488

AlexanderYastrebov opened this issue Apr 29, 2025 · 1 comment
Labels
good first issue monitoring Metrics related changes

Comments

@AlexanderYastrebov
Copy link
Member

AlexanderYastrebov commented Apr 29, 2025

Is your feature request related to a problem? Please describe.

In multitenant ingress setting users may define invalid routes and operators may have to figure out where invalid routes are coming from. Currently it is possible via monitoring logs for a specific error message.

Describe the solution you would like

Skipper serves valid routes via support listener API at /routes.
It also have a list of invalid routes so we may add a support API say at /invalid-routes to show them as well.
Along with a new metric for number of invalid routes this could be used for alerting and debugging invalid user configurations.

Describe alternatives you've considered (optional)

Monitor logs for a specific error message.

Additional context (optional)

The problem is partially addressed by a webhook which prevents users from creating routes with e.g. invalid eskip syntax but it does not (currently) prevent users from creating non-existing or disabled filters.

Would you like to work on it?

This is a good first issue for someone :)

@AlexanderYastrebov AlexanderYastrebov changed the title List invalid routes List invalid routes via support listener Apr 29, 2025
@szuecs
Copy link
Member

szuecs commented Apr 30, 2025

Idk API related: maybe /routes/invalid or a query: /routes?invalid=true or /routes?state=invalid.
Maybe path is better but I want to discuss some options and think which one is best and why.

Query is good for filtering but if you know skipper well you also know that invalid routes are dropped and not part of the active routing table.
From API point of view it might make sense to use the query instead of path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue monitoring Metrics related changes
Projects
None yet
Development

No branches or pull requests

2 participants