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

[ES|QL] automatically sync operator definitions and docs #188978

Closed
drewdaemon opened this issue Jul 23, 2024 · 9 comments · Fixed by #205565
Closed

[ES|QL] automatically sync operator definitions and docs #188978

drewdaemon opened this issue Jul 23, 2024 · 9 comments · Fixed by #205565
Assignees
Labels
Feature:ES|QL ES|QL related features in Kibana impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:ESQL ES|QL related features in Kibana

Comments

@drewdaemon
Copy link
Contributor

We currently scrape function definitions and docs for scalar functions from the Elasticsearch repo.

As of elastic/elasticsearch#108749, operator definitions and docs are now available. We should start pulling them in as well!

@drewdaemon drewdaemon added impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Feature:ES|QL ES|QL related features in Kibana Team:ESQL ES|QL related features in Kibana labels Jul 23, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-esql (Team:ESQL)

@stratoula
Copy link
Contributor

stratoula commented Sep 30, 2024

@drewdaemon can we work on this or not yet? Can you remind me ?

@drewdaemon
Copy link
Contributor Author

Yes, we can. It is not blocked.

@stratoula
Copy link
Contributor

Awesome, are you inspired for it ? Or should I move it to 8.17? (whatever you want)

@drewdaemon
Copy link
Contributor Author

@stratoula
Copy link
Contributor

stratoula commented Sep 30, 2024

Hmm, I wanted to finish the automization in favor of these if I had to choose:

The reasons I want to finish with the operations are:

  • I am anticipating some new operators so it would be better to have this automation already
  • I want to close the automation tasks as soon as possible

@drewdaemon
Copy link
Contributor Author

Your wish is my command!

I can look at #191111 next. I can put operators at the top after that. I did not realize new ones were planned.

I don't care who takes what, Quynh is welcome to pick up either if she has time when she is back.

How does this sound?


A couple tangential responses:

The snapshot is blocked (if I am not mistaken)

Yes, but I would expect it come unblocked in the next couple days

This is an ES elastic/elasticsearch#113411 issue, are you suggesting to take it? It can wait

Yeah, I was suggesting I'd contribute this change to ES. The reason it is important is because categorize and bucket and future grouping functions will be suggested in incorrect locations until they are properly labelled by ES. However, I can patch it on our side for now.

@stratoula
Copy link
Contributor

Yes, but I would expect it come unblocked in the next couple days

True, we can take it as long as it is avaibable in the snapshot (possibly next week). I think we have time till the FF and it will def make it

Yeah, I was suggesting I'd contribute this change to ES.

Put it on your list for sure. But I would prioritize it after the others.

@drewdaemon
Copy link
Contributor Author

drewdaemon commented Nov 6, 2024

Plan of action for this task

The updated scripts will automatically be called in CI.

kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Jan 29, 2025
…TCH operators (elastic#205565)

Closes elastic#188978
Closes elastic#199092

This PR addresses elastic#199092 and
adds automated script to sync operators and adds support for MATCH and
its equivalent `:` match operator.

https://github.com/user-attachments/assets/8f78345d-f1a0-4be4-8eba-2aae35225842

https://github.com/user-attachments/assets/eb9e63e3-0086-45a5-b782-199225895afc

### Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

### Identify risks

Does this PR introduce any risks? For example, consider risks like hard
to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified
risk. Invite stakeholders and evaluate how to proceed before merging.

- [ ] [See some risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
- [ ] ...

---------

Co-authored-by: Stratoula Kalafateli <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
(cherry picked from commit 6fed083)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:ES|QL ES|QL related features in Kibana impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:ESQL ES|QL related features in Kibana
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants