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

Support filter_path parameter for Kibana APIs just like the Elasticsearch APIs do #171841

Closed
bczifra opened this issue Nov 23, 2023 · 6 comments
Closed
Labels
Team:Fleet Team label for Observability Data Collection Fleet team

Comments

@bczifra
Copy link
Member

bczifra commented Nov 23, 2023

Describe the feature:
Elasticsearch supports a filter_path parameter that can be used to reduce the response returned by Elasticsearch. It would be helpful if Kibana also supported such a property.

Describe a specific use case for the feature:
Retrieving only a subset of the fields returned by a given API. For example, the Get agent policies returns quite a bit of data. If the user only wanted to return the id and the name, then using the filter_path option they could specify: GET /agent_policies?filter_path=items.*.id,items.*.name.

Related: #144640

@botelastic botelastic bot added the needs-team Issues missing a team label label Nov 23, 2023
@jsanz jsanz added the Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! label Dec 11, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-security (Team:Security)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Dec 11, 2023
@legrego legrego added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc and removed Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! labels Dec 11, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@pgayvallet pgayvallet added Team:Fleet Team label for Observability Data Collection Fleet team and removed Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Dec 12, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@pgayvallet
Copy link
Contributor

This is not something that can be done globally at core's level for all API. I'll tentatively assign to fleet given they own the endpoint in the description here.

@DBchmnn
Copy link

DBchmnn commented Aug 15, 2024

Are there any news regarding this topic? Will this functionality be implemented in a future version?
And is there any other current possibility to limit the response of Kibana API?

@kpollich
Copy link
Member

Unfortunately this isn't something we're actively considering supporting in the Fleet API, and without an ability to implement at the global level I don't think it's likely to become a priority for other APIs in Kibana either. Our recommendation today would be to handle filtering unneeded fields as part of your data fetching logic however you're consuming Kibana's APIs. If payload size is a concern, please ensure server.compression.enabled is set to true in your kibana.yml configuration.

@kpollich kpollich closed this as not planned Won't fix, can't repro, duplicate, stale Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Fleet Team label for Observability Data Collection Fleet team
Projects
None yet
Development

No branches or pull requests

7 participants