Orbtrace
ENTR
Satışla görüş
Self-host

Hızlı başlangıç

Hiçbir şey kurulu değilken ilk trace'i ekranda görene kadarki yol — kopyala-yapıştır, sırayla, Docker'lı herhangi bir makinede. Collector ayağa kaldırmak dahil her adımda dürüst.

Hiçbir şey kurulu değilken ekranda ilk trace'inize giden en hızlı yol — Docker'lı bir dizüstünde ya da tek bir VPS'te yaklaşık on dakika.

Sonunda neyiniz olacak

Dizüstünüzde ya da bir VPS'te çalışan bir Orbtrace, oturum açmış siz, ona test trace'leri besleyen küçük bir OpenTelemetry Collector ve ilk trace şelalenize bakan siz.

Bu beş değil, yaklaşık on dakika sürer — çünkü Orbtrace birçok eğitimin atladığı bir konuda dürüst: Orbtrace telemetriyi kendisi almaz. Ürünü gönderir (sunucu + arayüz + depolama); yanında, veriyi Orbtrace'in veritabanına ileten standart bir OpenTelemetry Collector'ı siz çalıştırırsınız. Hızlı başlangıç ikisini de kurar. (Bu ayrım neden? Bkz. Entegrasyon desenleri.)

Başlamadan önce

Gerekenler:

  • En az 8 GB boş RAM'i olan bir makine. Varsayılan yığın Apache Doris'i üç depolama düğümüyle çalıştırır ve bu bellek-açtır; 4 GB yalnızca sadeleştirilmiş tek-düğümlü bir varyant için yeterlidir (bkz. Kurulum içindeki not). 16 GB rahattır.
  • Docker Engine 24+ ve Docker Compose v2. docker --version ve docker compose version ile kontrol edin.
  • O makinede 8080 portu (Orbtrace arayüzü) boş, ayrıca 4317 ve 4318 (Collector'ın OTLP portları) boş.
  • On dakika dikkat.

Üç port da varsayılandır, zorunluluk değil. 8080 makinenizde zaten kullanılıyorsa 2. adımda ayar dosyasından değiştireceksiniz; Collector portları da 5. adımdaki -p bayraklarıyla taşınır.

Gerekmeyenler:

  • Bulut hesabı ya da alan adı (localhost kullanacağız).
  • Bir LLM API anahtarı (RCA ve yapay zekâ özellikleri bir sağlayıcı yapılandırana kadar kapalı — hızlı başlangıç bunlara ihtiyaç duymaz).
  • Bir lisans. Orbtrace kutudan çıktığı gibi ücretsiz COMMUNITY sürümünde çalışır (3 servis / 3 günlük saklama) — hızlı başlangıç için fazlasıyla yeterli. Ücretli sürümler için bkz. Lisanslama.

Adımlar

  1. 1

    Erişiminizi ve deploy bundle'ını alın

    İki şeye ihtiyacınız var:

    • Deploy bundle — içinde docker-compose.yml, Collector config'i ve örnek bir ayar dosyası var. Ücretsizdir, giriş gerektirmez: aşağıdaki düğme en son sürümü doğrudan indirir; indirme sayfası da aynı dosyayı sağlama toplamıyla (checksum) sunar.
    • Nivorbit'ten bir pull token — Orbtrace image'ının kendisi özeldir (private). Henüz token yok mu? sales@nivorbit.com'a yazın.

    Bundle'ı indirin ve açın:

    tar xzf orbtrace-2.1.0.tar.gz && cd orbtrace-2.1.0

    Registry'ye giriş yapın. Çalıştırmadan önce bu satırı düzenleyin — <token> ve <username> yerine Nivorbit'in size gönderdiği bilgileri yazın:

    echo "<token>" | docker login ghcr.io -u <username> --password-stdin

    Gereken erişim bu kadar — image, 3. adımda otomatik çekilir.

    Hiç registry erişimi olmayan hava boşluğunda mısınız?

    Nivorbit size image'ları gömülü bir bundle verir. bash images/LOAD.sh ile yükleyin ve girişi atlayın. Bkz. Hava boşluklu çalıştırma.

    Buradan sonrası için kısa yol

    1. ve 3. adımı elle yapmak istemiyor musunuz? Zaten doğru dizindesiniz — şunu çalıştırın:
    ./install.sh --port 8080

    8080, arayüzün yaşayacağı port — doluysa başka bir port seçin. Betik, ayar dosyasını üretilmiş sırlarla oluşturur, giriş için bir admin hesabı basar, yığını başlatır ve — masaüstü bir makinedeyseniz — hazır olduğunda arayüzü tarayıcınızda açar. Sonra 4. adıma atlayıp giriş yapın. Her hamleyi kendiniz görmek mi istiyorsunuz? 2. adımdan devam edin.

  2. 2

    Ayar dosyanızı oluşturun

    Bundle'ın compose/ dizinine girin, örnek ayar dosyasını kopyalayın ve ona taze bir Postgres parolası verin (asla varsayılanında kalmaması gereken tek değer — JWT imzalama anahtarlarını uygulama kendisi yönetir, ayarlanacak bir şey yok):

    cd compose
cp .env.example .env
sed -i.bak "s|^PGPASSWORD=.*|PGPASSWORD=$(openssl rand -base64 24 | tr -d '/+=')|" .env && rm .env.bak

    .env'i herhangi bir editörle açın:

    nano .env    # ya da: vim .env / code .env

    ve yerel bir admin girişi ayarlayın — e-posta, giriş ekranında yazacağınız değerdir:

    ORBTRACE_BOOTSTRAP_ADMIN_USERNAME=siz@example.com
ORBTRACE_BOOTSTRAP_ADMIN_PASSWORD=güçlü-bir-parola-seçin

    8080 portu makinenizde zaten kullanılıyor mu? Bunu düzelteceğiniz dosya da burası: ORBTRACE_HTTP_PORT'u boş bir porta ayarlayın — arayüzün public URL'leri onu otomatik takip eder. Installer'ı mı kullanıyorsunuz? Portu komutta verin: ./install.sh --port 9090.

    Hızlı başlangıç için uygun — üretimden önce değiştirin

    Az önce açtığınız kullanıcı adı/parola formu, SSO kurmadan değerlendirme yapabilmeniz içindir. Bu dağıtıma sizden başka biri erişmeden önce:

    • Girişi SSO'ya taşıyın (Google / Microsoft / GitHub / herhangi bir OIDC) ve ORBTRACE_BOOTSTRAP_ADMIN_PASSWORD'ü boş bırakın — bkz. Kimlik doğrulama.
    • PGPASSWORD ve DORIS_PASSWORD'ü varsayılanlarından değiştirin.

    Bu dosyadaki her ayar Yapılandırma'da açıklanır.

  3. 3

    Orbtrace'i başlatın

    .env'i oluşturduğunuz compose/ dizininden:

    docker compose up -d

    Bu, ürünü ve depolamasını çeker ve başlatır (dikkat: henüz Collector yok — o 5. adımda):

    On screen
    • orbtraceSpring Boot arka ucu ve web arayüzü.
    • doris-fe + doris-be ×3Apache Doris — log/trace/metriklerinizi saklayan veritabanı.
    • postgresOrbtrace'in kendi ayarlarını saklar: kullanıcılar, SLO'lar, alarm kuralları, panolar.
    • valkeyOturumlar ve kısa ömürlü durum için Redis uyumlu bir önbellek.

    İlk açılış, Doris depolama düğümlerini kaydedip Orbtrace veritabanı şemasını oluştururken iki-üç dakika sürer. Komut hemen döner; ilerlemeyi şununla izleyin:

    docker compose ps

    orbtrace healthy gösterdiğinde hazırsınız — şema tam yerine oturana kadar bu durumu kasıtlı olarak bekletir; yani healthy, sorgulanabilir demektir.

  4. 4

    Giriş yapın

    Tarayıcınızda http://localhost:8080 açın. Orbtrace başka bir makinede çalışıyorsa localhost yerine onun IP'sini, 2. adımda başka bir port seçtiyseniz 8080 yerine onu yazın.

    Karşınıza giriş ekranı çıkar. Giriş bilgileriniz, 2. adımı nasıl yaptığınıza bağlı:

    2. adımı nasıl yaptınızŞununla girin
    ./install.sh çalıştırdınız"Local admin login" altında bastığı e-posta ve parola
    .env'i kendiniz düzenledinizAyarladığınız ORBTRACE_BOOTSTRAP_ADMIN_USERNAME ve ORBTRACE_BOOTSTRAP_ADMIN_PASSWORD
    Hiçbirini yapmadınızadmin@orbtrace.local ve Orbtrace'in ilk açılışta ürettiği parola

    Son satır için: üretilen parola sunucu loguna yalnızca bir kez yazılır — şununla okuyun:

    docker compose logs orbtrace | grep -A 3 "BREAK-GLASS"

    ve giriş yaparken yeni bir parola seçmeniz istenir.

    İçeridesiniz. Genel Bakış (Overview) ekranı boş çünkü henüz hiçbir şey telemetri göndermiyor — sıradaki iki adım bunu çözecek. Taze kurulum kontrol listesi için bkz. İlk giriş.

  5. 5

    Bir Collector ayağa kaldırın

    Orbtrace telemetriyi saklar ve gösterir; almak ise OpenTelemetry Collector'ın işidir. Bir tane başlatın — standart upstream image artı bundle'daki config dosyası:

    docker run -d --name orbtrace-otelcol \
  --network orbtrace-net \
  -p 4317:4317 -p 4318:4318 \
  -v "$PWD/otelcol-config.yaml:/etc/otelcol-contrib/config.yaml" \
  --tmpfs /var/lib/otelcol/queue:rw,mode=1777 \
  otel/opentelemetry-collector-contrib:latest

    Bayrakların anlamı:

    • --network orbtrace-net — Collector veritabanına yazabilsin diye Orbtrace'in ağına katılır.
    • -p 4317:4317 -p 4318:4318 — uygulamalarınızın telemetri göndereceği iki OTLP portunu yayımlar. Bu portlar makinenizde doluysa her çiftin sol tarafını değiştirin.
    • --tmpfs …/queue — gönderim kuyruğu için küçük, bellek-içi bir çalışma alanı; image root olmayan bir kullanıcıyla çalışır ve en basit yazılabilir yer burasıdır.

    DORIS_PASSWORD değiştirdiyseniz

    Referans config, Doris'e root olarak parolasız yazar (varsayılan). .env'nizde bir DORIS_PASSWORD ayarladıysanız, onu Collector'a da verin: yukarıdaki komuta -e DORIS_PASSWORD=parolanız ekleyin.

    Temiz açıldığını kontrol edin:

    docker logs orbtrace-otelcol | tail

    doris-fe:8030'a dial tcp … connection refused olmaması, veritabanıyla konuştuğu anlamına gelir.

  6. 6

    Test trace akışı gönderin

    Henüz enstrümante edilmiş bir uygulamanız yok, o yüzden OpenTelemetry'nin kendi yük üretecini, telemetrygen'i kullanarak Collector'a trace gönderin:

    docker run --rm --network orbtrace-net \
  ghcr.io/open-telemetry/opentelemetry-collector-contrib/telemetrygen:latest \
  traces \
  --otlp-endpoint orbtrace-otelcol:4317 --otlp-insecure \
  --service quickstart-demo --traces 200 --rate 20

    Bu, quickstart-demo adlı sahte bir servisten saniyede 20 hızla 200 trace gönderir. Yaklaşık on saniyede biter.

  7. 7

    İlk trace'inize tıklayın

    http://localhost:8080/telemetry/traces adresini açın — localhost ve 8080'i 4. adımdaki gibi uyarlayın.

    Beliren satırlar, 6. adımda gönderdiğiniz 200 test isteği. Birine tıklayın: sağdaki panel onu bir şelale (waterfall) olarak çizer — her çubuk isteğin bir adımı, uzun çubuk uzun sürmüş demek. Detay için çubuğun üstüne gelin.

    Bu kadar — veri girdi, ekranda görüyorsunuz. Kendi donanımınızda çalışan bir observability platformunuz var. Gerisini Arayüz turu gösterir.

Şimdi ne olacak?

Döngünün tamamı çalışıyor, sadece veriler sahte. Üç iyi sonraki hamle:

Bir şey çalışmadıysa

Bir konteyner exited ya da unhealthy görünüyor. Loglarını okuyun, sonra Sorun giderme'ye bakın:

docker compose logs <ad>

Giriş sayfası yüklenmiyor. Bir dakika daha bekleyin — Doris depolama düğümlerini hâlâ kaydediyor ve Orbtrace o bitene kadar hizmet vermez.

Arayüz açık ama trace görünmüyor. 6. adımın hatasız bittiğini ve Collector'ın çalıştığını doğrulayın — Orbtrace ile aynı orbtrace-net ağını paylaşmalı:

docker ps | grep otelcol

Collector başlarken network orbtrace-net not found. Ağ, yığınla birlikte oluşturulur; önce yığını başlatın, sonra yeniden deneyin:

docker compose up -d

Nasıl durdurulur

docker stop orbtrace-otelcol && docker rm orbtrace-otelcol   # Collector
docker compose down            # Orbtrace'i durdur, veriyi koru
docker compose down -v         # Orbtrace'i durdur ve tüm veriyi sil
ÖncekiKavramlarSonrakiKurulum hazırlığı