Ana içeriğe atla
API Proxy’e gelen istek ve dönen yanıt mesajları API Proxy’nin yüklendiği ortamdaki API Proxy Trafik Log Konnektörlerine gönderilerek loglanır. Bu loglama işlemi mesaj işleme sürecinin bir parçasıdır. Log kayıtları iki tip veri içerir:
  1. Bunlardan ilki metrik verilerdir. Metrik verilerin saklanması isteğe bağlı değildir.
  2. İkincisi ise; İstemci → API Proxy, API Proxy → Backend API, Backend API → API Proxy, API Proxy → İstemci sırası ile iletilen istek ve yanıt mesajlarının, bu 4 bölgedeki içeriklerini oluşturan başlık (header), parametre (parameter) ve gövde (body) alanlarından oluşan kayıtlardır. Bu alanlardan hangilerinin log kayıtlarında bulunacağı ihtiyaca göre ya da log sunucusunun kaynak tüketimi baz alınarak belirlenebilir.
Varsayılan olarak projenin tüm mesaj bölgelerindeki log alanları aktiftir. Varsayılan olarak tüm log alanlarının aktif gelmesine rağmen, özellikle Üretim (Production) Ortamlarında log verisinin aşırı büyümemesi için Body alanlarının pasife alınması tercih edilebilir.

​
Log Kaydı Tutulan Bölgeler

API Proxy mesajları şu bölgelerde loglanabilir:

Request from Client

İstemciden API Proxy’e gelen istek mesajları

Request to Target

API Proxy’den Backend API’ye iletilen istek mesajları

Response from Target

Backend API’den API Proxy’e verilen yanıt mesajları

Response to Client

API Proxy’den istemciye gönderilen yanıt mesajları
Varsayılan olarak, projenin tüm mesaj bölgelerindeki alanların loglanması aktiftir. Loglanan alanlar ihtiyaca göre veya log sunucusunun kaynak tüketimi baz alınarak kısıtlanabilir.

​
Üretim Ortamı Önerileri

Üretim Ortamı İçin Öneriler: Üretim ortamında aşağıdaki bölgelerin loglanmasının devre dışı bırakılması tavsiye edilir.
Üretim ortamında çalışan API Proxy’lerde tüm poliçelerin ayarları ve testleri tamamlandığı için geliştirme yapılmayacaktır. Veritabanında verilerin aşırı büyümemesi için şu bölgelerin loglanması devre dışı bırakılabilir:
  • Request to Target: API Proxy’den Backend API’ye iletilen istekler
  • Response from Target: Backend API’den API Proxy’e verilen yanıtlar
Bu iki bölgedeki başlık, parametre ve gövde verilerinin yazılmaması veritabanı boyutunu kontrol altında tutmaya yardımcı olur.

​
Hata Durumunda Loglama

Hata Durumunda Otomatik Loglama: Tüm loglama alanları kapalı olsa dahi, istekte bir hata oluştuysa log alanlarının tümü hatanın tespit edilebilmesi için otomatik olarak kayıt edilir. Bu özellik genel ayarlarda açılıp kapatılabilir.

​
Formdata İstekleri

Formdata İstekleri: Formdata istekleri değişken veri büyüklükleri ve veri formatları nedeniyle dosya kısımları hiçbir şekilde loglanmamaktadır. Sadece diğer metadata alanları loglanmaktadır.

​
WebSocket ve gRPC İstekleri

WebSocket ve gRPC: WebSocket ve gRPC istekleri Apinizer’a gelen ve Apinizer’dan çıkan veriler şeklinde tutulduğundan bu tip API Proxy’lerde sadece 2 bölge bulunur:
  • Request from Client / Response to Client
  • Request to Target / Response from Target

​
Log Ayarları Sekmesi

API Proxy detay sayfasında Log Ayarları (Log Settings) sekmesi, trafik log konfigürasyonunu yönetmek için ayrılmış özel bir sekmedir. Eskiden Settings sekmesinin en altında yer alan log ayarları bölümü, artık bu ayrı sekmeden yönetilir.
Üç Seviyeli Yapılandırma: Log ayarlarını üç seviyede yapılandırabilirsiniz:
  • API Proxy bazında: Her API Proxy için genel log ayarları
  • Ortam bazında: Seçilen ortama özel log ayarları (ayarlar ortam bazlı saklanır)
  • Metod bazında: Belirli API metodları için özel log ayarları (Method Overrides)

​
Log Ayarları Ekranı

Log Ayarları sekmesinde API Proxy bazlı ve ortam bazlı log ayarları yapılabilir. Eğer entegrasyon ayarları yapılmışsa, hangi API Proxy’lerin trafik kayıtlarının bu entegrasyon hedeflerine gönderilebileceği de ayarlanabilir. Bu ayarlar sadece Elasticsearch için değil, Kafka, RabbitMQ, Veritabanı, ActiveMQ, Syslog, Webhook, Logback, Graylog gibi tüm konnektör tipleri için geçerlidir.

​
Ekran Bileşenleri

Üst Bar:
  • Ortam Seçici (Environment): Log ayarlarının uygulanacağı ortamı seçebilirsiniz. Ayarlar ortam bazlı saklanır.
  • Kaydet (Save): Yapılan değişiklikleri kaydeder.
Sol Kenar Çubuğu – Konnektörler:
  • Elasticsearch, Kafka, Logback, Syslog, Veritabanı, Graylog, RabbitMQ, ActiveMQ, Webhook konnektörleri listelenir.
  • Her konnektörün yanında etkin/devre dışı durumu gösterilir.
  • Metod Geçersiz Kılmaları (Method Overrides): API metodları için özel log ayarları tanımlanabilir. Tanımlı geçersiz kılma sayısı rozet ile gösterilir.
Ana İçerik Alanı:
  • Seçilen konnektör için etkinleştirme anahtarı ve log alanları (başlık, parametre, gövde) yapılandırılır.
  • Metadata ve gizlilik ayarları yönetilir.
Log Ayarları Sekmesi
Platform genelinde geçerli log ayarlarını Genel Ayarlar ekranından yapılandırabilirsiniz.

​
Konnektör Ayarları

Her konnektör için aşağıdaki alanlar yapılandırılabilir:
AlanAçıklama
Etkin (Enabled)Konnektöre log gönderiminin açık/kapalı olmasını belirler.
Başlık (Header)İlgili bölgedeki mesajın Başlık alanındaki değerlerin loglanmasını sağlar. Mesajdaki başlık bilgilerinin loglanıp loglanmadığını yönetir.
Gövde (Body)İlgili bölgedeki mesajın Gövde alanındaki değerin loglanmasını sağlar. Mesajdaki gövde bilgilerinin loglanıp loglanmadığını yönetir.
Parametre (Parameter)İlgili bölgedeki mesajın Parametre alanındaki değerlerin loglanmasını sağlar. Mesajdaki parametre bilgilerinin loglanıp loglanmadığını yönetir.

​
Metod Geçersiz Kılmaları

Belirli API metodları için varsayılan konnektör ayarlarından farklı log ayarları tanımlayabilirsiniz. Örneğin hassas bir metot için gövde loglamasını kapatabilir, diğer metodlar için açık bırakabilirsiniz.
  • Metod Geçersiz Kılması Ekle (Add Method Override): Metod ve konnektör tipi seçerek özel ayar tanımlarsınız.
  • Her geçersiz kılma için başlık, parametre ve gövde loglaması ayrı ayrı yapılandırılabilir.
  • Mevcut geçersiz kılmalar düzenlenebilir veya silinebilir.

​
Gizlilik Ayarları

API Proxy trafik loglarında hassas verilerin korunması için gizlilik ayarları yapılabilir. Bu ayarlar connector’ler environment’a eklenirken yapılandırılır. Hangi alanların loglanacağı ve hangi alanlarda gizlilik işlemleri (maskeleme, silme, hashleme, şifreleme) uygulanacağı belirlenebilir. Detaylı bilgi için Gateway Ortamlarına Konnektör Eklenmesi sayfasına bakabilirsiniz.
Log Ayarları bölümünde, log ayarları API Proxy bazlı olarak yönetilir.

​
İlgili Sayfalar

​
Sonraki Adımlar

Genel Ayarlar

API Proxy genel ayarları

Genel Bilgi Sekmesi

API Proxy genel bilgileri