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

[8.x](backport #4437) Update references to apps and pages #4541

Merged
merged 2 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Use *Discover* to validate that metrics are successfully reported to {kib}.
include::{observability-docs-root}/docs/en/observability/apm/tab-widgets/open-kibana-widget.asciidoc[]
--

. Open the main menu, then click *Discover*.
. Find **Discover** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. Select `apm-*` as your index pattern.
. Filter the data to only show documents with metrics: `[data_stream][type]: "metrics"`
. Narrow your search with a known OpenTelemetry field. For example, if you have an `order_value` field, add `order_value: *` to your search to return
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// tag::fleet-managed-settings[]
Configure and customize Fleet-managed APM settings directly in {kib}:

. Open {kib} and navigate to **{fleet}**.
. In {kib}, find **Fleet** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. Under the **Agent policies** tab, select the policy you would like to configure.
. Find the Elastic APM integration and select **Actions** > **Edit integration**.
// end::fleet-managed-settings[]
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ These index templates are composed of multiple component templates--reusable bui
that configure index mappings, settings, and aliases.

The default APM index templates can be viewed in {kib}.
Navigate to **{stack-manage-app}** → **Index Management** → **Index Templates**, and search for `apm`.
To open **Index Management**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
Select **Index Templates** and search for `apm`.
Select any of the APM index templates to view their relevant component templates.

[discrete]
Expand All @@ -29,8 +30,8 @@ Do not change or customize any default mappings.
The APM index templates by default reference a non-existent `@custom` component template for each data stream.
You can create or edit this `@custom` component template to customize your {es} indices.

First, determine which <<apm-data-streams,data stream>> you'd like to edit.
Then, open {kib} and navigate to **{stack-manage-app}** → **Index Management** **Component Templates**.
First, determine which <<apm-data-streams,data stream>> you'd like to edit in {kib}.
To open **Index Management**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field]. Select **Component Templates**.

Custom component templates are named following this pattern: `<name_of_data_stream>@custom`.
Search for the name of the data stream, like `traces-apm`, and select its custom component template.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ The default rollover definition for each APM data stream is applied based on {re

The APM data stream lifecycle policies can be viewed in {kib}:

. Navigate to *{stack-manage-app}* → *Index Management* → *Component Templates*.
. To open **Index Management**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. Select **Component Templates**.
. Search for `apm`.
. Look for templates with `@lifecycle` suffix.

Expand All @@ -146,7 +147,8 @@ This tutorial explains how to apply a custom index lifecycle policy to the `trac
The **Data Streams** view in {kib} shows you data streams,
index templates, and lifecycle policies:

. Navigate to **{stack-manage-app}** → **Index Management** → **Data Streams**.
. To open **Index Management**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. Select **Data Streams**.
. Search for `traces-apm` to see all data streams associated with APM trace data.
. In this example, I only have one data stream because I'm only using the `default` namespace.
You may have more if your setup includes multiple namespaces.
Expand All @@ -158,7 +160,7 @@ image::images/data-stream-overview.png[Data streams info]
[id="apm-data-streams-custom-two{append-legacy}"]
== Step 2: Create an index lifecycle policy

. Navigate to **{stack-manage-app}** → **Index Lifecycle Policies**.
. To open **Lifecycle Policies**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. Click **Create policy**.

Name your new policy; For this tutorial, I've chosen `custom-traces-apm-policy`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ POST /.ds-*-apm*/_delete_by_query
{kib}'s {ref}/index-mgmt.html[Index Management] allows you to manage your cluster's
indices, data streams, index templates, and much more.

In {kib}, navigate to **Stack Management** > **Index Management** > **Data Streams**.
To open **Index Management**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field]. Select **Data Streams**.
Select the data streams you want to delete, and click **Delete data streams**.

[float]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The Applications UI has a built-in workflow that you can use to easily create an
Only API keys created in the Applications UI will show up here.

Using a superuser account, or a user with the role created in the previous step,
open {kib} and navigate to **{observability}** → **Applications** → **Settings** → **Agent keys**.
In {kib}, find **Applications** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field]. Go to **Settings** → **Agent keys**.
Enter a name for your API key and select at least one privilege.

For example, to create an API key that can be used to ingest APM events
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,8 @@ POST /_aliases?pretty
=== Step 2: Create {kib} spaces

Next, you'll need to create a {Kib} space for each service environment.
To create these spaces, navigate to **Stack Management** > **Spaces** > **Create a space**.
To open **Spaces**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
To create a new space, click **Create a space**.
For this guide, we've created two Kibana spaces, one named `production` and one named `staging`.

See {kibana-ref}/xpack-spaces.html[Kibana spaces] for more information on creating a space.
Expand All @@ -273,7 +274,8 @@ The values in each column match the names of the filtered aliases we created in
[float]
=== Step 4: Create {kib} access roles

In {kib}, navigate to **Stack Management** > **Roles** and click **Create role**.
To open **Roles**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
Click **Create role**.

You'll need to create two roles: one for `staging` users (we'll call this role `staging_apm_viewer`)
and one for `production` users (we'll call this role `production_apm_viewer`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,9 +276,9 @@ PUT _ingest/pipeline/traces-apm@custom
----
<1> The name of the pipeline we previously created

TIP: If you prefer using a GUI, you can instead open {kib} and navigate to
**Stack Management** -> **Ingest Pipelines** -> **Create pipeline**.
Use the same naming convention explained previously to ensure your new pipeline matches the correct APM data stream.
TIP: If you prefer using a GUI, you can instead use the **Ingest Pipelines** page in {kib}.
To open **Ingest Pipelines**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
Click **Create pipeline** and use the same naming convention explained previously to ensure your new pipeline matches the correct APM data stream.

That's it! Passwords will now be redacted from your APM HTTP body data.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ You can create as many API keys per user as necessary.
[[apm-beats-api-key-publish]]
== Create an API key for writing events

In {kib}, navigate to **{stack-manage-app}** > **API keys** and click **Create API key**.
To open **API keys**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
Click **Create API key**.

[role="screenshot"]
image::images/server-api-key-create.png[API key creation]
Expand Down Expand Up @@ -78,7 +79,8 @@ output.elasticsearch:
[[apm-beats-api-key-monitor]]
== Create an API key for monitoring

In {kib}, navigate to **{stack-manage-app}** > **API keys** and click **Create API key**.
To open **API keys**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
Click **Create API key**.

[role="screenshot"]
image::images/server-api-key-create.png[API key creation]
Expand Down
5 changes: 3 additions & 2 deletions docs/en/observability/apm/tab-widgets/jaeger.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// tag::ess[]
. Log into {ess-console}[{ecloud}] and select your deployment.
In {kib}, select **Add data**, then search for and select "Elastic APM".
. In {kib}, find **Integrations** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. Select **Elastic APM**.
If the integration is already installed, under the polices tab, select **Actions** > **Edit integration**.
If the integration has not been installed, select **Add Elastic APM**.
Copy the URL. If you're using Agent authorization, copy the Secret token as well.
Expand All @@ -25,7 +26,7 @@ See the https://www.jaegertracing.io/docs/1.27/cli/[Jaeger CLI flags documentati

// tag::self-managed[]
. Configure the APM Integration as a collector for your Jaeger agents.
In {kib}, select **Add data**, then search for and select "Elastic APM".
In {kib}, find **Integrations** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field]. Select **Elastic APM**.
If the integration is already installed, under the polices tab, select **Actions** > **Edit integration**.
If the integration has not been installed, select **Add Elastic APM**.
Copy the Host. If you're using Agent authorization, copy the Secret token as well.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ The process of migrating should only take a few minutes.

With a Superuser account, complete the following steps:

. In {kib}, navigate to **{observability}** → **Applications** **Settings** → **Schema**.
. In {kib}, go to the **Applications** app and click **Settings** → **Schema**.
+
image::./images/schema-agent.png[switch to {agent}]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ and allowing for better performance while managing multiple observability use ca
If you're using the Hosted {ess}, see {cloud}/ec-enable-ccs.html[Enable cross-cluster search].

// lint ignore elasticsearch
You can add remote clusters directly in {kib}, under *Management* → *Elasticsearch* → *Remote clusters*.
To add remote clusters directly in {kib}, find `Remote Clusters` in the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
All you need is a name for the remote cluster and the seed node(s).
Remember the names of your remote clusters, you'll need them in step two.
See {ref}/ccr-getting-started.html[managing remote clusters] for detailed information on the setup process.
Expand All @@ -44,20 +44,20 @@ You can also specify certain clusters to display data from, for example,

There are two ways to edit the default {data-source}:

* In the Applications UI -- Navigate to *Applications* → *Settings* → *Indices*, and change all `xpack.apm.indices.*` values to
include remote clusters.
* In the Applications UI -- Find **Applications** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
Go to **Settings** → **Indices** and change all `xpack.apm.indices.*` values to include remote clusters.
* In `kibana.yml` -- Update the {kibana-ref}/apm-settings-kb.html[`xpack.apm.indices.*`] configuration values to
include remote clusters.

[TIP]
.Exclude data tiers from search
====
In a cross-cluster search (CCS) environment, it's possible for different clusters to serve different data tiers in responses.
If one of the requested clusters responds slowly, it can cause a timeout at the proxy after 320 seconds.
If one of the requested clusters responds slowly, it can cause a timeout at the proxy after 320 seconds.
This results in 502 Bad Gateway server error responses presented as failure toast messages in the UI, and no data loaded.

To prevent this, you can exclude {ref}/data-tiers.html[data tiers] that might slow down responses from search: the `data_frozen` and `data_cold` tiers. To exclude data tiers from search in the APM UI:

. In {kib}, go to *Stack Management* → *Advanced Settings*.
. To open **Advanced settings**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. In the *Observability* section, update the *Excluded data tiers from search* option with a list of data tiers.
====
16 changes: 11 additions & 5 deletions docs/en/observability/apm/view-and-analyze/inventory.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Inventory allows you to:
[[explore-your-entities]]
== Explore your entities

. In your Observability project, go to **Inventory** to view all of your entities.
. To view all your entities, find **Inventory** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
+
When you open the Inventory for the first time, you'll be asked to enable the EEM. Once enabled, the Inventory will be accessible to anyone with the appropriate privileges.
+
Expand Down Expand Up @@ -75,16 +75,22 @@ You can add entities to the Inventory through one of the following approaches: *
[[add-data-entities]]
== Add data

To add entities, select **Add data** from the left-hand navigation and choose one of the following onboarding journeys:
To add entities, select **Add data** and choose one of the following onboarding journeys:

- **Auto-detect logs and metrics**
- **Host**
Detects hosts (with metrics and logs)

- **Kubernetes**
Detects hosts, containers, and services

- **Elastic APM / OpenTelemetry / Synthetic Monitor**
- **Application**
Detects services
Associate existing service logs

- **Cloud**
Ingests telemetry data from the Cloud

[float]
[[associate-existing-service-logs]]
== Associate existing service logs

To learn how, refer to <<add-logs-service-name>>.
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,10 @@ Service groups are {kib} space-specific and available for any users with appropr
[role="screenshot"]
image::./images/apm-service-group.png[Example view of service group in the Applications UI in Kibana]

To enable Service groups, open {kib} and navigate to **Stack Management** → **Advanced Settings** → **Observability**,
and enable the **Service groups feature**.

To create a service group:

. Navigate to **Observability** → **Applications** → **Service inventory**.
. To open **Service inventory**, find **Applications** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. Switch to **Service groups**.
. Click **Create group**.
. Specify a name, color, and description.
Expand Down
8 changes: 4 additions & 4 deletions docs/en/observability/categorize-logs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Application log events are often unstructured and contain variable data. Many
log messages are the same or very similar, so classifying them can reduce
millions of log lines into just a few categories.

Within the {logs-app}, the *Categories* page enables you to identify patterns in
The *Categories* page enables you to identify patterns in
your log events quickly. Instead of manually identifying similar logs, the logs
categorization view lists log events that have been grouped based on their
messages and formats so that you can take action quicker.
Expand All @@ -28,11 +28,11 @@ the static parts of the message, clusters similar messages, classifies them into
message categories, and detects unusually high message counts in the categories.

// lint ignore ml
1. Select *Categories*, and you are prompted to use {ml} to create
log rate categorizations.
1. Open the **Categories** page by finding `Logs / Categories` in the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
You are prompted to use {ml} to create log rate categorizations.
2. Choose a time range for the {ml} analysis. By default, the {ml} job analyzes
log messages no older than four weeks and continues indefinitely.
3. Add the indices that contain the logs you want to examine. By default, Machine Learning analyzes messages in all log indices that match the patterns set in the *logs source* advanced setting. Update this setting by going to *Management* → *Advanced Settings* and searching for _logs source_.
3. Add the indices that contain the logs you want to examine. By default, Machine Learning analyzes messages in all log indices that match the patterns set in the *logs sources* advanced setting. To open **Advanced settings**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
4. Click *Create ML job*. The job is created, and it starts to run. It takes a few
minutes for the {ml} robots to collect the necessary data. After the job
processed the data, you can view the results.
Expand Down
Loading