Skip to content
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

Spacetime revamp #2880

Merged
merged 27 commits into from
May 1, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
f970454
move and rename logs
bmorelli25 Apr 26, 2023
826f91b
update cases wording
bmorelli25 Apr 26, 2023
3bc914e
Add new getting started section (WIP)
dedemorton Apr 27, 2023
588f6c9
Merge branch 'spacetime-revamp' of github.com:elastic/observability-d…
dedemorton Apr 27, 2023
c066240
conflict resolution is the best kind of resolution
bmorelli25 Apr 27, 2023
9feddea
Fix broken link
dedemorton Apr 27, 2023
78f8368
In progress changes
dedemorton Apr 27, 2023
a836258
Rename splunk file
dedemorton Apr 27, 2023
f78c76d
move UI content to observabilty intro page
mdbirnstiehl Apr 27, 2023
0a507b5
delete UI page and remove from index
mdbirnstiehl Apr 27, 2023
2cb1518
Merge branch 'spacetime-revamp' of github.com:elastic/observability-d…
dedemorton Apr 27, 2023
cc0a7f4
Add changes from review
dedemorton Apr 27, 2023
2321957
Fix broken link
dedemorton Apr 27, 2023
f02df29
add rough draft svg diagrams
bmorelli25 Apr 28, 2023
3b53881
fix link
bmorelli25 Apr 28, 2023
e96e16f
moar diagram stuffs
bmorelli25 Apr 28, 2023
a8c9dc8
update with review suggestions
mdbirnstiehl Apr 28, 2023
5056f31
Remove standalone tip
dedemorton Apr 28, 2023
256fbe8
Remove old files
dedemorton Apr 28, 2023
43478d7
colab diagram
bmorelli25 Apr 28, 2023
1e9668e
Merge branch 'spacetime-revamp' of https://github.com/elastic/observa…
bmorelli25 Apr 28, 2023
ea49d2f
Update docs/en/observability/user-experience.asciidoc
bmorelli25 Apr 28, 2023
b7c2b20
Add overview for getting started topics
dedemorton Apr 29, 2023
bc0c8b4
use svg not asciidoc
bmorelli25 May 1, 2023
f584522
update overview diagram
mdbirnstiehl May 1, 2023
93aa77f
fix conflict
mdbirnstiehl May 1, 2023
20ce794
Apply suggestions from code review
dedemorton May 1, 2023
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
2 changes: 1 addition & 1 deletion docs/en/observability/application-logs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[application-logs]]
= Application logs
= Monitor application logs

Application logs provide valuable insight into events that have occurred within your services and applications.

Expand Down
8 changes: 4 additions & 4 deletions docs/en/observability/create-cases.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[create-cases]]
= Cases

Cases are used to open and track observability issues directly in the Elastic
{observability} app. You can add assignees and tags to your cases, set their
severity and status, and add alerts, comments, and visualizations. You can also
send cases to third party systems by
Collect and share information about observability issues by opening a case directly
in the Elastic {observability} app. Cases allow you to track key investigation details,
add assignees and tags to your cases, set their severity and status, and add alerts,
comments, and visualizations. You can also send cases to third party systems by
<<cases-external-connectors,configuring external connectors>>.

[role="screenshot"]
Expand Down
30 changes: 8 additions & 22 deletions docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ include::{docs-root}/shared/attributes.asciidoc[]
:apm-repo-dir: {apm-server-root}/docs
:beats-repo-dir: {beats-root}/libbeat/docs
:shared: {observability-docs-root}/docs/en/shared
:kibana-repo-dir: {kibana-root}/docs
:kibana-repo-dir: {kibana-root}/docs

:synthetics_version: v1.0.0-beta.40
:project-monitors: project monitors
Expand All @@ -40,38 +40,24 @@ include::observability-introduction.asciidoc[leveloffset=+1]
// What's new
include::whats-new.asciidoc[leveloffset=+1]

// Send data to Elasticsearch
include::add-observability-data.asciidoc[leveloffset=+1]
// Get started with Elastic Observability
include::observability-get-started.asciidoc[leveloffset=+1]

include::spin-up-stack.asciidoc[leveloffset=+2]
include::logs-metrics-get-started.asciidoc[leveloffset=+2]

include::deploy-agent-to-send-data.asciidoc[leveloffset=+2]
include::ingest-traces.asciidoc[leveloffset=+2]

include::ingest-logs-metrics-uptime.asciidoc[leveloffset=+3]

include::ingest-traces.asciidoc[leveloffset=+3]

include::ingest-splunk.asciidoc[leveloffset=+3]

include::deploy-beats-to-send-data.asciidoc[leveloffset=+2]

include::ingest-logs.asciidoc[leveloffset=+3]

include::ingest-metrics.asciidoc[leveloffset=+3]

include::ingest-uptime.asciidoc[leveloffset=+3]

include::instrument-apps.asciidoc[leveloffset=+3]
include::ingest-splunk.asciidoc[leveloffset=+2]

// Observability overview page
include::observability-ui.asciidoc[leveloffset=+1]

// APM
include::apm.asciidoc[leveloffset=+1]

// Logs
include::application-logs.asciidoc[leveloffset=+1]
include::application-logs.asciidoc[leveloffset=+2]

// Logs
include::monitor-logs.asciidoc[leveloffset=+1]

include::tail-logs.asciidoc[leveloffset=+2]
Expand Down
42 changes: 32 additions & 10 deletions docs/en/observability/ingest-splunk.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@

:modulename: system nginx mysql

[[ingest-splunk]]
= Ingest data from Splunk (Experimental)
//TODO: Decide whether it really makes sense to move this. Maybe it's OK to
//leave this here for now since it's for a subset of users who might actually
//consider this info to be getting started info?

[NOTE]
=====
If you haven't already, you need to install {es} for storing and
searching your data, and {kib} for visualizing and managing it. For
more information, see <<spin-up-stack>>.
After {es} and {kib} are installed, {fleet} must be enabled; see the
<<ingest-logs-metrics-uptime>>.
//TODO: Rename file and anchor plus set up redirect if we decide to keep this
//as a GS topic.

[[ingest-splunk]]
= Get started with data from Splunk (Experimental)

=====
++++
<titleabbrev>Data from Splunk</titleabbrev>
++++

Apache, AWS CloudTrail, Nginx, and Zeek integrations offer the ability
to seamlessly ingest data from a Splunk Enterprise instance. Data
Expand All @@ -36,6 +36,28 @@ image::images/elastic-agent-splunk.png[Splunk integration components]
To ingest Nginx data from Splunk, perform the following steps.
The options are the same for Apache, AWS CloudTrail, and Zeek.

[discrete]
[[splunk-prereqs]]
== Prerequisites

//TODO: Consider using shared region to single source this info.

To follow the steps in this guide, you need an {stack} deployment that includes:

* {es} for storing and searching data
* {kib} for visualizing and managing data
* Kibana user with `All` privileges on {fleet} and Integrations. Since many
Integrations assets are shared across spaces, users need the Kibana privileges
in all spaces.
* Integrations Server (included by default in every {ess} deployment)

To get started quickly, spin up a deployment of our hosted {ess}. The {ess} is
available on AWS, GCP, and Azure. {ess-trial}[Try it out for free].

TIP: Not using {fleet}? Advanced users who want to configure and manage
{agent}s manually can
{fleet-guide}/install-standalone-elastic-agent.html[run agents standalone].

[discrete]
[[splunk-step-one]]
== Step 1: Add integration
Expand Down
56 changes: 29 additions & 27 deletions docs/en/observability/ingest-traces.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
[[ingest-traces]]
= Ingest application traces with {agent}
[[traces-apm-get-started]]
= Get started with application traces and APM

++++
<titleabbrev>Ingest traces</titleabbrev>
<titleabbrev>Traces and APM</titleabbrev>
++++

//TODO: Ask Brandon--can I rename this file? I guess we will need to coordinate
//with a corresponding update for APM. I just think it's good to rip of the
//bandaid and give these files accurate names. WDYT?
dedemorton marked this conversation as resolved.
Show resolved Hide resolved

// THIS CONTENT IS ALSO USED IN THE APM GUIDE
// tag::apm-quick-start[]

Expand All @@ -17,36 +21,32 @@ This guide describes how to:
For feedback and questions, please contact us in the {forum}[discuss forum].

[discrete]
[[fleet-prereqs-traces]]
[[ingest-prereqs-traces]]
== Prerequisites

You need {es} for storing and searching your data, and {kib} for visualizing and
managing it. You can use our {ess-product}[hosted {ess}] on {ecloud}
(recommended), or self-manage the {stack} on your own hardware.

Here's what you need for each deployment type:
//TODO: Ask Brandon if it's Ok to make this a shared region. I'm thinking "no"
//because it will get weird, but maybe if we use the full path in the include,
//it will be OK?
dedemorton marked this conversation as resolved.
Show resolved Hide resolved

include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/prereq-widget.asciidoc[]

[discrete]
[[set-up-fleet-traces]]
== Step 1: Set up {fleet}
To follow the steps in this guide, you need an {stack} deployment that includes:

Use {fleet} in {kib} to get APM data into the {stack}.
* {es} for storing and searching data
* {kib} for visualizing and managing data
* Kibana user with `All` privileges on {fleet} and Integrations. Since many
Integrations assets are shared across spaces, users need the Kibana privileges
in all spaces.
* Integrations Server (included by default in every {ess} deployment)

The first time you use {fleet}, you might need to set it up and add a
{fleet-server}:
To get started quickly, spin up a deployment of our hosted {ess}]. The {ess} is
available on AWS, GCP, and Azure. {ess-trial}[Try it out for free].

include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/add-fleet-server/widget.asciidoc[]

For more information, refer to {fleet-guide}/fleet-server.html[{fleet-server}].

NOTE: The APM integration does not support running {agent} in standalone mode;
you must use {fleet} to manage {agent}.
TIP: Not using {fleet}? Advanced users who want to configure and manage
{agent}s manually can
{fleet-guide}/install-standalone-elastic-agent.html[run agents standalone].

[discrete]
[[add-apm-integration]]
== Step 2: Configure the APM integration
== Step 1: Configure the APM integration

{ecloud} runs a hosted version of {integrations-server} that includes the APM integration.
Self-managed users will need to add the APM integration before configuring it.
Expand All @@ -55,7 +55,9 @@ include::./tab-widgets/add-apm-integration/widget.asciidoc[]

[discrete]
[[add-agent-to-fleet-traces]]
== Step 3: Install and run an {agent} on your machine
== Step 2: Install and run an {agent} on your machine

//TODO: Ask Brandon how to handle references to self managed users here
dedemorton marked this conversation as resolved.
Show resolved Hide resolved

****
This step is optional for both {ess} and self-managed users as
Expand Down Expand Up @@ -84,7 +86,7 @@ include::{ingest-docs-root}/docs/en/ingest-management/elastic-agent/install-flee

[discrete]
[[add-apm-integration-agents]]
== Step 4: Install APM agents
== Step 3: Install APM agents

APM agents are written in the same language as your service.
To monitor a new service, you must install the agent and configure it with a service name,
Expand Down Expand Up @@ -118,7 +120,7 @@ endif::[]

[discrete]
[[view-apm-integration-data]]
== Step 5: View your data
== Step 4: View your data

Back in {kib}, under {observability}, select APM.
You should see application performance monitoring data flowing into the {stack}!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[[ingest-logs-metrics-uptime]]
= Ingest logs and metrics with {agent}
[[logs-metrics-get-started]]
= Get started with logs and metrics

++++
<titleabbrev>Ingest logs and metrics</titleabbrev>
<titleabbrev>Logs and metrics</titleabbrev>
++++

****
Expand All @@ -18,39 +18,28 @@ This guide describes how to:
For feedback and questions, please contact us in the {forum}[discuss forum].

[discrete]
[[fleet-prereqs]]
[[logs-metrics-prereqs]]
== Prerequisites

You need {es} for storing and searching your data, and {kib} for visualizing and
managing it. You can use our {ess-product}[hosted {ess}] on {ecloud}
(recommended), or self-manage the {stack} on your own hardware.
To follow the steps in this guide, you need an {stack} deployment that includes:

Here's what you need for each deployment type:
* {es} for storing and searching data
* {kib} for visualizing and managing data
* Kibana user with `All` privileges on {fleet} and Integrations. Since many
Integrations assets are shared across spaces, users need the Kibana privileges
in all spaces.
* Integrations Server (included by default in every {ess} deployment)

--
include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/prereq-widget.asciidoc[]
--

[discrete]
[[set-up-fleet]]
== Step 1: Set up {fleet}

Use {fleet} in {kib} to get logs, metrics, and security data into the {stack}.
To get started quickly, spin up a deployment of our hosted {ess}. The {ess} is
available on AWS, GCP, and Azure. {ess-trial}[Try it out for free].

TIP: Not using {fleet}? Advanced users who want to configure and manage
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
{agent}s manually can
{fleet-guide}/install-standalone-elastic-agent.html[run agents standalone].

The first time you use {fleet}, you might need to set it up and add a
{fleet-server}:

include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/add-fleet-server/widget.asciidoc[]

For more information, refer to {fleet-guide}/fleet-server.html[{fleet-server}].

[discrete]
[[add-system-integration]]
== Step 2: Add the {agent} System integration
== Step 1: Add the {agent} System integration

{agent} is a single, unified way to add monitoring for logs, metrics, and other
types of data to a host. It can also protect hosts from security threats, query
Expand Down Expand Up @@ -104,7 +93,7 @@ TIP: If you accidentally close the popup, go to **{fleet} > Agents**, then click

[discrete]
[[add-agent-to-fleet]]
== Step 3: Install and run an {agent} on your machine
== Step 2: Install and run an {agent} on your machine

The **Add agent** flyout has two options: **Enroll in {fleet}** and
**Run standalone**. The default is to enroll the agents in {fleet}, as this
Expand Down Expand Up @@ -133,7 +122,7 @@ data.

[discrete]
[[view-data]]
== Step 4: Monitor host logs and metrics
== Step 3: Monitor host logs and metrics

. Verify that data is flowing. Wait until agent enrollment is confirmed and
incoming data is received, then click **View assets** to access dashboards
Expand Down Expand Up @@ -165,7 +154,7 @@ You can hover over any visualization to adjust its settings, or click the

[discrete]
[[add-nginx-integration]]
== Step 5: Monitor Nginx logs and metrics
== Step 4: Monitor Nginx logs and metrics
[discrete]

Next, add an Nginx integration to the policy used by your agent.
Expand Down
11 changes: 11 additions & 0 deletions docs/en/observability/observability-get-started.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[[observability-get-started]]
= Get started with Elastic Observability

++++
<titleabbrev>Get started</titleabbrev>
++++

Overview of the process.
Diagram would be nice.
Mention other ingest methods (cloud native, Beats, etc)
Introduce the topics nested under this container.
Loading