Skip to content

[Entity Analytics] Adding event based telemetry for entity highlights API usage#250101

Merged
ymao1 merged 2 commits intoelastic:mainfrom
ymao1:ea-249234
Jan 23, 2026
Merged

[Entity Analytics] Adding event based telemetry for entity highlights API usage#250101
ymao1 merged 2 commits intoelastic:mainfrom
ymao1:ea-249234

Conversation

@ymao1
Copy link
Copy Markdown
Contributor

@ymao1 ymao1 commented Jan 22, 2026

Resolves #249234

Summary

Adds call to report event when entity details highlight API is called.

To Verify

  1. Add telemetry.localShipper: true to your Kibana config
  2. Start ES and Kibana
  3. Generate some entity data
  4. For each entity, open the flyout and generate a summary
  5. Repeat for a few different entities
  6. In Dev Tools, perform the following query
GET ebt-kibana-server/_search
{
    "query": {
        "bool": {
            "filter": [
              {
                "term": {
                  "event_type": "entity_highlights_usage"
                }
              }
            ]
        }
    }
}
  1. You should see a document for each time you generated a summary with the entity type and space ID properties populated correctly

@ymao1 ymao1 self-assigned this Jan 22, 2026
@ymao1 ymao1 added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Team:Entity Analytics Security Entity Analytics Team v9.4.0 labels Jan 22, 2026
@ymao1
Copy link
Copy Markdown
Contributor Author

ymao1 commented Jan 22, 2026

@elasticmachine merge upstream

@elasticmachine
Copy link
Copy Markdown
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

cc @ymao1

@ymao1 ymao1 marked this pull request as ready for review January 22, 2026 22:53
@ymao1 ymao1 requested review from a team as code owners January 22, 2026 22:53
@elasticmachine
Copy link
Copy Markdown
Contributor

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

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 - LGTM, can see documents generating as described. 🚀

Copy link
Copy Markdown
Contributor

@szaffarano szaffarano left a comment

Choose a reason for hiding this comment

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

LGTM

@ymao1 ymao1 added backport:version Backport to applied version labels v9.3.0 and removed backport:skip This PR does not require backporting labels Jan 23, 2026
@ymao1 ymao1 merged commit 48d5a6d into elastic:main Jan 23, 2026
24 checks passed
@ymao1 ymao1 deleted the ea-249234 branch January 23, 2026 17:02
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 9.3

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

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jan 23, 2026
… API usage (elastic#250101)

Resolves elastic#249234

## Summary

Adds call to report event when entity details highlight API is called.

## To Verify
1. Add `telemetry.localShipper: true` to your Kibana config
2. Start ES and Kibana
3. Generate some entity data
4. For each entity, open the flyout and generate a summary
5. Repeat for a few different entities
6. In Dev Tools, perform the following query

```
GET ebt-kibana-server/_search
{
    "query": {
        "bool": {
            "filter": [
              {
                "term": {
                  "event_type": "entity_highlights_usage"
                }
              }
            ]
        }
    }
}
```

7. You should see a document for each time you generated a summary with
the entity type and space ID properties populated correctly

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
(cherry picked from commit 48d5a6d)
@kibanamachine
Copy link
Copy Markdown
Contributor

💚 All backports created successfully

Status Branch Result
9.3

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 Jan 24, 2026
…lights API usage (#250101) (#250258)

# Backport

This will backport the following commits from `main` to `9.3`:
- [[Entity Analytics] Adding event based telemetry for entity highlights
API usage (#250101)](#250101)

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

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

<!--BACKPORT [{"author":{"name":"Ying
Mao","email":"ying.mao@elastic.co"},"sourceCommit":{"committedDate":"2026-01-23T17:01:53Z","message":"[Entity
Analytics] Adding event based telemetry for entity highlights API usage
(#250101)\n\nResolves
https://github.com/elastic/kibana/issues/249234\n\n## Summary\n\nAdds
call to report event when entity details highlight API is called.\n\n##
To Verify\n1. Add `telemetry.localShipper: true` to your Kibana
config\n2. Start ES and Kibana\n3. Generate some entity data\n4. For
each entity, open the flyout and generate a summary\n5. Repeat for a few
different entities\n6. In Dev Tools, perform the following
query\n\n```\nGET ebt-kibana-server/_search\n{\n \"query\": {\n
\"bool\": {\n \"filter\": [\n {\n \"term\": {\n \"event_type\":
\"entity_highlights_usage\"\n }\n }\n ]\n }\n }\n}\n```\n\n7. You should
see a document for each time you generated a summary with\nthe entity
type and space ID properties populated correctly\n\nCo-authored-by:
Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"48d5a6d746635f4afaf6734d7414aeb4da86ac16","branchLabelMapping":{"^v9.4.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Entity
Analytics","backport:version","v9.3.0","v9.4.0"],"title":"[Entity
Analytics] Adding event based telemetry for entity highlights API
usage","number":250101,"url":"https://github.com/elastic/kibana/pull/250101","mergeCommit":{"message":"[Entity
Analytics] Adding event based telemetry for entity highlights API usage
(#250101)\n\nResolves
https://github.com/elastic/kibana/issues/249234\n\n## Summary\n\nAdds
call to report event when entity details highlight API is called.\n\n##
To Verify\n1. Add `telemetry.localShipper: true` to your Kibana
config\n2. Start ES and Kibana\n3. Generate some entity data\n4. For
each entity, open the flyout and generate a summary\n5. Repeat for a few
different entities\n6. In Dev Tools, perform the following
query\n\n```\nGET ebt-kibana-server/_search\n{\n \"query\": {\n
\"bool\": {\n \"filter\": [\n {\n \"term\": {\n \"event_type\":
\"entity_highlights_usage\"\n }\n }\n ]\n }\n }\n}\n```\n\n7. You should
see a document for each time you generated a summary with\nthe entity
type and space ID properties populated correctly\n\nCo-authored-by:
Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"48d5a6d746635f4afaf6734d7414aeb4da86ac16"}},"sourceBranch":"main","suggestedTargetBranches":["9.3"],"targetPullRequestStates":[{"branch":"9.3","label":"v9.3.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.4.0","branchLabelMappingKey":"^v9.4.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/250101","number":250101,"mergeCommit":{"message":"[Entity
Analytics] Adding event based telemetry for entity highlights API usage
(#250101)\n\nResolves
https://github.com/elastic/kibana/issues/249234\n\n## Summary\n\nAdds
call to report event when entity details highlight API is called.\n\n##
To Verify\n1. Add `telemetry.localShipper: true` to your Kibana
config\n2. Start ES and Kibana\n3. Generate some entity data\n4. For
each entity, open the flyout and generate a summary\n5. Repeat for a few
different entities\n6. In Dev Tools, perform the following
query\n\n```\nGET ebt-kibana-server/_search\n{\n \"query\": {\n
\"bool\": {\n \"filter\": [\n {\n \"term\": {\n \"event_type\":
\"entity_highlights_usage\"\n }\n }\n ]\n }\n }\n}\n```\n\n7. You should
see a document for each time you generated a summary with\nthe entity
type and space ID properties populated correctly\n\nCo-authored-by:
Elastic Machine
<elasticmachine@users.noreply.github.com>","sha":"48d5a6d746635f4afaf6734d7414aeb4da86ac16"}}]}]
BACKPORT-->

Co-authored-by: Ying Mao <ying.mao@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels release_note:skip Skip the PR/issue when compiling release notes Team:Entity Analytics Security Entity Analytics Team v9.3.0 v9.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Entity Analytics][Telemetry] Add kibana usage telemetry for AI Entity Highlights

5 participants