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.

Sign up for GitHub

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

[DOCS] Add placeholders for Observability docs #1216

Merged
merged 2 commits into from
Jun 29, 2020
+69 −0
Merged

[DOCS] Add placeholders for Observability docs #1216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72d54cf
Add placeholders for observability docs
Jun 25, 2020
a6eb87e
Restructure headings
Jun 26, 2020
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
11 changes: 11 additions & 0 deletions docs/en/observability/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
:doctype: book

= Observability Guide

include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[]

include::{docs-root}/shared/attributes.asciidoc[]

include::observability-introduction.asciidoc[]

include::observability-ui.asciidoc[]
36 changes: 36 additions & 0 deletions docs/en/observability/observability-introduction.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[[observability-introduction]]
[role="xpack"]
== What is Elastic Observability?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is all placeholder stuff, but we should start thinking about how we want to structure the content.

1 - We definitely want a one to one mapping between topics and HTML output. So one asciidoc file = one HTML file.

2 - To control TOC nesting, we should explore using level offsets. I've done this in the ingest management docs with mixed success. (The strategy worked for +1 and +2 offsets, but broke for anything nested more deeply.) We should follow up with other teams to see if they've had more success, but I think it's the best way forward to make it easier to decouple TOC/navigation from heading levels.


//TODO: Add content


[[observability-get-started]]
== Get started with the {stack}

To get started...

=== Hosted Elasticsearch Service

=== Install the {stack} yourself

=== Run the {stack} on Docker

=== Run the {stack} on Kubernetes

[float]
==== Step 1: Install {es}

[float]
==== Step 2: Install {kib}

[[observability-add-data]]
== Add observability data

=== Instrument applications

=== Ingest logs

=== Ingest metrics

=== Ingest uptime data
22 changes: 22 additions & 0 deletions docs/en/observability/observability-ui.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[[observability-ui]]
[role="xpack"]

== Monitor observable environments

Displayed on the Observability *Overview* page are a wide variety of chart
visualizations that provide you with analytical information on what is
happening within your environments.

The dashboard is comprised of four components to help you make your environments
observable; APM, logs, metrics, and uptime.

=== Services, transactions, and error rates

=== Log rates

=== System metrics

=== Systems availability

=== Alerts