diff --git a/images/observability-apm-help-me-decide.svg b/images/observability-apm-help-me-decide.svg new file mode 100644 index 0000000000..dfd0c7fe7d --- /dev/null +++ b/images/observability-apm-help-me-decide.svg @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/solutions/observability/apps/analyze-monitors.md b/solutions/observability/apps/analyze-monitors.md index 55a4323f21..0ee441300a 100644 --- a/solutions/observability/apps/analyze-monitors.md +++ b/solutions/observability/apps/analyze-monitors.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/analyze-monitors.html +applies_to: + stack: all --- # Analyze monitors [analyze-monitors] diff --git a/solutions/observability/apps/analyze.md b/solutions/observability/apps/analyze.md index d31b92d3e4..c45ed3d078 100644 --- a/solutions/observability/apps/analyze.md +++ b/solutions/observability/apps/analyze.md @@ -2,6 +2,8 @@ navigation_title: "Analyze" mapped_pages: - https://www.elastic.co/guide/en/observability/current/uptime-analyze.html +applies_to: + stack: all --- diff --git a/solutions/observability/apps/apm-agent-authorization.md b/solutions/observability/apps/apm-agent-authorization.md index 1f232522e9..ccfc74c828 100644 --- a/solutions/observability/apps/apm-agent-authorization.md +++ b/solutions/observability/apps/apm-agent-authorization.md @@ -1,11 +1,13 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-agent-auth.html +applies_to: + stack: all --- # APM agent authorization [apm-agent-auth] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "") Most options in this section are supported by all APM Server deployment methods. @@ -92,7 +94,7 @@ Authorization token for sending APM data. The same token must also be set in eac ## `auth.api_key.elasticsearch.*` configuration options [_auth_api_key_elasticsearch_configuration_options] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") The below options are only supported by the APM Server binary. diff --git a/solutions/observability/apps/apm-agent-central-configuration.md b/solutions/observability/apps/apm-agent-central-configuration.md index b22648c81c..4c9a12685c 100644 --- a/solutions/observability/apps/apm-agent-central-configuration.md +++ b/solutions/observability/apps/apm-agent-central-configuration.md @@ -2,19 +2,14 @@ navigation_title: "Centrally configure APM agents in Kibana" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-agent-configuration.html +applies_to: + stack: all --- # APM agent central configuration [apm-agent-configuration] - -::::{note} -APM agent central configuration is *not* compatible with [{{serverless-full}}](https://docs.elastic.co/serverless). - -:::: - - APM Agent configuration allows you to fine-tune your APM agent configuration from within the Applications UI. Changes are automatically propagated to your APM agents, so there’s no need to redeploy. To get started, choose the services and environments you wish to configure. The Applications UI will let you know when your APM agents have applied your configurations. diff --git a/solutions/observability/apps/apm-agent-explorer.md b/solutions/observability/apps/apm-agent-explorer.md index 37358c632b..e674a97aa6 100644 --- a/solutions/observability/apps/apm-agent-explorer.md +++ b/solutions/observability/apps/apm-agent-explorer.md @@ -1,15 +1,14 @@ --- -navigation_title: "Identify deployment details for APM agents" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-agent-explorer.html +applies_to: + stack: all --- - - # APM Agent explorer [apm-agent-explorer] -::::{warning} +::::{important} This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. :::: diff --git a/solutions/observability/apps/apm-k8s-attacher.md b/solutions/observability/apps/apm-k8s-attacher.md index c930464242..95134f2dd6 100644 --- a/solutions/observability/apps/apm-k8s-attacher.md +++ b/solutions/observability/apps/apm-k8s-attacher.md @@ -2,6 +2,8 @@ navigation_title: "Kubernetes" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-k8s-attacher.html +applies_to: + stack: all --- diff --git a/solutions/observability/apps/apm-reader-user.md b/solutions/observability/apps/apm-reader-user.md index 6673f53353..56f049205c 100644 --- a/solutions/observability/apps/apm-reader-user.md +++ b/solutions/observability/apps/apm-reader-user.md @@ -12,32 +12,18 @@ mapped_pages: APM reader users typically need to view the Applications UI and dashboards and visualizations that use APM data. These users might also need to create and edit dashboards, visualizations, and machine learning jobs. -## APM reader [apm-app-reader-full] +## APM reader [apm-app-reader-full] To create an APM reader user: 1. Create a new role, named something like `read-apm`, and assign the following privileges: -
-
- - -
-
+ ::::{tab-set} + :group: datastreams-classic + + :::{tab-item} Data streams + :sync: datastreams + | Type | Privilege | Purpose | | --- | --- | --- | | Index | `read` on `logs-apm*` | Read-only access to `logs-apm*` data | @@ -47,19 +33,19 @@ To create an APM reader user: | Index | `read` on `traces-apm*` | Read-only access to `traces-apm*` data | | Index | `view_index_metadata` on `traces-apm*` | Read-only access to `traces-apm*` index metadata | -
- -
+ ::: + + :::: 2. Assign the `read-apm` role created in the previous step, and the following built-in roles to any APM reader users: @@ -70,32 +56,18 @@ To create an APM reader user: -## Partial APM reader [apm-app-reader-partial] +## Partial APM reader [apm-app-reader-partial] In some instances, you may wish to restrict certain Kibana apps that a user has access to. 1. Create a new role, named something like `read-apm-partial`, and assign the following privileges: -
-
- - -
-
+ ::::{tab-set} + :group: datastreams-classic + + :::{tab-item} Data streams + :sync: datastreams + | Type | Privilege | Purpose | | --- | --- | --- | | Index | `read` on `logs-apm*` | Read-only access to `logs-apm*` data | @@ -105,19 +77,20 @@ In some instances, you may wish to restrict certain Kibana apps that a user has | Index | `read` on `traces-apm*` | Read-only access to `traces-apm*` data | | Index | `view_index_metadata` on `traces-apm*` | Read-only access to `traces-apm*` index metadata | -
- -
+ ::: + + :::: + 2. Assign feature privileges to any Kibana feature that the user needs access to. Here are two examples: diff --git a/solutions/observability/apps/apm-server-advanced-setup.md b/solutions/observability/apps/apm-server-advanced-setup.md index b2d716c066..94b19c34b8 100644 --- a/solutions/observability/apps/apm-server-advanced-setup.md +++ b/solutions/observability/apps/apm-server-advanced-setup.md @@ -2,6 +2,8 @@ navigation_title: "Advanced setup" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-setting-up-and-running.html +applies_to: + stack: all --- diff --git a/solutions/observability/apps/apm-server-binary.md b/solutions/observability/apps/apm-server-binary.md index b7204ea414..65204b6f42 100644 --- a/solutions/observability/apps/apm-server-binary.md +++ b/solutions/observability/apps/apm-server-binary.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/get-started-with-apm-server-binary.html +applies_to: + stack: all --- # APM Server binary [get-started-with-apm-server-binary] @@ -36,27 +38,49 @@ To download and install APM Server, use the commands below that work with your s $$$apm-deb$$$ **deb:** -Version 9.0.0 of APM Server has not yet been released. +```shell +curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{{apm_server_version}}-amd64.deb +sudo dpkg -i apm-server-{{apm_server_version}}-amd64.deb +``` $$$apm-rpm$$$ **RPM:** -Version 9.0.0 of APM Server has not yet been released. +```shell +curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{{apm_server_version}}-x86_64.rpm +sudo rpm -vi apm-server-{{apm_server_version}}-x86_64.rpm +``` $$$apm-linux$$$ **Other Linux:** -Version 9.0.0 of APM Server has not yet been released. +```shell +curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{{apm_server_version}}-linux-x86_64.tar.gz +tar xzvf apm-server-{{apm_server_version}}-linux-x86_64.tar.gz +``` $$$apm-mac$$$ **Mac:** -Version 9.0.0 of APM Server has not yet been released. +```shell +curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{{apm_server_version}}-darwin-x86_64.tar.gz +tar xzvf apm-server-{{apm_server_version}}-darwin-x86_64.tar.gz +``` $$$apm-installing-on-windows$$$ **Windows:** -Version 9.0.0 of APM Server has not yet been released. +1. Download the APM Server Windows zip file from the +https://www.elastic.co/downloads/apm/apm-server[downloads page]. + +1. Extract the contents of the zip file into `C:\Program Files`. + +1. Rename the `apm-server--windows` directory to `APM-Server`. + +1. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select *Run As Administrator*). +If you are running Windows XP, you may need to download and install PowerShell. + +1. From the PowerShell prompt, run the following commands to install APM Server as a Windows service: $$$apm-docker$$$ **Docker:** diff --git a/solutions/observability/apps/apm-server-command-reference.md b/solutions/observability/apps/apm-server-command-reference.md index 17afb14e87..59a2c918d4 100644 --- a/solutions/observability/apps/apm-server-command-reference.md +++ b/solutions/observability/apps/apm-server-command-reference.md @@ -2,6 +2,8 @@ navigation_title: "Command reference" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-command-line-options.html +applies_to: + stack: all --- @@ -71,7 +73,7 @@ apm-server apikey SUBCOMMAND [FLAGS] The user requesting to create an API Key needs to have APM privileges used by the APM Server. A superuser, by default, has these privileges. - ::::{dropdown} **Expand for more information on assigning these privileges to other users** + ::::{dropdown} Expand for more information on assigning these privileges to other users To create an APM Server user with the required privileges for creating and managing API keys: 1. Create an **API key role**, called something like `apm_api_key`, that has the following `cluster` level privileges: diff --git a/solutions/observability/apps/apm-server-systemd.md b/solutions/observability/apps/apm-server-systemd.md index 4a8175a1da..9bc7905064 100644 --- a/solutions/observability/apps/apm-server-systemd.md +++ b/solutions/observability/apps/apm-server-systemd.md @@ -1,11 +1,13 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-running-with-systemd.html +applies_to: + stack: all --- # APM Server and systemd [apm-running-with-systemd] -::::{important} +::::{important} These commands only apply to the APM Server binary installation method. Fleet-managed users should see [Start and stop {{agent}}s on edge hosts](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/start-stop-elastic-agent.md). :::: @@ -15,7 +17,7 @@ The DEB and RPM packages include a service unit for Linux systems with systemd. We recommend that the apm-server process is run as a non-root user. Therefore, that is the default setup for APM Server’s DEB package and RPM installation. -## Start and stop APM Server [_start_and_stop_apm_server] +## Start and stop APM Server [_start_and_stop_apm_server] Use `systemctl` to start or stop APM Server: @@ -38,7 +40,7 @@ sudo systemctl disable apm-server ``` -## APM Server status and logs [_apm_server_status_and_logs] +## APM Server status and logs [_apm_server_status_and_logs] To get the service status, use `systemctl`: @@ -53,7 +55,7 @@ journalctl -u apm-server.service ``` -## Customize systemd unit for APM Server [_customize_systemd_unit_for_apm_server] +## Customize systemd unit for APM Server [_customize_systemd_unit_for_apm_server] The systemd service unit file includes environment variables that you can override to change the default options. @@ -63,7 +65,7 @@ The systemd service unit file includes environment variables that you can overri | `BEAT_CONFIG_OPTS` | Flags for configuration file path | ``-c /etc/apm-server/apm-server.yml`` | | `BEAT_PATH_OPTS` | Other paths | ``-path.home /usr/share/apm-server -path.config /etc/apm-server -path.data /var/lib/apm-server -path.logs /var/log/apm-server`` | -::::{note} +::::{note} You can use `BEAT_LOG_OPTS` to set debug selectors for logging. However, to configure logging behavior, set the logging options described in [Configure logging](configure-logging.md). :::: @@ -84,13 +86,13 @@ systemctl daemon-reload systemctl restart apm-server ``` -::::{note} +::::{note} It is recommended that you use a configuration management tool to include drop-in unit files. If you need to add a drop-in manually, use `systemctl edit apm-server.service`. :::: -#### Configuration file ownership [apm-config-file-ownership] +#### Configuration file ownership [apm-config-file-ownership] On systems with POSIX file permissions, the APM Server configuration file is subject to ownership and file permission checks. These checks prevent unauthorized users from providing or modifying configurations that are run by APM Server. @@ -118,7 +120,7 @@ can only be writable by the owner but the permissions are "-rw-rw-r--" To correct this problem, use `chmod go-w /etc/apm-server/apm-server.yml` to remove write privileges from anyone other than the owner. -##### Disabling strict permission checks [_disabling_strict_permission_checks] +##### Disabling strict permission checks [_disabling_strict_permission_checks] You can disable strict permission checks from the command line by using `--strict.perms=false`, but we strongly encourage you to leave the checks enabled. diff --git a/solutions/observability/apps/applications-ui-central-config-user.md b/solutions/observability/apps/applications-ui-central-config-user.md index e243cebd32..54c4db70d3 100644 --- a/solutions/observability/apps/applications-ui-central-config-user.md +++ b/solutions/observability/apps/applications-ui-central-config-user.md @@ -16,26 +16,12 @@ Central configuration users need to be able to view, create, update, and delete 1. Create a new role, named something like `central-config-manager`, and assign the following privileges: -
-
- - -
-
+ ::::{tab-set} + :group: datastreams-classic + + :::{tab-item} Data streams + :sync: datastreams + | Type | Privilege | Purpose | | --- | --- | --- | | Index | `read` on `apm-agent-configuration` | Read-only access to `apm-agent-configuration` data | @@ -47,19 +33,20 @@ Central configuration users need to be able to view, create, update, and delete | Index | `read` on `traces-apm*` | Read-only access to `traces-apm*` data | | Index | `view_index_metadata` on `traces-apm*` | Read-only access to `traces-apm*` index metadata | -
- -
+ ::: + + :::: + ::::{tip} Using the deprecated APM Server binaries? Add the privileges under the **Classic APM indices** tab above. :::: @@ -78,26 +65,12 @@ In some instances, you may wish to create a user that can only read central conf 1. Create a new role, named something like `central-config-reader`, and assign the following privileges: -
-
- - -
-
+ ::::{tab-set} + :group: datastreams-classic + + :::{tab-item} Data streams + :sync: datastreams + | Type | Privilege | Purpose | | --- | --- | --- | | Index | `read` on `apm-agent-configuration` | Read-only access to `apm-agent-configuration` data | @@ -109,19 +82,20 @@ In some instances, you may wish to create a user that can only read central conf | Index | `read` on `traces-apm*` | Read-only access to `traces-apm*` data | | Index | `view_index_metadata` on `traces-apm*` | Read-only access to `traces-apm*` index metadata | -
- -
+ ::: + + :::: + ::::{tip} Using the deprecated APM Server binaries? Add the privileges under the **Classic APM indices** tab above. :::: diff --git a/solutions/observability/apps/applications-ui-settings.md b/solutions/observability/apps/applications-ui-settings.md index 7c2dec5d1b..4d5a217479 100644 --- a/solutions/observability/apps/applications-ui-settings.md +++ b/solutions/observability/apps/applications-ui-settings.md @@ -9,8 +9,7 @@ navigation_title: "Settings" # Applications UI settings [observability-apm-kibana-settings] -::::{admonition} Required role -:class: note +::::{note} The **Editor** role or higher is required to modify settings. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). @@ -20,6 +19,9 @@ You can adjust Application settings to fine-tune your experience in the Applicat ## General settings [observability-apm-kibana-settings-general-settings] +```{applies_to} +stack: ga 9.1 +``` To change APM settings, select **Settings** from any **Applications** page. The following settings are available. @@ -67,6 +69,6 @@ APM indices are {{kib}} Spaces-aware; Changes to APM index settings will only ap **APM Labs** allows you to easily try out new features that are technical preview. -To enable APM labs, go to **Applications** → **Settings*** → ***General settings*** and toggle ***Enable labs button in APM**. Select **Save changes** and refresh the page. +To enable APM labs, go to **Applications** → **Settings** → **General settings** and toggle **Enable labs button in APM**. Select **Save changes** and refresh the page. After enabling **APM Labs** select **Labs** in the toolbar to see the technical preview features available to try out. \ No newline at end of file diff --git a/solutions/observability/apps/applications-ui-storage-explorer-user.md b/solutions/observability/apps/applications-ui-storage-explorer-user.md index 19657eb814..d4fc585025 100644 --- a/solutions/observability/apps/applications-ui-storage-explorer-user.md +++ b/solutions/observability/apps/applications-ui-storage-explorer-user.md @@ -16,26 +16,12 @@ View the **Storage Explorer** in the Applications UI. 1. Create a new role, named something like `storage-explorer_user`, and assign the following privileges: -
-
- - -
-
+ ::::{tab-set} + :group: datastreams-classic + + :::{tab-item} Data streams + :sync: datastreams + | Type | Privilege | Purpose | | --- | --- | --- | | Cluster | `monitor` | Monitor the disk space used by APM data streams | @@ -43,18 +29,18 @@ View the **Storage Explorer** in the Applications UI. | Index | `monitor` on `metrics-apm*` | Monitor access to `metrics-apm*` for storage explorer | | Index | `monitor` on `traces-apm*` | Monitor access to `traces-apm*` for storage explorer | -
- -
+ ::: + + :::: 2. Assign the `storage-explorer_user` created previously, and the roles and privileges necessary to create a [full](apm-reader-user.md#apm-app-reader-full) or [partial](apm-reader-user.md#apm-app-reader-partial) APM reader to any users that need to view **Storage Explorer** in the Applications UI. diff --git a/solutions/observability/apps/collect-application-data.md b/solutions/observability/apps/collect-application-data.md index 21de927852..0f80f1c08d 100644 --- a/solutions/observability/apps/collect-application-data.md +++ b/solutions/observability/apps/collect-application-data.md @@ -9,15 +9,18 @@ mapped_urls: % is required role serverless only? -::::{admonition} Required role -:class: note +::::{note} -The **Admin** role or higher is required to send APM data to Elastic. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). +**For Observability Serverless projects**, the **Admin** role or higher is required to send APM data to Elastic. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). :::: +::::{note} + ![documentation icon](../../../images/serverless-documentation.svg "") Want to get started quickly? See [Get started with traces and APM](../../../solutions/observability/apps/get-started-with-apm.md). +:::: + ## Language-specific options [_language_specific_options] Use Elastic APM agents or an OpenTelemetry language SDK to instrument a service in the language its written in: diff --git a/solutions/observability/apps/collect-metrics.md b/solutions/observability/apps/collect-metrics.md index c207d5ad0f..5585ee08e9 100644 --- a/solutions/observability/apps/collect-metrics.md +++ b/solutions/observability/apps/collect-metrics.md @@ -41,7 +41,7 @@ Use **Discover** to validate that metrics are successfully reported to {{kib}}. 5. 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 only OpenTelemetry metrics documents. -## Visualize in {{kib}} [apm-open-telemetry-visualize] +## Visualize your metrics[apm-open-telemetry-visualize] Use **Lens** to create visualizations for OpenTelemetry metrics. Lens enables you to build visualizations by dragging and dropping data fields. It makes smart visualization suggestions for your data, allowing you to switch between visualization types. diff --git a/solutions/observability/apps/configure-anonymous-authentication.md b/solutions/observability/apps/configure-anonymous-authentication.md index ee77561338..428b64c82a 100644 --- a/solutions/observability/apps/configure-anonymous-authentication.md +++ b/solutions/observability/apps/configure-anonymous-authentication.md @@ -2,6 +2,8 @@ navigation_title: "Anonymous authentication" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuration-anonymous.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure anonymous authentication [apm-configuration-anonymous] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "") Most options on this page are supported by all APM Server deployment methods. diff --git a/solutions/observability/apps/configure-apm-agent-central-configuration.md b/solutions/observability/apps/configure-apm-agent-central-configuration.md index 834532d52a..33228a2408 100644 --- a/solutions/observability/apps/configure-apm-agent-central-configuration.md +++ b/solutions/observability/apps/configure-apm-agent-central-configuration.md @@ -2,6 +2,8 @@ navigation_title: "APM agent central configuration" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configure-agent-config.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure APM agent central configuration [apm-configure-agent-config] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "") APM agent central configuration is supported by all APM Server deployment methods, but some options are only supported for APM Server binary users. diff --git a/solutions/observability/apps/configure-apm-instrumentation.md b/solutions/observability/apps/configure-apm-instrumentation.md index 103364c3dd..59f35bbbf6 100644 --- a/solutions/observability/apps/configure-apm-instrumentation.md +++ b/solutions/observability/apps/configure-apm-instrumentation.md @@ -2,6 +2,8 @@ navigation_title: "Instrumentation" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuration-instrumentation.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure APM instrumentation [apm-configuration-instrumentation] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") Instrumentation of APM Server is not yet supported for Fleet-managed APM. diff --git a/solutions/observability/apps/configure-apm-server.md b/solutions/observability/apps/configure-apm-server.md index 7fb6d2bcb3..cabbc58269 100644 --- a/solutions/observability/apps/configure-apm-server.md +++ b/solutions/observability/apps/configure-apm-server.md @@ -2,6 +2,8 @@ mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-manage-apm-settings.html - https://www.elastic.co/guide/en/observability/current/apm-configuring-howto-apm-server.html +applies_to: + stack: all --- # Configure APM Server [apm-configuring-howto-apm-server] diff --git a/solutions/observability/apps/configure-console-output.md b/solutions/observability/apps/configure-console-output.md index 4613a2257c..e748b056ee 100644 --- a/solutions/observability/apps/configure-console-output.md +++ b/solutions/observability/apps/configure-console-output.md @@ -2,6 +2,8 @@ navigation_title: "Console" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-console-output.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure the Console output [apm-console-output] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") The Console output is not yet supported by {{fleet}}-managed APM Server. diff --git a/solutions/observability/apps/configure-elasticsearch-output.md b/solutions/observability/apps/configure-elasticsearch-output.md index 198b37e33f..34253c0bd1 100644 --- a/solutions/observability/apps/configure-elasticsearch-output.md +++ b/solutions/observability/apps/configure-elasticsearch-output.md @@ -2,6 +2,8 @@ navigation_title: "{{es}}" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-elasticsearch-output.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure the Elasticsearch output [apm-elasticsearch-output] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") This documentation only applies to APM Server binary users. Fleet-managed users should see [Configure the {{es}} output](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/elasticsearch-output.md). diff --git a/solutions/observability/apps/configure-individual-browser-monitors.md b/solutions/observability/apps/configure-individual-browser-monitors.md index 446849093d..773fd47223 100644 --- a/solutions/observability/apps/configure-individual-browser-monitors.md +++ b/solutions/observability/apps/configure-individual-browser-monitors.md @@ -19,7 +19,7 @@ After [writing synthetic journeys](../../../solutions/observability/apps/write-s You’ll need to set a few configuration options: -* **Give your monitor a name.** Provide a human readable name and a unique ID for the monitor. This will appear in {{kib}} or your Observability serverless project where you can view and manage monitors after they’re created. +* **Give your monitor a name.** Provide a human readable name and a unique ID for the monitor. This will appear in {{kib}} or your Observability Serverless project where you can view and manage monitors after they’re created. * **Set the schedule.** Specify the interval at which your tests will run. * **Specify where the monitors should run.** You can run monitors on Elastic’s global managed testing infrastructure or [create a {{private-location}}](../../../solutions/observability/apps/monitor-resources-on-private-networks.md) to run monitors from your own premises. * **Set other options as needed.** There are several other options you can set to customize your implementation including params, tags, screenshot options, throttling options, and more. diff --git a/solutions/observability/apps/configure-kafka-output.md b/solutions/observability/apps/configure-kafka-output.md index 548465e99b..5c0bf30cb2 100644 --- a/solutions/observability/apps/configure-kafka-output.md +++ b/solutions/observability/apps/configure-kafka-output.md @@ -2,14 +2,15 @@ navigation_title: "Kafka" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-kafka-output.html +applies_to: + stack: all --- - # Configure the Kafka output [apm-kafka-output] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") The Kafka output is not yet supported by {{fleet}}-managed APM Server. diff --git a/solutions/observability/apps/configure-kibana-endpoint.md b/solutions/observability/apps/configure-kibana-endpoint.md index def5644f77..a16555ca20 100644 --- a/solutions/observability/apps/configure-kibana-endpoint.md +++ b/solutions/observability/apps/configure-kibana-endpoint.md @@ -2,6 +2,8 @@ navigation_title: "{{kib}} endpoint" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-setup-kibana-endpoint.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure the Kibana endpoint [apm-setup-kibana-endpoint] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") You must configure the {{kib}} endpoint when running the APM Server binary with a non-{{es}} output. Configuring the {{kib}} endpoint allows the APM Server to communicate with {{kib}} and ensure that the APM integration was properly set up. It is also required for APM agent configuration when using an output other than {{es}}. diff --git a/solutions/observability/apps/configure-lightweight-monitors.md b/solutions/observability/apps/configure-lightweight-monitors.md index 93c1a5df8a..d549657afc 100644 --- a/solutions/observability/apps/configure-lightweight-monitors.md +++ b/solutions/observability/apps/configure-lightweight-monitors.md @@ -17,7 +17,7 @@ Lightweight monitors can be configured using either the [Synthetics UI](../../.. ## Synthetics UI [synthetics-lightweight-ui] -To use the UI, go to the Synthetics UI in {{kib}} or in your Observability serverless project to create and configure monitors. For step-by-step instructions, refer to [Use the Synthetics UI](../../../solutions/observability/apps/create-monitors-in-synthetics-app.md). +To use the UI, go to the Synthetics UI in {{kib}} or in your Observability Serverless project to create and configure monitors. For step-by-step instructions, refer to [Use the Synthetics UI](../../../solutions/observability/apps/create-monitors-in-synthetics-app.md). :::{image} ../../../images/observability-synthetics-get-started-ui-lightweight.png :alt: Synthetics Create monitor UI @@ -130,7 +130,7 @@ $$$monitor-service_name$$$ **`service.name`** : Type: [string](../../../solutions/observability/apps/configure-lightweight-monitors.md#synthetics-lightweight-data-string) - APM service name for this monitor. Corresponds to the `service.name` ECS field. Set this when monitoring an app that is also using APM to enable integrations between Synthetics and APM data in Kibana or your Observability serverless project. + APM service name for this monitor. Corresponds to the `service.name` ECS field. Set this when monitoring an app that is also using APM to enable integrations between Synthetics and APM data in Kibana or your Observability Serverless project. $$$monitor-enabled$$$ diff --git a/solutions/observability/apps/configure-logging.md b/solutions/observability/apps/configure-logging.md index a44c66a980..10449312ec 100644 --- a/solutions/observability/apps/configure-logging.md +++ b/solutions/observability/apps/configure-logging.md @@ -2,6 +2,8 @@ navigation_title: "Logging" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuration-logging.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure logging [apm-configuration-logging] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") These configuration options are only relevant to APM Server binary users. Fleet-managed users should see [View {{agent}} logs](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/monitor-elastic-agent.md) to learn how to view logs and change the logging level of {{agent}}. diff --git a/solutions/observability/apps/configure-logstash-output.md b/solutions/observability/apps/configure-logstash-output.md index 7a14cdcc46..04a546e186 100644 --- a/solutions/observability/apps/configure-logstash-output.md +++ b/solutions/observability/apps/configure-logstash-output.md @@ -2,6 +2,8 @@ navigation_title: "{{ls}}" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-logstash-output.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure the Logstash output [apm-logstash-output] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") The {{ls}} output is not yet supported by {{fleet}}-managed APM Server. diff --git a/solutions/observability/apps/configure-output-for-elasticsearch-service-on-elastic-cloud.md b/solutions/observability/apps/configure-output-for-elasticsearch-service-on-elastic-cloud.md index e20a2c234a..1b8c3a6a9d 100644 --- a/solutions/observability/apps/configure-output-for-elasticsearch-service-on-elastic-cloud.md +++ b/solutions/observability/apps/configure-output-for-elasticsearch-service-on-elastic-cloud.md @@ -2,6 +2,8 @@ navigation_title: "{{ech}}" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configure-cloud-id.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure the output for {{ech}} [apm-configure-cloud-id] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") This documentation only applies to APM Server binary users. diff --git a/solutions/observability/apps/configure-output.md b/solutions/observability/apps/configure-output.md index 60e79e6715..bd561e4ed4 100644 --- a/solutions/observability/apps/configure-output.md +++ b/solutions/observability/apps/configure-output.md @@ -2,6 +2,8 @@ navigation_title: "Output" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuring-output.html +applies_to: + stack: all --- @@ -19,7 +21,7 @@ Output configuration options. * [Console](configure-console-output.md) -## Source maps [apm-sourcemap-output] +## Source maps [apm-sourcemap-output] Source maps can be uploaded through all outputs but must eventually be stored in {{es}}. When using outputs other than {{es}}, `source_mapping.elasticsearch` must be set for source maps to be applied. Be sure to update `source_mapping.index_pattern` if source maps are stored in the non-default location. See [`source_mapping.elasticsearch`](configure-real-user-monitoring-rum.md#apm-config-sourcemapping-elasticsearch) for more details. diff --git a/solutions/observability/apps/configure-project-paths.md b/solutions/observability/apps/configure-project-paths.md index a6bb5f6d3d..bc6a411314 100644 --- a/solutions/observability/apps/configure-project-paths.md +++ b/solutions/observability/apps/configure-project-paths.md @@ -2,6 +2,8 @@ navigation_title: "Project paths" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuration-path.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure project paths [apm-configuration-path] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") This documentation is only relevant for APM Server binary users. Fleet-managed paths are defined in [Installation layout](installation-layout.md). diff --git a/solutions/observability/apps/configure-real-user-monitoring-rum.md b/solutions/observability/apps/configure-real-user-monitoring-rum.md index 72c8da99ce..2e1cacf2fe 100644 --- a/solutions/observability/apps/configure-real-user-monitoring-rum.md +++ b/solutions/observability/apps/configure-real-user-monitoring-rum.md @@ -2,6 +2,8 @@ navigation_title: "Real User Monitoring (RUM)" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuration-rum.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure Real User Monitoring (RUM) [apm-configuration-rum] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "") Most options in this section are supported by all APM Server deployment methods. diff --git a/solutions/observability/apps/configure-redis-output.md b/solutions/observability/apps/configure-redis-output.md index 244c95e84f..f28a7d939d 100644 --- a/solutions/observability/apps/configure-redis-output.md +++ b/solutions/observability/apps/configure-redis-output.md @@ -2,6 +2,8 @@ navigation_title: "Redis" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-redis-output.html +applies_to: + stack: all --- @@ -9,7 +11,7 @@ mapped_pages: # Configure the Redis output [apm-redis-output] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") The Redis output is not yet supported by {{fleet}}-managed APM Server. diff --git a/solutions/observability/apps/configure-settings.md b/solutions/observability/apps/configure-settings.md index 3997b25b94..b804456ff7 100644 --- a/solutions/observability/apps/configure-settings.md +++ b/solutions/observability/apps/configure-settings.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/configure-uptime-settings.html +applies_to: + stack: all --- # Configure settings [configure-uptime-settings] diff --git a/solutions/observability/apps/create-apm-rules-alerts.md b/solutions/observability/apps/create-apm-rules-alerts.md index 335e0c9d34..04d89e41d4 100644 --- a/solutions/observability/apps/create-apm-rules-alerts.md +++ b/solutions/observability/apps/create-apm-rules-alerts.md @@ -28,9 +28,10 @@ For a complete walkthrough of the **Create rule** flyout panel, including detail :::: -% Stateful only after this? - ## Rules and alerts in the Applications UI [_rules_and_alerts_in_the_applications_ui] +```{applies_to} +stack: all +``` View and manage rules and alerts in the Applications UI. diff --git a/solutions/observability/apps/create-custom-links.md b/solutions/observability/apps/create-custom-links.md index 503586739d..9637ec7154 100644 --- a/solutions/observability/apps/create-custom-links.md +++ b/solutions/observability/apps/create-custom-links.md @@ -8,10 +8,9 @@ navigation_title: "Create custom links" # Custom links in the Applications UI [apm-custom-links] -::::{admonition} Required role -:class: note +::::{note} -For serverless Observability projects, the **Editor** role or higher is required to create and manage custom links. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). +**For serverless Observability projects**, the **Editor** role or higher is required to create and manage custom links. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). :::: diff --git a/solutions/observability/apps/create-upload-source-maps-rum.md b/solutions/observability/apps/create-upload-source-maps-rum.md index 13a009bc02..ceaf9ab189 100644 --- a/solutions/observability/apps/create-upload-source-maps-rum.md +++ b/solutions/observability/apps/create-upload-source-maps-rum.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-source-map-how-to.html +applies_to: + stack: all --- # Create and upload source maps (RUM) [apm-source-map-how-to] diff --git a/solutions/observability/apps/cross-cluster-search-with-application-data.md b/solutions/observability/apps/cross-cluster-search-with-application-data.md index 6d7ef8d634..9119892d0d 100644 --- a/solutions/observability/apps/cross-cluster-search-with-application-data.md +++ b/solutions/observability/apps/cross-cluster-search-with-application-data.md @@ -2,6 +2,8 @@ navigation_title: "Cross-cluster search" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-cross-cluster-search.html +applies_to: + stack: all --- @@ -35,8 +37,7 @@ There are two ways to edit the default {{data-source}}: * In the Applications UI — Find **Applications** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). Go to **Settings** → **Indices** and change all `xpack.apm.indices.*` values to include remote clusters. * In `kibana.yml` — Update the [`xpack.apm.indices.*`](asciidocalypse://docs/kibana/docs/reference/configuration-reference/apm-settings.md) configuration values to include remote clusters. -::::{admonition} Exclude data tiers from search -:class: tip +::::{tip} 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. This results in 502 Bad Gateway server error responses presented as failure toast messages in the UI, and no data loaded. diff --git a/solutions/observability/apps/data-streams.md b/solutions/observability/apps/data-streams.md index e969c432f6..bf0cefcbb3 100644 --- a/solutions/observability/apps/data-streams.md +++ b/solutions/observability/apps/data-streams.md @@ -5,7 +5,7 @@ mapped_pages: # Data streams [apm-data-streams] -::::{admonition} +::::{note} {{agent}} uses data streams to store append-only time series data across multiple indices. Data streams are well-suited for logs, metrics, traces, and other continuously generated data, and offer a host of benefits over other indexing strategies: * Reduced number of fields per index diff --git a/solutions/observability/apps/dependencies.md b/solutions/observability/apps/dependencies.md index 7f96b12fc6..2839eeac28 100644 --- a/solutions/observability/apps/dependencies.md +++ b/solutions/observability/apps/dependencies.md @@ -29,8 +29,7 @@ If your usage pattern *has* changed, the dependency view can quickly show you wh ## Operations [dependencies-operations] -::::{admonition} Dependency operations is in beta -:class: important +::::{Warning} The Dependency operations functionality is in beta and is subject to change. The design and code is less mature than official generally available features and is being provided as-is with no warranties. diff --git a/solutions/observability/apps/elastic-apm-agents.md b/solutions/observability/apps/elastic-apm-agents.md index 8489d4f985..9bac33353b 100644 --- a/solutions/observability/apps/elastic-apm-agents.md +++ b/solutions/observability/apps/elastic-apm-agents.md @@ -9,10 +9,9 @@ navigation_title: "APM agents" # Elastic APM agents [observability-apm-agents-elastic-apm-agents] -::::{admonition} Required role -:class: note +::::{note} -**For Observability serverless projects**, the **Admin** role or higher is required to use APM agents. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). +**For Observability Serverless projects**, the **Admin** role or higher is required to use APM agents. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). :::: diff --git a/solutions/observability/apps/errors-2.md b/solutions/observability/apps/errors-2.md index 306bf40a19..65d4da3979 100644 --- a/solutions/observability/apps/errors-2.md +++ b/solutions/observability/apps/errors-2.md @@ -6,11 +6,6 @@ mapped_urls: # Errors [apm-errors] -::::{tip} -[Errors](/solutions/observability/apps/errors.md) are groups of exceptions with a similar exception or log message. -:::: - - *Errors* are groups of exceptions with a similar exception or log message. The **Errors** overview provides a high-level view of the exceptions that APM agents catch, or that users manually report with APM agent APIs. Like errors are grouped together to make it easy to quickly see which errors are affecting your services, and to take actions to rectify them. A service returning a 5xx code from a request handler, controller, etc., will not create an exception that an APM agent can catch, and will therefore not show up in this view. diff --git a/solutions/observability/apps/explore-mobile-sessions-with-discover.md b/solutions/observability/apps/explore-mobile-sessions-with-discover.md index 820edcc301..930d1f0daf 100644 --- a/solutions/observability/apps/explore-mobile-sessions-with-discover.md +++ b/solutions/observability/apps/explore-mobile-sessions-with-discover.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-mobile-session-explorer.html +applies_to: + stack: all --- # Explore mobile sessions with Discover [apm-mobile-session-explorer] @@ -33,19 +35,19 @@ Copy this value and open the Discover page: :class: screenshot ::: -set the data view. `APM` selected in the example: +Set the data view. `APM` selected in the example: :::{image} ../../../images/observability-mobile-session-explorer-apm.png :alt: Example view of Explorer selecting APM data view :class: screenshot ::: -filter using the `session.id`: `session.id: ""`: +Filter using the `session.id`: `session.id: ""`: :::{image} ../../../images/observability-mobile-session-filter-discover.png :alt: Filter Explor using session.id :class: screenshot ::: -explore all the documents associated with that session id including crashes, lifecycle events, network requests, errors, and other custom events! +Explore all the documents associated with that session id including crashes, lifecycle events, network requests, errors, and other custom events! diff --git a/solutions/observability/apps/filter-application-data.md b/solutions/observability/apps/filter-application-data.md index 54f80f75c2..31bb811f33 100644 --- a/solutions/observability/apps/filter-application-data.md +++ b/solutions/observability/apps/filter-application-data.md @@ -36,10 +36,10 @@ Service environments are defined when configuring your APM agents. It’s vital * **Go:** [`ELASTIC_APM_ENVIRONMENT`](asciidocalypse://docs/apm-agent-go/docs/reference/configuration.md#config-environment) * **iOS agent:** *Not yet supported* -* **Java:** [`environment`](asciidocalypse://docs/apm-agent-java/docs/reference/config-core.md#config-environment) -* **.NET:** [`Environment`](asciidocalypse://docs/apm-agent-dotnet/docs/reference/config-core.md#config-environment) -* **Node.js:** [`environment`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#environment) -* **PHP:** [`environment`](asciidocalypse://docs/apm-agent-php/docs/reference/configuration-reference.md#config-environment) -* **Python:** [`environment`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-environment) -* **Ruby:** [`environment`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-environment) -* **Real User Monitoring:** [`environment`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md#environment) \ No newline at end of file +* **Java:** [`environment`](asciidocalypse://docs/apm-agent-java/docs/reference/ingestion-tools/apm-agent-java/config-core.md#config-environment) +* **.NET:** [`Environment`](asciidocalypse://docs/apm-agent-dotnet/docs/reference/ingestion-tools/apm-agent-dotnet/config-core.md#config-environment) +* **Node.js:** [`environment`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/ingestion-tools/apm-agent-nodejs/configuration.md#environment) +* **PHP:** [`environment`](asciidocalypse://docs/apm-agent-php/docs/reference/ingestion-tools/apm-agent-php/configuration-reference.md#config-environment) +* **Python:** [`environment`](asciidocalypse://docs/apm-agent-python/docs/reference/ingestion-tools/apm-agent-python/configuration.md#config-environment) +* **Ruby:** [`environment`](asciidocalypse://docs/apm-agent-ruby/docs/reference/ingestion-tools/apm-agent-ruby/configuration.md#config-environment) +* **Real User Monitoring (Elastic Stack only):** [`environment`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/ingestion-tools/apm-agent-rum-js/configuration.md#environment) \ No newline at end of file diff --git a/solutions/observability/apps/find-transaction-latency-failure-correlations.md b/solutions/observability/apps/find-transaction-latency-failure-correlations.md index 3015bed74c..27263a9383 100644 --- a/solutions/observability/apps/find-transaction-latency-failure-correlations.md +++ b/solutions/observability/apps/find-transaction-latency-failure-correlations.md @@ -19,9 +19,6 @@ To find correlations: Select a service on the **Services** page in the Applications UI then select a transaction group from the **Transactions** tab. -::::{note} -Queries within the Applications UI are also applied to the correlations. -:::: ::: @@ -33,13 +30,12 @@ Queries within the Applications UI are also applied to the correlations. 3. Select the **Transactions** tab. 4. Select a transaction group in the **Transactions** table. -::::{note} -Active queries *are* applied to correlations. +::: :::: -::: - +:::: {note} +Active queries *are* applied to correlations. :::: diff --git a/solutions/observability/apps/fleet-managed-apm-server.md b/solutions/observability/apps/fleet-managed-apm-server.md index 6577f6e8ea..9f00b31faf 100644 --- a/solutions/observability/apps/fleet-managed-apm-server.md +++ b/solutions/observability/apps/fleet-managed-apm-server.md @@ -144,10 +144,10 @@ If you don’t have a {{fleet}} setup already in place, the easiest way to get s Any {{agent}}s assigned to this policy will collect APM data from your instrumented services. -::::{admonition} +::::{tip} An internet connection is required to install the APM integration via the Fleet UI in Kibana. -::::{dropdown} **If you don’t have an internet connection** +::::{dropdown} If you don’t have an internet connection If your environment has network traffic restrictions, there are other ways to install the APM integration. See [Air-gapped environments](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/air-gapped.md) for more information. Option 1: Update `kibana.yml` diff --git a/solutions/observability/apps/general-configuration-options.md b/solutions/observability/apps/general-configuration-options.md index 21ca289f90..2e6fa95b54 100644 --- a/solutions/observability/apps/general-configuration-options.md +++ b/solutions/observability/apps/general-configuration-options.md @@ -1,11 +1,13 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuration-process.html +applies_to: + stack: all --- # General configuration options [apm-configuration-process] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "") Most options on this page are supported by all APM Server deployment methods. diff --git a/solutions/observability/apps/get-started-with-apm.md b/solutions/observability/apps/get-started-with-apm.md index de0ae5ec71..18670a3bec 100644 --- a/solutions/observability/apps/get-started-with-apm.md +++ b/solutions/observability/apps/get-started-with-apm.md @@ -88,70 +88,10 @@ Install, configure, and run the APM Server binary wherever you need it. This decision tree highlights key factors to help you make an informed decision about implementing Elastic APM. It provides practical guidance and is not intended to serve as a comprehensive reference of all possible implementations and capabilities. -
- - - -APM Server binary - -Fleet-managed APM Server -YAML - - - - -UI - -Curated UI or YAML-based? -What is your preferred method of configuration? - -no - - - - -yes - -Integrations collect observability data from specific services and protect endpoints. -Do you want to use other integrations with APM Server? - -Logstash or -Kafka - - -Elasticsearch - - - -Most users need Elasticsearch -Which output are you using? - -APM agents live on edge machines a single APM Server is hosted centrally -but -Centrally hosted - - -APM agents APM Server live on each edge machine -and -Edge machines - - -Note that central is required for RUM. -Where will you run APM Server? - -no - - -yes - - - -Elastic Cloud simplifies the management and deployment of Elastic APM. -Are you using Elastic Cloud? - - -
- +:::{image} ../../../images/observability-apm-help-me-decide.svg +:alt: APM decision tree +:class: screenshot +::: % What needs to be done: Align serverless/stateful diff --git a/solutions/observability/apps/get-started-with-uptime.md b/solutions/observability/apps/get-started-with-uptime.md index e6b0186a41..d6bb92c3b2 100644 --- a/solutions/observability/apps/get-started-with-uptime.md +++ b/solutions/observability/apps/get-started-with-uptime.md @@ -2,6 +2,8 @@ navigation_title: "Get started" mapped_pages: - https://www.elastic.co/guide/en/observability/current/uptime-get-started.html +applies_to: + stack: all --- diff --git a/solutions/observability/apps/high-availability.md b/solutions/observability/apps/high-availability.md index 04f5f577c5..294d8fac52 100644 --- a/solutions/observability/apps/high-availability.md +++ b/solutions/observability/apps/high-availability.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-high-availability.html +applies_to: + stack: all --- # High Availability [apm-high-availability] @@ -13,7 +15,7 @@ In case of temporal issues, like unavailable {{es}} or a sudden high workload, A If {{es}} goes down, the APM Server will eventually deny incoming requests. Both the APM Server and {{apm-agent}}(s) will issue logs accordingly. -::::{tip} +::::{tip} Fleet-managed APM Server users might also be interested in [Fleet/Agent proxy support](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md). :::: diff --git a/solutions/observability/apps/infrastructure.md b/solutions/observability/apps/infrastructure.md index d4b1c53b76..82b59d7fad 100644 --- a/solutions/observability/apps/infrastructure.md +++ b/solutions/observability/apps/infrastructure.md @@ -6,8 +6,7 @@ mapped_urls: # Infrastructure [observability-apm-infrastructure] -::::{admonition} Applications UI Infrastructure is in beta -:class: important +::::{important} The Applications UI Infrastructure functionality is in beta and is subject to change. The design and code is less mature than official generally available features and is being provided as-is with no warranties. @@ -28,8 +27,8 @@ The **Infrastructure** tab provides information about the containers, pods, and IT ops and software reliability engineers (SREs) can use this tab to quickly find a service’s underlying infrastructure resources when debugging a problem. Knowing what infrastructure is related to a service allows you to remediate issues by restarting, killing hanging instances, changing configuration, rolling back deployments, scaling up, scaling out, and so on. -::::{admonition} Why is the infrastructure tab empty? -:class: tip +::::{tip} +**Why is the infrastructure tab empty?** If there is no data in the Application UI’s infrastructure tab for a selected service, you can read more about why this happens and how to fix it in the [troubleshooting docs](../../../troubleshoot/observability/apm/common-problems.md#troubleshooting-apm-infra-data). diff --git a/solutions/observability/apps/inspect-uptime-duration-anomalies.md b/solutions/observability/apps/inspect-uptime-duration-anomalies.md index 06c7bad9ba..c3f74b577d 100644 --- a/solutions/observability/apps/inspect-uptime-duration-anomalies.md +++ b/solutions/observability/apps/inspect-uptime-duration-anomalies.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/inspect-uptime-duration-anomalies.html +applies_to: + stack: all --- # Inspect uptime duration anomalies [inspect-uptime-duration-anomalies] diff --git a/solutions/observability/apps/installation-layout.md b/solutions/observability/apps/installation-layout.md index d35de60f55..a57581cdbb 100644 --- a/solutions/observability/apps/installation-layout.md +++ b/solutions/observability/apps/installation-layout.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-directory-layout.html +applies_to: + stack: all --- # Installation layout [apm-directory-layout] @@ -8,7 +10,7 @@ mapped_pages: View the installation layout and default paths for both Fleet-managed APM Server and the APM Server binary. -## Fleet-managed [_fleet_managed] +## Fleet-managed [_fleet_managed] {{agent}} files are installed in the following locations. You cannot override these installation paths because they are required for upgrades. @@ -104,7 +106,7 @@ You can install {{agent}} in a custom base path other than `C:\Program Files`. ::::::: -## APM Server binary [_apm_server_binary] +## APM Server binary [_apm_server_binary] APM Server uses the following default paths unless you explicitly change them. diff --git a/solutions/observability/apps/integrate-with-jaeger-deprecated.md b/solutions/observability/apps/integrate-with-jaeger-deprecated.md index 7669265bb1..728306b8a8 100644 --- a/solutions/observability/apps/integrate-with-jaeger-deprecated.md +++ b/solutions/observability/apps/integrate-with-jaeger-deprecated.md @@ -2,6 +2,8 @@ navigation_title: "Jaeger (deprecated)" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-jaeger-integration.html +applies_to: + stack: all --- @@ -51,7 +53,7 @@ The APM integration serves Jaeger gRPC over the same host and port as the Elasti ::::::{tab-item} {{ecloud}} 1. Log into [{{ecloud}}](https://cloud.elastic.co?page=docs&placement=docs-body) and select your deployment. 2. In {{kib}}, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). -3. 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. +3. 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. 4. Configure the APM Integration as a collector for your Jaeger agents. As of this writing, the Jaeger agent binary offers the following CLI flags, which can be used to enable TLS, output to {{ecloud}}, and set the APM Integration secret token: @@ -69,7 +71,7 @@ For the equivalent environment variables, change all letters to upper-case and r :::::: ::::::{tab-item} Self-managed -1. Configure the APM Integration as a collector for your Jaeger agents. In {{kib}}, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). 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. +1. Configure the APM Integration as a collector for your Jaeger agents. In {{kib}}, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). 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. As of this writing, the Jaeger agent binary offers the `--reporter.grpc.host-port` CLI flag. Use this to define the host and port that the APM Integration is listening on: diff --git a/solutions/observability/apps/interpret-application-data.md b/solutions/observability/apps/interpret-application-data.md index 66c0cc57c8..8a3fa36a18 100644 --- a/solutions/observability/apps/interpret-application-data.md +++ b/solutions/observability/apps/interpret-application-data.md @@ -17,5 +17,5 @@ Learn how to get the most out of your data using the Applications UI. | --- | --- | | [Finding transaction latency and failure correlations](../../../solutions/observability/apps/find-transaction-latency-failure-correlations.md) | Surface characteristics of your data that are potentially correlated with high-latency or erroneous transactions. | | [Tracking deployments with annotations](../../../solutions/observability/apps/track-deployments-with-annotations.md) | Annotations enable you to easily determine if your deployment has increased response times for an end-user or if the memory/CPU footprint of your application has changed. | -| [Exploring mobile sessions with Discover](../../../solutions/observability/apps/explore-mobile-sessions-with-discover.md) | Use session tracking via a globally unique identifier to explore the activities of a specific user during a specific period of time. | +| [Exploring mobile sessions with Discover](../../../solutions/observability/apps/explore-mobile-sessions-with-discover.md) | **Elastic Stack only:** Use session tracking via a globally unique identifier to explore the activities of a specific user during a specific period of time. | | [Observing Lambda functions](../../../solutions/observability/apps/observe-lambda-functions.md) | Learn how your AWS Lambda functions relate to and depend on other services, and get insight into function execution and runtime behavior, like lambda duration, cold start rate, cold start duration, compute usage, memory usage, and more. | \ No newline at end of file diff --git a/solutions/observability/apps/limitations.md b/solutions/observability/apps/limitations.md index f456a3aebf..4596734d69 100644 --- a/solutions/observability/apps/limitations.md +++ b/solutions/observability/apps/limitations.md @@ -34,6 +34,9 @@ The [OpenTelemetry Collector exporter for Elastic](https://github.com/open-telem % Statefull only for tail-based sampling? ## OpenTelemetry’s tail-based sampling [apm-open-telemetry-tbs] +```{applies_to} +stack: all +``` Tail-based sampling allows to make sampling decisions after all spans of a trace have been completed. This allows for more powerful and informed sampling rules. diff --git a/solutions/observability/apps/logs.md b/solutions/observability/apps/logs.md index 94367245fe..014a0896a9 100644 --- a/solutions/observability/apps/logs.md +++ b/solutions/observability/apps/logs.md @@ -24,6 +24,9 @@ Logs displayed on this page are filtered on `service.name` :::: ## Integrate with logging frameworks [apm-logs-correlation] +```{applies_to} +stack: all +``` Elastic APM integrates with popular logging frameworks, making it easy to correlate your logs and traces. This enables you to: diff --git a/solutions/observability/apps/manage-data-retention.md b/solutions/observability/apps/manage-data-retention.md index 83c064b032..7699f3c629 100644 --- a/solutions/observability/apps/manage-data-retention.md +++ b/solutions/observability/apps/manage-data-retention.md @@ -49,7 +49,7 @@ To find Synthetics data streams: :::{tab-item} Serverless :sync: serverless -1. Navigate to **Project settings** → **Management*** → ***Index Management** → **Data Streams**. +1. Navigate to **Project settings** → **Management** → **Index Management** → **Data Streams**. 2. Filter the list of data streams for those containing the term `synthetics`. 1. In the UI there will be three types of browser data streams: `synthetics-browser-*`, `synthetics-browser.network-*`, and `synthetics-browser.screenshot-*`. diff --git a/solutions/observability/apps/metrics.md b/solutions/observability/apps/metrics.md index ac4ceba49a..f7feec20e9 100644 --- a/solutions/observability/apps/metrics.md +++ b/solutions/observability/apps/metrics.md @@ -1162,7 +1162,7 @@ Note that all the below limits may change in the future with further improvement * For service-summary metrics, there is no additional limit. -In the above, a service is defined as a combination of `service.name`, `service.environment`, `service.language.name` and `agent.name`. +In the previous metrics, a service is defined as a combination of `service.name`, `service.environment`, `service.language.name` and `agent.name`. ### Overflows [_overflows] diff --git a/solutions/observability/apps/mobile-service-overview.md b/solutions/observability/apps/mobile-service-overview.md index 4fae7a47e6..511ed3d15a 100644 --- a/solutions/observability/apps/mobile-service-overview.md +++ b/solutions/observability/apps/mobile-service-overview.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-mobile-service-overview.html +applies_to: + stack: all --- # Mobile service overview [apm-mobile-service-overview] @@ -27,6 +29,7 @@ Understand the impact of slow application load times and variations in applicati Note: due to the way crash rate is calculated (crashes per session) it is possible to have greater than 100% rate, due to fact that a session may contain multiple crashes. + :::{image} ../../../images/observability-mobile-location.png :alt: mobile service overview centered on location map :class: screenshot @@ -37,6 +40,7 @@ Note: due to the way crash rate is calculated (crashes per session) it is possib Optimize your end-user experience and your application QA strategy based on your most used device models and operating system versions. + :::{image} ../../../images/observability-mobile-most-used.png :alt: mobile service overview showing most used devices :class: screenshot @@ -51,6 +55,7 @@ The **Transactions** table displays a list of *transaction groups* for the selec By default, transaction groups are sorted by *Impact* to show the most used and slowest endpoints in your service. If there is a particular endpoint you are interested in, click **View transactions** to view a list of similar transactions on the [transactions overview](transactions-2.md) page. + :::{image} ../../../images/observability-traffic-transactions.png :alt: Traffic and transactions :class: screenshot @@ -73,6 +78,7 @@ If there is no HTTP status, both transactions and spans are considered successfu The **Dependencies** table displays a list of downstream services or external connections relevant to the service at the selected time range. The table displays latency, throughput, failed transaction rate, and the impact of each dependency. By default, dependencies are sorted by *Impact* to show the most used and the slowest dependency. If there is a particular dependency you are interested in, click **[View dependencies](dependencies.md)** to learn more about it. + ::::{note} Displaying dependencies for services instrumented with the Real User Monitoring (RUM) agent requires an agent version ≥ v5.6.3. :::: @@ -83,6 +89,7 @@ Displaying dependencies for services instrumented with the Real User Monitoring :class: screenshot ::: + :::{image} ../../../images/observability-mobile-tp.png :alt: mobile service overview showing latency :class: screenshot diff --git a/solutions/observability/apps/monitor-apm-server-binary.md b/solutions/observability/apps/monitor-apm-server-binary.md index dcf1596779..20e28434d6 100644 --- a/solutions/observability/apps/monitor-apm-server-binary.md +++ b/solutions/observability/apps/monitor-apm-server-binary.md @@ -2,10 +2,10 @@ navigation_title: "APM Server binary" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-monitoring.html +applies_to: + stack: all --- - - # Monitor the APM Server binary [apm-monitoring] @@ -13,8 +13,4 @@ There are two methods to monitor the APM Server binary. Make sure monitoring is * [Internal collection](use-internal-collection-to-send-monitoring-data.md) - Internal collectors send monitoring data directly to your monitoring cluster. * [{{metricbeat}} collection](use-metricbeat-to-send-monitoring-data.md) - {{metricbeat}} collects monitoring data from your APM Server instance and sends it directly to your monitoring cluster. -* [Local collection](use-select-metrics-emitted-directly-to-monitoring-cluster.md) - Local collection sends select monitoring data directly to the standard indices of your monitoring cluster. - - - - +* [Local collection](use-select-metrics-emitted-directly-to-monitoring-cluster.md) - Local collection sends select monitoring data directly to the standard indices of your monitoring cluster. \ No newline at end of file diff --git a/solutions/observability/apps/monitor-apm-server.md b/solutions/observability/apps/monitor-apm-server.md index acb28280b3..4fa00156ac 100644 --- a/solutions/observability/apps/monitor-apm-server.md +++ b/solutions/observability/apps/monitor-apm-server.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-monitor-apm.html +applies_to: + stack: all --- # Monitor APM Server [apm-monitor-apm] diff --git a/solutions/observability/apps/monitor-fleet-managed-apm-server.md b/solutions/observability/apps/monitor-fleet-managed-apm-server.md index d8567eceea..91b9b3d99d 100644 --- a/solutions/observability/apps/monitor-fleet-managed-apm-server.md +++ b/solutions/observability/apps/monitor-fleet-managed-apm-server.md @@ -2,6 +2,8 @@ navigation_title: "Fleet-managed" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-monitor-apm-self-install.html +applies_to: + stack: all --- diff --git a/solutions/observability/apps/monitor-resources-on-private-networks.md b/solutions/observability/apps/monitor-resources-on-private-networks.md index d95561232a..17c04220a9 100644 --- a/solutions/observability/apps/monitor-resources-on-private-networks.md +++ b/solutions/observability/apps/monitor-resources-on-private-networks.md @@ -50,9 +50,9 @@ By default {{private-location}}s are configured to allow two simultaneous browse :::: -## Connect to the {{stack}} or your Observability serverless project [synthetics-private-location-connect] +## Connect to the {{stack}} or your Observability Serverless project [synthetics-private-location-connect] -After setting up {{fleet}}, you’ll connect {{fleet}} to the {{stack}} or your Observability serverless project and enroll an {{agent}} in {{fleet}}. +After setting up {{fleet}}, you’ll connect {{fleet}} to the {{stack}} or your Observability Serverless project and enroll an {{agent}} in {{fleet}}. Elastic provides Docker images that you can use to run {{fleet}} and an {{agent}} more easily. For monitors running on {{private-location}}s, you *must* use the `elastic-agent-complete` Docker image to create a self-hosted {{agent}} node. The standard {{ecloud}} or self-hosted {{agent}} will not work. diff --git a/solutions/observability/apps/observe-lambda-functions.md b/solutions/observability/apps/observe-lambda-functions.md index 428b140d81..4e2117bb28 100644 --- a/solutions/observability/apps/observe-lambda-functions.md +++ b/solutions/observability/apps/observe-lambda-functions.md @@ -34,11 +34,6 @@ Cold start is also displayed in the trace waterfall, where you can drill-down in The [latency correlations](../../../solutions/observability/apps/find-transaction-latency-failure-correlations.md) feature can be used to visualize the impact of Lambda cold starts on latency—​just select the `faas.coldstart` field. -:::{image} ../../../images/observability-lambda-correlations.png -:alt: lambda correlations example -:class: screenshot -::: - ## AWS Lambda function grouping [apm-lambda-service-config] diff --git a/solutions/observability/apps/overviews.md b/solutions/observability/apps/overviews.md index f7d97dd042..310f3a9326 100644 --- a/solutions/observability/apps/overviews.md +++ b/solutions/observability/apps/overviews.md @@ -16,7 +16,11 @@ For a quick, high-level overview of the health and performance of your applicati * [Dependencies](../../../solutions/observability/apps/dependencies.md) * [Service Map](../../../solutions/observability/apps/service-map.md) -% Stateful for mobile service? + +## View an individual service [apm-ui-individual-service] +```{applies_to} +stack: all +``` View an individual service: diff --git a/solutions/observability/apps/parse-data-using-ingest-pipelines.md b/solutions/observability/apps/parse-data-using-ingest-pipelines.md index 5ef9bd19a5..f8b39033ad 100644 --- a/solutions/observability/apps/parse-data-using-ingest-pipelines.md +++ b/solutions/observability/apps/parse-data-using-ingest-pipelines.md @@ -10,7 +10,7 @@ Ingest pipelines preprocess and enrich APM documents before indexing them. For e The default APM pipelines are defined in {{es}} apm-data plugin index templates. {{es}} then uses the index pattern in these index templates to match pipelines to APM data streams. -## Custom ingest pipelines [custom-ingest-pipelines] +## Custom ingest pipelines [custom-ingest-pipelines] Elastic APM supports custom ingest pipelines. A custom pipeline allows you to transform data to better match your specific use case. This can be useful, for example, to ensure data security by removing or obfuscating sensitive information. @@ -19,12 +19,12 @@ Each data stream ships with a default pipeline. This default pipeline calls an i In addition, ingest pipelines can also be used to direct application metrics (`metrics-apm.app.*`) to a data stream with a different dataset, e.g. to combine metrics for two applications. Sending other APM data to alternate data streams, like traces (`traces-apm.*`), logs (`logs-apm.*`), and internal metrics (`metrics-apm.internal*`) is not currently supported. -## `@custom` ingest pipeline naming convention [custom-ingest-pipeline-naming] +## `@custom` ingest pipeline naming convention [custom-ingest-pipeline-naming] `@custom` pipelines are specific to each data stream and follow a similar naming convention: `-@custom`. As a reminder, the default APM data streams are: * Application traces: `traces-apm-` -* RUM and iOS agent application traces: `traces-apm.rum-` +* RUM and iOS agent application traces (Elastic Stack only): `traces-apm.rum-` * APM internal metrics: `metrics-apm.internal-` * APM transaction metrics: `metrics-apm.transaction.-` * APM service destination metrics: `metrics-apm.service_destination.-` @@ -39,7 +39,7 @@ To match a custom ingest pipeline with a data stream, follow the `-`. Services that match the query within the last 24 hours will be assigned to the group. -::: - -:::{tab-item} Serverless -:sync: serverless - -1. In your {{obs-serverless}} project, go to **Applications** → **Service Inventory**. -2. Switch to **Service groups**. -3. Click **Create group**. -4. Specify a name, color, and description. -5. Click **Select services**. -6. Specify a [Kibana Query Language (KQL)](../../../explore-analyze/query-filter/languages/kql.md) query to filter services by one or more of the following dimensions: `agent.name`, `service.name`, `service.language.name`, `service.environment`, `labels.`. Services that match the query within the last 24 hours will be assigned to the group. - -::: - -:::: - - ### Examples [apm-services-examples] Not sure where to get started? Here are some sample queries you can build from: diff --git a/solutions/observability/apps/ssltls-input-settings.md b/solutions/observability/apps/ssltls-input-settings.md index 464edf1e6b..2dce7d25f9 100644 --- a/solutions/observability/apps/ssltls-input-settings.md +++ b/solutions/observability/apps/ssltls-input-settings.md @@ -1,11 +1,13 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-agent-server-ssl.html +applies_to: + stack: all --- # SSL/TLS input settings [apm-agent-server-ssl] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "") Most options on this page are supported by all APM Server deployment methods. diff --git a/solutions/observability/apps/ssltls-output-settings.md b/solutions/observability/apps/ssltls-output-settings.md index 1bc35db76a..6cc22c06d1 100644 --- a/solutions/observability/apps/ssltls-output-settings.md +++ b/solutions/observability/apps/ssltls-output-settings.md @@ -1,11 +1,13 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuration-ssl.html +applies_to: + stack: all --- # SSL/TLS output settings [apm-configuration-ssl] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") These configuration options are only relevant to APM Server binary users. Fleet-managed users should see the [Fleet output settings](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/fleet-settings.md). diff --git a/solutions/observability/apps/ssltls-settings.md b/solutions/observability/apps/ssltls-settings.md index 1fdc960818..bef159623e 100644 --- a/solutions/observability/apps/ssltls-settings.md +++ b/solutions/observability/apps/ssltls-settings.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configuration-ssl-landing.html +applies_to: + stack: all --- # SSL/TLS settings [apm-configuration-ssl-landing] diff --git a/solutions/observability/apps/storage-explorer.md b/solutions/observability/apps/storage-explorer.md index 148e15ccf4..79d415125f 100644 --- a/solutions/observability/apps/storage-explorer.md +++ b/solutions/observability/apps/storage-explorer.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-storage-explorer.html +applies_to: + stack: all --- # Storage Explorer [apm-storage-explorer] @@ -38,7 +40,7 @@ The service statistics table provides detailed information on each service: * A list of **service environments**. * The **sampling rate**. This value is calculated by dividing the number of sampled transactions by total throughput. It might differ from the configured sampling rate for two reasons: with head-based sampling, the initial service makes the sampling decision, and with tail-based sampling, granular policies allow you to set multiple sample rates. * The estimated **size on disk**. This storage size includes both primary and replica shards and is calculated by prorating the total size of your indices by the service’s document count divided by the total number of documents. -* Number of **transactions**, **spans***, ***errors**, and **metrics** — doc count and size on disk. +* Number of **transactions**, **spans**, **errors**, and **metrics** — doc count and size on disk. :::{image} ../../../images/observability-storage-explorer-expanded.png :alt: APM Storage Explorer service breakdown diff --git a/solutions/observability/apps/switch-an-elastic-cloud-cluster-to-apm-integration.md b/solutions/observability/apps/switch-an-elastic-cloud-cluster-to-apm-integration.md index da487aeebd..c1caa86b5e 100644 --- a/solutions/observability/apps/switch-an-elastic-cloud-cluster-to-apm-integration.md +++ b/solutions/observability/apps/switch-an-elastic-cloud-cluster-to-apm-integration.md @@ -46,7 +46,7 @@ With a Superuser account, complete the following steps: You can now update settings that were removed during the upgrade. See [Configure APM Server](configure-apm-server.md) for a reference of all available settings. -In {{kib}}, navigate to **Management** > **Fleet***. Select the ***Elastic Cloud Agent Policy***. Next to the ***Elastic APM*** integration, select ***Actions** > **Edit integration**. +In {{kib}}, navigate to **Management** > **Fleet**. Select the **Elastic Cloud Agent Policy**. Next to the **Elastic APM** integration, select **Actions** > **Edit integration**. ## Scale APM and {{fleet}} [apm-integration-upgrade-ess-4] diff --git a/solutions/observability/apps/tail-based-sampling.md b/solutions/observability/apps/tail-based-sampling.md index 3fc340701c..1f18833e4e 100644 --- a/solutions/observability/apps/tail-based-sampling.md +++ b/solutions/observability/apps/tail-based-sampling.md @@ -1,11 +1,13 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-tail-based-samling-config.html +applies_to: + stack: all --- # Tail-based sampling [apm-tail-based-samling-config] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "") Most options on this page are supported by all APM Server deployment methods when writing to {{es}}. If you are using a different [output](configure-output.md), tail-based sampling is *not* supported. diff --git a/solutions/observability/apps/track-deployments-with-annotations.md b/solutions/observability/apps/track-deployments-with-annotations.md index 043f90bc45..91e9d459ba 100644 --- a/solutions/observability/apps/track-deployments-with-annotations.md +++ b/solutions/observability/apps/track-deployments-with-annotations.md @@ -8,10 +8,9 @@ navigation_title: "Track deployments with annotations" # Track deployments with annotations [apm-transactions-annotations] -::::{admonition} Required role -:class: note +::::{note} -For Observability serverless projects, the **Admin** role or higher is required to create and manage annotations. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). +**For Observability Serverless projects**, the **Admin** role or higher is required to create and manage annotations. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles). :::: diff --git a/solutions/observability/apps/transaction-sampling.md b/solutions/observability/apps/transaction-sampling.md index b7fa3dff7e..8ddb76973a 100644 --- a/solutions/observability/apps/transaction-sampling.md +++ b/solutions/observability/apps/transaction-sampling.md @@ -95,14 +95,15 @@ Refer to the documentation of your favorite OpenTelemetry agent or SDK for more % Stateful only for tail-based sampling ## Tail-based sampling [apm-tail-based-sampling] +```{applies_to} +stack: all +``` -::::{admonition} Support for tail-based sampling -:class: note +::::{note} +**Support for tail-based sampling** Tail-based sampling is only supported when writing to {{es}}. If you are using a different [output](../../../solutions/observability/apps/configure-output.md), tail-based sampling is *not* supported. -Tail-based sampling is *not* compatible with [{{serverless-full}}](https://docs.elastic.co/serverless). - :::: diff --git a/solutions/observability/apps/transactions-2.md b/solutions/observability/apps/transactions-2.md index 828bc81e9c..9f276d95af 100644 --- a/solutions/observability/apps/transactions-2.md +++ b/solutions/observability/apps/transactions-2.md @@ -17,13 +17,13 @@ A *transaction* describes an event captured by an Elastic APM agent instrumentin The **Latency**, **Throughput**, **Failed transaction rate**, **Time spent by span type**, and **Cold start rate** charts display information on all transactions associated with the selected service: **Latency** -: Response times for the service. Options include average, 95th, and 99th percentile. If there’s a weird spike that you’d like to investigate, you can simply zoom in on the graph - this will adjust the specific time range, and all of the data on the page will update accordingly. + Response times for the service. Options include average, 95th, and 99th percentile. If there’s a weird spike that you’d like to investigate, you can simply zoom in on the graph - this will adjust the specific time range, and all of the data on the page will update accordingly. **Throughput** -: Visualize response codes: `2xx`, `3xx`, `4xx`, etc. Useful for determining if more responses than usual are being served with a particular response code. Like in the latency graph, you can zoom in on anomalies to further investigate them. + Visualize response codes: `2xx`, `3xx`, `4xx`, etc. Useful for determining if more responses than usual are being served with a particular response code. Like in the latency graph, you can zoom in on anomalies to further investigate them. **Failed transaction rate** -: The failed transaction rate represents the percentage of failed transactions from the perspective of the selected service. It’s useful for visualizing unexpected increases, decreases, or irregular patterns in a service’s transactions. + The failed transaction rate represents the percentage of failed transactions from the perspective of the selected service. It’s useful for visualizing unexpected increases, decreases, or irregular patterns in a service’s transactions. ::::{tip} HTTP **transactions** from the HTTP server perspective do not consider a `4xx` status code (client error) as a failure because the failure was caused by the caller, not the HTTP server. Thus, `event.outcome=success` and there will be no increase in failed transaction rate. @@ -36,7 +36,7 @@ The **Latency**, **Throughput**, **Failed transaction rate**, **Time spent by sp **Time spent by span type** -: Visualize where your application is spending most of its time. For example, is your app spending time in external calls, database processing, or application code execution? + Visualize where your application is spending most of its time. For example, is your app spending time in external calls, database processing, or application code execution? The time a transaction took to complete is also recorded and displayed on the chart under the "app" label. "app" indicates that something was happening within the application, but we’re not sure exactly what. This could be a sign that the APM agent does not have auto-instrumentation for whatever was happening during that time. @@ -44,7 +44,7 @@ The **Latency**, **Throughput**, **Failed transaction rate**, **Time spent by sp **Cold start rate** -: Only applicable to serverless transactions, this chart displays the percentage of requests that trigger a cold start of a serverless function. See [Cold starts](../../../solutions/observability/apps/observe-lambda-functions.md#apm-lambda-cold-start-info) for more information. + Only applicable to serverless transactions, this chart displays the percentage of requests that trigger a cold start of a serverless function. See [Cold starts](../../../solutions/observability/apps/observe-lambda-functions.md#apm-lambda-cold-start-info) for more information. ## Transactions table [transactions-table] diff --git a/solutions/observability/apps/tune-data-ingestion.md b/solutions/observability/apps/tune-data-ingestion.md index aa584c0a7d..c0e257923f 100644 --- a/solutions/observability/apps/tune-data-ingestion.md +++ b/solutions/observability/apps/tune-data-ingestion.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-tune-data-ingestion.html +applies_to: + stack: all --- # Tune data ingestion [apm-tune-data-ingestion] diff --git a/solutions/observability/apps/upstream-opentelemetry-collectors-language-sdks.md b/solutions/observability/apps/upstream-opentelemetry-collectors-language-sdks.md index 99fe4d9f9d..4dc6910602 100644 --- a/solutions/observability/apps/upstream-opentelemetry-collectors-language-sdks.md +++ b/solutions/observability/apps/upstream-opentelemetry-collectors-language-sdks.md @@ -173,7 +173,9 @@ java -javaagent:/path/to/opentelemetry-javaagent-all.jar \ com.mycompany.checkout.CheckoutServiceServer ``` -1. [preview] The OpenTelemetry logs intake via APM Server is currently in technical preview.`OTEL_RESOURCE_ATTRIBUTES` +1. [preview] The OpenTelemetry logs intake via APM Server is currently in technical preview. + +`OTEL_RESOURCE_ATTRIBUTES` : Fields that describe the service and the environment that the service runs in. See [resource attributes](../../../solutions/observability/apps/resource-atrributes.md) for more information. `OTEL_EXPORTER_OTLP_ENDPOINT` @@ -213,7 +215,9 @@ java -javaagent:/path/to/opentelemetry-javaagent-all.jar \ com.mycompany.checkout.CheckoutServiceServer ``` -1. [preview] The OpenTelemetry logs intake via Elastic is currently in technical preview.`OTEL_RESOURCE_ATTRIBUTES` +1. [preview] The OpenTelemetry logs intake via Elastic is currently in technical preview. + +`OTEL_RESOURCE_ATTRIBUTES` : Fields that describe the service and the environment that the service runs in. See [resource attributes](../../../solutions/observability/apps/resource-atrributes.md) for more information. `OTEL_EXPORTER_OTLP_ENDPOINT` diff --git a/solutions/observability/apps/uptime-monitoring-deprecated.md b/solutions/observability/apps/uptime-monitoring-deprecated.md index 1923e31daa..22ffbd85ab 100644 --- a/solutions/observability/apps/uptime-monitoring-deprecated.md +++ b/solutions/observability/apps/uptime-monitoring-deprecated.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/uptime-intro.html +applies_to: + stack: all --- # Uptime monitoring (deprecated) [uptime-intro] diff --git a/solutions/observability/apps/use-advanced-queries-on-application-data.md b/solutions/observability/apps/use-advanced-queries-on-application-data.md index 69f7fa9699..78a5146307 100644 --- a/solutions/observability/apps/use-advanced-queries-on-application-data.md +++ b/solutions/observability/apps/use-advanced-queries-on-application-data.md @@ -28,7 +28,7 @@ To learn more about the {{kib}} query language capabilities, see the [Kibana Que :::: -### Applications UI queries [apm-app-queries] +### APM queries [apm-app-queries] APM queries can be handy for removing noise from your data in the [Services](../../../solutions/observability/apps/services.md), [Transactions](../../../solutions/observability/apps/transactions-2.md), [Errors](../../../solutions/observability/apps/errors-2.md), [Metrics](../../../solutions/observability/apps/metrics-2.md), and [Traces](../../../solutions/observability/apps/traces-2.md) views. diff --git a/solutions/observability/apps/use-environment-variables-in-configuration.md b/solutions/observability/apps/use-environment-variables-in-configuration.md index 1d55697e30..0f040e4d0e 100644 --- a/solutions/observability/apps/use-environment-variables-in-configuration.md +++ b/solutions/observability/apps/use-environment-variables-in-configuration.md @@ -1,11 +1,13 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-config-env.html +applies_to: + stack: all --- # Use environment variables in the configuration [apm-config-env] -::::{admonition} +::::{note} ![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "") This documentation is only relevant for APM Server binary users. diff --git a/solutions/observability/apps/use-internal-collection-to-send-monitoring-data.md b/solutions/observability/apps/use-internal-collection-to-send-monitoring-data.md index 37a2118a16..c95fda3d5c 100644 --- a/solutions/observability/apps/use-internal-collection-to-send-monitoring-data.md +++ b/solutions/observability/apps/use-internal-collection-to-send-monitoring-data.md @@ -2,10 +2,10 @@ navigation_title: "Use internal collection" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-monitoring-internal-collection.html +applies_to: + stack: all --- - - # Use internal collection to send monitoring data [apm-monitoring-internal-collection] @@ -73,106 +73,106 @@ Use internal collectors to send {{beats}} monitoring data directly to your monit 4. [View the monitoring data in {{kib}}](../../../deploy-manage/monitor/stack-monitoring/kibana-monitoring-data.md). -## Settings for internal collection [apm-configuration-monitor] +## Settings for internal collection [apm-configuration-monitor] Use the following settings to configure internal collection when you are not using {{metricbeat}} to collect monitoring data. You specify these settings in the X-Pack monitoring section of the `apm-server.yml` config file: -### `monitoring.enabled` [_monitoring_enabled] +### `monitoring.enabled` [_monitoring_enabled] The `monitoring.enabled` config is a boolean setting to enable or disable {{monitoring}}. If set to `true`, monitoring is enabled. The default value is `false`. -### `monitoring.elasticsearch` [_monitoring_elasticsearch] +### `monitoring.elasticsearch` [_monitoring_elasticsearch] The {{es}} instances that you want to ship your APM Server metrics to. This configuration option contains the following fields: -#### `api_key` [_api_key_3] +#### `api_key` [_api_key_3] The detail of the API key to be used to send monitoring information to {{es}}. See [Grant access using API keys](grant-access-using-api-keys.md) for more information. -#### `bulk_max_size` [_bulk_max_size_5] +#### `bulk_max_size` [_bulk_max_size_5] The maximum number of metrics to bulk in a single {{es}} bulk API index request. The default is `50`. For more information, see [{{es}}](configure-elasticsearch-output.md). -#### `backoff.init` [_backoff_init_5] +#### `backoff.init` [_backoff_init_5] The number of seconds to wait before trying to reconnect to {{es}} after a network error. After waiting `backoff.init` seconds, APM Server tries to reconnect. If the attempt fails, the backoff timer is increased exponentially up to `backoff.max`. After a successful connection, the backoff timer is reset. The default is `1s`. -#### `backoff.max` [_backoff_max_5] +#### `backoff.max` [_backoff_max_5] The maximum number of seconds to wait before attempting to connect to {{es}} after a network error. The default is `60s`. -#### `compression_level` [_compression_level_4] +#### `compression_level` [_compression_level_4] The gzip compression level. Setting this value to `0` disables compression. The compression level must be in the range of `1` (best speed) to `9` (best compression). The default value is `0`. Increasing the compression level reduces the network usage but increases the CPU usage. -#### `headers` [_headers_2] +#### `headers` [_headers_2] Custom HTTP headers to add to each request. For more information, see [{{es}}](configure-elasticsearch-output.md). -#### `hosts` [_hosts_4] +#### `hosts` [_hosts_4] The list of {{es}} nodes to connect to. Monitoring metrics are distributed to these nodes in round robin order. For more information, see [{{es}}](configure-elasticsearch-output.md). -#### `max_retries` [_max_retries_5] +#### `max_retries` [_max_retries_5] The number of times to retry sending the monitoring metrics after a failure. After the specified number of retries, the metrics are typically dropped. The default value is `3`. For more information, see [{{es}}](configure-elasticsearch-output.md). -#### `parameters` [_parameters_2] +#### `parameters` [_parameters_2] Dictionary of HTTP parameters to pass within the URL with index operations. -#### `password` [_password_4] +#### `password` [_password_4] The password that APM Server uses to authenticate with the {{es}} instances for shipping monitoring data. -#### `metrics.period` [_metrics_period] +#### `metrics.period` [_metrics_period] The time interval (in seconds) when metrics are sent to the {{es}} cluster. A new snapshot of APM Server metrics is generated and scheduled for publishing each period. The default value is 10 * time.Second. -#### `state.period` [_state_period] +#### `state.period` [_state_period] The time interval (in seconds) when state information are sent to the {{es}} cluster. A new snapshot of APM Server state is generated and scheduled for publishing each period. The default value is 60 * time.Second. -#### `protocol` [_protocol] +#### `protocol` [_protocol] The name of the protocol to use when connecting to the {{es}} cluster. The options are: `http` or `https`. The default is `http`. If you specify a URL for `hosts`, however, the value of protocol is overridden by the scheme you specify in the URL. -#### `proxy_url` [_proxy_url_4] +#### `proxy_url` [_proxy_url_4] The URL of the proxy to use when connecting to the {{es}} cluster. For more information, see [{{es}}](configure-elasticsearch-output.md). -#### `timeout` [_timeout_5] +#### `timeout` [_timeout_5] The HTTP request timeout in seconds for the {{es}} request. The default is `90`. -#### `ssl` [_ssl_5] +#### `ssl` [_ssl_5] Configuration options for Transport Layer Security (TLS) or Secure Sockets Layer (SSL) parameters like the certificate authority (CA) to use for HTTPS-based connections. If the `ssl` section is missing, the host CAs are used for HTTPS connections to {{es}}. For more information, see [SSL/TLS output settings](ssltls-output-settings.md). -#### `username` [_username_3] +#### `username` [_username_3] The user ID that APM Server uses to authenticate with the {{es}} instances for shipping monitoring data. diff --git a/solutions/observability/apps/use-metricbeat-to-send-monitoring-data.md b/solutions/observability/apps/use-metricbeat-to-send-monitoring-data.md index 3d989d4856..aa5831efe1 100644 --- a/solutions/observability/apps/use-metricbeat-to-send-monitoring-data.md +++ b/solutions/observability/apps/use-metricbeat-to-send-monitoring-data.md @@ -2,10 +2,10 @@ navigation_title: "Use {{metricbeat}} collection" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-monitoring-metricbeat-collection.html +applies_to: + stack: all --- - - # Use Metricbeat to send monitoring data [apm-monitoring-metricbeat-collection] @@ -17,7 +17,7 @@ To collect and ship monitoring data: 2. [Install and configure {{metricbeat}} to collect monitoring data](#apm-configure-metricbeat) -## Configure the shipper you want to monitor [apm-configure-shipper] +## Configure the shipper you want to monitor [apm-configure-shipper] 1. Enable the HTTP endpoint to allow external collection of monitoring data: @@ -62,7 +62,7 @@ To collect and ship monitoring data: 5. Start APM Server. -## Install and configure {{metricbeat}} to collect monitoring data [apm-configure-metricbeat] +## Install and configure {{metricbeat}} to collect monitoring data [apm-configure-metricbeat] 1. Install {{metricbeat}} on the same server as APM Server. To learn how, see [Get started with {{metricbeat}}](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-installation-configuration.md). If you already have {{metricbeat}} installed on the server, skip this step. 2. Enable the `beat-xpack` module in {{metricbeat}}.
@@ -118,7 +118,7 @@ To collect and ship monitoring data: 5. Identify where to send the monitoring data.
- ::::{tip} + ::::{tip} In production environments, we strongly recommend using a separate cluster (referred to as the *monitoring cluster*) to store the data. Using a separate monitoring cluster prevents production cluster outages from impacting your ability to access your monitoring data. It also prevents monitoring activities from impacting the performance of your production cluster. :::: @@ -143,7 +143,7 @@ To collect and ship monitoring data: If you configured the monitoring cluster to use encrypted communications, you must access it via HTTPS. For example, use a `hosts` setting like `https://es-mon-1:9200`. - ::::{important} + ::::{important} The {{es}} {{monitor-features}} use ingest pipelines, therefore the cluster that stores the monitoring data must have at least one ingest node. :::: @@ -152,7 +152,7 @@ To collect and ship monitoring data: 1. Create a user on the monitoring cluster that has the `remote_monitoring_agent` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md). Alternatively, if it’s available in your environment, use the `remote_monitoring_user` [built-in user](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md). - ::::{tip} + ::::{tip} If you’re using {{ilm}}, the remote monitoring user requires additional privileges to create and read indices. For more information, see [Use feature roles](create-assign-feature-roles-to-apm-server-users.md). :::: diff --git a/solutions/observability/apps/use-opentelemetry-with-apm.md b/solutions/observability/apps/use-opentelemetry-with-apm.md index acbf96558a..158326190d 100644 --- a/solutions/observability/apps/use-opentelemetry-with-apm.md +++ b/solutions/observability/apps/use-opentelemetry-with-apm.md @@ -1,16 +1,15 @@ --- +navigation_title: "OpenTelemetry" mapped_urls: - https://www.elastic.co/guide/en/serverless/current/observability-apm-agents-opentelemetry.html - https://www.elastic.co/guide/en/observability/current/apm-open-telemetry.html - -navigation_title: "OpenTelemetry" --- # Use OpenTelemetry with APM [apm-open-telemetry] ::::{note} -For a complete overview of using OpenTelemetry with Elastic, explore** [**Elastic Distributions of OpenTelemetry**](https://github.com/elastic/opentelemetry). +For a complete overview of using OpenTelemetry with Elastic, explore [**Elastic Distributions of OpenTelemetry**](https://github.com/elastic/opentelemetry). :::: diff --git a/solutions/observability/apps/use-select-metrics-emitted-directly-to-monitoring-cluster.md b/solutions/observability/apps/use-select-metrics-emitted-directly-to-monitoring-cluster.md index f9d038ced6..0cb53f746b 100644 --- a/solutions/observability/apps/use-select-metrics-emitted-directly-to-monitoring-cluster.md +++ b/solutions/observability/apps/use-select-metrics-emitted-directly-to-monitoring-cluster.md @@ -2,10 +2,10 @@ navigation_title: "Use local collection" mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-monitoring-local-collection.html +applies_to: + stack: all --- - - # Use the select metrics emitted directly to your monitoring cluster [apm-monitoring-local-collection] @@ -28,6 +28,4 @@ Here is the list of every metrics we currently expose: * grpc.server.response.valid.count * grpc.server.response.errors.count * grpc.server.errors.timeout -* grpc.server.errors.ratelimit - - +* grpc.server.errors.ratelimit \ No newline at end of file diff --git a/solutions/observability/apps/use-synthetics-cli.md b/solutions/observability/apps/use-synthetics-cli.md index 38135da948..43882bacbd 100644 --- a/solutions/observability/apps/use-synthetics-cli.md +++ b/solutions/observability/apps/use-synthetics-cli.md @@ -155,7 +155,7 @@ If the journey contains external NPM packages other than the `@elastic/synthetic `--url ` -: The URL for the deployment or Observability serverless project to which you want to upload the monitors. +: The URL for the deployment or Observability Serverless project to which you want to upload the monitors. This can also be set in the configuration file using [`project.url`](../../../solutions/observability/apps/configure-synthetics-projects.md#synthetics-configuration-project). The value defined via the CLI will take precedence. @@ -267,7 +267,7 @@ Run `npx @elastic/synthetics locations` with no flags to list all the available To list both locations on Elastic’s global managed infrastructure and {{private-locations}}, include: `--url ` -: The URL for the {{kib}} deployment or Observability serverless project from which to fetch all available public and {{private-location}}s. +: The URL for the {{kib}} deployment or Observability Serverless project from which to fetch all available public and {{private-location}}s. `--auth ` : API key used for [authentication](../../../deploy-manage/api-keys/elasticsearch-api-keys.md). diff --git a/solutions/observability/apps/view-monitor-status.md b/solutions/observability/apps/view-monitor-status.md index e65d43958e..56da359903 100644 --- a/solutions/observability/apps/view-monitor-status.md +++ b/solutions/observability/apps/view-monitor-status.md @@ -1,6 +1,8 @@ --- mapped_pages: - https://www.elastic.co/guide/en/observability/current/view-monitor-status.html +applies_to: + stack: all --- # View monitor status [view-monitor-status] diff --git a/solutions/observability/apps/work-with-params-secrets.md b/solutions/observability/apps/work-with-params-secrets.md index ccf01153ca..33aa8c6c14 100644 --- a/solutions/observability/apps/work-with-params-secrets.md +++ b/solutions/observability/apps/work-with-params-secrets.md @@ -29,7 +29,7 @@ The values in the configuration file are read in the following order: 1. **Global parameters in an Observability project**: The *Global parameters* set using the UI are read first. 2. **Configuration file**: Then the *Global parameters* are merged with any parameters defined in a configuration file. If a parameter is defined in both the Observability UI **and** a Synthetics project configuration file, the value in the configuration file will be used. -3. **CLI**: Then the parameters defined in the configuration are merged with any parameters passed to the CLI `--params` argument. If a parameter is defined in a Synthetics project configuration file **and** using the CLI argument, the value defined using the CLI will be used. When running a script using the CLI, *Global parameters* defined in {{kib}} or the Observability serverless project have no impact on the test because it won’t have access to {{kib}} or the Observability project. +3. **CLI**: Then the parameters defined in the configuration are merged with any parameters passed to the CLI `--params` argument. If a parameter is defined in a Synthetics project configuration file **and** using the CLI argument, the value defined using the CLI will be used. When running a script using the CLI, *Global parameters* defined in {{kib}} or the Observability Serverless project have no impact on the test because it won’t have access to {{kib}} or the Observability project. ### Global parameters in your Observability project [observability-synthetics-params-secrets-global-parameters-in-your-observability-project] diff --git a/solutions/observability/apps/write-synthetic-test.md b/solutions/observability/apps/write-synthetic-test.md index f0b41878a4..c34d7c044a 100644 --- a/solutions/observability/apps/write-synthetic-test.md +++ b/solutions/observability/apps/write-synthetic-test.md @@ -42,7 +42,7 @@ The synthetics agent exposes an API for creating and running tests, including: : Runs a provided function after a single `journey` has completed. Takes one parameter: a `callback` (function). Learn more in [Set up and remove a global state](../../../solutions/observability/apps/write-synthetic-test.md#before-after). `monitor` -: The `monitor.use` method allows you to determine a monitor’s configuration on a journey-by-journey basis. If you want two journeys to create monitors with different intervals, for example, you should call `monitor.use` in each of them and set the `schedule` property to different values in each. Note that this is only relevant when using the `push` command to create monitors in {{kib}} an Observability serverless project. Learn more in [Configure individual monitors](../../../solutions/observability/apps/configure-individual-browser-monitors.md). +: The `monitor.use` method allows you to determine a monitor’s configuration on a journey-by-journey basis. If you want two journeys to create monitors with different intervals, for example, you should call `monitor.use` in each of them and set the `schedule` property to different values in each. Note that this is only relevant when using the `push` command to create monitors in {{kib}} an Observability Serverless project. Learn more in [Configure individual monitors](../../../solutions/observability/apps/configure-individual-browser-monitors.md). ## Create a journey [synthetics-create-journey] diff --git a/solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md b/solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md index 7a089ede4f..df41d83528 100644 --- a/solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md +++ b/solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md @@ -46,7 +46,7 @@ Expand the **quick guide** to learn how, or skip to the next section if your dat 7. Click **Save and continue**. This step takes a minute or two to complete. When it’s done, you’ll have an agent policy that contains an integration policy for the configuration you just specified. If an {{agent}} is already assigned to the policy, you’re done. Otherwise, you need to deploy an {{agent}}. 8. To deploy an {{agent}}: - 1. In the popup, click **Add {{agent}} to your hosts** to open the **Add agent*** flyout. If you accidentally close the popup or the flyout doesn’t open, go to ***{{fleet}} → Agents**, then click **Add agent** to access the flyout. + 1. In the popup, click **Add {{agent}} to your hosts** to open the **Add agent** flyout. If you accidentally close the popup or the flyout doesn’t open, go to **{{fleet}} → Agents**, then click **Add agent** to access the flyout. 2. Follow the steps in the **Add agent** flyout to download, install, and enroll the {{agent}}. 9. When incoming data is confirmed—​after a minute or two—​click **View assets** to access the dashboards. diff --git a/solutions/observability/get-started.md b/solutions/observability/get-started.md index 9f44c8877b..0d04e50c8f 100644 --- a/solutions/observability/get-started.md +++ b/solutions/observability/get-started.md @@ -24,7 +24,7 @@ Learn about key features available to help you get value from your observability ## Get started with your use case [get-started-with-use-case] -Learn how to spin up a deployment on {{ech}} or create an Observability serverless project and use Elastic Observability to gain deeper insight into the behavior of your applications and systems. +Learn how to spin up a deployment on {{ech}} or create an Observability Serverless project and use Elastic Observability to gain deeper insight into the behavior of your applications and systems. :::{image} ../../images/observability-get-started.svg :alt: get started