Skip to content

READMEs: match the tree #152

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

Merged
litkhai merged 1 commit into from
Nov 10, 2026
Merged

READMEs: match the tree #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Composable collector configuration, one fragment per class of machine — what t

| | |
|---|---|
| [otel-profiles](otel-profiles/) | `linux-host` · `gpu-nvidia` · `baremetal-node` · `virt-kvm` · `virt-vsphere` |
| [otel-profiles](otel-profiles/) | `linux-host` · `windows-host` · `gpu-nvidia` · `baremetal-node` · `virt-kvm` · `virt-vsphere` · `mysql` · `aws-rds-mysql` |

### 🧰 ClickStack config (`clickstack-config/`)

Expand All @@ -52,13 +52,14 @@ self-hosted and Cloud by environment alone.
|---|---|
| [clickstack-config](clickstack-config/) | log/trace/metric sources, a dashboard, an alert and a webhook |

The local stack and the Cloud target every lab above runs against, with a readiness check and an end-to-end telemetry check, are in [`_base/`](_base/).

### 🗺 Roadmap

Planned — not written yet.

| Path | Plan |
|------|------|
| `_base/` | ClickStack all-in-one compose (Win/Mac/Linux), Cloud `.env.example`, ingestion check SQL |
| `labs/otel-schema` | `otel_logs`, `otel_traces`, `otel_metrics_*`: layout, sort keys, attribute Map/JSON |
| `labs/ingestion` | OTel Collector ClickHouse exporter, batching, async insert, sampling |
| `labs/hyperdx-sources` | Log/Trace/Metric source setup and required mappings |
Expand Down Expand Up @@ -133,7 +134,7 @@ ClickHouse 기반 관측성 실습입니다. OpenTelemetry 수집, ClickStack/Hy

| | |
|---|---|
| [otel-profiles](otel-profiles/) | `linux-host` · `gpu-nvidia` · `baremetal-node` · `virt-kvm` · `virt-vsphere` |
| [otel-profiles](otel-profiles/) | `linux-host` · `windows-host` · `gpu-nvidia` · `baremetal-node` · `virt-kvm` · `virt-vsphere` · `mysql` · `aws-rds-mysql` |

### 🧰 ClickStack 설정 (`clickstack-config/`)

Expand All @@ -144,13 +145,14 @@ source·대시보드·알림을 하나의 Terraform 설정으로 관리하며, s
|---|---|
| [clickstack-config](clickstack-config/) | log/trace/metric source, 대시보드, 알림, 웹훅 |

위 실습이 모두 실행되는 로컬 스택과 Cloud 대상, 준비 상태 확인과 텔레메트리 end-to-end 확인은 [`_base/`](_base/)에 있습니다.

### 🗺 로드맵

계획만 있고 아직 작성하지 않은 실습입니다.

| 경로 | 계획 |
|------|------|
| `_base/` | ClickStack all-in-one compose(Win/Mac/Linux), Cloud 연결 `.env.example`, 수집 확인 SQL |
| `labs/otel-schema` | `otel_logs`, `otel_traces`, `otel_metrics_*` 구조, 정렬 키, 속성 Map/JSON |
| `labs/ingestion` | OTel Collector ClickHouse exporter, 배치·async insert, 샘플링 |
| `labs/hyperdx-sources` | Log/Trace/Metric source 설정과 필수 매핑 |
Expand Down
10 changes: 6 additions & 4 deletions labs/ch2otel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ ch2otel/
├── scripts/
│ ├── status.sh # Check RMV and table status
│ └── refresh.sh # Manually refresh all RMVs
└── sql/
└── ch2otel-template.sql # SQL template for deployment
├── sql/
│ └── ch2otel-template.sql # SQL template for deployment
└── archive_sql_v0/ # Earlier multi-part SQL scripts (v2.1.0), kept for reference
```

### 🚀 Quick Start
Expand Down Expand Up @@ -192,8 +193,9 @@ ch2otel/
├── scripts/
│ ├── status.sh # RMV 및 테이블 상태 확인
│ └── refresh.sh # 모든 RMV 수동 갱신
└── sql/
└── ch2otel-template.sql # 배포용 SQL 템플릿
├── sql/
│ └── ch2otel-template.sql # 배포용 SQL 템플릿
└── archive_sql_v0/ # 이전 버전의 분할 SQL 스크립트(v2.1.0), 참고용으로 보관
```

### 🚀 빠른 시작
Expand Down
4 changes: 4 additions & 0 deletions labs/privatelink-gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,8 @@ V5 and V7 controls ran once against a local ClickHouse 26.9.7.9 container.
| `terraform/` | the ClickHouse service and `ip_access`, three VPCs and the Transit Gateway, the endpoint and its private hosted zone, the NLB, EC2 with SSM, and MSK behind `enable_kafka` |
| `collector/` | `gateway-durable` (file-storage queue, long retry), `gateway-default` (defaults), `agent`, `ingest-kafka`, `consumer-kafka` — `otel/opentelemetry-collector-contrib:0.155.0` |
| `bin/` | `setup.sh` (ingest user and databases), `check.sh <V1…V8, K1…K6>`, `outage.sh block/unblock` |
| `sql/` | `00-ingest-user.sql` (the ingest user's grants, sent by `setup.sh`), `counts.sql` and `dupes.sql` (row counts and duplicate spans per run, used by `check.sh`) |
| `results/` | each `check.sh` run writes its result lines to `<UTC date>-<id>.txt` here |

```bash
export AWS_PROFILE=<profile>
Expand Down Expand Up @@ -489,6 +491,8 @@ SQL과 V5, V7 제어 실험은 로컬 ClickHouse 26.9.7.9 컨테이너에서 한
| `terraform/` | ClickHouse 서비스와 `ip_access`, VPC 셋과 Transit Gateway, endpoint와 private hosted zone, NLB, SSM을 쓰는 EC2, `enable_kafka`로 켜는 MSK |
| `collector/` | `gateway-durable`(file storage queue, 긴 retry), `gateway-default`(기본값), `agent`, `ingest-kafka`, `consumer-kafka` — `otel/opentelemetry-collector-contrib:0.155.0` |
| `bin/` | `setup.sh`(수집 사용자와 데이터베이스), `check.sh <V1…V8, K1…K6>`, `outage.sh block/unblock` |
| `sql/` | `00-ingest-user.sql`(수집 사용자 권한, `setup.sh`가 전송), `counts.sql`과 `dupes.sql`(run별 행 수와 중복 span, `check.sh`가 사용) |
| `results/` | `check.sh`를 실행할 때마다 결과 줄을 `<UTC 날짜>-<id>.txt`로 여기에 씁니다 |

```bash
export AWS_PROFILE=<profile>
Expand Down
Loading