Skip to content

[Observability][Streams] Remove overview docs #2085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 4 additions & 36 deletions solutions/observability/logs/streams/streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,42 +31,10 @@ Access streams in one of the following ways:

- From **Discover**, expand a document's details flyout and select **Stream** or an action associated with the document's data stream. Streams will open filtered to only the selected stream. This only works for documents stored in a data stream.


## Overview tab [streams-overview-tab]

Use the **Overview** tab to find key metrics for the selected stream, such as data retention, document count, storage size, and average ingestion.

![Screenshot of the Overview tab UI](<../../../images/logs-streams-overview.png>)

the **Overview** tab is made up of the following components:

- **Data retention**: Your current data retention policy. For more detailed information, refer to the [**Data Retention**](./management/retention.md) tab on the **Management** page.
- **Document count**: The current total number of documents in your stream, unrelated to the time range.
- **Storage size**: The current total storage size of your stream, unrelated to the time range.
- **Ingestion**: shows the average ingestion per day since the stream was created.
- **Dashboards table**: quick links to [dashboards](#streams-dashboard-tab) you've added to the stream.

% Maybe we want to add something about the documents ingestion graph as well?


## Dashboards tab [streams-dashboard-tab]

Use the **Dashboards** tab to add dashboards to your stream. [Dashboards](../../../../explore-analyze/dashboards.md) are visualizations that group together important assets for your stream.

Add a dashboard to your stream by selecting it from the list of available dashboards.

![Screenshot of the dashboards UI](<../../../images/logs-streams-dashboard.png>)

Added dashboards are also shown on the [**Overview** tab](#streams-overview-tab) as quick links.

## Manage stream [streams-management-tab]

Use the **Manage stream** page to interact with and configure your stream in the following ways:

% Probably want a screenshot here for consistency with the other tabs?

- [Extract field](./management/extract.md): Parse and extract information from log messages into dedicated fields.
- [Data retention](./management/retention.md): Manage how your stream retains data and get insight into data ingestion and storage size.
- [Advanced](./management/advanced.md): Review and manually modify the inner workings of your stream.
Interact with and configure your stream in the following ways:

% TODO this is very short now. There will likely be more to add here in the future, not sure if it makes sense to fill the space now
- [Data retention](./management/retention.md): Manage how your stream retains data and get insight into data ingestion and storage size under the **Data retention** tab.
- [Processing](./management/extract.md): Parse and extract information from log messages into dedicated fields under the **Processing** tab.
- [Advanced](./management/advanced.md): Review and manually modify the inner workings of your stream under the **Advanced** tab.
Loading