{"id":2547,"date":"2019-03-23T10:37:06","date_gmt":"2019-03-23T07:37:06","guid":{"rendered":"https:\/\/gokhan-gokalp.com\/?p=2547"},"modified":"2019-03-23T10:42:59","modified_gmt":"2019-03-23T07:42:59","slug":"logging-api-requests-and-responses-to-graylog-over-azure-api-management-using-azure-functions","status":"publish","type":"post","link":"https:\/\/gokhan-gokalp.com\/tr\/logging-api-requests-and-responses-to-graylog-over-azure-api-management-using-azure-functions\/","title":{"rendered":"API Request ve Response’lar\u0131n\u0131 Azure API Management \u00fczerinden Azure Funtions Kullanarak GrayLog’a Loglama"},"content":{"rendered":"

Sizlerinde bildi\u011fi gibi hemen hemen her backend application’\u0131n\u0131n sahip olmas\u0131 gereken en temel \u00f6zelliklerden birisi, request<\/em> ve response<\/em>‘lar\u0131n log<\/strong>‘lanmas\u0131d\u0131r. \u00d6zellikle \u00e7oklu\u00a0API<\/em> kullan\u0131m\u0131n\u0131n s\u00f6z konusu oldu\u011fu ortamlarda, “nice-to-have<\/em>” durumundan “must-have<\/em>” durumuna ge\u00e7i\u015f yapan temel bir \u00f6zellik.\"\"<\/a><\/p>\n

\u00c7\u00fcnk\u00fc \u00f6yle bir zaman geliyor ki, API<\/em>‘\u0131\u00a0call eden bir client’a, g\u00f6nderdi\u011fi request’in hatal\u0131 parametreler i\u00e7erdi\u011fini g\u00f6sterebilmeniz gerekiyor.<\/p>\n

K\u0131sacas\u0131, daha iyi bir “iz s\u00fcrebilmek<\/strong>” ad\u0131na API’<\/em>lar\u0131m\u0131za kazand\u0131rmam\u0131z gereken bir \u00f6zellik.<\/p><\/blockquote>\n

Hikaye<\/h2>\n

K\u0131sa bir s\u00fcre i\u00e7erisinde, t\u00fcm API<\/em> request ve response’lar\u0131n\u0131 log’lama gereksinimimiz olu\u015ftu. Evet, bunu ger\u00e7ekle\u015ftirebilmenin bir \u00e7ok y\u00f6ntemi mevcut. \u00d6rne\u011fin her API<\/em>‘\u0131n i\u00e7erisinde bir middleware yazarak, request ve response’lar\u0131 log’layabilmek gibi. Tabi hepsinin de ayr\u0131 bir tradeoff’u mevcut.<\/p>\n

Bir middleware yazd\u0131k diyelim, hangi API’<\/em>a kim implemente edecek? Performans’a k\u00f6t\u00fc bir \u015fekilde yan etki edecek mi? Tabi, en \u00f6nemlisi de vakit<\/strong>.<\/p>\n

Bu makale kapsam\u0131nda ise, request ve response’lar\u0131 log’layabilme gereksinimimizi “quick-win” bir \u00e7\u00f6z\u00fcm olarak nas\u0131l ger\u00e7ekle\u015ftirdi\u011fime de\u011finmeye \u00e7al\u0131\u015faca\u011f\u0131m.<\/p>\n

Peki<\/h2>\n

\u00c7\u00f6z\u00fcm\u00fcn daha net anla\u015f\u0131labilmesi i\u00e7in \u00f6ncelikle sistemimiz hakk\u0131nda sizlere k\u0131saca bir bilgi vermek istiyorum. \u00dczerinde \u00e7al\u0131\u015ft\u0131\u011f\u0131m proje, tamamen cloud-native<\/em> ve microservice<\/em> yakla\u015f\u0131m\u0131 ile design edilmi\u015f bir sistem’e sahip. Application’lar Azure Kubernetes Service<\/em> \u00fczerinde ve t\u00fcm API<\/em>‘lar\u0131m\u0131z\u0131\u00a0Azure API Management<\/em> vas\u0131tas\u0131yla y\u00f6netiyoruz.<\/p>\n

\"\"<\/a><\/p>\n

Azure API Management<\/em>, distributed olarak design etti\u011fimiz sistemde bizim i\u00e7in olmazsa olmaz par\u00e7alardan bir tanesi. Bu makale kapsam\u0131nda, microservice mimarisinde API Gateway<\/em> kullan\u0131m\u0131n\u0131n faydalar\u0131n\u0131n detay\u0131na \u00e7ok fazla girmeyece\u011fim.<\/p>\n

Fakat, API Gateway<\/em> kullan\u0131m\u0131n\u0131n bana “quick-win” bir \u00e7\u00f6z\u00fcm \u00fcretebilmemi sa\u011flayan noktalar\u0131ndan bir tanesine de\u011finmek istiyorum.<\/p>\n

API Gateway<\/em>, sisteme “tek bir giri\u015f noktas\u0131” ve uniform bir experience olu\u015fturabilmemize olanak sa\u011flamaktad\u0131r.<\/p><\/blockquote>\n

Dolay\u0131s\u0131yla routing i\u015fleminin d\u0131\u015f\u0131nda, request ve response’lar \u00fczerinde de istedi\u011fimiz manupilasyonlar\u0131 yapabilmemize olanak tan\u0131maktad\u0131r.<\/p>\n

Hal buyken, neden request ve response log’lama i\u015flemlerini tek tek her bir API<\/em> i\u00e7erisinden ger\u00e7ekle\u015ftireyim? De\u011fil mi?<\/p>\n

\"\"<\/a><\/p>\n

Bir \u00e7ok API<\/em> Gateway’in de sahip oldu\u011fu gibi, Azure API Management<\/em>‘da bir logging policy’sine sahip. Bu policy’leri kullanarak, platform-independet\u00a0<\/strong>ve merkezi<\/strong> bir logging i\u015flemi ger\u00e7ekle\u015ftirebilmek m\u00fcmk\u00fcn oluyor.<\/p>\n

Peki, Nas\u0131l?<\/b><\/h2>\n

Bu noktada, bir ka\u00e7 farkl\u0131 ad\u0131m\u0131 s\u0131ras\u0131yla izleyece\u011fiz:<\/p>\n

    \n
  1. Azure Event Hub<\/em>\u00a0olu\u015fturulmas\u0131<\/li>\n
  2. Azure API Management<\/em> Logger olu\u015fturulmas\u0131<\/li>\n
  3. Azure API Management<\/em> Log Policy’sinin configure edilmesi<\/li>\n
  4. Azure Event Hub<\/em>\u00a0triggered Azure Function<\/em> olu\u015fturulmas\u0131 ve GrayLog<\/em>‘a log g\u00f6nderilmesi<\/li>\n
  5. Olu\u015fturulan Azure Function<\/em>‘\u0131n deploy edilmesi<\/li>\n<\/ol>\n

    1. Azure Event Hub<\/em>\u00a0olu\u015fturulmas\u0131<\/h4>\n

    Azure API Management<\/em>‘da “Log to EventHub<\/em>” isminde bir advanced policy’e sahibiz. Bu policy ile performance impact’ini minimize ederek (performance impact’ini de g\u00f6z \u00f6n\u00fcnde bulundurmal\u0131y\u0131m), t\u00fcm log’lar\u0131 Event Hub<\/em>‘a g\u00f6nderebilir ve daha sonra istedi\u011fimiz gibi i\u015fleyebilir, kaydedebiliriz.<\/p>\n

    E\u011fer hali haz\u0131rda bir\u00a0Event Hub<\/em>\u00a0kullanm\u0131yorsan\u0131z, bir Event Hub<\/em>\u00a0namespace’i ve instance’\u0131na ihtiyac\u0131n\u0131z var demektir.<\/p>\n

    Azure Event Hub<\/em>\u00a0saniyede milyonlarca event’i al\u0131p, i\u015fleyebilme yetene\u011fine sahip bir event ingestion service’idir.<\/p><\/blockquote>\n

    Hemen olu\u015fturabilmek i\u00e7in buradaki<\/a><\/em> ad\u0131mlar\u0131 takip edebiliriniz.<\/p>\n

    Event Hub<\/em>\u00a0olu\u015fturma ad\u0131mlar\u0131n\u0131 tamamlad\u0131ktan sonra, Azure API Management<\/em> i\u00e7erisinden Event Hub<\/em>‘\u0131 kullanabilmemiz i\u00e7in bir shared access policy<\/em>‘e ihtiyac\u0131m\u0131z var. Bu policy’i elde edebilmek i\u00e7in olu\u015fturmu\u015f oldu\u011funuz Event Hub<\/em>\u00a0entity’sine t\u0131klayarak detaylar\u0131na girelim.<\/p>\n

    \"\"<\/a><\/p>\n

    Ard\u0131ndan yukar\u0131daki gibi sol tarafda bulunan “Shared access policies<\/em>” sekmesine t\u0131klayal\u0131m.<\/p>\n

    \"\"<\/a><\/p>\n

    \u015eimdi policy tan\u0131mlayabilmek i\u00e7in “Add<\/em>” butonuna basal\u0131m ve tan\u0131mlama i\u015flemini ger\u00e7ekle\u015ftirelim. Ben “AzureAPIManagement<\/em>” isminde bir policy tan\u0131mlad\u0131m. Olu\u015fturma i\u015fleminin ard\u0131ndan, yukar\u0131da g\u00f6rd\u00fc\u011f\u00fcm\u00fcz gibi Event Hub<\/em> instance’\u0131n\u0131n connection string bilgilerine eri\u015febilece\u011fiz.<\/p>\n

    2. Azure API Management<\/em> Logger olu\u015fturulmas\u0131<\/h4>\n

    Event Hub<\/em> ad\u0131mlar\u0131n\u0131 tamamlad\u0131k. \u015eimdi ise Azure API Management<\/em> i\u00e7erisinde bir logger<\/strong>‘a ihtiyac\u0131m\u0131z var. Logger’\u0131 olu\u015fturma i\u015flemini Azure API Management REST API<\/em>‘\u0131 \u00fczerinden ger\u00e7ekle\u015ftirece\u011fiz.<\/p>\n

    Logger olu\u015fturma i\u015flemine ba\u015flamadan \u00f6nce, Azure API Management<\/em> servisindeki REST API<\/em> hizmetini enable etmemiz gerekmektedir. Enable edebilmek i\u00e7in\u00a0Azure API Management<\/em> instance’\u0131 i\u00e7erisinden, a\u015fa\u011f\u0131daki gibi “Management API<\/em>” sekmesine girerek “Enable API Management REST API<\/em>” checkbox’\u0131n\u0131 i\u015faretlememiz yeterli olacakt\u0131r.<\/p>\n

    \"\"<\/a><\/p>\n

    REST API<\/em>‘\u0131 enable ettikten sonra, a\u015fa\u011f\u0131daki “Accesss token<\/em>” b\u00f6l\u00fcm\u00fcndeki “Generate<\/em>” butonuna basarak bir access token elde edelim.<\/p>\n

    Art\u0131k bir logger olu\u015fturabiliriz. Logger olu\u015fturabilmek i\u00e7in a\u015fa\u011f\u0131daki URL<\/em>‘e bir HTTP PUT<\/em> request’i g\u00f6ndermemiz gerekmektedir.<\/p>\n

    https:\/\/my-api-management. management.azure-api.net\/loggers\/my-logger?api-version=2018-01-01<\/em><\/p>\n

    NOT: {my-api-management<\/em>} ve {my-logger<\/em>} parametrelerini, kendi service name’leriniz ile de\u011fi\u015ftirmeyi unutmay\u0131n.<\/p><\/blockquote>\n

    Header’a ise eklememiz gereken bir ka\u00e7 parametre bulunmaktad\u0131r.<\/p>\n