diff --git a/docs/apm/advanced-queries.asciidoc b/docs/apm/advanced-queries.asciidoc index 7b771eb66261..d32109dfb704 100644 --- a/docs/apm/advanced-queries.asciidoc +++ b/docs/apm/advanced-queries.asciidoc @@ -14,22 +14,22 @@ or, to only show transactions that are slower than a specified time threshold. * Filter by response status code: `context.response.status_code ≥ 400` * Filter by single user ID: `context.user.id : 12` -When querying in the APM app, you're merely searching and selecting data from fields in Elasticsearch documents. +When querying in the APM app, you're merely searching and selecting data from fields in OpenSearch documents. Queries entered into the query bar are also added as parameters to the URL, so it's easy to share a specific query or view with others. When you type, you can begin to see some of the transaction fields available for filtering: [role="screenshot"] -image::apm/images/apm-query-bar.png[Example of the Kibana Query bar in APM app in Kibana] +image::apm/images/apm-query-bar.png[Example of the OpenSearchDashboards Query bar in APM app in OpenSearchDashboards] -TIP: Read the {kibana-ref}/kuery-query.html[Kibana Query Language Enhancements] documentation to learn more about the capabilities of the {kib} query language. +TIP: Read the {opensearch-dashboards-ref}/kuery-query.html[OpenSearchDashboards Query Language Enhancements] documentation to learn more about the capabilities of the {osd} query language. [float] [[discover-advanced-queries]] === Querying in Discover -Alternatively, you can query your APM documents in {kibana-ref}/discover.html[*Discover*]. +Alternatively, you can query your APM documents in {opensearch-dashboards-ref}/discover.html[*Discover*]. Querying documents in *Discover* works the same way as querying in the APM app, and *Discover* supports all of the example APM app queries shown on this page. diff --git a/docs/apm/agent-configuration.asciidoc b/docs/apm/agent-configuration.asciidoc index f5c89d19afaf..445b4d2f84cb 100644 --- a/docs/apm/agent-configuration.asciidoc +++ b/docs/apm/agent-configuration.asciidoc @@ -13,7 +13,7 @@ To get started, choose the services and environments you wish to configure. The APM app will let you know when your agents have applied your configurations. [role="screenshot"] -image::apm/images/apm-agent-configuration.png[APM Agent configuration in Kibana] +image::apm/images/apm-agent-configuration.png[APM Agent configuration in OpenSearchDashboards] [float] ==== Precedence @@ -26,10 +26,10 @@ For this reason, it is still essential to set custom default configurations loca [float] ==== APM Server setup -This feature requires https://www.elastic.co/guide/en/apm/server/master/setup-kibana-endpoint.html[Kibana endpoint configuration] in APM Server. +This feature requires https://www.elastic.co/guide/en/apm/server/master/setup-opensearch-dashboards-endpoint.html[OpenSearchDashboards endpoint configuration] in APM Server. -APM Server acts as a proxy between the agents and Kibana. -Kibana communicates any changed settings to APM Server so that your agents only need to poll APM Server to determine which settings have changed. +APM Server acts as a proxy between the agents and OpenSearchDashboards. +OpenSearchDashboards communicates any changed settings to APM Server so that your agents only need to poll APM Server to determine which settings have changed. [float] ==== Supported configurations diff --git a/docs/apm/api.asciidoc b/docs/apm/api.asciidoc index 01ba084b9e9e..2fd9528d9b79 100644 --- a/docs/apm/api.asciidoc +++ b/docs/apm/api.asciidoc @@ -10,7 +10,7 @@ Some APM app features are provided via a REST API: * <> * <> -* <> +* <> [float] [[apm-api-example]] @@ -19,15 +19,15 @@ Some APM app features are provided via a REST API: // The following content is reused throughout the API docs // tag::using-the-APIs[] Interact with APM APIs using cURL or another API tool. -All APM APIs are Kibana APIs, not Elasticsearch APIs; -because of this, the Kibana dev tools console cannot be used to interact with APM APIs. +All APM APIs are OpenSearchDashboards APIs, not OpenSearch APIs; +because of this, the OpenSearchDashboards dev tools console cannot be used to interact with APM APIs. For all APM APIs, you must use a request header. -Supported headers are `Authorization`, `kbn-xsrf`, and `Content-Type`. +Supported headers are `Authorization`, `osd-xsrf`, and `Content-Type`. `Authorization: ApiKey {credentials}`:: -Kibana supports token-based authentication with the Elasticsearch API key service. -The API key returned by the {ref}/security-api-create-api-key.html[Elasticsearch create API key API] +OpenSearchDashboards supports token-based authentication with the OpenSearch API key service. +The API key returned by the {ref}/security-api-create-api-key.html[OpenSearch create API key API] can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{credentials}`, where `{credentials}` is the base64 encoding of `id` and `api_key` joined by a colon. + @@ -36,8 +36,8 @@ Alternatively, you can create a user and use their username and password to auth Whether using `Authorization: ApiKey {credentials}`, or `-u $USER:$PASSWORD`, users interacting with APM APIs must have <>. -`kbn-xsrf: true`:: - By default, you must use `kbn-xsrf` for all API calls, except in the following scenarios: +`osd-xsrf: true`:: + By default, you must use `osd-xsrf` for all API calls, except in the following scenarios: * The API endpoint uses the `GET` or `HEAD` operations * The path is whitelisted using the <> setting @@ -45,8 +45,8 @@ users interacting with APM APIs must have <> -which you can use to automate certain aspects of configuring and deploying Kibana. +In addition to the APM specific API endpoints, OpenSearchDashboards provides its own <> +which you can use to automate certain aspects of configuring and deploying OpenSearchDashboards. An example is below. [[api-create-apm-index-pattern]] ==== Customize the APM index pattern -As an alternative to updating <> in your `kibana.yml` configuration file, -you can use Kibana's <> to update the default APM index pattern on the fly. +As an alternative to updating <> in your `opensearch_dashboards.yml` configuration file, +you can use OpenSearchDashboards's <> to update the default APM index pattern on the fly. The following example sets the default APM app index pattern to `some-other-pattern-*`: @@ -493,7 +493,7 @@ The following example sets the default APM app index pattern to `some-other-patt ---- curl -X PUT "localhost:5601/api/saved_objects/index-pattern/apm_static_index_pattern_id" \ <1> -H 'Content-Type: application/json' \ --H 'kbn-xsrf: true' \ +-H 'osd-xsrf: true' \ -H 'Authorization: Basic ${YOUR_AUTH_TOKEN}' \ -d' { "attributes": { @@ -525,7 +525,7 @@ To view the new APM app index pattern, use the < --H 'kbn-xsrf: true' \ +-H 'osd-xsrf: true' \ -H 'Authorization: Basic ${YOUR_AUTH_TOKEN}' ---- <1> `apm_static_index_pattern_id` is the internal, hard-coded ID of the APM index pattern. @@ -552,4 +552,4 @@ The API returns the following: // More examples will go here -More information on Kibana's API is available in <>. +More information on OpenSearchDashboards's API is available in <>. diff --git a/docs/apm/apm-alerts.asciidoc b/docs/apm/apm-alerts.asciidoc index 7bdfe80b4217..5edd2733640e 100644 --- a/docs/apm/apm-alerts.asciidoc +++ b/docs/apm/apm-alerts.asciidoc @@ -8,15 +8,15 @@ beta::[] -The APM app integrates with Kibana's {kibana-ref}/alerting-getting-started.html[alerting and actions] feature. +The APM app integrates with OpenSearchDashboards's {opensearch-dashboards-ref}/alerting-getting-started.html[alerting and actions] feature. It provides a set of built-in **actions** and APM specific threshold **alerts** for you to use -and enables central management of all alerts from <>. +and enables central management of all alerts from <>. [role="screenshot"] image::apm/images/apm-alert.png[Create an alert in the APM app] For a walkthrough of the alert flyout panel, including detailed information on each configurable property, -see Kibana's <>. +see OpenSearchDashboards's <>. The APM app supports four different types of alerts: @@ -116,15 +116,15 @@ Select **Save**. The alert has been created and is now active! [[apm-alert-manage]] === Manage alerts and actions -From the APM app, select **Alerts** > **View active alerts** to be taken to the Kibana alerts and actions management page. +From the APM app, select **Alerts** > **View active alerts** to be taken to the OpenSearchDashboards alerts and actions management page. From this page, you can create, edit, disable, mute, and delete alerts, and create, edit, and disable connectors. [float] [[apm-alert-more-info]] === More information -See {kibana-ref}/alerting-getting-started.html[alerting and actions] for more information. +See {opensearch-dashboards-ref}/alerting-getting-started.html[alerting and actions] for more information. NOTE: If you are using an **on-premise** Elastic Stack deployment with security, -communication between Elasticsearch and Kibana must have TLS configured. -More information is in the alerting {kibana-ref}/alerting-getting-started.html#alerting-setup-prerequisites[prerequisites]. \ No newline at end of file +communication between OpenSearch and OpenSearchDashboards must have TLS configured. +More information is in the alerting {opensearch-dashboards-ref}/alerting-getting-started.html#alerting-setup-prerequisites[prerequisites]. \ No newline at end of file diff --git a/docs/apm/apm-app-users.asciidoc b/docs/apm/apm-app-users.asciidoc index 3f0a42251304..9450f54fa0c6 100644 --- a/docs/apm/apm-app-users.asciidoc +++ b/docs/apm/apm-app-users.asciidoc @@ -3,7 +3,7 @@ == APM app users and privileges :beat_default_index_prefix: apm -:beat_kib_app: APM app +:beat_osd_app: APM app :annotation_index: observability-annotations ++++ @@ -14,15 +14,15 @@ You can use role-based access control to grant users access to secured resources. The roles that you set up depend on your organization's security requirements and the minimum privileges required to use specific features. -{es-security-features} provides {ref}/built-in-roles.html[built-in roles] that grant a +{opensearch-security-features} provides {ref}/built-in-roles.html[built-in roles] that grant a subset of the privileges needed by APM users. When possible, assign users the built-in roles to minimize the affect of future changes on your security strategy. If no built-in role is available, you can assign users the privileges needed to accomplish a specific task. In general, there are three types of privileges you'll work with: -* **Elasticsearch cluster privileges**: Manage the actions a user can perform against your cluster. -* **Elasticsearch index privileges**: Control access to the data in specific indices your cluster. -* **Kibana space privileges**: Grant users write or read access to features and apps within Kibana. +* **OpenSearch cluster privileges**: Manage the actions a user can perform against your cluster. +* **OpenSearch index privileges**: Control access to the data in specific indices your cluster. +* **OpenSearchDashboards space privileges**: Grant users write or read access to features and apps within OpenSearchDashboards. //// *********************************** *********************************** @@ -48,8 +48,8 @@ These users might also need to create and edit dashboards, visualizations, and m |==== |Role | Purpose -|`kibana_admin` -|Grants access to all features in Kibana. +|`opensearch_dashboards_admin` +|Grants access to all features in OpenSearchDashboards. |`apm_user` |Grants the privileges required for APM users on +{beat_default_index_prefix}*+ indices @@ -61,7 +61,7 @@ These users might also need to create and edit dashboards, visualizations, and m [[apm-app-reader-partial]] ==== Partial APM reader -In some instances, you may wish to restrict certain Kibana apps that a user has access to. +In some instances, you may wish to restrict certain OpenSearchDashboards apps that a user has access to. . Assign the following built in roles: + @@ -72,7 +72,7 @@ In some instances, you may wish to restrict certain Kibana apps that a user has |Grants the privileges required for APM users on +{beat_default_index_prefix}*+ indices |==== -. Assign space privileges to any Kibana space that the user needs access to. +. Assign space privileges to any OpenSearchDashboards space that the user needs access to. Here are two examples: + [options="header"] @@ -80,8 +80,8 @@ Here are two examples: |Type | Privilege | Purpose | Spaces -| `Read` or `All` on the {beat_kib_app} -| Allow the use of the the {beat_kib_app} +| `Read` or `All` on the {beat_osd_app} +| Allow the use of the the {beat_osd_app} | Spaces | `Read` or `All` on Dashboards and Discover @@ -112,7 +112,7 @@ Here are two examples: NOTE: By default, the `apm_user` built-in role provides access to Observability annotations. You only need to create an annotation user if the default annotation index -defined in <> has been customized. +defined in <> has been customized. [[apm-app-annotation-user]] ==== Annotation user @@ -136,7 +136,7 @@ and assign the following privileges: |==== + ^1^ +\{ANNOTATION_INDEX\}+ should be the index name you've defined in -<>. +<>. . Assign the `annotation_user` created previously, and the built-in roles necessary to create a <> or <> APM reader to any users that need to view annotations in the APM app @@ -173,15 +173,15 @@ Central configuration users need to be able to view, create, update, and delete |Grants the privileges required for APM users on +{beat_default_index_prefix}*+ indices |==== -. Assign the following Kibana space privileges: +. Assign the following OpenSearchDashboards space privileges: + [options="header"] |==== |Type | Privilege | Purpose | Spaces -|`All` on {beat_kib_app} -|Allow full use of the {beat_kib_app} +|`All` on {beat_osd_app} +|Allow full use of the {beat_osd_app} |==== [[apm-app-central-config-reader]] @@ -199,15 +199,15 @@ but not create, update, or delete them. |Grants the privileges required for APM users on +{beat_default_index_prefix}*+ indices |==== -. Assign the following Kibana space privileges: +. Assign the following OpenSearchDashboards space privileges: + [options="header"] |==== |Type | Privilege | Purpose | Spaces -|`read` on the {beat_kib_app} -|Allow read access to the {beat_kib_app} +|`read` on the {beat_osd_app} +|Allow read access to the {beat_osd_app} |==== [[apm-app-central-config-api]] @@ -232,15 +232,15 @@ See <>. Users can list, search, create, update, and delete central configurations via the APM app API. -. Assign the following Kibana space privileges: +. Assign the following OpenSearchDashboards space privileges: + [options="header"] |==== |Type | Privilege | Purpose | Spaces -|`all` on the {beat_kib_app} -|Allow all access to the {beat_kib_app} +|`all` on the {beat_osd_app} +|Allow all access to the {beat_osd_app} |==== [[apm-app-api-config-reader]] @@ -248,15 +248,15 @@ Users can list, search, create, update, and delete central configurations via th Sometimes a user only needs to list and search central configurations via the APM app API. -. Assign the following Kibana space privileges: +. Assign the following OpenSearchDashboards space privileges: + [options="header"] |==== |Type | Privilege | Purpose | Spaces -|`read` on the {beat_kib_app} -|Allow read access to the {beat_kib_app} +|`read` on the {beat_osd_app} +|Allow read access to the {beat_osd_app} |==== [[apm-app-api-annotation-manager]] @@ -289,16 +289,16 @@ and assign the following privileges: |==== . Assign the `annotation_role` created previously, -and the following Kibana space privileges to any annotation API users: +and the following OpenSearchDashboards space privileges to any annotation API users: + [options="header"] |==== |Type | Privilege | Purpose | Spaces -|`all` on the {beat_kib_app} -|Allow all access to the {beat_kib_app} +|`all` on the {beat_osd_app} +|Allow all access to the {beat_osd_app} |==== //LEARN MORE -//Learn more about <>. +//Learn more about <>. diff --git a/docs/apm/custom-links.asciidoc b/docs/apm/custom-links.asciidoc index 4fdf39b643f9..c225a97b5354 100644 --- a/docs/apm/custom-links.asciidoc +++ b/docs/apm/custom-links.asciidoc @@ -155,24 +155,24 @@ See the {jira-query-params}[Jira application administration knowledge base] for a full list of supported query parameters. [float] -[[custom-links-examples-kib]] -==== Kibana dashboards +[[custom-links-examples-osd]] +==== OpenSearchDashboards dashboards -Link to a custom dashboard in Kibana. +Link to a custom dashboard in OpenSearchDashboards. |==== |Label |`Open transaction in custom visualization` -|Link |`https://kibana-instance/app/kibana#/dashboard?_g=query:(language:kuery,query:'transaction.id:{{transaction.id}}'...` +|Link |`https://opensearch-dashboards-instance/app/opensearch-dashboards#/dashboard?_g=query:(language:kuery,query:'transaction.id:{{transaction.id}}'...` |==== **Example** -This link opens the current `transaction.id` in a custom kibana dashboard. +This link opens the current `transaction.id` in a custom OpenSearch Dashboards dashboard. There are no filters set. |==== |Label |`Open transaction in Python drilldown viz` -|URL |`https://kibana-instance/app/kibana#/dashboard?_g=(filters:!(),refreshInterval:(pause:!t,value:0),time:(from:now-24h,to:now))&_a=(description:'',filters:!(),fullScreenMode:!f,options:(hidePanelTitles:!f,useMargins:!t),panels:!((embeddableConfig:(),gridData:(h:15,i:cb79c1c0-1af8-472c-aaf7-d158a76946fb,w:24,x:0,y:0),id:c8c74b20-6a30-11ea-92ab-b5d3feff11df,panelIndex:cb79c1c0-1af8-472c-aaf7-d158a76946fb,type:visualization,version:'7.7')),query:(language:kuery,query:'transaction.id:{{transaction.id}}'),timeRestore:!f,title:'',viewMode:edit)` +|URL |`https://opensearch-dashboards-instance/app/opensearch-dashboards#/dashboard?_g=(filters:!(),refreshInterval:(pause:!t,value:0),time:(from:now-24h,to:now))&_a=(description:'',filters:!(),fullScreenMode:!f,options:(hidePanelTitles:!f,useMargins:!t),panels:!((embeddableConfig:(),gridData:(h:15,i:cb79c1c0-1af8-472c-aaf7-d158a76946fb,w:24,x:0,y:0),id:c8c74b20-6a30-11ea-92ab-b5d3feff11df,panelIndex:cb79c1c0-1af8-472c-aaf7-d158a76946fb,type:visualization,version:'7.7')),query:(language:kuery,query:'transaction.id:{{transaction.id}}'),timeRestore:!f,title:'',viewMode:edit)` |==== [float] diff --git a/docs/apm/deployment-annotations.asciidoc b/docs/apm/deployment-annotations.asciidoc index 53fd963a81f7..7212e4c44c9e 100644 --- a/docs/apm/deployment-annotations.asciidoc +++ b/docs/apm/deployment-annotations.asciidoc @@ -23,7 +23,7 @@ so that each time you deploy, a POST request is sent to the annotation API endpo curl -X POST \ http://localhost:5601/api/apm/services/${SERVICE_NAME}/annotation \ <1> -H 'Content-Type: application/json' \ --H 'kbn-xsrf: true' \ +-H 'osd-xsrf: true' \ -H 'Authorization: Basic ${API_KEY}' \ <2> -d '{ "@timestamp": "${DEPLOY_TIME}", <3> @@ -45,4 +45,4 @@ See the <> reference for more information. NOTE: If custom annotations have been created for the selected time period, any derived annotations, i.e., those created automatically when `service.version` changes, will not be shown. [role="screenshot"] -image::apm/images/apm-transaction-annotation.png[Example view of transactions annotation in the APM app in Kibana] +image::apm/images/apm-transaction-annotation.png[Example view of transactions annotation in the APM app in OpenSearchDashboards] diff --git a/docs/apm/errors.asciidoc b/docs/apm/errors.asciidoc index 49351ec25585..07b5f75b04c1 100644 --- a/docs/apm/errors.asciidoc +++ b/docs/apm/errors.asciidoc @@ -11,12 +11,12 @@ This makes it very easy to quickly see which errors are affecting your services, and to take actions to rectify them. [role="screenshot"] -image::apm/images/apm-errors-overview.png[Example view of the errors overview in the APM app in Kibana] +image::apm/images/apm-errors-overview.png[Example view of the errors overview in the APM app in OpenSearchDashboards] Selecting an error group ID or error message brings you to the *Error group*. [role="screenshot"] -image::apm/images/apm-error-group.png[Example view of the error group page in the APM app in Kibana] +image::apm/images/apm-error-group.png[Example view of the error group page in the APM app in OpenSearchDashboards] Here, you'll see the error message, culprit, and the number of occurrences over time. diff --git a/docs/apm/filters.asciidoc b/docs/apm/filters.asciidoc index c405ea10ade3..62a1f21fb647 100644 --- a/docs/apm/filters.asciidoc +++ b/docs/apm/filters.asciidoc @@ -19,19 +19,19 @@ They are available in the Services, Transactions, Errors, Metrics, and Traces vi and any filter applied will persist as you move between pages. [role="screenshot"] -image::apm/images/global-filters.png[Global filters available in the APM app in Kibana] +image::apm/images/global-filters.png[Global filters available in the APM app in OpenSearchDashboards] [float] ===== Global time range -The <> in {kib} restricts APM data to a specific time period. +The <> in {osd} restricts APM data to a specific time period. [float] [[query-bar]] ===== Query bar The query bar is a powerful data query feature. -Similar to the query bar in {kibana-ref}/discover.html[Discover], +Similar to the query bar in {opensearch-dashboards-ref}/discover.html[Discover], it enables you to pass advanced queries on your data to filter on particular pieces of information that you're interested in. It comes with a handy autocomplete that helps find the fields and even provides suggestions to the data they include. You can select the query bar and hit the down arrow on your keyboard to begin seeing recommendations. @@ -72,4 +72,4 @@ With just a click, you can filter your transactions by the transaction result, host, container ID, Kubernetes pod, and more. [role="screenshot"] -image::apm/images/local-filter.png[Local filters available in the APM app in Kibana] \ No newline at end of file +image::apm/images/local-filter.png[Local filters available in the APM app in OpenSearchDashboards] \ No newline at end of file diff --git a/docs/apm/index.asciidoc b/docs/apm/index.asciidoc index 1eff4f578af9..caaaa35fef73 100644 --- a/docs/apm/index.asciidoc +++ b/docs/apm/index.asciidoc @@ -11,7 +11,7 @@ endif::[] [partintro] -- -The APM app in {kib} is provided with the basic license. +The APM app in {osd} is provided with the basic license. It allows you to monitor your software services and applications in real-time; visualize detailed performance information on your services, identify and analyze errors, diff --git a/docs/apm/metrics.asciidoc b/docs/apm/metrics.asciidoc index e64cbc846960..ea35af1be021 100644 --- a/docs/apm/metrics.asciidoc +++ b/docs/apm/metrics.asciidoc @@ -9,7 +9,7 @@ If you're experiencing a problem with your service, you can use this page to att For example, you might be able to correlate a high number of errors with a long transaction duration, high CPU usage, or a memory leak. [role="screenshot"] -image::apm/images/apm-metrics.png[Example view of the Metrics overview in APM app in Kibana] +image::apm/images/apm-metrics.png[Example view of the Metrics overview in APM app in OpenSearchDashboards] If you're using the Java Agent, you can view metrics for each JVM. diff --git a/docs/apm/service-maps.asciidoc b/docs/apm/service-maps.asciidoc index d44c4ff6caa5..c2b3d05d06cf 100644 --- a/docs/apm/service-maps.asciidoc +++ b/docs/apm/service-maps.asciidoc @@ -14,7 +14,7 @@ We currently surface two types of service maps: * Service-specific: Highlight connections for a selected service. [role="screenshot"] -image::apm/images/service-maps.png[Example view of service maps in the APM app in Kibana] +image::apm/images/service-maps.png[Example view of service maps in the APM app in OpenSearchDashboards] [float] [[service-maps-how]] @@ -47,7 +47,7 @@ Use the environment drop-down to only see the data you're interested in, like `d Additional filters are not currently available for service maps. [role="screenshot"] -image::apm/images/service-maps-java.png[Example view of service maps with Java highlighted in the APM app in Kibana] +image::apm/images/service-maps-java.png[Example view of service maps with Java highlighted in the APM app in OpenSearchDashboards] [float] [[service-map-anomaly-detection]] @@ -77,7 +77,7 @@ Nodes appear on the map in one of two shapes: * **Circle**: Instrumented services. Interior icons are based on the language of the agent used. * **Diamond**: Databases, external, and messaging. Interior icons represent the generic type, -with specific icons for known entities, like Elasticsearch. +with specific icons for known entities, like OpenSearch. Type and subtype are based on `span.type`, and `span.subtype`. [float] diff --git a/docs/apm/services.asciidoc b/docs/apm/services.asciidoc index 2bf2e35c21cd..e936551f033c 100644 --- a/docs/apm/services.asciidoc +++ b/docs/apm/services.asciidoc @@ -11,4 +11,4 @@ Health status is powered by machine learning and requires anomaly detection to b Learn more in <>. [role="screenshot"] -image::apm/images/apm-services-overview.png[Example view of services table the APM app in Kibana] +image::apm/images/apm-services-overview.png[Example view of services table the APM app in OpenSearchDashboards] diff --git a/docs/apm/set-up.asciidoc b/docs/apm/set-up.asciidoc index b2e78bd08bc9..90be3e70674e 100644 --- a/docs/apm/set-up.asciidoc +++ b/docs/apm/set-up.asciidoc @@ -6,27 +6,27 @@ Set up ++++ -APM is available via the navigation sidebar in {Kib}. +APM is available via the navigation sidebar in {Osd}. If you have not already installed and configured Elastic APM, -the *Setup Instructions* in Kibana will get you started. +the *Setup Instructions* in OpenSearchDashboards will get you started. [role="screenshot"] -image::apm/images/apm-setup.png[Installation instructions on the APM page in Kibana] +image::apm/images/apm-setup.png[Installation instructions on the APM page in OpenSearchDashboards] [float] [[apm-configure-index-pattern]] === Load the index pattern -Index patterns tell Kibana which Elasticsearch indices you want to explore. +Index patterns tell OpenSearchDashboards which OpenSearch indices you want to explore. An APM index pattern is necessary for certain features in the APM app, like the query bar. To set up the correct index pattern, -simply click *Load Kibana objects* at the bottom of the Setup Instructions. +simply click *Load OpenSearchDashboards objects* at the bottom of the Setup Instructions. [role="screenshot"] -image::apm/images/apm-index-pattern.png[Setup index pattern for APM in Kibana] +image::apm/images/apm-index-pattern.png[Setup index pattern for APM in OpenSearchDashboards] TIP: To use a custom index pattern, -adjust Kibana's <> or use the <>. +adjust OpenSearchDashboards's <> or use the <>. [float] [[apm-getting-started-next]] diff --git a/docs/apm/settings.asciidoc b/docs/apm/settings.asciidoc index 44da63143f63..ec432f4dc194 100644 --- a/docs/apm/settings.asciidoc +++ b/docs/apm/settings.asciidoc @@ -1,7 +1,7 @@ // Do not link directly to this page. // Link to the anchor in `/docs/settings/apm-settings.asciidoc` instead. [role="xpack"] -[[apm-settings-in-kibana]] +[[apm-settings-in-opensearch-dashboards]] == APM app settings ++++ diff --git a/docs/apm/spans.asciidoc b/docs/apm/spans.asciidoc index 7f29b1f003f1..7b0d526bb62e 100644 --- a/docs/apm/spans.asciidoc +++ b/docs/apm/spans.asciidoc @@ -6,7 +6,7 @@ The trace sample timeline visualization is a bird's-eye view of what your applic This makes it useful for visualizing where a selected transaction spent most of its time. [role="screenshot"] -image::apm/images/apm-transaction-sample.png[Example of distributed trace colors in the APM app in Kibana] +image::apm/images/apm-transaction-sample.png[Example of distributed trace colors in the APM app in OpenSearchDashboards] View a span in detail by clicking on it in the timeline waterfall. For example, when you click on an SQL Select database query, @@ -21,7 +21,7 @@ Spans are automatically captured by APM agents, and you can also define custom s Each span has a type and is defined by a different color in the timeline/waterfall visualization. [role="screenshot"] -image::apm/images/apm-span-detail.png[Example view of a span detail in the APM app in Kibana] +image::apm/images/apm-span-detail.png[Example view of a span detail in the APM app in OpenSearchDashboards] [float] [[distributed-tracing]] @@ -31,7 +31,7 @@ If your trace sample timeline is colorful, it's indicative of a distributed trac Services in a distributed trace are separated by color and listed in the order they occur. [role="screenshot"] -image::apm/images/apm-services-trace.png[Example of distributed trace colors in the APM app in Kibana] +image::apm/images/apm-services-trace.png[Example of distributed trace colors in the APM app in OpenSearchDashboards] As application architectures are shifting from monolithic to more distributed, service-based architectures, distributed tracing has become a crucial feature of modern application performance monitoring. @@ -40,7 +40,7 @@ From initial web requests to your front-end service, to queries made to your bac this makes finding possible bottlenecks throughout your application much easier and faster. [role="screenshot"] -image::apm/images/apm-distributed-tracing.png[Example view of the distributed tracing in APM app in Kibana] +image::apm/images/apm-distributed-tracing.png[Example view of the distributed tracing in APM app in OpenSearchDashboards] Don't forget; by definition, a distributed trace includes more than one transaction. When viewing distributed traces in the timeline waterfall, diff --git a/docs/apm/traces.asciidoc b/docs/apm/traces.asciidoc index 3bafebd73315..259428e79db0 100644 --- a/docs/apm/traces.asciidoc +++ b/docs/apm/traces.asciidoc @@ -17,4 +17,4 @@ it's the collective amount of pain a specific endpoint is causing your users. If there's a particular endpoint you're worried about, you can click on it to view the <>. [role="screenshot"] -image::apm/images/apm-traces.png[Example view of the Traces overview in APM app in Kibana] +image::apm/images/apm-traces.png[Example view of the Traces overview in APM app in OpenSearchDashboards] diff --git a/docs/apm/transactions.asciidoc b/docs/apm/transactions.asciidoc index fef98a86de1d..e0919d5b0137 100644 --- a/docs/apm/transactions.asciidoc +++ b/docs/apm/transactions.asciidoc @@ -8,7 +8,7 @@ APM agents automatically collect performance metrics on HTTP requests, database Selecting a <> brings you to the *transactions* overview. [role="screenshot"] -image::apm/images/apm-transactions-overview.png[Example view of transactions table in the APM app in Kibana] +image::apm/images/apm-transactions-overview.png[Example view of transactions table in the APM app in OpenSearchDashboards] The *transaction duration*, *transactions per minute*, *transaction error rate*, and *time spent by span type* charts display information on all transactions associated with the selected service: @@ -47,7 +47,7 @@ In other words, this view groups all transactions of the same name together, and only displays one entry for each group. [role="screenshot"] -image::apm/images/apm-transactions-table.png[Example view of the transactions table in the APM app in Kibana] +image::apm/images/apm-transactions-table.png[Example view of the transactions table in the APM app in OpenSearchDashboards] By default, transaction groups are sorted by _Impact_. Impact helps show the most used and slowest endpoints in your service - in other words, @@ -125,5 +125,5 @@ For a particular transaction sample, we can get even more information in the *me * User - Requires additional configuration, but allows you to see which user experienced the current transaction. * Custom - You can configure your agent to add custom contextual information on transactions. -TIP: All of this data is stored in documents in Elasticsearch. -This means you can select "Actions - View sample document" to see the actual Elasticsearch document under the discover tab. +TIP: All of this data is stored in documents in OpenSearch. +This means you can select "Actions - View sample document" to see the actual OpenSearch document under the discover tab. diff --git a/docs/apm/troubleshooting.asciidoc b/docs/apm/troubleshooting.asciidoc index f911ec0be8bc..5808505140cb 100644 --- a/docs/apm/troubleshooting.asciidoc +++ b/docs/apm/troubleshooting.asciidoc @@ -6,7 +6,7 @@ ++++ If you have something to add to this section, please consider creating a pull request with -your proposed changes in the https://github.com/elastic/kibana[Kibana repository]. +your proposed changes in the https://github.com/elastic/opensearch-dashboards[OpenSearchDashboards repository]. Also, check out the https://discuss.elastic.co/c/apm[APM discussion forum]. @@ -48,17 +48,17 @@ GET /_template/apm-{version} // CONSOLE *Using Logstash, Kafka, etc.* -If you're not outputting data directly from APM Server to Elasticsearch (perhaps you're using Logstash or Kafka), +If you're not outputting data directly from APM Server to OpenSearch (perhaps you're using Logstash or Kafka), then the index template will not be set up automatically. Instead, you'll need to {apm-server-ref}/apm-server-template.html[load the template manually]. *Using a custom index names* This problem can also occur if you've customized the index name that you write APM data to. The default index name that APM writes events to can be found -{apm-server-ref}/elasticsearch-output.html#index-option-es[here]. +{apm-server-ref}/opensearch-output.html#index-option-opensearch[here]. If you change the default, you must also configure the `setup.template.name` and `setup.template.pattern` options. -See {apm-server-ref}/configuration-template.html[Load the Elasticsearch index template]. -If the Elasticsearch index template has already been successfully loaded to the index, +See {apm-server-ref}/configuration-template.html[Load the OpenSearch index template]. +If the OpenSearch index template has already been successfully loaded to the index, you can customize the indices that the APM app uses to display data. Navigate to *APM* > *Settings* > *Indices*, and change all `apm_oss.*Pattern` values to include the new index pattern. For example: `customIndexName-*`. @@ -108,7 +108,7 @@ You can always add additional metadata to your transactions using {apm-overview- After ensuring you've correctly named your transactions, you might still see an error in the APM app related to too many transaction names. If this is the case, you can increase the default number of transaction groups displayed in the APM app by configuring -<>. +<>. **More information** @@ -147,7 +147,7 @@ You can also use the Agent's public API to manually set a name for the transacti [[troubleshooting-fields-unsearchable]] === Fields are not searchable -In Elasticsearch, index templates are used to define settings and mappings that determine how fields should be analyzed. +In OpenSearch, index templates are used to define settings and mappings that determine how fields should be analyzed. The recommended index template file for APM Server is installed by the APM Server packages. This template, by default, enables and disables indexing on certain fields.