Skip to content

Commit

Permalink
Port EEM and new services experience docs to stateful
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton committed Aug 6, 2024
1 parent 3fe0031 commit 70ccf4d
Show file tree
Hide file tree
Showing 4 changed files with 114 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 56 additions & 0 deletions docs/en/observability/apm/new-experience-services.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
[role="exclude",id="new-experience-services"]
= New services experience

//TODO: Unhide this topic when we figure out where it should live.

preview::[]

With this technical preview,
Elastic expands the **Services** inventory to include services found in logs.
This means you can monitor the services you care about even if you only have logs
and aren't ready to instrument your services.

The new **Services** inventory shows services instrumented with APM or OpenTelemetry,
plus any services declared using `service.name` in your logs:

[role="screenshot"]
image::images/entity-centric-services-inventory.png[Services inventory that shows APM data and log data]

For instrumented services that also have custom logs, the APM and log data are displayed in the same view.
For services that only have log data,
the log data is displayed, and you have the option of adding APM later.

NOTE: The new **Services** inventory requires the Elastic Entity Model (EEM). To learn more, refer to <<elastic-entity-model>>.

[discrete]
== Turn on the new experience

//QUESTION FOR REVIEWERS: Does the kibana.yml also need to be modified to enable the new experience?

The new services experience is turned off by default. To turn it on:

. Go to **{observability}** → **APM** → **Services**.
. Click **Try out Elastic's new experience!**

If you have the correct privileges, the EEM will be turned on automatically.
Otherwise, you need to ask your administrator to turn on this feature under **Stack Management**.

To turn off the new experience, click **Restore classic view**.
You can switch back and forth between the new and classic views whenever you want.

****
**Does turning on the new experience affect other users?**
No. The settings are applied at the browser level,
which means that other users need to turn on the new experience if they want to use it.
****

[discrete]
== Add services to the inventory

To add services to the inventory, use one of the following approaches:

* Instrument your services with APM or OpenTelemetry.
To learn how, refer to <<traces-get-started>>.
//TODO: uncomment when the logging topic about service.name is available.
//* Declare `service.name` in your logs. To learn how, <<add-logs-service-name>>.
52 changes: 52 additions & 0 deletions docs/en/observability/elastic-entity-model.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
[role="exclude",id="elastic-entity-model"]
= Elastic Entity Model

//TODO: Unhide this topic when we figure out where it should live.

preview::[]

The Elastic Entity Model consists of:

* a data model and related entity indices
* an Entity Discovery Framework, which consists of {ref}/transforms.html[transforms] and {ref}/ingest.html[Ingest pipelines] that read from signal indices and write data to entity indices
* a set of management APIs that empower entity-centric Elastic solution features and workflows

In the context of Elastic Observability,
an _entity_ is an object of interest that can be associated with produced telemetry and identified as unique.
Note that this definition is intentionally closely aligned to the work of the https://github.com/open-telemetry/oteps/blob/main/text/entities/0256-entities-data-model.md#data-model[OpenTelemetry Entities SIG].
Examples of entities include (but are not limited to) services, hosts, and containers.

The concept of an entity is important as a means to unify observability signals based on the underlying entity that the signals describe.

[discrete]
== Enable or disable the Elastic Entity Model

During Technical Preview,
the Elastic Entity Model is enabled when you turn on the entity-centric service inventory described in <<new-experience-services>>.

The following {es} privileges are required to turn on the new experience:

[cols="1,1"]
|====
|**Index privileges**
|names: [`.entities*`], privileges: [`create_index`, `index`, `create_doc`, `auto_configure`, `read`]

names: [`logs-*`, `filebeat*`, `metrics-*`, `metricbeat*`, `traces-*`, `.entities*`], privileges: [`read`, `view_index_metadata`],
|**Cluster privileges**
|`manage_transform`, `manage_ingest_pipelines`, `manage_index_templates`

|**Application privileges**
|application: `kibana-.kibana`, privileges: [`saved_object:entity-definition/*`, `saved_object:entity-discovery-api-key/*`], resources: [*]
|====

For more information, refer to {ref}/security-privileges.html[Security privileges] in the {es} documentation.

**To disable the Elastic Entity Model:**

- From the Dev Console, run the command: `DELETE kbn:/internal/entities/managed/enablement`

[NOTE]
====
* The Elastic Entity Model currently supports the <<new-experience-services,new service inventory experience>> limited to service-based entities (as identified by `service.name`) located in data identified by `logs-*` and `trace-*` index patterns
* During Technical Preview, Entity Discovery Framework components are not enabled by default
====
6 changes: 6 additions & 0 deletions docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -209,5 +209,11 @@ include::fields-reference.asciidoc[leveloffset=+1]
// Tutorials
include::tutorials.asciidoc[]

// Temporary parking place for new content

include::elastic-entity-model.asciidoc[leveloffset=+1]

include::./apm/new-experience-services.asciidoc[leveloffset=+1]

// add redirects file
include::redirects.asciidoc[]

0 comments on commit 70ccf4d

Please sign in to comment.