Skip to content

ES|QL change_point docs and tech preview #126407

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 15 commits into from
Apr 14, 2025
Merged

ES|QL change_point docs and tech preview #126407

merged 15 commits into from
Apr 14, 2025

Conversation

jan-elastic
Copy link
Contributor

No description provided.

@jan-elastic jan-elastic added v9.1.0 :Analytics/ES|QL AKA ESQL >non-issue :ml Machine learning Team:ML Meta label for the ML team labels Apr 7, 2025
@elasticsearchmachine elasticsearchmachine added the Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) label Apr 7, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

craigtaverner
craigtaverner approved these changes Apr 7, 2025
View reviewed changes
Copy link
Contributor

@craigtaverner craigtaverner left a comment

Choose a reason for hiding this comment

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

Looks fine, but I think needs the [preview] prefix. I'm restructuring these docs in another PR, but can deal with this change if you merge first.

@craigtaverner
Copy link
Contributor

We're also moving to make sure all examples in the commands docs are actually tested examples from the CSV-spec files. Perhaps you could add a comment about which file and which example is used in these docs?

@craigtaverner
Copy link
Contributor

I did a search for | CHANGE_POINT message_count ON day in the change_point.csv-spec file but could not find this example. Perhaps you could add the example to that file, or use an existing example from that file?

@jan-elastic
Copy link
Contributor Author

We're also moving to make sure all examples in the commands docs are actually tested examples from the CSV-spec files. Perhaps you could add a comment about which file and which example is used in these docs?

This example isn't in the csv-spec files. I don't think those have good-looking change point detection examples for the docs.

This is an example similar to the one in change point aggregation, which uses a standard Kibana sample data set.

Is this a problem?

@craigtaverner
Copy link
Contributor

We would like all examples in the docs to be examples from real tests, so that if, for example, a feature changes behaviour, the example changes too. In 8.x branches all docs examples are extracted from csv-spec files. In 9.x docs I've recovered that status for all the functions and operators, but not yet for the commands. So I'm working on making commands use csv-spec examples, and all those that already existed in 8.x will be fine, but any new ones (like yours) might not be fine.

@jan-elastic
Copy link
Contributor Author

OK, I have added a different example and also added that one to the csv tests.

I didn't feel like adding MBs of data to the test suite, even though I think the kibana_sample_data_logs gives a nicer example for the documentation.

@nik9000
Copy link
Member

nik9000 commented Apr 8, 2025

I didn't feel like adding MBs of data to the test suite, even though I think the kibana_sample_data_logs gives a nicer example for the documentation.

I don't think it'd be unreasonable for us to have that available to be honest.

craigtaverner
craigtaverner requested changes Apr 11, 2025
View reviewed changes
Copy link
Contributor

@craigtaverner craigtaverner left a comment

Choose a reason for hiding this comment

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

This needs to be modified a lot for the new split-up commands docs.

@jan-elastic jan-elastic force-pushed the esql_change_point_docs_and_tech_preview branch from 5ad7fcc to 75e05f3 Compare April 11, 2025 09:29
@jan-elastic jan-elastic force-pushed the esql_change_point_docs_and_tech_preview branch 3 times, most recently from 9c470b4 to c6c9e05 Compare April 11, 2025 09:34
@jan-elastic jan-elastic force-pushed the esql_change_point_docs_and_tech_preview branch from c6c9e05 to 2bfadd7 Compare April 11, 2025 09:37
@craigtaverner craigtaverner force-pushed the esql_change_point_docs_and_tech_preview branch from 2bfadd7 to 4d8244c Compare April 11, 2025 09:47
craigtaverner
craigtaverner approved these changes Apr 11, 2025
View reviewed changes
Copy link
Contributor

@craigtaverner craigtaverner left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@stratoula stratoula added the ES|QL-ui Impacts ES|QL UI label Apr 11, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/kibana-esql (ES|QL-ui)

@stratoula
Copy link

@darnautov when this is merged we can enable the change_pont autocomplete

craigtaverner
craigtaverner approved these changes Apr 11, 2025
View reviewed changes
Copy link
Contributor

@craigtaverner craigtaverner left a comment

Choose a reason for hiding this comment

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

Looks good to me. One change suggested in the docs where we should call CHANGE_POINT a command, not a function.

@jan-elastic jan-elastic merged commit 3f2f5ee into main Apr 14, 2025
18 checks passed
@jan-elastic jan-elastic deleted the esql_change_point_docs_and_tech_preview branch April 14, 2025 07:56
@jan-elastic jan-elastic mentioned this pull request Apr 14, 2025
Merged
@darnautov darnautov mentioned this pull request Apr 14, 2025
Merged
darnautov added a commit to elastic/kibana that referenced this pull request Apr 14, 2025
@darnautov
[ES|QL] Enable suggestions for CHANGE_POINT command (#218100)
1a6cea5 
## Summary

With the `CHANGE_POINT` command moved to tech preview (PR
elastic/elasticsearch#126407), we can enable
suggestions in the editor.
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Apr 14, 2025
@darnautov
[ES|QL] Enable suggestions for CHANGE_POINT command (elastic#218100)
ed6b91e 
## Summary

With the `CHANGE_POINT` command moved to tech preview (PR
elastic/elasticsearch#126407), we can enable
suggestions in the editor.

(cherry picked from commit 1a6cea5)
kibanamachine added a commit to elastic/kibana that referenced this pull request Apr 14, 2025
@kibanamachine @darnautov
[8.x] [ES|QL] Enable suggestions for CHANGE_POINT command (#218100) (…
6350ab9 
…#218124)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[ES|QL] Enable suggestions for `CHANGE_POINT` command
(#218100)](#218100)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Dima
Arnautov","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-04-14T14:12:45Z","message":"[ES|QL]
Enable suggestions for `CHANGE_POINT` command (#218100)\n\n##
Summary\n\nWith the `CHANGE_POINT` command moved to tech preview
(PR\nhttps://github.com/elastic/elasticsearch/pull/126407), we can
enable\nsuggestions in the
editor.","sha":"1a6cea558964a87255d2a00ca58e62d914a55c80","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:enhancement","Team:ESQL","backport:version","v9.1.0","v8.19.0"],"title":"[ES|QL]
Enable suggestions for `CHANGE_POINT`
command","number":218100,"url":"https://github.com/elastic/kibana/pull/218100","mergeCommit":{"message":"[ES|QL]
Enable suggestions for `CHANGE_POINT` command (#218100)\n\n##
Summary\n\nWith the `CHANGE_POINT` command moved to tech preview
(PR\nhttps://github.com/elastic/elasticsearch/pull/126407), we can
enable\nsuggestions in the
editor.","sha":"1a6cea558964a87255d2a00ca58e62d914a55c80"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/218100","number":218100,"mergeCommit":{"message":"[ES|QL]
Enable suggestions for `CHANGE_POINT` command (#218100)\n\n##
Summary\n\nWith the `CHANGE_POINT` command moved to tech preview
(PR\nhttps://github.com/elastic/elasticsearch/pull/126407), we can
enable\nsuggestions in the
editor.","sha":"1a6cea558964a87255d2a00ca58e62d914a55c80"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Dima Arnautov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@craigtaverner craigtaverner craigtaverner approved these changes

@costin costin Awaiting requested review from costin

@nik9000 nik9000 Awaiting requested review from nik9000

@luigidellaquila luigidellaquila Awaiting requested review from luigidellaquila

Assignees
No one assigned
Labels
:Analytics/ES|QL AKA ESQL ES|QL-ui Impacts ES|QL UI :ml Machine learning >non-issue Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:ML Meta label for the ML team v9.1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@jan-elastic @elasticsearchmachine @craigtaverner @nik9000 @stratoula @luigidellaquila