kibana/docs/developer
Kevin Lacabane 0b3f4fbd3c
[eem] _search endpoint / initial entity manager UI (#199609)
## Summary

- create `_search` endpoint to discover entities with esql queries. It
currently reads sources of the provided `type` from
`kibana_entity_definitions` index. Run this query to insert a
definition:
```
POST kibana_entity_definitions/_doc
{
    "entity_type": "service",
    "index_patterns": ["remote_cluster:logs-*"],
    "metadata_fields": [],
    "identity_fields": ["service.name"],
    "filters": [],
    "timestamp_field": "@timestamp"
}
```

By default `_search` will look at data in the last 5m. The lookup period
can be overriden by providing `start`/`end` parameters in ISO format. It
also accepts a `limit` to specify the number of entities returned which
defaults to 10

```
POST kbn:/internal/entities/v2/_search
{
    "type": "service",
    "start": "2024-11-19T20:40:00.000Z",
    "end": "2024-11-19T20:50:00.000Z",
    "limit": 20
}
```

- create `_search/preview` endpoint to preview output of entity sources
without persisting them
 
- create UI to preview results of an entity definition at
`/app/entity_manager`. The application is living in its own plugin at
`observability_solution/entity_manager_app`
![Screenshot 2024-11-11 at 11 37
18](https://github.com/user-attachments/assets/f284342d-21a3-4ba1-be94-38cff311266c)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Milton Hultgren <miltonhultgren@gmail.com>
2024-11-22 16:12:04 +01:00
..
advanced Update legacy url aliases developer documentation (#199969) 2024-11-14 09:26:58 +01:00
architecture [Docs] Reset release files for 9.0 (#199519) 2024-11-22 10:24:10 +01:00
best-practices Update stability.asciidoc (#187294) 2024-07-01 12:41:32 -06:00
contributing [FTR] Refactor test/common/services/* -> packages/kbn-ftr-common-functional-[ui-]services/* (#191805) 2024-09-05 10:00:55 +01:00
getting-started [Docs] Update nav instructions and sample data installation to accommodate for the solution views (#199163) 2024-11-08 11:10:32 +01:00
images docs: interpreting ci failures (#153549) 2023-03-24 17:27:11 +01:00
plugin [DOCS] Port forward link fix (#178875) 2024-03-20 09:16:04 -04:00
index.asciidoc Add more details on developer documentation (#126674) 2022-03-03 11:44:05 -07:00
plugin-list.asciidoc [eem] _search endpoint / initial entity manager UI (#199609) 2024-11-22 16:12:04 +01:00
telemetry.asciidoc [dev/cli/timings] report on time to dev server listening (#95120) 2021-03-24 18:45:24 -04:00