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

[Automatic Import] add yarn draw-graphs command #191813

Merged
merged 8 commits into from
Sep 2, 2024

Conversation

P1llus
Copy link
Member

@P1llus P1llus commented Aug 30, 2024

Summary

This adds the yarn draw-graphs plugin specific command, which is defined in our plugins package.json. The command can be run from the root of our plugin, and does not require any additional dependencies.

The graphs are added to docs/imgs and linked in the README.md of the plugin.

The purpose of this PR is not to write a better README or provide any automation of the task itself, that would be separate tasks, but simply allow the creation of graphs to the readme, which can be useful to debug changes to nodes and conditional edges.

Examples:
ecs_graph
ecs_subgraph
log_detection_graph
related_graph
categorization_graph

@P1llus P1llus added enhancement New value added to drive a business result release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:Security-Scalability Team label for Security Integrations Scalability Team labels Aug 30, 2024
@P1llus P1llus requested a review from a team as a code owner August 30, 2024 09:39
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-scalability (Team:Security-Scalability)

@P1llus P1llus self-assigned this Aug 30, 2024
Copy link
Contributor

@bhapas bhapas left a comment

Choose a reason for hiding this comment

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

LGTM. Just couple of suggestions if you wish to try

@bhapas bhapas added the v8.16.0 label Aug 30, 2024
Copy link
Contributor

@bhapas bhapas left a comment

Choose a reason for hiding this comment

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

LGTM

@P1llus P1llus enabled auto-merge (squash) September 2, 2024 08:37
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @P1llus

@P1llus P1llus merged commit 1606db8 into elastic:main Sep 2, 2024
24 checks passed
@bhapas bhapas added backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) and removed backport:skip This commit does not require backporting backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Sep 10, 2024
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Sep 10, 2024
@bhapas bhapas added backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) and removed backport:skip This commit does not require backporting labels Sep 10, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 10, 2024
## Summary

This adds the `yarn draw-graphs` plugin specific command, which is
defined in our plugins `package.json`. The command can be run from the
root of our plugin, and does not require any additional dependencies.

The graphs are added to `docs/imgs` and linked in the README.md of the
plugin.

The purpose of this PR is not to write a better README or provide any
automation of the task itself, that would be separate tasks, but simply
allow the creation of graphs to the readme, which can be useful to debug
changes to nodes and conditional edges.

Examples:

![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16)

![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993)

![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488)

![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5)

![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 1606db8)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.15

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 10, 2024
## Summary

This adds the `yarn draw-graphs` plugin specific command, which is
defined in our plugins `package.json`. The command can be run from the
root of our plugin, and does not require any additional dependencies.

The graphs are added to `docs/imgs` and linked in the README.md of the
plugin.

The purpose of this PR is not to write a better README or provide any
automation of the task itself, that would be separate tasks, but simply
allow the creation of graphs to the readme, which can be useful to debug
changes to nodes and conditional edges.

Examples:

![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16)

![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993)

![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488)

![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5)

![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 1606db8)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.15

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Sep 10, 2024
…2433)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[Automatic Import] add yarn draw-graphs command
(#191813)](#191813)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Marius
Iversen","email":"marius.iversen@elastic.co"},"sourceCommit":{"committedDate":"2024-09-02T11:00:30Z","message":"[Automatic
Import] add yarn draw-graphs command (#191813)\n\n## Summary\r\n\r\nThis
adds the `yarn draw-graphs` plugin specific command, which is\r\ndefined
in our plugins `package.json`. The command can be run from the\r\nroot
of our plugin, and does not require any additional
dependencies.\r\n\r\nThe graphs are added to `docs/imgs` and linked in
the README.md of the\r\nplugin.\r\n\r\nThe purpose of this PR is not to
write a better README or provide any\r\nautomation of the task itself,
that would be separate tasks, but simply\r\nallow the creation of graphs
to the readme, which can be useful to debug\r\nchanges to nodes and
conditional
edges.\r\n\r\nExamples:\r\n\r\n![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16)\r\n\r\n![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993)\r\n\r\n![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488)\r\n\r\n![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5)\r\n\r\n![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"1606db8ad8040b395c08302e7a3add28907c906a","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["enhancement","release_note:skip","backport:prev-minor","v8.16.0","Team:Security-Scalability"],"title":"[Automatic
Import] add yarn draw-graphs
command","number":191813,"url":"https://github.com/elastic/kibana/pull/191813","mergeCommit":{"message":"[Automatic
Import] add yarn draw-graphs command (#191813)\n\n## Summary\r\n\r\nThis
adds the `yarn draw-graphs` plugin specific command, which is\r\ndefined
in our plugins `package.json`. The command can be run from the\r\nroot
of our plugin, and does not require any additional
dependencies.\r\n\r\nThe graphs are added to `docs/imgs` and linked in
the README.md of the\r\nplugin.\r\n\r\nThe purpose of this PR is not to
write a better README or provide any\r\nautomation of the task itself,
that would be separate tasks, but simply\r\nallow the creation of graphs
to the readme, which can be useful to debug\r\nchanges to nodes and
conditional
edges.\r\n\r\nExamples:\r\n\r\n![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16)\r\n\r\n![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993)\r\n\r\n![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488)\r\n\r\n![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5)\r\n\r\n![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"1606db8ad8040b395c08302e7a3add28907c906a"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/191813","number":191813,"mergeCommit":{"message":"[Automatic
Import] add yarn draw-graphs command (#191813)\n\n## Summary\r\n\r\nThis
adds the `yarn draw-graphs` plugin specific command, which is\r\ndefined
in our plugins `package.json`. The command can be run from the\r\nroot
of our plugin, and does not require any additional
dependencies.\r\n\r\nThe graphs are added to `docs/imgs` and linked in
the README.md of the\r\nplugin.\r\n\r\nThe purpose of this PR is not to
write a better README or provide any\r\nautomation of the task itself,
that would be separate tasks, but simply\r\nallow the creation of graphs
to the readme, which can be useful to debug\r\nchanges to nodes and
conditional
edges.\r\n\r\nExamples:\r\n\r\n![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16)\r\n\r\n![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993)\r\n\r\n![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488)\r\n\r\n![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5)\r\n\r\n![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"1606db8ad8040b395c08302e7a3add28907c906a"}}]}]
BACKPORT-->

Co-authored-by: Marius Iversen <marius.iversen@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) enhancement New value added to drive a business result release_note:skip Skip the PR/issue when compiling release notes Team:Security-Scalability Team label for Security Integrations Scalability Team v8.15.2 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants