Skip to content

[SecuritySolution] Update Entity Store Dashboard to prompt for Service Entity Type #207336

Merged
machadoum merged 12 commits intoelastic:mainfrom
machadoum:siem-ea-11580
Jan 23, 2025
Merged

[SecuritySolution] Update Entity Store Dashboard to prompt for Service Entity Type #207336
machadoum merged 12 commits intoelastic:mainfrom
machadoum:siem-ea-11580

Conversation

@machadoum
Copy link
Copy Markdown
Member

@machadoum machadoum commented Jan 21, 2025 •
edited
Loading

Summary

This ticket is part of the Service Entity Store Epic.

  • Display a callout to install uninstalled entity types
    • It will be displayed when the entity store is running, but some available entity types are not installed
  • Add entityTypes param to the init entity store API
  • Enable serviceEntityStoreEnabled flag by default

Checklist

How to test it?

  • Disable the experimental flag on x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts
  • Open Manage/Entity Store/Engine Status
  • Verify that the service entity store is NOT installed
  • Reenable the flag on x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts
  • Open the Entity Dashboard page
  • It should display a callout to install more entity types
  • Click "enable"
  • It should install the service entity store
  • Open Manage/Entity Store/Engine Status
  • Verify that the service entity store IS installed

Reviewers should verify this PR satisfies this list as well.

  • Unit or functional tests were updated or added to match the most common scenarios
  • Flaky Test Runner 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

@machadoum machadoum added v9.0.0 Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. release_note:feature Makes this part of the condensed release notes Theme: entity_analytics Feature:Entity Analytics Security Solution Entity Analytics features Team:Entity Analytics Security Entity Analytics Team backport:version Backport to applied version labels v8.18.0 labels Jan 21, 2025
@machadoum machadoum self-assigned this Jan 21, 2025
@machadoum machadoum force-pushed the siem-ea-11580 branch 2 times, most recently from 296871c to 9358a54 Compare January 21, 2025 12:39
@machadoum machadoum marked this pull request as ready for review January 21, 2025 12:43
@machadoum machadoum requested a review from a team as a code owner January 21, 2025 12:43
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Jan 21, 2025

Pinging @elastic/security-solution (Team: SecuritySolution)

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Jan 21, 2025

Pinging @elastic/security-entity-analytics (Team:Entity Analytics)

@machadoum machadoum requested a review from a team as a code owner January 22, 2025 10:18
@machadoum
Copy link
Copy Markdown
Member Author

machadoum commented Jan 22, 2025

I have addressed the comments and enabled the experimental flag by default.

tiansivive
tiansivive reviewed Jan 22, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@tiansivive tiansivive left a comment

Choose a reason for hiding this comment

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

Thanks for this Pablo, just soome small comments

@CAWilson94
Copy link
Copy Markdown
Contributor

CAWilson94 commented Jan 22, 2025

I have addressed the comments and enabled the experimental flag by default

Allo! The testing instructions say it to disable this and check service store is not installed. When I do this it is installed.

Double checked this with restarting ES and Kibana. Disabled the flag via serviceEntityStoreEnabled: false in security_solution/common/experimental_features.ts.

image

@machadoum
Copy link
Copy Markdown
Member Author

machadoum commented Jan 22, 2025 •
edited
Loading

I have addressed the comments and enabled the experimental flag by default

Allo! The testing instructions say it to disable this and check service store is not installed. When I do this it is installed.

Double checked this with restarting ES and Kibana. Disabled the flag via serviceEntityStoreEnabled: false in security_solution/common/experimental_features.ts.

image

I'm very sorry about that. I added a new commit that enables the flag by default, as discussed during stand-up, but haven't updated the test steps. I will do that now.

jaredburgettelastic
jaredburgettelastic approved these changes Jan 22, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@jaredburgettelastic jaredburgettelastic left a comment

Choose a reason for hiding this comment

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

I have not desk tested, but changes LGTM!

CAWilson94
CAWilson94 approved these changes Jan 23, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@CAWilson94 CAWilson94 left a comment

Choose a reason for hiding this comment

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

Desk tested - enable callout working and service store is installed ✅ Nice Work!

@machadoum machadoum enabled auto-merge (squash) January 23, 2025 10:41
@machadoum machadoum merged commit 5c59f3b into elastic:main Jan 23, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Jan 23, 2025

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12927538944

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Jan 23, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] Jest Tests #20 / useGetCaseUsers shows a toast error when the api return an error

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
securitySolution 21.3MB 21.3MB +1.1KB

History

cc @machadoum

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Jan 23, 2025

💔 All backports failed

Status Branch Result
❌ 8.x Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 207336

Questions ?

Please refer to the Backport tool documentation

viduni94 pushed a commit to viduni94/kibana that referenced this pull request Jan 23, 2025
@machadoum @kibanamachine @viduni94
[SecuritySolution] Update Entity Store Dashboard to prompt for Servic…
37adf99 
…e Entity Type (elastic#207336)

## Summary

* Display a callout to install uninstalled entity types
* It will be displayed when the entity store is running, but some
available entity types are not installed
* Add `entityTypes` param to the init entity store API
* Enable `serviceEntityStoreEnabled` flag by default
### Checklist


### How to test it?
* Disable the experimental flag on
`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`
* Open `Manage/Entity Store/Engine Status`
* Verify that the service entity store is NOT installed
* Reenable the flag on
`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`
* Open the Entity Dashboard page
* It should display a callout to install more entity types
* Click "enable"
* It should install the service entity store
* Open `Manage/Entity Store/Engine Status`
* Verify that the service entity store IS installed

Reviewers should verify this PR satisfies this list as well.

- [x] [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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [x] 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)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This was referenced Jan 24, 2025
Merged
Merged
machadoum added a commit to machadoum/kibana that referenced this pull request Jan 27, 2025
@machadoum
[SecuritySolution] Update Entity Store Dashboard to prompt for Servic…
5d13ab0 
…e Entity Type (elastic#207336)

## Summary

* Display a callout to install uninstalled entity types
* It will be displayed when the entity store is running, but some
available entity types are not installed
* Add `entityTypes` param to the init entity store API
* Enable `serviceEntityStoreEnabled` flag by default
### Checklist

### How to test it?
* Disable the experimental flag on
`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`
* Open `Manage/Entity Store/Engine Status`
* Verify that the service entity store is NOT installed
* Reenable the flag on
`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`
* Open the Entity Dashboard page
* It should display a callout to install more entity types
* Click "enable"
* It should install the service entity store
* Open `Manage/Entity Store/Engine Status`
* Verify that the service entity store IS installed

Reviewers should verify this PR satisfies this list as well.

- [x] [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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [x] 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)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 5c59f3b)

# Conflicts:
#	oas_docs/output/kibana.yaml
#	x-pack/solutions/security/plugins/security_solution/common/api/entity_analytics/entity_store/enable.gen.ts
#	x-pack/solutions/security/plugins/security_solution/common/api/entity_analytics/entity_store/enable.schema.yaml
#	x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml
#	x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml
#	x-pack/solutions/security/plugins/security_solution/public/entity_analytics/components/entity_store/components/dashboard_enablement_panel.tsx
#	x-pack/solutions/security/plugins/security_solution/server/lib/entity_analytics/entity_store/entity_store_data_client.ts
@machadoum machadoum mentioned this pull request Jan 27, 2025
Merged
@machadoum
Copy link
Copy Markdown
Member Author

machadoum commented Jan 27, 2025

💚 All backports created successfully

Status Branch Result
✅ 8.x

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

Questions ?

Please refer to the Backport tool documentation

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jan 27, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Jan 27, 2025

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

machadoum added a commit that referenced this pull request Jan 27, 2025
@machadoum @kibanamachine
[8.x] [SecuritySolution] Update Entity Store Dashboard to prompt for …
1d660bd 
…Service Entity Type (#207336) (#208319)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[SecuritySolution] Update Entity Store Dashboard to prompt for
Service Entity Type
(#207336)](#207336)

<!--- Backport version: 9.6.4 -->

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

<!--BACKPORT [{"author":{"name":"Pablo
Machado","email":"pablo.nevesmachado@elastic.co"},"sourceCommit":{"committedDate":"2025-01-23T10:46:46Z","message":"[SecuritySolution]
Update Entity Store Dashboard to prompt for Service Entity Type
(#207336)\n\n## Summary\n\n* Display a callout to install uninstalled
entity types\n* It will be displayed when the entity store is running,
but some\navailable entity types are not installed\n* Add `entityTypes`
param to the init entity store API\n* Enable `serviceEntityStoreEnabled`
flag by default\n### Checklist\n\n\n### How to test it?\n* Disable the
experimental flag
on\n`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`\n*
Open `Manage/Entity Store/Engine Status`\n* Verify that the service
entity store is NOT installed\n* Reenable the flag
on\n`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`\n*
Open the Entity Dashboard page\n* It should display a callout to install
more entity types\n* Click \"enable\"\n* It should install the service
entity store\n* Open `Manage/Entity Store/Engine Status`\n* Verify that
the service entity store IS installed\n\nReviewers should verify this PR
satisfies this list as well.\n\n- [x] [Unit or
functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere
updated or added to match the most common scenarios\n- [ ] [Flaky
Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\nused on any tests changed\n- [x] The PR description includes the
appropriate Release Notes section,\nand the correct `release_note:*`
label is applied per
the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n---------\n\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"5c59f3bdcdd9524667047ed546c6370015ed96d2","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["v9.0.0","Team:
SecuritySolution","release_note:feature","Theme:
entity_analytics","Feature:Entity Analytics","Team:Entity
Analytics","backport:version","v8.18.0"],"title":"[SecuritySolution]
Update Entity Store Dashboard to prompt for Service Entity Type
","number":207336,"url":"https://github.com/elastic/kibana/pull/207336","mergeCommit":{"message":"[SecuritySolution]
Update Entity Store Dashboard to prompt for Service Entity Type
(#207336)\n\n## Summary\n\n* Display a callout to install uninstalled
entity types\n* It will be displayed when the entity store is running,
but some\navailable entity types are not installed\n* Add `entityTypes`
param to the init entity store API\n* Enable `serviceEntityStoreEnabled`
flag by default\n### Checklist\n\n\n### How to test it?\n* Disable the
experimental flag
on\n`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`\n*
Open `Manage/Entity Store/Engine Status`\n* Verify that the service
entity store is NOT installed\n* Reenable the flag
on\n`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`\n*
Open the Entity Dashboard page\n* It should display a callout to install
more entity types\n* Click \"enable\"\n* It should install the service
entity store\n* Open `Manage/Entity Store/Engine Status`\n* Verify that
the service entity store IS installed\n\nReviewers should verify this PR
satisfies this list as well.\n\n- [x] [Unit or
functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere
updated or added to match the most common scenarios\n- [ ] [Flaky
Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\nused on any tests changed\n- [x] The PR description includes the
appropriate Release Notes section,\nand the correct `release_note:*`
label is applied per
the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n---------\n\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"5c59f3bdcdd9524667047ed546c6370015ed96d2"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/207336","number":207336,"mergeCommit":{"message":"[SecuritySolution]
Update Entity Store Dashboard to prompt for Service Entity Type
(#207336)\n\n## Summary\n\n* Display a callout to install uninstalled
entity types\n* It will be displayed when the entity store is running,
but some\navailable entity types are not installed\n* Add `entityTypes`
param to the init entity store API\n* Enable `serviceEntityStoreEnabled`
flag by default\n### Checklist\n\n\n### How to test it?\n* Disable the
experimental flag
on\n`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`\n*
Open `Manage/Entity Store/Engine Status`\n* Verify that the service
entity store is NOT installed\n* Reenable the flag
on\n`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`\n*
Open the Entity Dashboard page\n* It should display a callout to install
more entity types\n* Click \"enable\"\n* It should install the service
entity store\n* Open `Manage/Entity Store/Engine Status`\n* Verify that
the service entity store IS installed\n\nReviewers should verify this PR
satisfies this list as well.\n\n- [x] [Unit or
functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere
updated or added to match the most common scenarios\n- [ ] [Flaky
Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\nused on any tests changed\n- [x] The PR description includes the
appropriate Release Notes section,\nand the correct `release_note:*`
label is applied per
the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n---------\n\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"5c59f3bdcdd9524667047ed546c6370015ed96d2"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jan 27, 2025
JoseLuisGJ pushed a commit to JoseLuisGJ/kibana that referenced this pull request Jan 27, 2025
@machadoum @kibanamachine @JoseLuisGJ
[SecuritySolution] Update Entity Store Dashboard to prompt for Servic…
7be6c4c 
…e Entity Type (elastic#207336)

## Summary

* Display a callout to install uninstalled entity types
* It will be displayed when the entity store is running, but some
available entity types are not installed
* Add `entityTypes` param to the init entity store API
* Enable `serviceEntityStoreEnabled` flag by default
### Checklist


### How to test it?
* Disable the experimental flag on
`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`
* Open `Manage/Entity Store/Engine Status`
* Verify that the service entity store is NOT installed
* Reenable the flag on
`x-pack/solutions/security/plugins/security_solution/common/experimental_features.ts`
* Open the Entity Dashboard page
* It should display a callout to install more entity types
* Click "enable"
* It should install the service entity store
* Open `Manage/Entity Store/Engine Status`
* Verify that the service entity store IS installed

Reviewers should verify this PR satisfies this list as well.

- [x] [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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [x] 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)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tiansivive tiansivive tiansivive left review comments

@CAWilson94 CAWilson94 CAWilson94 approved these changes

@jaredburgettelastic jaredburgettelastic jaredburgettelastic approved these changes

@abhishekbhatia1710 abhishekbhatia1710 Awaiting requested review from abhishekbhatia1710 abhishekbhatia1710 is a code owner automatically assigned from elastic/security-entity-analytics

Assignees

@machadoum machadoum

Labels

backport:version Backport to applied version labels Feature:Entity Analytics Security Solution Entity Analytics features release_note:feature Makes this part of the condensed release notes Team:Entity Analytics Security Entity Analytics Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Theme: entity_analytics v8.18.0 v9.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@machadoum @elasticmachine @CAWilson94 @kibanamachine @tiansivive @jaredburgettelastic