Cloudflare API Gateway Ortamında Gözlemlenebilirlik ve OpenTelemetry Entegrasyonu
Günümüzün karmaşık, dağıtık sistemlerinde, uygulamalarımızın ve altyapımızın nasıl çalıştığını anlamak, sorunları hızlıca tespit edip çözmek ve kullanıcı deneyimini optimize etmek hayati önem taşır. İşte tam da bu noktada gözlemlenebilirlik (observability) kavramı devreye giriyor. Bu makalede, gözlemlenebilirliğin ne olduğunu, neden önemli olduğunu, OpenTelemetry’nin bu alandaki rolünü ve Cloudflare API Gateway gibi kritik bir bileşenin bulunduğu mimarilerde OpenTelemetry ile nasıl daha iyi bir gözlemlenebilirlik sağlayabileceğimizi detaylıca inceleyeceğiz.
Gözlemlenebilirlik (Observability) Nedir?
Gözlemlenebilirlik, bir sistemin dışarıdan gözlemlenebilir çıktıları (loglar, metrikler, izler) aracılığıyla iç durumunun ne kadar iyi anlaşılabildiğini ifade eden bir özelliktir. Kısacası, sisteminize “ne oluyor?” sorusunu sorabildiğinizde ve bu soruya tatmin edici, detaylı cevaplar alabildiğinizde sisteminiz gözlemlenebilirdir. Bu, özellikle mikroservis mimarileri ve bulut tabanlı uygulamalar gibi karmaşık, dinamik ortamlarda kritik bir yetenektir.
Gözlemlenebilirlik ve İzleme (Monitoring) Arasındaki Fark
Gözlemlenebilirlik ve izleme terimleri sıklıkla birbirinin yerine kullanılsa da, aslında farklı kavramları ifade ederler. İzleme (monitoring), genellikle önceden tanımlanmış eşik değerlere veya bilinen sorunlara odaklanır. “CPU kullanımı %80’in üzerine çıktı mı?” veya “Sunucu yanıt vermiyor mu?” gibi sorulara cevap verir. Yani, *bildiğiniz sorunları* takip etmenizi sağlar.
Gözlemlenebilirlik ise, *bilmediğiniz sorunları* veya beklenmedik davranışları anlamanıza olanak tanır. Bir sistemde beklenmedik bir yavaşlama olduğunda, gözlemlenebilirlik size bu yavaşlamanın nedenini (örneğin, belirli bir veritabanı sorgusunun aniden yavaşlaması veya bir üçüncü taraf API’sinin gecikmesi) bulmak için gerekli tüm veriyi sunar. İzleme “ne” olduğunu söylerken, gözlemlenebilirlik “neden” olduğunu anlamanıza yardımcı olur.
Gözlemlenebilirliğin Üç Temel Sütunu: Loglar, Metrikler, İzler
Gözlemlenebilirliğin temelini oluşturan üç ana veri türü vardır:
1. Loglar (Logs): Bir sistemdeki belirli olayları kaydeden zaman damgalı metin kayıtlarıdır. Hata mesajları, kullanıcı girişi, veritabanı işlemleri gibi discrete (ayrık) olayları içerirler. Loglar, genellikle bir olayın tam olarak ne zaman ve nasıl gerçekleştiğini anlamak için kullanılır.
2. Metrikler (Metrics): Zaman içinde ölçülen sayısal değerlerdir. CPU kullanımı, bellek tüketimi, istek sayısı, hata oranı, yanıt süresi gibi verileri içerirler. Metrikler, sistemin genel sağlığı ve performansı hakkında toplu bilgiler sunar ve trendleri izlemek için idealdir.
3. İzler (Traces): Dağıtık bir sistemdeki tek bir isteğin (request) uçtan uca yolculuğunu gösteren verilerdir. Bir isteğin farklı servisler arasında nasıl hareket ettiğini, her serviste ne kadar zaman geçirdiğini ve olası hataların nerede meydana geldiğini anlamak için kullanılırlar. İzler, özellikle mikroservis mimarilerinde performans darboğazlarını ve bağımlılık sorunlarını tespit etmek için vazgeçilmezdir.
Neden Gözlemlenebilirlik Önemlidir?
Gözlemlenebilirlik, modern yazılım geliştirme ve operasyon süreçlerinde birçok avantaj sunar:
* Daha Hızlı Sorun Tespiti ve Çözümü: Sorunların kök nedenlerini daha hızlı bulmanızı sağlar.
* Geliştirilmiş Kullanıcı Deneyimi: Performans sorunlarını proaktif olarak tespit ederek kullanıcıların etkilenmesini önler.
* Daha İyi Sistem Anlayışı: Uygulamalarınızın ve altyapınızın gerçek dünya koşullarında nasıl davrandığını derinlemesine anlamanıza yardımcı olur.
* Verimli Kaynak Kullanımı: Performans darboğazlarını veya gereksiz kaynak tüketimini belirleyerek optimizasyon fırsatları sunar.
* Geliştirici Verimliliği: Geliştiricilerin kendi kodlarının dağıtık bir sistemdeki etkileşimlerini anlamalarını kolaylaştırır.
OpenTelemetry Nedir ve Neden Kullanmalıyız?
OpenTelemetry, bulut yerlisi (cloud-native) yazılımın gözlemlenebilirliğini sağlamak için tasarlanmış, CNCF (Cloud Native Computing Foundation) tarafından desteklenen açık kaynaklı bir projedir. Amacı, loglar, metrikler ve izler dahil olmak üzere telemetri verilerini toplamak, işlemek ve dışa aktarmak için standartlaştırılmış, satıcıdan bağımsız bir çerçeve sunmaktır.
OpenTelemetry’nin Bileşenleri: SDK’lar, Collector, Exporter’lar
OpenTelemetry ekosistemi birkaç ana bileşenden oluşur:
1. SDK’lar (Software Development Kits): Çeşitli programlama dilleri için (Python, Java, Go, Node.js, .NET vb.) sağlanan kütüphanelerdir. Uygulamalarınıza telemetri verisi üretme yeteneği kazandırmak için kullanılırlar. Otomatik enstrümantasyon (framework’leri veya kütüphaneleri otomatik olarak izler) ve manuel enstrümantasyon (kodunuza özel izleme noktaları ekleme) seçenekleri sunarlar.
2. Collector: Telemetri verilerini alır, işler ve dışa aktarır. Bir aracı (agent) veya ağ geçidi (gateway) olarak çalışabilir. Verileri toplama, filtreleme, dönüştürme, toplu işleme (batching) ve farklı formatlara çevirme gibi görevleri üstlenir. Bu sayede, uygulamanızın doğrudan bir gözlemlenebilirlik backend’ine veri gönderme yükünü hafifletir ve farklı backend’lere veri gönderme esnekliği sağlar.
3. Exporter’lar: Toplanan telemetri verilerini belirli bir gözlemlenebilirlik backend’ine (örneğin, Jaeger, Prometheus, Grafana, Datadog, Splunk, ELK Stack) göndermek için kullanılırlar. OpenTelemetry, birçok popüler backend için yerleşik dışa aktarıcılar sunar.
OpenTelemetry’nin Avantajları
OpenTelemetry’yi kullanmanın başlıca avantajları şunlardır:
* Satıcı Bağımsızlığı (Vendor Neutrality): Verilerinizi belirli bir satıcıya veya ürüne kilitlemez. Topladığınız verileri istediğiniz gözlemlenebilirlik backend’ine gönderebilirsiniz. Bu, gelecekte backend değiştirme esnekliği sağlar.
* Standartlaşma: Telemetri verilerinin toplanması ve formatlanması için endüstri standardı bir yaklaşım sunar. Bu, farklı araçların ve ekiplerin uyumlu bir şekilde çalışmasını kolaylaştırır.
* Zengin Ekosistem: Birçok programlama dili için SDK desteği ve çeşitli backend’lerle entegrasyonu sayesinde geniş bir kullanım alanına sahiptir.
* Topluluk Desteği: CNCF’in bir parçası olarak, geniş ve aktif bir geliştirici topluluğu tarafından desteklenir, bu da sürekli gelişim ve iyileştirmeler anlamına gelir.
OpenTelemetry’nin Çalışma Prensibi
OpenTelemetry, temelde uygulamanızdan telemetri verilerini (izler, metrikler, loglar) toplar. Bu veriler daha sonra bir OpenTelemetry Collector’a gönderilir. Collector, bu verileri işler (örneğin, filtreler, zenginleştirir, toplu hale getirir) ve yapılandırılmış dışa aktarıcılar aracılığıyla tercih ettiğiniz gözlemlenebilirlik backend’ine (örneğin, Jaeger için izler, Prometheus için metrikler) gönderir. Backend’de bu veriler depolanır, görselleştirilir ve analiz edilir.
Cloudflare API Gateway’e Yakından Bakış
Cloudflare API Gateway, modern API tabanlı uygulamaların önünde duran, trafiği yöneten, güvenliği sağlayan ve performansı optimize eden kritik bir bileşendir. API isteklerini yönlendirme, kimlik doğrulama, yetkilendirme, hız sınırlama, önbellekleme ve güvenlik duvarı (WAF) gibi işlevleri merkezi bir noktadan yönetmenizi sağlar.
Cloudflare API Gateway’in Temel Özellikleri
Cloudflare API Gateway’in sunduğu bazı temel özellikler şunlardır:
* Trafik Yönetimi: İstekleri doğru servislere yönlendirme, yük dengeleme.
* Güvenlik: DDoS koruması, Web Uygulama Güvenlik Duvarı (WAF), API kimlik doğrulama ve yetkilendirme, bot yönetimi.
* Performans Optimizasyonu: Önbellekleme, içerik dağıtım ağı (CDN) entegrasyonu.
* Hız Sınırlama (Rate Limiting): API’lerin aşırı kullanımını önleme ve kötü niyetli saldırıları engelleme.
* Gelişmiş Analizler: API trafiği, performans ve güvenlik olayları hakkında detaylı raporlar.
API Gateway Neden Kritik Bir Bileşendir?
API Gateway, özellikle mikroservis mimarilerinde merkezi bir kontrol noktası görevi görür. Uygulama geliştiricilerin güvenlik, performans ve trafik yönetimi gibi endişelerle uğraşmak yerine iş mantığına odaklanmasını sağlar. Ayrıca, API’lerin dış dünyaya tutarlı ve güvenli bir arayüz sunmasına yardımcı olur.
Cloudflare’ın Kendi Gözlemlenebilirlik Araçları
Cloudflare, API Gateway ve diğer hizmetleri için kapsamlı yerleşik gözlemlenebilirlik araçları sunar:
* Analytics Dashboard: API trafiği, güvenlik olayları, performans metrikleri hakkında görselleştirilmiş veriler.
* Logpush: Cloudflare’ın ürettiği HTTP istek loglarını, güvenlik olay loglarını ve diğer operasyonel logları Amazon S3, Google Cloud Storage, Splunk, Datadog gibi çeşitli hedeflere gerçek zamanlı veya toplu olarak gönderme yeteneği.
* Workers: Sunucusuz işlevler aracılığıyla özel loglama veya telemetri toplama mantığı ekleme imkanı.
Bu araçlar, Cloudflare ortamının kendisi hakkında değerli bilgiler sağlar. Ancak, OpenTelemetry ile entegrasyon, Cloudflare’ın sağladığı verileri, kendi arka uç servislerinizden gelen verilerle birleştirerek uçtan uca, bütünsel bir gözlemlenebilirlik deneyimi yaratmanızı sağlar.
Cloudflare API Gateway Ortamında OpenTelemetry Entegrasyonu
Cloudflare API Gateway, yönetilen bir hizmet olduğundan, doğrudan içine OpenTelemetry SDK’ları kurmak veya enstrümanlamak mümkün değildir. Ancak, OpenTelemetry’yi kullanarak Cloudflare API Gateway’in bulunduğu bir mimaride gözlemlenebilirliği artırmanın iki temel yolu vardır:
1. Gateway Arkasındaki Servisleri OpenTelemetry ile İzlemek: Bu, en yaygın ve etkili yaklaşımdır.
2. Cloudflare Loglarını ve Metriklerini OpenTelemetry Ekosistemine Dahil Etmek: Cloudflare’ın ürettiği verileri OpenTelemetry Collector aracılığıyla işlemek.
Doğrudan Gateway Entegrasyonunun Zorlukları ve Yaklaşımları
Yönetilen bir hizmet olan Cloudflare API Gateway’i doğrudan OpenTelemetry ile enstrümanlamak, genellikle satıcı tarafından desteklenmediği için mümkün değildir. Ancak, bazı dolaylı yaklaşımlar düşünülebilir:
* Cloudflare Workers ile Özel Telemetri: Cloudflare Workers kullanarak API istekleri üzerinde custom kod çalıştırabilir ve bu kod içinde OpenTelemetry SDK’larını (JavaScript için) kullanarak izler veya metrikler oluşturup bir OpenTelemetry Collector’a gönderebilirsiniz. Bu, özellikle istek başlıklarını veya belirli iş mantığını izlemek istediğinizde faydalı olabilir.
* Proxy/Sidecar Yaklaşımı: API Gateway’in önünde veya arkasında, tüm trafiği yakalayan ve OpenTelemetry ile enstrümanlanmış bir proxy (örneğin, Envoy) kullanmak. Bu, karmaşıklığı artırsa da, daha granüler kontrol sağlayabilir. Ancak Cloudflare’ın kendisi bir proxy görevi gördüğü için bu senaryo genellikle gereksizdir.
En pratik ve yaygın yaklaşım, Cloudflare API Gateway’in arkasında çalışan kendi servislerinizi OpenTelemetry ile enstrümanlamaktır.
Gateway Arkasındaki Servisleri OpenTelemetry ile İzlemek
Bu yaklaşımda, Cloudflare API Gateway gelen istekleri arka uç servislerinize yönlendirir. Siz de bu arka uç servislerini (mikroservisler, sunucusuz işlevler vb.) OpenTelemetry SDK’ları ile enstrümanlarsınız.
Nasıl Çalışır:
1. Bir kullanıcı isteği Cloudflare API Gateway’e ulaşır.
2. Gateway, isteği ilgili arka uç servisine yönlendirir.
3. Arka uç servisi, OpenTelemetry SDK’ları sayesinde bu isteği bir “iz” (trace) olarak başlatır.
4. İstek, servisin içinde farklı fonksiyonları veya veritabanı işlemlerini tetikledikçe, OpenTelemetry bu olayları “span” olarak kaydeder ve iz’e ekler.
5. Eğer istek başka bir servise gidiyorsa, OpenTelemetry bağlam yayılımı (context propagation) sayesinde iz kimliğini (trace ID) HTTP başlıkları aracılığıyla diğer servise iletir. Böylece, tüm servislerdeki ilgili span’ler aynı iz altında toplanır.
6. Servisler, topladıkları izleri, metrikleri ve logları yerel bir OpenTelemetry Collector’a veya doğrudan merkezi bir Collector’a gönderir.
7. Collector, verileri işler ve Jaeger, Prometheus, Grafana gibi backend’lere aktarır.
Bu sayede, Cloudflare API Gateway’den geçen bir isteğin, arka uç servislerinizde nasıl işlendiğini uçtan uca görebilir, performans darboğazlarını ve hataları kolayca tespit edebilirsiniz.
Cloudflare Loglarını ve Metriklerini OpenTelemetry Ekosistemine Dahil Etmek
Cloudflare’ın ürettiği loglar ve metrikler, sisteminizin genel sağlığı ve API Gateway’in performansı hakkında değerli bilgiler içerir. Bu verileri OpenTelemetry ekosistemine dahil etmek, bütünsel bir görünüm elde etmenizi sağlar.
Nasıl Yapılır:
1. Cloudflare Logpush Kullanımı: Cloudflare Logpush hizmetini yapılandırarak HTTP istek loglarını, güvenlik olay loglarını ve diğer logları bir depolama hedefine (örneğin, Amazon S3, Google Cloud Storage) veya doğrudan bir HTTP uç noktasına (webhook) gönderin.
2. OpenTelemetry Collector ile Log Tüketimi:
* Eğer logları bir depolama hedefine gönderiyorsanız, bir OpenTelemetry Collector’ı bu depolama hedefinden logları okuyacak şekilde yapılandırabilirsiniz (örneğin, S3 receiver kullanarak).
* Eğer Cloudflare Logpush’u bir HTTP uç noktasına gönderiyorsanız, Collector’ı bir HTTP receiver ile bu uç noktayı dinleyecek şekilde ayarlayabilirsiniz.
* Collector, aldığı logları OpenTelemetry log formatına dönüştürebilir, zenginleştirebilir ve ardından Prometheus/Grafana (metrik olarak), ELK Stack (log olarak) veya diğer log yönetim sistemlerine aktarabilir.
3. Metrik Entegrasyonu: Cloudflare’ın kendi metrikleri genellikle API veya panelleri aracılığıyla erişilebilir. Doğrudan OpenTelemetry formatına dönüştürmek karmaşık olabilir. Ancak, Cloudflare API’lerini kullanarak metrikleri çekip, bunları bir OpenTelemetry Collector’a gönderecek özel bir servis yazabilirsiniz. Collector daha sonra bu metrikleri Prometheus veya başka bir metrik backend’ine aktarabilir.
Bu entegrasyon, Cloudflare’ın sunduğu dış katman gözlemlenebilirliğini, kendi uygulamalarınızın iç gözlemlenebilirliği ile birleştirerek, API isteklerinin tüm yaşam döngüsünü kapsayan güçlü bir analiz yeteneği sunar.
Pratik Adımlar ve Örnek Senaryolar
Şimdi, OpenTelemetry’yi Cloudflare API Gateway arkasındaki bir servise nasıl entegre edeceğinize dair pratik adımlara ve örnek senaryolara göz atalım.
OpenTelemetry SDK ile Servisleri Enstrümanlamak (Örnek: Node.js/Python)
Arka uç servislerinizi OpenTelemetry ile enstrümanlamak, genellikle birkaç adımdan oluşur:
1. Gerekli Kütüphaneleri Kurma:
* Node.js:
npm install @opentelemetry/api @opentelemetry/sdk-node @opentelemetry/auto-instrumentations-node @opentelemetry/exporter-otlp-proto
* Python:
pip install opentelemetry-sdk opentelemetry-exporter-otlp opentelemetry-instrumentation-flask # veya django, fastapi
2. Enstrümantasyonu Başlatma: Uygulamanızın başlangıç noktasında OpenTelemetry SDK'sını yapılandırmanız gerekir.
* Node.js (örnek server.js veya app.js dosyasının başında):
// tracer.js
const { NodeSDK } = require('@opentelemetry/sdk-node');
const { OTLPTraceExporter } = require('@opentelemetry/exporter-otlp-proto');
const { Resource } = require('@opentelemetry/resources');
const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions');
const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
const sdk = new NodeSDK({
resource: new Resource({
[SemanticResourceAttributes.SERVICE_NAME]: 'my-api-service',
[SemanticResourceAttributes.SERVICE_VERSION]: '1.0.0',
}),
traceExporter: new OTLPTraceExporter({
url: 'http://localhost:4318/v1/traces', // OpenTelemetry Collector'ın OTLP HTTP uç noktası
}),
instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();
console.log('OpenTelemetry SDK started.');
// Uygulamanızın geri kalanını burada başlatın
require('./app'); // Örneğin, Express uygulamanızın olduğu dosya
Bu tracer.js dosyasını node -r ./tracer.js app.js şeklinde çalıştırabilirsiniz.
* Python (örnek app.py):
from opentelemetry import trace
from opentelemetry.sdk.resources import Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.instrumentation.flask import FlaskInstrumentor # veya diğer framework'ler için
# Kaynak tanımlaması
resource = Resource.create({
"service.name": "my-api-service",
"service.version": "1.0.0",
})
# Tracer sağlayıcıyı ayarla
provider = TracerProvider(resource=resource)
trace.set_tracer_provider(provider)
# OTLP exporter'ı ayarla (Collector'a göndermek için)
otlp_exporter = OTLPSpanExporter(endpoint="http://localhost:4318/v1/traces") # OpenTelemetry Collector'ın OTLP HTTP uç noktası
span_processor = BatchSpanProcessor(otlp_exporter)
provider.add_span_processor(span_processor)
# Flask uygulamasını enstrümanla
from flask import Flask
app = Flask(__name__)
FlaskInstrumentor().instrument_app(app)
@app.route("/")
def hello_world():
return "Hello, World!
"
if __name__ == "__main__":
app.run(debug=True)
3. Manuel Enstrümantasyon (Gerektiğinde): Otomatik enstrümantasyon çoğu zaman yeterli olsa da, belirli iş mantığı adımlarını veya kritik kod bloklarını özel olarak izlemek için manuel span'ler oluşturabilirsiniz.
* Python (manuel span örneği):
tracer = trace.get_tracer(__name__)
@app.route("/process")
def process_data():
with tracer.start_as_current_span("process-data-operation") as span:
# Bazı işlemler...
span.set_attribute("data.size", 1024)
# Başka bir fonksiyon çağrısı
result = some_internal_function()
return f"Processed: {result}
"OpenTelemetry Collector Kurulumu ve Yapılandırması
OpenTelemetry Collector, telemetri verilerini alıp işleyerek backend'lere gönderen merkezi bir bileşendir. Bir Docker container'ı olarak veya doğrudan bir sunucuya kurulabilir.
Örnek otel-collector-config.yaml:
receivers:
otlp:
protocols:
http: # SDK'lardan HTTP üzerinden OTLP verisi almak için
endpoint: 0.0.0.0:4318
grpc: # SDK'lardan gRPC üzerinden OTLP verisi almak için
endpoint: 0.0.0.0:4317
processors:
batch: # Verileri toplu işleyerek gönderme
send_batch_size: 100
timeout: 10s
memory_limiter: # Bellek kullanımını sınırlama
limit_mib: 256
spike_limit_mib: 64
check_interval: 5s
exporters:
jaeger: # İzleri Jaeger'a gönderme
endpoint: jaeger:14250 # Jaeger Agent/Collector gRPC portu
tls:
insecure: true
prometheus: # Metrikleri Prometheus'a gönderme
endpoint: 0.0.0.0:8889 # Prometheus tarafından scrape edilecek port
logging: # Debugging için konsola loglama
verbosity: detailed
otlp/grafana: # Logları ve diğer verileri Grafana Loki/Tempo'ya gönderme (örnek)
endpoint: http://grafana-tempo:4318
tls:
insecure: true
service:
pipelines:
traces:
receivers: [otlp]
processors: [memory_limiter, batch]
exporters: [jaeger, logging, otlp/grafana] # Jaeger ve Grafana Tempo'ya gönder
metrics:
receivers: [otlp]
processors: [memory_limiter, batch]
exporters: [prometheus, logging] # Prometheus'a gönder
logs:
receivers: [otlp]
processors: [memory_limiter, batch]
exporters: [logging, otlp/grafana] # Grafana Loki'ye gönder
Docker ile Çalıştırma:
docker run -p 4317:4317 -p 4318:4318 -p 8889:8889 \
-v ./otel-collector-config.yaml:/etc/otel-collector-config.yaml \
otel/opentelemetry-collector:latest \
--config=/etc/otel-collector-config.yamlVerilerin Bir Backend'e Gönderilmesi (Jaeger, Prometheus, Grafana, ELK)
OpenTelemetry Collector aracılığıyla toplanan veriler, çeşitli gözlemlenebilirlik backend'lerine gönderilebilir:
* İzler (Traces): Jaeger (açık kaynak), Grafana Tempo, New Relic, Datadog gibi dağıtık izleme sistemlerine gönderilir.
* Metrikler (Metrics): Prometheus (açık kaynak), Grafana Mimir, VictoriaMetrics, Datadog gibi metrik depolama ve görselleştirme sistemlerine gönderilir. Prometheus, metrikleri Collector'dan "scrape" eder.
* Loglar (Logs): ELK Stack (Elasticsearch, Logstash, Kibana), Grafana Loki, Splunk gibi log yönetim sistemlerine gönderilir.
Bu backend'ler, toplanan verileri görselleştirmenizi, sorgulamanızı ve analiz etmenizi sağlayarak sisteminizin içgörülerini ortaya çıkarır. Örneğin, Jaeger'da bir izi inceleyerek bir isteğin Cloudflare API Gateway'den geçip arka uç servislerinizde nasıl ilerlediğini