Skip to content

Commit

Permalink
docs: remove tab widget code (elastic#997)
Browse files Browse the repository at this point in the history
# Conflicts:
#	docs/en/ingest-management/troubleshooting.asciidoc
  • Loading branch information
bmorelli25 committed Aug 25, 2021
1 parent da72eab commit ecb5cdd
Show file tree
Hide file tree
Showing 22 changed files with 60 additions and 290 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,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[]
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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[]
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -109,6 +109,3 @@ automatically if the system is rebooted.
For additional configuration options, see <<elastic-agent-configuration>>.

If you run into problems, see <<fleet-troubleshooting>>.

// Add Javascript and CSS for tabbed panels
include::{tab-widgets}/code.asciidoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To remove {agent} manually from your system:

. <<unenroll-elastic-agent,Unenroll the agent>> 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, <<stop-elastic-agent,stop the agent>>. If any {agent}-related
processes are still running, stop them too.
Expand All @@ -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[]
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <<fleet-server,{fleet-server}>>,
a mechanism to connect your {agent}s to {fleet}.
a mechanism to connect your {agent}s to {fleet}.

[WARNING]
====
Expand Down Expand Up @@ -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[]
3 changes: 0 additions & 3 deletions docs/en/ingest-management/fleet/fleet-server.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
5 changes: 1 addition & 4 deletions docs/en/ingest-management/getting-started-traces.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ If you run into problems:
are collected automatically unless you change the default settings. For more
information, refer to <<elastic-agent-logging>>.

* Refer to <<fleet-troubleshooting>>.
* Refer to <<fleet-troubleshooting>>.

[discrete]
[[add-apm-integration]]
Expand Down Expand Up @@ -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[]
5 changes: 1 addition & 4 deletions docs/en/ingest-management/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ If you run into problems:
are collected automatically unless you change the default settings. For more
information, refer to <<elastic-agent-logging>>.

* Refer to <<fleet-troubleshooting>>.
* Refer to <<fleet-troubleshooting>>.
// end::agent-enroll[]

[discrete]
Expand Down Expand Up @@ -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[]
5 changes: 1 addition & 4 deletions docs/en/ingest-management/troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -427,9 +427,6 @@ 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[]


[discrete]
[[fleet-ece-config]]
Expand All @@ -442,6 +439,6 @@ When an {ece} deployment is set up with APM and {fleet}, even though the deploym
WARN [transport] transport/tcp.go:52 DNS lookup failure "instance-000000 0000": lookup instance-0000000000 on 169.254.165.225:23: no such host
----

This is a known issue with the {stack} pack version 7.14 and {ece} version 2.10. With the original {stack} pack version 7.14, if downloaded from the Elastic website before August 10, 2021, Fleet does not work when enabled in a deployment.
This is a known issue with the {stack} pack version 7.14 and {ece} version 2.10. With the original {stack} pack version 7.14, if downloaded from the Elastic website before August 10, 2021, Fleet does not work when enabled in a deployment.

To resolve the problem, link:{ece-ref}/ece-manage-elastic-stack.html[get and re-upload a fresh copy] of the version 7.14 {stack} pack to overwrite the original one. If you have existing version 7.14 deployments, then restart Fleet/APM after re-uploading the {stack} pack to enable Fleet. This issue will be addressed in later stack packs and {s} versions.
3 changes: 0 additions & 3 deletions docs/en/observability/add-observability-data.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,3 @@ services. For details, see <<ingest-uptime,Ingest uptime data>>.

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 <<instrument-apps,Instrument applications>>.

// Add Javascript and CSS for tabbed panels
include::{shared}/tab-widget-code/code.asciidoc[]
13 changes: 5 additions & 8 deletions docs/en/observability/ingest-logs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
=====
Expand Down Expand Up @@ -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>
----
--

Expand All @@ -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.
=====
Expand All @@ -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]]
Expand Down Expand Up @@ -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 <<monitor-logs,Logs app>>.

// Add Javascript and CSS for tabbed panels
include::{beats-repo-dir}/tab-widgets/code.asciidoc[]

:!beatname_uc:
:!beatname_lc:
:!beatname_pkg:
Expand Down
19 changes: 8 additions & 11 deletions docs/en/observability/ingest-metrics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<add-observability-data,Send data to {es}>>.
=====

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.

Expand All @@ -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:

Expand All @@ -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}
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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 <<analyze-metrics,Metrics app>>.

// Add Javascript and CSS for tabbed panels
include::{beats-repo-dir}/tab-widgets/code.asciidoc[]

:!beatname_uc:
:!beatname_lc:
:!beatname_pkg:
Expand Down
43 changes: 20 additions & 23 deletions docs/en/observability/ingest-uptime.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<add-observability-data,Send data to {es}>>.
=====

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]]
Expand All @@ -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.
Expand All @@ -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:
Expand All @@ -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.
=====
Expand All @@ -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
Expand Down Expand Up @@ -128,31 +128,31 @@ 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.
=====

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`:

Expand All @@ -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.
=====

Expand All @@ -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.

Expand Down Expand Up @@ -244,9 +244,6 @@ include::{beats-repo-dir}/tab-widgets/open-kibana-widget.asciidoc[]

Now let's have a look at the <<monitor-uptime,Uptime app>>.

// Add Javascript and CSS for tabbed panels
include::{beats-repo-dir}/tab-widgets/code.asciidoc[]

:!beatname_uc:
:!beatname_lc:
:!beatname_pkg:
Loading

0 comments on commit ecb5cdd

Please sign in to comment.