Skip to content

Commit c5b0546

Browse files
AlexanderWertAlexanderWert
committed
refined structure
Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
1 parent c44ae5c commit c5b0546

30 files changed

+247
-150
lines changed

‎docs/_kubernetes/operator/instrumenting-java.md ‎docs/_edot-sdks/java/setup/k8s.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: Java Applications
2+
title: EDOT Java on Kubernetes
33
layout: default
44
nav_order: 1
5-
parent: Instrumenting Applications
5+
parent: Setup
6+
grand_parent: EDOT Java
67
---
78

89
# Instrumenting Java applications with EDOT SDKs on Kubernetes

‎docs/_edot-sdks/java/setup.md ‎docs/_edot-sdks/java/setup/setup.md

File renamed without changes.

‎docs/_kubernetes/operator/instrumenting-nodejs.md ‎docs/_edot-sdks/nodejs/setup/k8s.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: Node.js Applications
2+
title: EDOT Node.js on Kubernetes
33
layout: default
4-
nav_order: 2
5-
parent: Instrumenting Applications
4+
nav_order: 1
5+
parent: Setup
6+
grand_parent: EDOT Node.js
67
---
78

89
# Instrumenting Node.js applications with EDOT SDKs on Kubernetes

‎docs/_edot-sdks/nodejs/setup/setup.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Setup
3+
layout: default
4+
nav_order: 1
5+
parent: EDOT Node.js
6+
---
7+
8+
# Setting up EDOT Node.js
9+
10+
TODO:
11+
- where to download
12+
- explicit description of basic setup here (even if it overlaps with upstream docs)
13+
- link to upstream docs for more advanced setup use cases

‎docs/_kubernetes/operator/instrumenting-python.md ‎docs/_edot-sdks/python/setup/k8s.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: Python Applications
2+
title: EDOT Python on Kubernetes
33
layout: default
4-
nav_order: 3
5-
parent: Instrumenting Applications
4+
nav_order: 1
5+
parent: Setup
6+
grand_parent: EDOT Python
67
---
78

89
# Instrumenting Python applications with EDOT SDKs on Kubernetes

‎docs/_edot-sdks/python/setup/setup.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Setup
3+
layout: default
4+
nav_order: 1
5+
parent: EDOT Python
6+
---
7+
8+
# Setting up EDOT Python
9+
10+
TODO:
11+
- where to download
12+
- explicit description of basic setup here (even if it overlaps with upstream docs)
13+
- link to upstream docs for more advanced setup use cases

‎docs/_kubernetes/operator/troubleshoot-auto-instrumentation.md

-92
This file was deleted.

‎docs/deployment-options/ech.md

-6
This file was deleted.

‎docs/deployment-options/index.md

-7
This file was deleted.

‎docs/deployment-options/self-managed.md

-6
This file was deleted.

‎docs/deployment-options/serverless.md

-6
This file was deleted.

‎docs/quickstart/ech/docker.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Hosts & VMs
3+
layout: default
4+
nav_order: 3
5+
parent: Elastic Cloud Hosted
6+
---
7+
8+
# Quick Start - Docker - Hosted
9+
10+
TODO

‎docs/quickstart/ech/hosts_vms.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Hosts & VMs
3+
layout: default
4+
nav_order: 2
5+
parent: Elastic Cloud Hosted
6+
---
7+
8+
# Quick Start - Hosts & VMs - Hosted
9+
10+
TODO

‎docs/quickstart/ech/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ nav_order: 3
55
parent: Quick Start
66
---
77

8-
# EDOT Quick Start on Elastic Cloud Hosted
8+
# Quick Start on Elastic Cloud Hosted

‎docs/quickstart/ech/k8s.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Kubernetes
3+
layout: default
4+
nav_order: 1
5+
parent: Elastic Cloud Hosted
6+
---
7+
8+
# Quick Start - Kubernetes - Hosted
9+
10+
TODO

‎docs/quickstart/index.md

+6-17
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,13 @@ This guide helps you set up Elastic Distributions for OpenTelemetry (EDOT) to mo
1010

1111
> 🏁 *By the end of this guide, you’ll have a fully operational EDOT-powered monitoring pipeline sending data to Elastic Observability.*
1212
13-
| | **Kubernetes** | **Docker** | **Hosts & VMs** |
14-
|-------------------------------|:-------------------------:|:--------------------------:|:-------------------------:|
15-
| **Self-managed** | [Quick Start 🆂 ☸️] | [Quick Start 🆂 🐳 ] | [Quick Start 🆂 🖥 ] |
16-
| **Elastic Cloud Serverless** | [Quick Start ☁️ ☸️] | [Quick Start ☁️ 🐳 ] | [Quick Start ☁️ 🖥 ] |
17-
| **Elastic Cloud Hosted** | [Quick Start 🗄️ ☸️] | [Quick Start 🗄️ 🐳 ] | [Quick Start 🗄️ 🖥 ] |
18-
19-
20-
## 📖 Guide content
21-
22-
* [Kubernetes](./kubernetes)
23-
24-
* Infrastructure & Application Monitoring](#%EF%B8%8F-kubernetes---infrastructure--application--monitoring)
25-
26-
* Hosts Monitoring and Log collection
27-
* [Linux](#linux)
28-
* [Mac](#macos)
29-
* [Windows](#windows)
13+
Choose the Quick Start guide based on the environment of your target system (`Kubernetes`, `Docker` or plain `Hosts / VMs`) and your Elastic deployment model (`Self-managed`, `Elastic Cloud Serverless`, `Elastic Cloud Hosted`):
3014

15+
| | ☸️ **Kubernetes** | 🐳 **Docker** | 🖥 **Hosts / VMs** |
16+
|---------------------------------|:-------------------------:|:--------------------------:|:-------------------------:|
17+
| 🆂 **Self-managed Elastic Stack** | [Quick Start 🆂 ☸️] | [Quick Start 🆂 🐳 ] | [Quick Start 🆂 🖥 ] |
18+
| ☁️ **Elastic Cloud Serverless** | [Quick Start ☁️ ☸️] | [Quick Start ☁️ 🐳 ] | [Quick Start ☁️ 🖥 ] |
19+
| 🗄️ **Elastic Cloud Hosted** | [Quick Start 🗄️ ☸️] | [Quick Start 🗄️ 🐳 ] | [Quick Start 🗄️ 🖥 ] |
3120

3221
## Troubleshooting
3322
- [EDOT Collector Troubleshooting](_edot-collector/edot-collector-troubleshoot.md)

‎docs/quickstart/self-managed/docker.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Hosts & VMs
3+
layout: default
4+
nav_order: 3
5+
parent: Self-managed
6+
---
7+
8+
# Quick Start - Docker - Self-managed

‎docs/quickstart/self-managed/hosts_vms.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@ nav_order: 2
55
parent: Self-managed
66
---
77

8-
# Hosts & VMs - Quick Start
8+
# Quick Start - Hosts & VMs - Self-managed
9+
910
These instructions guide you through setting up the EDOT Collector to collect host metrics, logs and application traces using an OpenTelemetry configuration. You’ll download the appropriate package for your system, configure authentication, and run the collector. Optional steps allow you to customize log collection paths and set up application monitoring.
10-
![EDOT-host-metrics-logs](../images/edot-host-metrics-logs.png)
11+
![EDOT-host-metrics-logs](../../images/edot-host-metrics-logs.png)
1112

1213
## Run EDOT Collector for Host Metrics and Log collection
14+
1315
These instructions will download EDOT collector including an OpenTelemetry collector configuration that will:
1416

1517
* Collect metrics from your host
1618
* Collect logs from a set of locations in your host
1719
Run the below commands to download the EDOT Collector package relevant to your system's architecture.
1820

1921
### Linux
22+
2023
Download EDOT Collector
2124

2225
```bash

‎docs/quickstart/self-managed/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ nav_order: 1
55
parent: Quick Start
66
---
77

8-
# EDOT Quick Start with a Self-managed Elastic Stack
8+
# Quick Start with a Self-managed Elastic Stack

‎docs/quickstart/self-managed/k8s.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ nav_order: 1
55
parent: Self-managed
66
---
77

8-
# ☸️ Kubernetes - Quick Start
8+
# Quick Start - Kubernetes - Self-managed
99

1010
The quick start for Kubernetes covers collection of OpenTelemetry data for infrastructure monitoring, logs collection and application monitoring. These instructions will install an OpenTelemetry Operator preconfigured to automate orchestration of EDOT as below:
1111

@@ -14,7 +14,7 @@ The quick start for Kubernetes covers collection of OpenTelemetry data for infra
1414
* **EDOT Collector Gateway:** perform APM pre-processing (when applicable). Route all telemetry to Elastic,
1515
* **EDOT SDKs**: Annotated applications will be auto-instrumented with EDOT SDKs
1616

17-
![K8s-architecture](../images/EDOT-K8s-architecture.png)
17+
![K8s-architecture](../../images/EDOT-K8s-architecture.png)
1818

1919
## Kubernetes Infrastructure Metrics and Log Collection
2020

‎docs/quickstart/serverless/docker.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Hosts & VMs
3+
layout: default
4+
nav_order: 3
5+
parent: Elastic Cloud Serverless
6+
---
7+
8+
# Quick Start - Docker - Serverless
9+
10+
TODO

‎docs/quickstart/serverless/hosts_vms.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Hosts & VMs
3+
layout: default
4+
nav_order: 2
5+
parent: Elastic Cloud Serverless
6+
---
7+
8+
# Quick Start - Hosts & VMs - Serverless
9+
10+
TODO

‎docs/quickstart/serverless/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ nav_order: 2
55
parent: Quick Start
66
---
77

8-
# EDOT Quick Start on Elastic Cloud Serverless
8+
# Quick Start on Elastic Cloud Serverless

‎docs/quickstart/serverless/k8s.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Kubernetes
3+
layout: default
4+
nav_order: 1
5+
parent: Elastic Cloud Serverless
6+
---
7+
8+
# Quick Start - Kubernetes - Serverless
9+
10+
TODO

‎docs/use-cases/host-metrics.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Collecting Host Metrics
3+
layout: default
4+
nav_order: 2
5+
parent: Use Cases
6+
---
7+
8+
# Collecting Host Metrics with EDOT

‎docs/use-cases/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Use Cases
3+
layout: default
4+
nav_order: 3
5+
---
6+
7+
# Use Cases

0 commit comments

Comments
 (0)