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

Create new IA for observability docs #4134

Merged
merged 27 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
90b6484
Create new IA for observability docs
dedemorton Aug 9, 2024
de1cddf
Try making the nav titles shorter
dedemorton Aug 13, 2024
80621c7
Merge branch 'main' into issue#247
dedemorton Aug 19, 2024
89247f1
Align TOC with latest outline
dedemorton Aug 19, 2024
45527e0
Fix link text and rename analyze-metrics file
dedemorton Aug 19, 2024
6fd7dfd
Add redirect page for observability tutorials
dedemorton Aug 20, 2024
c80b2c8
Add content to start here topic
dedemorton Aug 20, 2024
fe338df
Add content to overview topic about monitoring applications and services
dedemorton Aug 20, 2024
c6aa571
Add content to overview topic about incident management
dedemorton Aug 20, 2024
2aec89f
Remove old tutorial container topic
dedemorton Aug 20, 2024
2701742
Apply changes from colleenmcginnis
dedemorton Aug 23, 2024
aafd6f1
Apply feedback from alaudazzi
dedemorton Aug 23, 2024
ed55b90
More K8s tutorial to infra/hosts monitoring section
dedemorton Aug 23, 2024
8546736
Add getting started change and other changes requested by obs docs
dedemorton Aug 24, 2024
ed321e3
Fix broken apm links
dedemorton Aug 26, 2024
a0b7a5e
Apply more link fixes
dedemorton Aug 26, 2024
5b301a8
Merge branch 'main' into issue#247
dedemorton Aug 26, 2024
b7695cb
Reorganize getting started/quick start section
dedemorton Aug 26, 2024
8b0f363
Resolve or remove related TODOs
dedemorton Aug 28, 2024
a1cd10a
Merge branch 'main' into issue#247
dedemorton Aug 28, 2024
22af269
Update docs/en/observability/splunk-get-started.asciidoc
dedemorton Aug 29, 2024
af8af2b
Make changes to getting started section
dedemorton Aug 29, 2024
8d975b0
Move universal profiling to section about infra monitoring
dedemorton Aug 30, 2024
9f54a64
Move troubleshooting up a level in the nav
dedemorton Sep 3, 2024
eedfc98
Delete old APM tutorial
dedemorton Sep 3, 2024
bbc3284
Merge branch 'main' into issue#247
dedemorton Sep 3, 2024
f8602d2
Fix jump tables
dedemorton Sep 4, 2024
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
4 changes: 4 additions & 0 deletions docs/en/observability/apm.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
[[apm]]
= Application performance monitoring (APM)

++++
<titleabbrev>Application performance (APM)</titleabbrev>
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
++++

// OTHER ATTRS
// TODO: Check that these are still relevant
:no_kibana:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[[application-and-service-monitoring]]
= Application and service monitoring

++++
<titleabbrev>Applications and services</titleabbrev>
++++

Explore the topics in this section to learn how to observe and monitor software applications and services running in your environment.

[cols="1,1"]
|===
|<<apm>>
|Monitor software services and applications in real time, by collecting detailed performance information on response time for incoming requests, database queries, calls to caches, external HTTP requests, and more.

|<<monitor-java-app>>
|Monitor a Java application using Elastic Observability: Logs, Infrastructure metrics, APM, and Uptime.
dedemorton marked this conversation as resolved.
Show resolved Hide resolved

|<<monitor-uptime-synthetics>>
|Monitor the availability of network endpoints and services.

|<<universal-profiling>>
|Profile all the code running on a machine, including application code, kernel, and third-party libraries.

|<<user-experience>>
|Quantify and analyze the perceived performance of your web application using real-world user experiences.

|<<uptime-intro>>
|Periodically check the status of your services and applications.

|<<troubleshooting>>
|Troubleshoot issues across Observability apps: select and filter result data in any dimension, look for the cause or impact of performance problems, and view information about all requests that were made to collect the data displayed on the current page.
|===
6 changes: 5 additions & 1 deletion docs/en/observability/ci-cd-observability.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[[ci-cd-observability]]
= CI/CD observability
= CI/CD monitoring
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
:figure-caption!:

++++
<titleabbrev>CI/CD</titleabbrev>
++++

To help administrators monitor and troubleshoot their CI/CD platform and help developers
increase the speed and reliability of their CI/CD pipelines, Elastic {observability}
provides visibility in Continuous Integration and Continuous Delivery (CI/CD) processes.
Expand Down
25 changes: 25 additions & 0 deletions docs/en/observability/cloud-monitoring.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[[cloud-monitoring]]
= Cloud monitoring

++++
<titleabbrev>Cloud</titleabbrev>
++++

Explore the topics in this section to learn how to observe and monitor a broad range of resources and applications running in your cloud ecosystem.

//TODO: This topic needs input from Arianna and PMs to figure out what to highlight given our current spotty coverage in the docs.

[cols="1,1"]
|===
|<<monitor-amazon-web-services>>
|Monitor AWS services and resources, including EC2, Kinesis data streams, S3 buckets, SQS, VPC Flow Logs, CloudTrail logs, network firewall logs, WAF logs, and CloudWatch logs.

|<<monitor-azure-web-services>>
|Get visibility into your key Azure services including through secure native integration within the Azure console.

|<<monitor-gcp>>
|Track performance of your Google Cloud services, including through agentless data ingestion with Google Pub/Sub.
|===



Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
= Amazon Web Services (AWS) monitoring

++++
<titleabbrev>AWS monitoring</titleabbrev>
<titleabbrev>AWS</titleabbrev>
++++

Elastic Observability offers powerful monitoring solutions to keep your AWS environments reliable and efficient, providing deep insights into the performance of your applications, services, and infrastructure components.

Learn how to use the Elastic Observability solution to observe and monitor a broad range of AWS resources and applications.
Learn how to use the Elastic Observability solution to observe and monitor a broad range of AWS resources and applications.

- <<monitor-aws-elastic-agent,Monitor {aws} with {agent}>>
- <<monitor-aws,Monitor {aws} with {beats}>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -410,5 +410,7 @@ To track your AWS billing, open the
[role="screenshot"]
image::images/agent-tut-billing-dashboard.png[Screenshot of the Billing Overview dashboard]

Congratulations! You have completed the tutorial. To try other tutorials in this
series, visit the <<observability-tutorials>> page.
Congratulations! You have completed the tutorial.

//TODO: Remove this link
//To try other tutorials in this series, visit the <<observability-tutorials>> page.
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ In this step, you install the Azure Billing Metrics integration in {kib}. This
integration contains an input for collecting metrics, such as Azure usage
details and forecast information, about your subscription.

To add the integration:
To add the integration:

. Go to the {kib} home page and click **Add integrations**.
+
Expand All @@ -137,7 +137,7 @@ documentation.
[horizontal]
**Client ID**::
The Application (client) ID that you copied earlier when you created the service
principal.
principal.

**Client secret**:: The secret value that you copied earlier.

Expand All @@ -151,7 +151,7 @@ image::images/agent-tut-azure-integration-settings.png[Screenshot of integration

. Make sure the **Collect Azure Billing metrics** selector is turned on.

. Accept the defaults to create a new agent policy.
. Accept the defaults to create a new agent policy.

. Click **Save and continue**. This step takes a minute or two to complete. When
it's done, you'll have an agent policy that contains the Azure configuration you
Expand Down Expand Up @@ -247,7 +247,7 @@ image::images/agent-tut-azure-create-eventhub.png[Screenshot of window for creat
. Click **Create** to deploy the resource.
. In the new namespace, click **+ Event Hub** and enter a name for the event
hub.
. Click **Review + create**, and then click **Create** to deploy the resource.
. Click **Review + create**, and then click **Create** to deploy the resource.
. Make a note of the namespace and event hub name because you will need them
later.

Expand All @@ -266,7 +266,7 @@ This setup is more efficient than using a single event hub for all logs because
it:

* Ensures that you publish only the logs expected by the downstream
integration.
integration.
* Saves bandwidth and compute resources because inputs only need to process
relevant logs, rather than processing all the logs for all your monitored
services, then discarding unneeded logs.
Expand Down Expand Up @@ -306,7 +306,7 @@ image::images/agent-tut-azure-log-categories.png[Screenshot of Azure diagnostic
Now that activity logs are streaming into the event hub, you can configure
the Azure activity log integration to ingest the logs.

To add the integration:
To add the integration:

. Go to the {kib} home page and click **Add integrations**.

Expand Down Expand Up @@ -390,5 +390,5 @@ you can use to visualize the data. In {kib}, open the main menu and click
[role="screenshot"]
image::images/agent-tut-azure-activity-logs-dashboard.png[Screenshot of Azure activity logs dashboard]

Congratulations! You have completed the tutorial. To try other tutorials in this
series, visit the <<observability-tutorials>> page.
Congratulations! You have completed the tutorial.
// To try other tutorials in this series, visit the <<observability-tutorials>> page.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
= Azure monitoring

++++
<titleabbrev>Azure monitoring</titleabbrev>
<titleabbrev>Azure</titleabbrev>
++++

Elastic Observability offers powerful monitoring solutions to keep your Azure environments reliable and efficient, providing deep insights into the performance of your applications, services, and infrastructure components.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,5 +147,6 @@ To explore the data further, click **Open as page**.
[role="screenshot"]
image::monitor-azure-native-kibana-vms-metrics-detail.png[Screenshot of detailed VM metrics]

Congratulations! You have completed the tutorial. To try other tutorials in this
series, visit the <<observability-tutorials>> page.
Congratulations! You have completed the tutorial.

//To try other tutorials in this series, visit the <<observability-tutorials>> page.
9 changes: 8 additions & 1 deletion docs/en/observability/fields-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,21 @@
This section lists Elastic Common Schema (ECS) fields the Logs and Infrastructure apps use to display data.

ECS is an open source specification that defines a standard set of fields to use when storing event data in
{es}, such as logs and metrics.
{es}, such as logs and metrics.

//TODO: This topic should mention integrations and Elastic Agent, too.

Beat modules (for example, {filebeat-ref}/filebeat-modules.html[{filebeat} modules])
are ECS-compliant, so manual field mapping is not required, and all data is
populated automatically in the Logs and Infrastructure apps. If you cannot use {beats}, map your data to
{ecs-ref}[ECS fields] (see {ecs-ref}/ecs-converting.html[how to map data to ECS]).
You can also try using the experimental https://github.com/elastic/ecs-mapper[ECS Mapper] tool.

This reference covers:

* <<logs-app-fields>>
* <<metrics-app-fields>>

include::logs-app-fields.asciidoc[leveloffset=+1]

include::metrics-app-fields.asciidoc[leveloffset=+1]
12 changes: 6 additions & 6 deletions docs/en/observability/gcp-dataflow.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[[gcp-dataflow]]
=== GCP Dataflow templates
== GCP Dataflow templates

In this tutorial, you'll learn how to ship logs directly from the Google Cloud
Console with the Dataflow template for analyzing GCP Audit Logs in the {stack}.

[discrete]
==== What you'll learn
=== What you'll learn

You'll learn how to:

Expand All @@ -14,14 +14,14 @@ You'll learn how to:
view those logs in {kib}.

[discrete]
==== Before you begin
=== Before you begin

Create a deployment using our hosted {ess} on {ess-trial}[{ecloud}].
The deployment includes an {es} cluster for storing and searching your data,
and {kib} for visualizing and managing your data.

[discrete]
==== Step 1: Install the GCP integration
=== Step 1: Install the GCP integration

You’ll start with installing the Elastic GCP integration to add pre-built
dashboards, ingest node configurations, and other assets that help you get
Expand Down Expand Up @@ -58,15 +58,15 @@ For this tutorial the data is written to the `logs-gcp.audit-default` data strea
====
****
[discrete]
==== Step 2: Create a Pub/Sub topic and subscription
=== Step 2: Create a Pub/Sub topic and subscription

Before configuring the Dataflow template, create a Pub/Sub
topic and subscription from your Google Cloud Console where you can send your
logs from Google Operations Suite.
include::gcp-topic.asciidoc[]

[discrete]
==== Step 3: Configure the Google Dataflow template
=== Step 3: Configure the Google Dataflow template

After creating a Pub/Sub topic and subscription, go to the *Dataflow Jobs* page
and configure your template to use them. Use the search bar to find the page:
Expand Down
19 changes: 19 additions & 0 deletions docs/en/observability/incident-management.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[[incident-management]]
= Incident management

Explore the topics in this section to learn how to respond to incidents detected in your {observability} data.


[cols="1,1"]
|===
|<<create-alerts>>
|Trigger alerts when incidents occur, and use built-in connectors to send the alerts to email, slack, or other third-party systems, such as your external incident management application.

|<<create-cases>>
|Collect and share information about {observability} issues by opening cases and optionally sending them to your external incident management application.

|<<slo>>
|Set clear, measurable targets for your service performance, based on factors like availability, response times, error rates, and other key metrics.
|===


Loading
Loading