Skip to content

Commit d072ab0

Browse files
[docs] Miscellaneous docs clean up (#17372) (#17383)
* remove unused substitutions * move images * validate build (cherry picked from commit 284272b) Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
1 parent 3092c03 commit d072ab0

32 files changed

+30
-480
lines changed

docs/docset.yml

Lines changed: 0 additions & 450 deletions
Large diffs are not rendered by default.

docs/reference/advanced-pipeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ A few log entries come from Buffalo, so the query produces the following respons
601601

602602
If you are using Kibana to visualize your data, you can also explore the Filebeat data in Kibana:
603603

604-
:::{image} ../images/kibana-filebeat-data.png
604+
:::{image} images/kibana-filebeat-data.png
605605
:alt: Discovering Filebeat data in Kibana
606606
:::
607607

docs/reference/dashboard-monitoring-with-elastic-agent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Check out [Installing {{agent}}](docs-content://reference/ingestion-tools/fleet/
6464

6565
1. Go to the {{kib}} home page, and click **Add integrations**.
6666

67-
:::{image} ../images/kibana-home.png
67+
:::{image} images/kibana-home.png
6868
:alt: {{kib}} home page
6969
:class: screenshot
7070
:::
@@ -125,7 +125,7 @@ After you have confirmed enrollment and data is coming in, click **View assets*
125125

126126
For traditional Stack Monitoring UI, the dashboards marked **[Logs {{ls}}]** are used to visualize the logs produced by your {{ls}} instances, with those marked **[Metrics {{ls}}]** for the technical preview metrics dashboards. These are populated with data only if you selected the **Metrics (Technical Preview)** checkbox.
127127

128-
:::{image} ../images/integration-assets-dashboards.png
128+
:::{image} images/integration-assets-dashboards.png
129129
:alt: Integration assets
130130
:class: screenshot
131131
:::
@@ -137,7 +137,7 @@ A number of dashboards are included to view {{ls}} as a whole, and dashboards th
137137

138138
From the list of assets, open the **[Metrics {{ls}}] {{ls}} overview** dashboard to view overall performance. Then follow the navigation panel to further drill down into {{ls}} performance.
139139

140-
:::{image} ../images/integration-dashboard-overview.png
140+
:::{image} images/integration-dashboard-overview.png
141141
:alt: The {{ls}} Overview dashboard in {{kib}} with various metrics from your monitored {ls}
142142
:class: screenshot
143143
:::

docs/reference/dead-letter-queues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Each event written to the dead letter queue includes the original event, metadat
2424

2525
To process events in the dead letter queue, create a Logstash pipeline configuration that uses the [`dead_letter_queue` input plugin](/reference/plugins-inputs-dead_letter_queue.md) to read from the queue. See [Processing events in the dead letter queue](#processing-dlq-events) for more information.
2626

27-
:::{image} ../images/dead_letter_queue.png
27+
:::{image} images/dead_letter_queue.png
2828
:alt: Diagram showing pipeline reading from the dead letter queue
2929
:::
3030

docs/reference/deploying-scaling-logstash.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The goal of this document is to highlight the most common architecture patterns
1414

1515
For first time users, if you simply want to tail a log file to grasp the power of the Elastic Stack, we recommend trying [Filebeat Modules](beats://reference/filebeat/filebeat-modules-overview.md). Filebeat Modules enable you to quickly collect, parse, and index popular log types and view pre-built Kibana dashboards within minutes. [Metricbeat Modules](beats://reference/metricbeat/metricbeat-modules.md) provide a similar experience, but with metrics data. In this context, Beats will ship data directly to Elasticsearch where [Ingest Nodes](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md) will process and index your data.
1616

17-
:::{image} ../images/deploy1.png
17+
:::{image} images/deploy1.png
1818
:alt: deploy1
1919
:::
2020

@@ -42,7 +42,7 @@ Beats and Logstash make ingest awesome. Together, they provide a comprehensive s
4242

4343
Beats run across thousands of edge host servers, collecting, tailing, and shipping logs to Logstash. Logstash serves as the centralized streaming engine for data unification and enrichment. The [Beats input plugin](/reference/plugins-inputs-beats.md) exposes a secure, acknowledgement-based endpoint for Beats to send data to Logstash.
4444

45-
:::{image} ../images/deploy2.png
45+
:::{image} images/deploy2.png
4646
:alt: deploy2
4747
:::
4848

@@ -97,7 +97,7 @@ If external monitoring is preferred, there are [monitoring APIs](monitoring-logs
9797

9898
Users may have other mechanisms of collecting logging data, and it’s easy to integrate and centralize them into the Elastic Stack. Let’s walk through a few scenarios:
9999

100-
:::{image} ../images/deploy3.png
100+
:::{image} images/deploy3.png
101101
:alt: deploy3
102102
:::
103103

@@ -145,7 +145,7 @@ If you are leveraging message queuing technologies as part of your existing infr
145145

146146
For users who want to integrate data from existing Kafka deployments or require the underlying usage of ephemeral storage, Kafka can serve as a data hub where Beats can persist to and Logstash nodes can consume from.
147147

148-
:::{image} ../images/deploy4.png
148+
:::{image} images/deploy4.png
149149
:alt: deploy4
150150
:::
151151

docs/reference/first-event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ First, let’s test your Logstash installation by running the most basic *Logsta
99

1010
A Logstash pipeline has two required elements, `input` and `output`, and one optional element, `filter`. The input plugins consume data from a source, the filter plugins modify the data as you specify, and the output plugins write the data to a destination.
1111

12-
:::{image} ../images/basic_logstash_pipeline.png
12+
:::{image} images/basic_logstash_pipeline.png
1313
:alt: basic logstash pipeline
1414
:::
1515

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/reference/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,24 @@ mapped_pages:
77

88
# Logstash introduction [introduction]
99

10-
Logstash is an open source data collection engine with real-time pipelining capabilities.
11-
Logstash can dynamically unify data from disparate sources and normalize the data into destinations of your choice.
10+
Logstash is an open source data collection engine with real-time pipelining capabilities.
11+
Logstash can dynamically unify data from disparate sources and normalize the data into destinations of your choice.
1212
Cleanse and democratize all your data for diverse advanced downstream analytics and visualization use cases.
1313

14-
While Logstash originally drove innovation in log collection, its capabilities extend well beyond that use case.
15-
Any type of event can be enriched and transformed with a broad array of input, filter, and output plugins, with many native codecs further simplifying the ingestion process.
14+
While Logstash originally drove innovation in log collection, its capabilities extend well beyond that use case.
15+
Any type of event can be enriched and transformed with a broad array of input, filter, and output plugins, with many native codecs further simplifying the ingestion process.
1616
Logstash accelerates your insights by harnessing a greater volume and variety of data.
1717

1818
::::{admonition} {{ls}} to {{serverless-full}}
19-
You’ll use the {{ls}} [{{es}} output plugin](/logstash/docs/reference/plugins-outputs-elasticsearch.md) to send data to {{serverless-full}}.
19+
You’ll use the {{ls}} [{{es}} output plugin](/reference/plugins-outputs-elasticsearch.md) to send data to {{serverless-full}}.
2020
Note these differences between {{es-serverless}} and both {{ess}} and self-managed {{es}}:
2121

22-
* Use **API keys** to access {{serverless-full}} from {{ls}}. Any user-based security settings in your in your [{{es}} output plugin](/logstash/docs/reference/plugins-outputs-elasticsearch.md) configuration are ignored and may cause errors.
23-
* {{serverless-full}} uses **data streams** and [{{dlm}} ({{dlm-init}})](docs-content://manage-data/lifecycle/data-stream.md) instead of {{ilm}} ({{ilm-init}}). Any {{ilm-init}} settings in your [{{es}} output plugin](/logstash/docs/reference/plugins-outputs-elasticsearch.md) configuration are ignored and may cause errors.
22+
* Use **API keys** to access {{serverless-full}} from {{ls}}. Any user-based security settings in your in your [{{es}} output plugin](/reference/plugins-outputs-elasticsearch.md) configuration are ignored and may cause errors.
23+
* {{serverless-full}} uses **data streams** and [{{dlm}} ({{dlm-init}})](docs-content://manage-data/lifecycle/data-stream.md) instead of {{ilm}} ({{ilm-init}}). Any {{ilm-init}} settings in your [{{es}} output plugin](/reference/plugins-outputs-elasticsearch.md) configuration are ignored and may cause errors.
2424
* **{{ls}} monitoring** is available through the [{{ls}} Integration](https://github.com/elastic/integrations/blob/main/packages/logstash/_dev/build/docs/README.md) in [Elastic Observability](docs-content://solutions/observability.md) on {{serverless-full}}.
2525

26-
**Known issue for Logstash to Elasticsearch Serverless.**
27-
The logstash-output-elasticsearch `hosts` setting defaults to port :9200.
26+
**Known issue for Logstash to Elasticsearch Serverless.**
27+
The logstash-output-elasticsearch `hosts` setting defaults to port :9200.
2828
Set the value to port :443 instead.
2929

3030
::::

docs/reference/logstash-centralized-pipeline-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To manage Logstash pipelines in {{kib}}:
3030

3131
1. Open {{kib}} in your browser and go to the Management tab. If you’ve set up configuration management correctly, you’ll see an area for managing Logstash.
3232

33-
:::{image} ../images/centralized_config.png
33+
:::{image} images/centralized_config.png
3434
:alt: centralized config
3535
:::
3636

docs/reference/logstash-monitoring-ui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ mapped_pages:
77

88
Use the {{stack}} {{monitor-features}} to view metrics and gain insight into how your {{ls}} deployment is running. In the overview dashboard, you can see all events received and sent by Logstash, plus info about memory usage and uptime:
99

10-
:::{image} ../images/overviewstats.png
10+
:::{image} images/overviewstats.png
1111
:alt: Logstash monitoring overview dashboard in Kibana
1212
:::
1313

1414
Then you can drill down to see stats about a specific node:
1515

16-
:::{image} ../images/nodestats.png
16+
:::{image} images/nodestats.png
1717
:alt: Logstash monitoring node stats dashboard in Kibana
1818
:::
1919

docs/reference/logstash-pipeline-viewer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The pipeline viewer UI offers additional visibility into the behavior and perfor
99

1010
The pipeline viewer highlights CPU% and event latency in cases where the values are anomalous. This information helps you quickly identify processing that is disproportionately slow.
1111

12-
:::{image} ../images/pipeline-tree.png
12+
:::{image} images/pipeline-tree.png
1313
:alt: Pipeline Viewer
1414
:class: screenshot
1515
:::
@@ -35,7 +35,7 @@ Each pipeline is identified by a pipeline ID (`main` by default). For each pipel
3535

3636
Many elements in the tree are clickable. For example, you can click the plugin name to expand the detail view.
3737

38-
:::{image} ../images/pipeline-input-detail.png
38+
:::{image} images/pipeline-input-detail.png
3939
:alt: Pipeline Input Detail
4040
:class: screenshot
4141
:::

docs/reference/monitoring-internal-collection-legacy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ To monitor Logstash nodes:
169169
5. Restart your Logstash nodes.
170170
6. To verify your monitoring configuration, point your web browser at your {{kib}} host, and select **Stack Monitoring** from the side navigation. If this is an initial setup, select **set up with self monitoring** and click **Turn on monitoring**. Metrics reported from your Logstash nodes should be visible in the Logstash section. When security is enabled, to view the monitoring dashboards you must log in to {{kib}} as a user who has the `kibana_user` and `monitoring_user` roles.
171171

172-
:::{image} ../images/monitoring-ui.png
172+
:::{image} images/monitoring-ui.png
173173
:alt: Monitoring
174174
:::
175175

docs/reference/monitoring-with-elastic-agent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Check out [Installing {{agent}}](docs-content://reference/ingestion-tools/fleet/
7272

7373
1. Go to the {{kib}} home page, and click **Add integrations**.
7474

75-
:::{image} ../images/kibana-home.png
75+
:::{image} images/kibana-home.png
7676
:alt: {{kib}} home page
7777
:class: screenshot
7878
:::
@@ -133,7 +133,7 @@ After you have confirmed enrollment and data is coming in, click **View assets*
133133

134134
For traditional Stack Monitoring UI, the dashboards marked **[Logs {{ls}}]** are used to visualize the logs produced by your {{ls}} instances, with those marked **[Metrics {{ls}}]** for the technical preview metrics dashboards. These are populated with data only if you selected the **Metrics (Technical Preview)** checkbox.
135135

136-
:::{image} ../images/integration-assets-dashboards.png
136+
:::{image} images/integration-assets-dashboards.png
137137
:alt: Integration assets
138138
:class: screenshot
139139
:::

docs/reference/serverless-monitoring-with-elastic-agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ For more info, check out the [Elastic Observability](docs-content://solutions/ob
6060

6161
From the list of assets, open the **[Metrics {{ls}}] {{ls}} overview** dashboard to view overall performance. Then follow the navigation panel to further drill down into {{ls}} performance.
6262

63-
:::{image} ../images/integration-dashboard-overview.png
63+
:::{image} images/integration-dashboard-overview.png
6464
:alt: The {{ls}} Overview dashboard in {{kib}} with various metrics from your monitored {ls}
6565
:class: screenshot
6666
:::

docs/reference/tuning-logstash.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ If you plan to modify the default pipeline settings, take into account the follo
6161

6262
When tuning Logstash you may have to adjust the heap size. You can use the [VisualVM](https://visualvm.github.io/) tool to profile the heap. The **Monitor** pane in particular is useful for checking whether your heap allocation is sufficient for the current workload. The screenshots below show sample **Monitor** panes. The first pane examines a Logstash instance configured with too many inflight events. The second pane examines a Logstash instance configured with an appropriate amount of inflight events. Note that the specific batch sizes used here are most likely not applicable to your specific workload, as the memory demands of Logstash vary in large part based on the type of messages you are sending.
6363

64-
:::{image} ../images/pipeline_overload.png
64+
:::{image} images/pipeline_overload.png
6565
:alt: pipeline overload
6666
:::
6767

68-
:::{image} ../images/pipeline_correct_load.png
68+
:::{image} images/pipeline_correct_load.png
6969
:alt: pipeline correct load
7070
:::
7171

0 commit comments

Comments
 (0)