From 4c5d96bf4f475ef88da9722627709fbaba387f46 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 25 Aug 2021 12:41:47 -0700 Subject: [PATCH] docs: remove tab widget code (#997) --- .../elastic-agent-standalone-logging.asciidoc | 3 - .../install-elastic-agent.asciidoc | 6 +- .../run-elastic-agent-standalone.asciidoc | 5 +- .../start-elastic-agent.asciidoc | 3 - .../elastic-agent/stop-elastic-agent.asciidoc | 5 +- .../uninstall-elastic-agent.asciidoc | 5 +- .../upgrade-elastic-agent.asciidoc | 7 +- .../fleet/fleet-server.asciidoc | 3 - .../getting-started-traces.asciidoc | 5 +- .../getting-started.asciidoc | 5 +- .../troubleshooting.asciidoc | 3 - .../add-observability-data.asciidoc | 3 - docs/en/observability/ingest-logs.asciidoc | 13 +- docs/en/observability/ingest-metrics.asciidoc | 19 +- docs/en/observability/ingest-uptime.asciidoc | 43 +++-- .../en/observability/instrument-apps.asciidoc | 3 - docs/en/observability/monitor-aws.asciidoc | 3 - docs/en/observability/monitor-azure.asciidoc | 7 +- docs/en/observability/monitor-gcp.asciidoc | 3 - .../observability/monitor-java-app.asciidoc | 35 ++-- .../monitor-k8s/monitor-k8s.asciidoc | 3 - docs/en/shared/tab-widget-code/code.asciidoc | 166 ------------------ 22 files changed, 59 insertions(+), 289 deletions(-) delete mode 100644 docs/en/shared/tab-widget-code/code.asciidoc diff --git a/docs/en/ingest-management/elastic-agent/elastic-agent-standalone-logging.asciidoc b/docs/en/ingest-management/elastic-agent/elastic-agent-standalone-logging.asciidoc index b2dc9f8852..dbf8ce8a67 100644 --- a/docs/en/ingest-management/elastic-agent/elastic-agent-standalone-logging.asciidoc +++ b/docs/en/ingest-management/elastic-agent/elastic-agent-standalone-logging.asciidoc @@ -123,6 +123,3 @@ information. We recommended using this option in combination with `agent.logging Default: `false` |=== - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/elastic-agent/install-elastic-agent.asciidoc b/docs/en/ingest-management/elastic-agent/install-elastic-agent.asciidoc index 1e388e55e9..7ae63e84c3 100644 --- a/docs/en/ingest-management/elastic-agent/install-elastic-agent.asciidoc +++ b/docs/en/ingest-management/elastic-agent/install-elastic-agent.asciidoc @@ -98,7 +98,7 @@ Because {agent} is installed as an auto-starting service, it will restart automatically if the system is rebooted. To confirm that {agent} is installed and running, go to the **Agents** tab in -{fleet}. +{fleet}. If you run into problems: @@ -117,7 +117,3 @@ locations. You cannot override these installation paths because they are required for upgrades. include::{tab-widgets}/install-layout-widget.asciidoc[] - - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/elastic-agent/run-elastic-agent-standalone.asciidoc b/docs/en/ingest-management/elastic-agent/run-elastic-agent-standalone.asciidoc index a00036504b..a7caf50306 100644 --- a/docs/en/ingest-management/elastic-agent/run-elastic-agent-standalone.asciidoc +++ b/docs/en/ingest-management/elastic-agent/run-elastic-agent-standalone.asciidoc @@ -4,7 +4,7 @@ Instead of using {fleet} to manage your {agent}s, you can run agents standalone. With standalone mode, you manually configure and manage the agents locally on -the systems where they are installed. +the systems where they are installed. IMPORTANT: Standalone agents are unable to update to new integration package versions automatically. When you update the package version in {kib}, you'll @@ -109,6 +109,3 @@ automatically if the system is rebooted. For additional configuration options, see <>. If you run into problems, see <>. - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/elastic-agent/start-elastic-agent.asciidoc b/docs/en/ingest-management/elastic-agent/start-elastic-agent.asciidoc index f89e42a024..562faf484e 100644 --- a/docs/en/ingest-management/elastic-agent/start-elastic-agent.asciidoc +++ b/docs/en/ingest-management/elastic-agent/start-elastic-agent.asciidoc @@ -6,6 +6,3 @@ If you've stopped the {agent} service and want to restart it, use the commands that work with your system: include::{tab-widgets}/start-widget.asciidoc[] - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/elastic-agent/stop-elastic-agent.asciidoc b/docs/en/ingest-management/elastic-agent/stop-elastic-agent.asciidoc index df0d9bf0de..0cee3490f5 100644 --- a/docs/en/ingest-management/elastic-agent/stop-elastic-agent.asciidoc +++ b/docs/en/ingest-management/elastic-agent/stop-elastic-agent.asciidoc @@ -3,9 +3,6 @@ = Stop {agent} To stop {agent} and its related executables, stop the {agent} service. Use the -commands that work with your system: +commands that work with your system: include::{tab-widgets}/stop-widget.asciidoc[] - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/elastic-agent/uninstall-elastic-agent.asciidoc b/docs/en/ingest-management/elastic-agent/uninstall-elastic-agent.asciidoc index f6c9e13ff2..8e1319b234 100644 --- a/docs/en/ingest-management/elastic-agent/uninstall-elastic-agent.asciidoc +++ b/docs/en/ingest-management/elastic-agent/uninstall-elastic-agent.asciidoc @@ -32,7 +32,7 @@ To remove {agent} manually from your system: . <> if it's managed by {fleet}. -. For standalone agents, back up any configuration files you want to preserve. +. For standalone agents, back up any configuration files you want to preserve. . On your host, <>. If any {agent}-related processes are still running, stop them too. @@ -52,6 +52,3 @@ NOTE: When you remove the {elastic-endpoint} integration from a macOS host (10.13, 10.14, or 10.15), the Endpoint System Extension is left on disk intentionally. If you want to remove the extension, refer to the documentation for your operating sytem. - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/elastic-agent/upgrade-elastic-agent.asciidoc b/docs/en/ingest-management/elastic-agent/upgrade-elastic-agent.asciidoc index cbc918d78f..cd4ceed95f 100644 --- a/docs/en/ingest-management/elastic-agent/upgrade-elastic-agent.asciidoc +++ b/docs/en/ingest-management/elastic-agent/upgrade-elastic-agent.asciidoc @@ -57,7 +57,7 @@ would run: [source,shell] ---- cd /Library/Elastic/Agent/ -sudo elastic-agent upgrade 7.10.1 +sudo elastic-agent upgrade 7.10.1 ---- For more command-line options, see the help for the @@ -68,7 +68,7 @@ For more command-line options, see the help for the == Upgrade from 7.12 or lower As part of the 7.13 release, we introduce <>, -a mechanism to connect your {agent}s to {fleet}. +a mechanism to connect your {agent}s to {fleet}. [WARNING] ==== @@ -120,6 +120,3 @@ NOTE: Starting from version 7.13.0 {fleet-server} is required. -- include::{observability-docs-root}/docs/en/ingest-management/getting-started.asciidoc[tag=agent-enroll] -- - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/fleet/fleet-server.asciidoc b/docs/en/ingest-management/fleet/fleet-server.asciidoc index 18ac489e76..50ab23a814 100644 --- a/docs/en/ingest-management/fleet/fleet-server.asciidoc +++ b/docs/en/ingest-management/fleet/fleet-server.asciidoc @@ -79,6 +79,3 @@ coming[a future update] //TODO: Describe how to scale up the number of {agent}s that can be managed in // {fleet} by deploying more Fleet Servers. Document limits and recommendations. // Also describe deployment options (like adding a load balancer) - -//needed to render tab widgets -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/getting-started-traces.asciidoc b/docs/en/ingest-management/getting-started-traces.asciidoc index 266baf43b1..98a5b330b7 100644 --- a/docs/en/ingest-management/getting-started-traces.asciidoc +++ b/docs/en/ingest-management/getting-started-traces.asciidoc @@ -119,7 +119,7 @@ If you run into problems: are collected automatically unless you change the default settings. For more information, refer to <>. -* Refer to <>. +* Refer to <>. [discrete] [[add-apm-integration]] @@ -230,6 +230,3 @@ problems while sipping your favorite beverage poolside. * Got everything working like you want it? Roll out your agent policies to other hosts by deploying {agent}s across your infrastructure! - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/getting-started.asciidoc b/docs/en/ingest-management/getting-started.asciidoc index 605151c668..a003b52b58 100644 --- a/docs/en/ingest-management/getting-started.asciidoc +++ b/docs/en/ingest-management/getting-started.asciidoc @@ -111,7 +111,7 @@ If you run into problems: are collected automatically unless you change the default settings. For more information, refer to <>. -* Refer to <>. +* Refer to <>. // end::agent-enroll[] [discrete] @@ -298,6 +298,3 @@ problems while sipping your favorite beverage poolside. * Got everything working like you want it? Roll out your agent policies to other hosts by deploying {agent}s across your infrastructure! - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/ingest-management/troubleshooting.asciidoc b/docs/en/ingest-management/troubleshooting.asciidoc index b3cb273c92..c259a39898 100644 --- a/docs/en/ingest-management/troubleshooting.asciidoc +++ b/docs/en/ingest-management/troubleshooting.asciidoc @@ -427,6 +427,3 @@ installed integrations. . Under advanced settings, set `windows.advanced.diagnostic.enabled` to `false`, and then save the integration. - -// Add Javascript and CSS for tabbed panels -include::{tab-widgets}/code.asciidoc[] diff --git a/docs/en/observability/add-observability-data.asciidoc b/docs/en/observability/add-observability-data.asciidoc index 13c32cd1e3..051cdc5bd9 100644 --- a/docs/en/observability/add-observability-data.asciidoc +++ b/docs/en/observability/add-observability-data.asciidoc @@ -36,6 +36,3 @@ services. For details, see <>. 4. If you have added an APM Server as part of an {ess-trial}[{ess}] deployment, configure your APM agents to send data to your {es} cluster. For details, see <>. - -// Add Javascript and CSS for tabbed panels -include::{shared}/tab-widget-code/code.asciidoc[] diff --git a/docs/en/observability/ingest-logs.asciidoc b/docs/en/observability/ingest-logs.asciidoc index 23d2a5a10b..f1db359963 100644 --- a/docs/en/observability/ingest-logs.asciidoc +++ b/docs/en/observability/ingest-logs.asciidoc @@ -58,7 +58,7 @@ To learn more about required roles and privileges, see {filebeat-ref}/feature-ro [NOTE] ===== -You can send data to other {filebeat-ref}/configuring-output.html[outputs], such as Logstash, +You can send data to other {filebeat-ref}/configuring-output.html[outputs], such as Logstash, but that requires additional configuration and setup. ===== @@ -96,7 +96,7 @@ default locations, set the `paths` variable: ---- - module: nginx access: - var.paths: ["/var/log/nginx/access.log*"] <1> + var.paths: ["/var/log/nginx/access.log*"] <1> ---- -- @@ -106,8 +106,8 @@ To see the full list of variables for a module, see the documentation under [TIP] ===== To test your configuration file, change to the directory where the {beatname_uc} binary -is installed, and run {beatname_uc} in the foreground with the following options specified: -`./filebeat test config -e`. Make sure your config files are in the path expected by +is installed, and run {beatname_uc} in the foreground with the following options specified: +`./filebeat test config -e`. Make sure your config files are in the path expected by {beatname_uc} (see {filebeat-ref}/directory-layout.html[Directory layout]), or use the `-c` flag to specify the path to the config file. ===== @@ -116,7 +116,7 @@ For more information about configuring {beatname_uc}, also see: * {filebeat-ref}/configuring-howto-filebeat.html[Configure {beatname_uc}] * {beats-ref}/config-file-format.html[Config file format] -* {filebeat-ref}/filebeat-reference-yml.html[`filebeat.reference.yml`]: This reference +* {filebeat-ref}/filebeat-reference-yml.html[`filebeat.reference.yml`]: This reference configuration file shows all non-deprecated options. You’ll find it in the same location as `filebeat.yml`. [[set-filebeat-assets]] @@ -193,9 +193,6 @@ examine the document contents in either table or JSON format, and view a documen Now let's have a look at the <>. -// Add Javascript and CSS for tabbed panels -include::{beats-repo-dir}/tab-widgets/code.asciidoc[] - :!beatname_uc: :!beatname_lc: :!beatname_pkg: diff --git a/docs/en/observability/ingest-metrics.asciidoc b/docs/en/observability/ingest-metrics.asciidoc index 7893f0781c..349fa67348 100644 --- a/docs/en/observability/ingest-metrics.asciidoc +++ b/docs/en/observability/ingest-metrics.asciidoc @@ -17,7 +17,7 @@ If you haven't already, you need to install {es} for storing and searching your managing it. For more information, see <>. ===== -Install and configure {metricbeat} on your servers to collect and preprocess system +Install and configure {metricbeat} on your servers to collect and preprocess system and service metrics, such as information about running processes, as well as CPU, memory, disk, and network utilization numbers. @@ -31,7 +31,7 @@ Redis or MySQL. A module consists of metricsets that fetch and structure the dat [[install-metricbeat]] == Step 1: Install {metricbeat} -Install {metricbeat} as close as possible to the service you want to monitor. +Install {metricbeat} as close as possible to the service you want to monitor. To download and install {metricbeat}, use the commands that work with your system: @@ -43,7 +43,7 @@ include::{beats-repo-dir}/tab-widgets/install-widget.asciidoc[] * {metricbeat-ref}/running-on-docker.html[Docker] * {metricbeat-ref}/running-on-cloudfoundry.html[Cloud Foundry] * {metricbeat-ref}/setup-repositories.html[APT or YUM] -* https://www.elastic.co/downloads/beats/{beatname_lc}[Download page] +* https://www.elastic.co/downloads/beats/{beatname_lc}[Download page] [[metrics-connect-to-stack]] == Step 2: Connect to {es} and {kib} @@ -79,14 +79,14 @@ See the {metricbeat-ref}/command-line-options.html#modules-command[modules comma to learn more about this command. If you are using a Docker image, see {metricbeat-ref}/running-on-docker.html[Run Metricbeat on Docker]. -. In the module configs under `modules.d`, change the module settings to match your environment. +. In the module configs under `modules.d`, change the module settings to match your environment. See {metricbeat-ref}/configuration-metricbeat.html#module-config-options[Standard config options] for more about available settings. -TIP: To test your configuration file, change to the directory where the {beatname_uc} binary is installed, and run +TIP: To test your configuration file, change to the directory where the {beatname_uc} binary is installed, and run {beatname_uc} in the foreground with the following options specified: `./metricbeat test config -e`. Make sure -your config files are in the path expected by {beatname_uc} (see -{metricbeat-ref}/directory-layout.html[Directory layout]), or use +your config files are in the path expected by {beatname_uc} (see +{metricbeat-ref}/directory-layout.html[Directory layout]), or use the `-c` flag to specify the path to the config file. For more information about configuring {beatname_uc}, also see: @@ -148,16 +148,13 @@ include::{beats-repo-dir}/tab-widgets/open-kibana-widget.asciidoc[] . Open the main menu, then click *Discover* + -. Select `metricbeat-*` as your index pattern. +. Select `metricbeat-*` as your index pattern. + Each document in the index that matches the `metricbeat-*` index pattern is displayed. By default, *Discover* shows data for the last 15 minutes. Now let's have a look at the <>. -// Add Javascript and CSS for tabbed panels -include::{beats-repo-dir}/tab-widgets/code.asciidoc[] - :!beatname_uc: :!beatname_lc: :!beatname_pkg: diff --git a/docs/en/observability/ingest-uptime.asciidoc b/docs/en/observability/ingest-uptime.asciidoc index 9c5c83b4cc..7710954cca 100644 --- a/docs/en/observability/ingest-uptime.asciidoc +++ b/docs/en/observability/ingest-uptime.asciidoc @@ -15,10 +15,10 @@ If you haven't already, you need to install {es} for storing and searching your managing it. For more information, see <>. ===== -Install and configure {heartbeat} on your servers to periodically check the status of your -services. {heartbeat} uses probing to monitor the availability of services and helps +Install and configure {heartbeat} on your servers to periodically check the status of your +services. {heartbeat} uses probing to monitor the availability of services and helps verify that you’re meeting your service level agreements for service uptime. -You typically install {heartbeat} as part of a monitoring service that runs on a separate machine +You typically install {heartbeat} as part of a monitoring service that runs on a separate machine and possibly even outside of the network where the services that you want to monitor are running. [[deployment-considerations]] @@ -43,7 +43,7 @@ To check if your site is reachable via CDN POPS, deploy multiple {heartbeat} ins different data centers around the world. + * A service within a single data center that is accessed across multiple VPNs. -+ ++ Set up one {heartbeat} instance within the VPN the service operates from, and another within an additional VPN that users access the service from. In the event of an outage, having both instances helps pinpoint the network errors. @@ -59,7 +59,7 @@ immediately apparent if the service has a connectivity issue to the outside worl [[install-heartbeat]] == Step 1: Install {beatname_uc} -You typically install {heartbeat} as part of a monitoring service that runs on a separate machine +You typically install {heartbeat} as part of a monitoring service that runs on a separate machine and possibly even outside of the network where the services that you want to monitor are running. To download and install {beatname_uc}, use the commands that work with your system: @@ -86,7 +86,7 @@ include::{beats-repo-dir}/tab-widgets/set-connection-widget.asciidoc[] [NOTE] ===== -You can send data to other {heartbeat-ref}/configuring-output.html[outputs], such as Logstash, +You can send data to other {heartbeat-ref}/configuring-output.html[outputs], such as Logstash, but that requires additional configuration and setup. ===== @@ -98,7 +98,7 @@ To learn more about required roles and privileges, see {heartbeat-ref}/feature-r {beatname_uc} provides monitors to check the status of hosts at set intervals. {beatname_uc} currently provides monitors for ICMP, TCP, and HTTP (see -{heartbeat-ref}/heartbeat-overview.html[{beatname_uc} overview] for more about these monitors). +{heartbeat-ref}/heartbeat-overview.html[{beatname_uc} overview] for more about these monitors). You configure each monitor individually. In `heartbeat.yml`, specify the list of monitors that you want to enable. Each item in the list begins with a @@ -128,10 +128,10 @@ was started. {beatname_uc} adds the `@every` keyword to the syntax provided by t [TIP] ===== -To test your configuration file, change to the directory where the {beatname_uc} binary -is installed, and run {beatname_uc} in the foreground with the following options specified: -`./heartbeat test config -e`. Make sure your config files are in the path expected by -{beatname_uc} (see {heartbeat-ref}/directory-layout.html[Directory layout]), or use the +To test your configuration file, change to the directory where the {beatname_uc} binary +is installed, and run {beatname_uc} in the foreground with the following options specified: +`./heartbeat test config -e`. Make sure your config files are in the path expected by +{beatname_uc} (see {heartbeat-ref}/directory-layout.html[Directory layout]), or use the `-c` flag to specify the path to the config file. ===== @@ -139,20 +139,20 @@ For more information about configuring {beatname_uc}, also see: * {heartbeat-ref}/configuring-howto-heartbeat.html[Configure {beatname_uc}] * {beats-ref}/config-file-format.html[Config file format] -* {heartbeat-ref}/heartbeat-reference-yml.html[`heartbeat.reference.yml`]: This +* {heartbeat-ref}/heartbeat-reference-yml.html[`heartbeat.reference.yml`]: This reference configuration file shows all non-deprecated options. You’ll find it in the same location as `heartbeat.yml`. [[configure-heartbeat-location]] == Step 4: Configure {beatname_uc} location -{beatname_uc} can be deployed in multiple locations so that you can detect +{beatname_uc} can be deployed in multiple locations so that you can detect differences in availability and response times across those locations. Configure the {beatname_uc} location to allow {kib} to display location-specific information on Uptime maps and perform Uptime anomaly detection based on location. -To configure the location of a {beatname_uc} instance, modify the -`add_observer_metadata` processor in +{beatname_lc}.yml+. The following +To configure the location of a {beatname_uc} instance, modify the +`add_observer_metadata` processor in +{beatname_lc}.yml+. The following example specifies the `geo.name` of the `add_observer_metadata` processor as `us-east-1a`: @@ -176,10 +176,10 @@ processors: [TIP] ===== -To test your configuration file, change to the directory where the {beatname_uc} binary -is installed, and run {beatname_uc} in the foreground with the following options specified: -`./heartbeat test config -e`. Make sure your config files are in the path expected by -{beatname_uc} (see {heartbeat-ref}/directory-layout.html[Directory layout]), or use the +To test your configuration file, change to the directory where the {beatname_uc} binary +is installed, and run {beatname_uc} in the foreground with the following options specified: +`./heartbeat test config -e`. Make sure your config files are in the path expected by +{beatname_uc} (see {heartbeat-ref}/directory-layout.html[Directory layout]), or use the `-c` flag to specify the path to the config file. ===== @@ -201,7 +201,7 @@ include::{beats-repo-dir}/tab-widgets/setup-widget.asciidoc[] `-e` is optional and sends output to standard error instead of the configured log output. This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}. -It does not install {beatname_uc} dashboards. {beatname_uc} dashboards and +It does not install {beatname_uc} dashboards. {beatname_uc} dashboards and installation steps are available in the https://github.com/elastic/uptime-contrib[uptime-contrib] GitHub repository. @@ -244,9 +244,6 @@ include::{beats-repo-dir}/tab-widgets/open-kibana-widget.asciidoc[] Now let's have a look at the <>. -// Add Javascript and CSS for tabbed panels -include::{beats-repo-dir}/tab-widgets/code.asciidoc[] - :!beatname_uc: :!beatname_lc: :!beatname_pkg: diff --git a/docs/en/observability/instrument-apps.asciidoc b/docs/en/observability/instrument-apps.asciidoc index ebb4672746..378aded8ed 100644 --- a/docs/en/observability/instrument-apps.asciidoc +++ b/docs/en/observability/instrument-apps.asciidoc @@ -56,8 +56,5 @@ include::{beats-repo-dir}/tab-widgets/open-kibana-widget.asciidoc[] . In the side navigation, select *Observability*, and click *Overview*. -// Add Javascript and CSS for tabbed panels -include::{beats-repo-dir}/tab-widgets/code.asciidoc[] - :!beatname_uc: :!beatname_lc: diff --git a/docs/en/observability/monitor-aws.asciidoc b/docs/en/observability/monitor-aws.asciidoc index 8bc2cc2c2b..0c8d8c7147 100644 --- a/docs/en/observability/monitor-aws.asciidoc +++ b/docs/en/observability/monitor-aws.asciidoc @@ -430,6 +430,3 @@ If you want to track your billings on {aws}, you can also check the **[Metricbeat AWS] Billing Overview** dashboard: image::aws-billing.png[Billing Overview] - -// Add Javascript and CSS for tabbed panels -include::{beats-repo-dir}/tab-widgets/code.asciidoc[] diff --git a/docs/en/observability/monitor-azure.asciidoc b/docs/en/observability/monitor-azure.asciidoc index d178085846..d4ed4e9e34 100644 --- a/docs/en/observability/monitor-azure.asciidoc +++ b/docs/en/observability/monitor-azure.asciidoc @@ -120,7 +120,7 @@ This may take a few minutes. [role="screenshot"] image:monitor-azure-kibana-observability-page-data.png[{kib} observability page (with data)] - + . To access the Logs app and analyze all your subscription and resource logs, click *View in app*. + @@ -165,7 +165,7 @@ To view the data for all the monitored VMs, delete the filter. === Step 4: Ingest other Azure metrics using the {metricbeat} Azure module Some Azure metrics are not available via the native integration. -If you want to collect those metrics, you need to use the +If you want to collect those metrics, you need to use the https://docs.microsoft.com/en-us/rest/api/monitor/[Azure Monitor REST API] and {metricbeat}. @@ -361,6 +361,3 @@ dashboard. Keep in mind it collects data every 24 hours. [role="screenshot"] image:monitor-azure-billing-overview-dashboard.png[{metricbeat} azure billing overview dashboard] - -// Add Javascript and CSS for tabbed panels -include::{beats-repo-dir}/tab-widgets/code.asciidoc[] diff --git a/docs/en/observability/monitor-gcp.asciidoc b/docs/en/observability/monitor-gcp.asciidoc index 517c1c87bc..490cfcec4e 100644 --- a/docs/en/observability/monitor-gcp.asciidoc +++ b/docs/en/observability/monitor-gcp.asciidoc @@ -258,6 +258,3 @@ the file if it does not exist and to use the correct full path). dashboard. + image::monitor-gcp-audit-overview-dashboard.png[{filebeat} audit overview dashboard] - -// Add Javascript and CSS for tabbed panels -include::{beats-repo-dir}/tab-widgets/code.asciidoc[] diff --git a/docs/en/observability/monitor-java-app.asciidoc b/docs/en/observability/monitor-java-app.asciidoc index 8fe9189108..d249d76261 100644 --- a/docs/en/observability/monitor-java-app.asciidoc +++ b/docs/en/observability/monitor-java-app.asciidoc @@ -35,7 +35,7 @@ To create the Java application, you require OpenJDK 14 (or higher) and the https web framework. The application will include the main endpoint, an artificially long-running endpoint, and an endpoint that needs to poll another data source. There will also be a background job -running. +running. . Set up a Gradle project and create the following `build.gradle` file. + @@ -155,7 +155,7 @@ import io.javalin.Javalin; import io.javalin.http.Handler; public class App { - + public static void main(String[] args) { Javalin app = Javalin.create().start(7000); app.get("/", mainHandler()); @@ -233,7 +233,7 @@ public class AppTests { === Step 2: Ingest logs Logs can be events such as checkout, an exception, or an HTTP request. For this tutorial, -let's use log4j2 as our logging implementation. +let's use log4j2 as our logging implementation. [discrete] ==== Add logging implementation @@ -446,9 +446,9 @@ following request: ---- POST /_security/api_key { - "name": "filebeat_javalin-app", + "name": "filebeat_javalin-app", "role_descriptors": { - "filebeat_writer": { + "filebeat_writer": { "cluster": ["monitor", "read_ilm"], "index": [ { @@ -903,7 +903,7 @@ logging configuration. The sample added a `JavalinAppLogRolling` appender to our configuration that uses the same logging pattern as before, but rolls over if a new day -starts or if the log file has reached 50 megabytes. +starts or if the log file has reached 50 megabytes. If a new log file is created, older log files are gzipped as well to take less space on disk. The size of 50 megabytes refers to the unpacked file size, so @@ -949,7 +949,7 @@ PUT _ingest/pipeline/javalin_pipeline } ] } - + # Test the pipeline POST _ingest/pipeline/javalin_pipeline/_simulate { @@ -1032,7 +1032,7 @@ dependencies { testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.2' } -// this is needed to ensure JSON logging works as expected when building +// this is needed to ensure JSON logging works as expected when building // a shadow jar shadowJar { transform(com.github.jengelman.gradle.plugins.shadow.transformers.Log4j2PluginsCacheFileTransformer) @@ -1364,7 +1364,7 @@ visualization called `Lens`. . Log into {kib} and select *Visualize* -> *Create Visualization*. + -. Create a line chart and select `metricbeat-*` as the source. +. Create a line chart and select `metricbeat-*` as the source. + The basic idea is to have a {ref}/search-aggregations-metrics-max-aggregation.html[max @@ -1491,7 +1491,7 @@ visualization than shown, with a peak where you ran the `wrk` command above. You will only see data from a single shipper. Still, the moment you are running several services and the ability to group this per Kubernetes pod or host enables you to spot hosts with elevated -CPU or memory consumption. +CPU or memory consumption. + . Click *Metrics Explorer*, you can start exploring your data for specific hosts or the CPU usage across your @@ -1661,7 +1661,7 @@ your source code. [source,gradle] ---- dependencies { - ... + ... implementation 'co.elastic.apm:apm-agent-attach:1.17.0' ... } @@ -1827,13 +1827,13 @@ image:./images/monitor-java-app-apm-ui-javalin-wttr-2.png[Transaction with span] If the `city` parameter if that URL is of high cardinality, this will result in a high amount of URLs mentioned instead of the generic endpoint. If you would like to prevent this, a possibility would -be to use `ctx.matchedPath()` to log every call to the weather API as +be to use `ctx.matchedPath()` to log every call to the weather API as `GET /weather/:city`. This however requires some refactoring by removing the `app.before()` handler and replacing it with a `app.after()` handler. + [source,java] ---- -app.after(ctx -> ElasticApm.currentTransaction().setName(ctx.method() +app.after(ctx -> ElasticApm.currentTransaction().setName(ctx.method() + " " + ctx.endpointHandlerPath())); ---- @@ -1997,7 +1997,7 @@ and install {heartbeat}, use the commands that work with your system: include::{beats-repo-dir}/tab-widgets/install-widget-heartbeat.asciidoc[] After downloading and unpacking, we have to set up the cloud id and the -password one more time. +password one more time. . We need to create another `API_KEY` as an elastic admin user in {kib}. + @@ -2073,7 +2073,7 @@ processors: include::{beats-repo-dir}/tab-widgets/start-widget-heartbeat.asciidoc[] -To view the Uptime app, +To view the Uptime app, select *Observability* -> *Uptime*. The overview looks like this. @@ -2085,7 +2085,7 @@ details for one of those alerts. Click *Javalin Web Application*. You can see the execution for the last scheduled checks, but the duration for each check might be more interesting. -You can see if the latency for one of your checks is going up. +You can see if the latency for one of your checks is going up. The interesting part is the world map at the top. You can specify in the configuration where the check originated, which in this case was in Munich in Europe. @@ -2110,6 +2110,3 @@ the time. For more information about using Elastic Observability, see the <>. - -// Add Javascript and CSS for tabbed panels -include::{beats-repo-dir}/tab-widgets/code.asciidoc[] diff --git a/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc b/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc index b6757cdb9d..4f40a690df 100644 --- a/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc +++ b/docs/en/observability/monitor-k8s/monitor-k8s.asciidoc @@ -68,6 +68,3 @@ problems while sipping your favorite beverage poolside. * Want Elastic to do the heavy lifting? Use machine learning to {observability-guide}/inspect-log-anomalies.html[detect anomalies]. - -// required for tab widgets -include::{shared}/tab-widget-code/code.asciidoc[] diff --git a/docs/en/shared/tab-widget-code/code.asciidoc b/docs/en/shared/tab-widget-code/code.asciidoc deleted file mode 100644 index 718a71bfec..0000000000 --- a/docs/en/shared/tab-widget-code/code.asciidoc +++ /dev/null @@ -1,166 +0,0 @@ -// Defining styles and script here for simplicity. -++++ - - - -++++