Skip to content

ESQL: Add query monitoring API #4260

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Apr 16, 2025
Merged

ESQL: Add query monitoring API #4260

merged 10 commits into from
Apr 16, 2025

Conversation

GalLalouche
Copy link
Contributor

Follow up to elastic/elasticsearch#124832, adding endpoints for list and get query APIs.

@GalLalouche GalLalouche added specification skip-backport This pull request should not be backported labels Apr 10, 2025
@GalLalouche GalLalouche requested a review from pquentin April 10, 2025 17:16
@cla-checker-service CLA Checker Service
Copy link

cla-checker-service bot commented Apr 10, 2025 •
edited
Loading

💚 CLA has been signed

@GalLalouche GalLalouche force-pushed the gal/list_query_api branch 2 times, most recently from 66ba192 to 3c249df Compare April 10, 2025 17:20
@GalLalouche GalLalouche requested a review from a team as a code owner April 10, 2025 18:37
@github-actions GitHub Actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.get_query ⚪ Missing test Missing test
esql.list_queries ⚪ Missing test Missing test
security.activate_user_profile 🟢 9/9 9/9
security.authenticate 🟢 30/30 30/30
security.bulk_delete_role 🟢 1/1 1/1
security.bulk_put_role 🟢 1/1 1/1
security.bulk_update_api_keys 🟢 4/4 4/4
security.change_password 🟢 9/9 9/9
security.clear_api_key_cache 🟢 13/13 13/13
security.clear_cached_privileges 🟢 3/3 3/3
security.clear_cached_realms 🟢 1/1 1/1
security.clear_cached_roles 🟢 2/2 2/2
security.clear_cached_service_tokens 🟢 4/4 4/4
security.create_api_key 🟢 68/68 59/59
security.create_cross_cluster_api_key 🟢 3/3 3/3
security.create_service_token 🟢 3/3 3/3
security.delegate_pki ⚪ Missing test Missing test
security.delete_privileges 🟢 6/6 6/6
security.delete_role_mapping 🟢 9/9 9/9
security.delete_role 🟢 8/8 8/8
security.delete_service_token ⚪ Missing test Missing test
security.delete_user 🟢 9/9 9/9
security.disable_user_profile 🟢 1/1 1/1
security.disable_user 🟢 3/3 3/3
security.enable_user_profile 🟢 1/1 1/1
security.enable_user 🟢 4/4 4/4
security.enroll_kibana ⚪ Missing test Missing test
security.enroll_node ⚪ Missing test Missing test
security.get_api_key 🟢 26/26 26/26
security.get_builtin_privileges 🟢 1/1 1/1
security.get_privileges 🟢 12/12 12/12
security.get_role_mapping 🔴 18/18 10/18
security.get_role 🟢 24/24 24/24
security.get_service_accounts ⚪ Missing test Missing test
security.get_service_credentials 🟢 1/1 1/1
security.get_settings 🟢 3/3 3/3
security.get_token 🟢 25/25 24/24
security.get_user_privileges 🟢 8/8 8/8
security.get_user_profile 🟢 8/8 8/8
security.get_user 🟢 25/25 25/25
security.grant_api_key 🟢 7/7 7/7
security.has_privileges_user_profile 🟢 3/3 3/3
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.invalidate_token 🟢 11/11 11/11
security.oidc_authenticate ⚪ Missing test Missing test
security.oidc_logout ⚪ Missing test Missing test
security.oidc_prepare_authentication ⚪ Missing test Missing test
security.put_privileges 🟢 10/10 10/10
security.put_role_mapping 🔴 2/11 11/11
security.put_role 🟢 39/39 38/38
security.put_user 🟢 48/48 47/47
security.query_api_keys 🟢 14/14 14/14
security.query_role 🟢 2/2 2/2
security.query_user 🟢 4/4 4/4
security.saml_authenticate ⚪ Missing test Missing test
security.saml_complete_logout ⚪ Missing test Missing test
security.saml_invalidate ⚪ Missing test Missing test
security.saml_logout ⚪ Missing test Missing test
security.saml_prepare_authentication ⚪ Missing test Missing test
security.saml_service_provider_metadata ⚪ Missing test Missing test
security.suggest_user_profiles 🟢 1/1 1/1
security.update_api_key 🟢 5/5 5/5
security.update_cross_cluster_api_key 🟢 2/2 2/2
security.update_settings 🟢 2/2 2/2
security.update_user_profile_data 🟢 1/1 1/1

You can validate these APIs yourself by using the make validate target.

pquentin
pquentin reviewed Apr 11, 2025
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Excellent work, thank you!

specification/esql/list_queries/ListQueriesResponse.ts
Comment on lines +32 to +36
export class Response {
body: {
queries: Dictionary<TaskId, Body>
}
}
Copy link
Member

Choose a reason for hiding this comment

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

@flobernd Do you think we should use codegen_name here?

Copy link
Member

Choose a reason for hiding this comment

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

No need for codegen_name here since this looks like a PropertiesBody.

It would only be required if the body looked like this:

export class Response {
  body: Dictionary<TaskId, Body>
}

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for double checking @pquentin !

@github-actions GitHub Actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.get_query ⚪ Missing test Missing test
esql.list_queries ⚪ 1/1 Missing test
security.activate_user_profile 🟢 9/9 9/9
security.authenticate 🟢 30/30 30/30
security.bulk_delete_role 🟢 1/1 1/1
security.bulk_put_role 🟢 1/1 1/1
security.bulk_update_api_keys 🟢 4/4 4/4
security.change_password 🟢 9/9 9/9
security.clear_api_key_cache 🟢 13/13 13/13
security.clear_cached_privileges 🟢 3/3 3/3
security.clear_cached_realms 🟢 1/1 1/1
security.clear_cached_roles 🟢 2/2 2/2
security.clear_cached_service_tokens 🟢 4/4 4/4
security.create_api_key 🟢 68/68 59/59
security.create_cross_cluster_api_key 🟢 3/3 3/3
security.create_service_token 🟢 3/3 3/3
security.delegate_pki ⚪ Missing test Missing test
security.delete_privileges 🟢 6/6 6/6
security.delete_role_mapping 🟢 9/9 9/9
security.delete_role 🟢 8/8 8/8
security.delete_service_token ⚪ Missing test Missing test
security.delete_user 🟢 9/9 9/9
security.disable_user_profile 🟢 1/1 1/1
security.disable_user 🟢 3/3 3/3
security.enable_user_profile 🟢 1/1 1/1
security.enable_user 🟢 4/4 4/4
security.enroll_kibana ⚪ Missing test Missing test
security.enroll_node ⚪ Missing test Missing test
security.get_api_key 🟢 26/26 26/26
security.get_builtin_privileges 🟢 1/1 1/1
security.get_privileges 🟢 12/12 12/12
security.get_role_mapping 🔴 18/18 10/18
security.get_role 🟢 24/24 24/24
security.get_service_accounts ⚪ Missing test Missing test
security.get_service_credentials 🟢 1/1 1/1
security.get_settings 🟢 3/3 3/3
security.get_token 🟢 25/25 24/24
security.get_user_privileges 🟢 8/8 8/8
security.get_user_profile 🟢 8/8 8/8
security.get_user 🟢 25/25 25/25
security.grant_api_key 🟢 7/7 7/7
security.has_privileges_user_profile 🟢 3/3 3/3
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.invalidate_token 🟢 11/11 11/11
security.oidc_authenticate ⚪ Missing test Missing test
security.oidc_logout ⚪ Missing test Missing test
security.oidc_prepare_authentication ⚪ Missing test Missing test
security.put_privileges 🟢 10/10 10/10
security.put_role_mapping 🔴 2/11 11/11
security.put_role 🟢 39/39 38/38
security.put_user 🟢 48/48 47/47
security.query_api_keys 🟢 14/14 14/14
security.query_role 🟢 2/2 2/2
security.query_user 🟢 4/4 4/4
security.saml_authenticate ⚪ Missing test Missing test
security.saml_complete_logout ⚪ Missing test Missing test
security.saml_invalidate ⚪ Missing test Missing test
security.saml_logout ⚪ Missing test Missing test
security.saml_prepare_authentication ⚪ Missing test Missing test
security.saml_service_provider_metadata ⚪ Missing test Missing test
security.suggest_user_profiles 🟢 1/1 1/1
security.update_api_key 🟢 5/5 5/5
security.update_cross_cluster_api_key 🟢 2/2 2/2
security.update_settings 🟢 2/2 2/2
security.update_user_profile_data 🟢 1/1 1/1

You can validate these APIs yourself by using the make validate target.

@GalLalouche GalLalouche requested a review from pquentin April 15, 2025 11:47
@github-actions GitHub Actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.get_query ⚪ Missing test Missing test
esql.list_queries ⚪ 1/1 Missing test
security.activate_user_profile 🟢 9/9 9/9
security.authenticate 🟢 30/30 30/30
security.bulk_delete_role 🟢 1/1 1/1
security.bulk_put_role 🟢 1/1 1/1
security.bulk_update_api_keys 🟢 4/4 4/4
security.change_password 🟢 9/9 9/9
security.clear_api_key_cache 🟢 13/13 13/13
security.clear_cached_privileges 🟢 3/3 3/3
security.clear_cached_realms 🟢 1/1 1/1
security.clear_cached_roles 🟢 2/2 2/2
security.clear_cached_service_tokens 🟢 4/4 4/4
security.create_api_key 🟢 68/68 59/59
security.create_cross_cluster_api_key 🟢 3/3 3/3
security.create_service_token 🟢 3/3 3/3
security.delegate_pki ⚪ Missing test Missing test
security.delete_privileges 🟢 6/6 6/6
security.delete_role_mapping 🟢 9/9 9/9
security.delete_role 🟢 8/8 8/8
security.delete_service_token ⚪ Missing test Missing test
security.delete_user 🟢 9/9 9/9
security.disable_user_profile 🟢 1/1 1/1
security.disable_user 🟢 3/3 3/3
security.enable_user_profile 🟢 1/1 1/1
security.enable_user 🟢 4/4 4/4
security.enroll_kibana ⚪ Missing test Missing test
security.enroll_node ⚪ Missing test Missing test
security.get_api_key 🟢 26/26 26/26
security.get_builtin_privileges 🟢 1/1 1/1
security.get_privileges 🟢 12/12 12/12
security.get_role_mapping 🔴 18/18 10/18
security.get_role 🟢 24/24 24/24
security.get_service_accounts ⚪ Missing test Missing test
security.get_service_credentials 🟢 1/1 1/1
security.get_settings 🟢 3/3 3/3
security.get_token 🟢 25/25 24/24
security.get_user_privileges 🟢 8/8 8/8
security.get_user_profile 🟢 8/8 8/8
security.get_user 🟢 25/25 25/25
security.grant_api_key 🟢 7/7 7/7
security.has_privileges_user_profile 🟢 3/3 3/3
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.invalidate_token 🟢 11/11 11/11
security.oidc_authenticate ⚪ Missing test Missing test
security.oidc_logout ⚪ Missing test Missing test
security.oidc_prepare_authentication ⚪ Missing test Missing test
security.put_privileges 🟢 10/10 10/10
security.put_role_mapping 🔴 2/11 11/11
security.put_role 🟢 39/39 38/38
security.put_user 🟢 48/48 47/47
security.query_api_keys 🟢 14/14 14/14
security.query_role 🟢 2/2 2/2
security.query_user 🟢 4/4 4/4
security.saml_authenticate ⚪ Missing test Missing test
security.saml_complete_logout ⚪ Missing test Missing test
security.saml_invalidate ⚪ Missing test Missing test
security.saml_logout ⚪ Missing test Missing test
security.saml_prepare_authentication ⚪ Missing test Missing test
security.saml_service_provider_metadata ⚪ Missing test Missing test
security.suggest_user_profiles 🟢 1/1 1/1
security.update_api_key 🟢 5/5 5/5
security.update_cross_cluster_api_key 🟢 2/2 2/2
security.update_settings 🟢 2/2 2/2
security.update_user_profile_data 🟢 1/1 1/1

You can validate these APIs yourself by using the make validate target.

pquentin
pquentin approved these changes Apr 16, 2025
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM.

@pquentin pquentin merged commit d91bfcd into main Apr 16, 2025
10 checks passed
@pquentin pquentin deleted the gal/list_query_api branch April 16, 2025 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flobernd flobernd flobernd left review comments

@pquentin pquentin pquentin approved these changes

Assignees
No one assigned
Labels
compiler skip-backport This pull request should not be backported specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@GalLalouche @pquentin @flobernd