Edge Microgateway için işlem ve yapılandırma referansı

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin.
bilgi

Edge Microgateway 2.3.x sürümü

Genel Bakış

Bu konuda, izleme, günlük kaydı ve hata ayıklama dahil olmak üzere Edge Microgateway'in nasıl yönetileceği ve yapılandırılacağı açıklanmaktadır.

Yapılandırma değişiklikleri yapma

Bilmeniz gereken yapılandırma dosyaları şunlardır:

  • Varsayılan sistem yapılandırma dosyası
  • Yeni başlatılan bir Edge Microgateway örneği için varsayılan yapılandırma dosyası
  • Çalışan örnekler için dinamik yapılandırma dosyası

Bu bölümde, söz konusu dosyalar ve bunları değiştirme hakkında bilmeniz gerekenler ele alınmaktadır. Yapılandırma dosyası ayarları hakkında ayrıntılı bilgi için Edge Microgateway yapılandırma referansı başlıklı makaleyi inceleyin.

Varsayılan sistem yapılandırma dosyası

Edge Microgateway'i yüklediğinizde varsayılan bir sistem yapılandırma dosyası şuraya yerleştirilir:

[prefix]/lib/node_modules/edgemicro/config/default.yaml

Burada [prefix], npm ön ek dizinidir. Edge Microgateway'in yüklü olduğu yerler başlıklı makaleyi inceleyin.

Sistem yapılandırma dosyasını değiştirirseniz Edge Microgateway'i yeniden başlatmanız, yeniden yapılandırmanız ve yeniden başlatmanız gerekir:

  1. edgemicro init numaralı telefonu ara
  2. edgemicro configure [params] numaralı telefonu ara
  3. edgemicro start [params] numaralı telefonu ara

Yeni başlatılan Edge Microgateway örnekleri için varsayılan yapılandırma dosyası

edgemicro init komutunu çalıştırdığınızda sistem yapılandırma dosyası (yukarıda açıklanmıştır), default.yaml, şu dizine yerleştirilir: ~/.edgemicro

~/.edgemicro dizinindeki yapılandırma dosyasını değiştirirseniz Edge Microgateway'i yeniden yapılandırmanız ve yeniden başlatmanız gerekir:

  1. edgemicro stop
  2. edgemicro configure [params]
  3. edgemicro start [params]

Çalışan örnekler için dinamik yapılandırma dosyası

edgemicro configure [params] komutunu çalıştırdığınızda ~/.edgemicro içinde dinamik bir yapılandırma dosyası oluşturulur. Dosya, şu kalıba göre adlandırılır: [org]-[env]-config.yaml. Burada org ve env, Apigee Edge kuruluşunuzun ve ortamınızın adlarıdır. Bu dosyayı kullanarak yapılandırma değişiklikleri yapabilir ve ardından sıfır kesinti süresiyle yeniden yükleyebilirsiniz. Örneğin, bir eklenti ekleyip yapılandırırsanız aşağıda açıklandığı gibi, kesinti süresi olmadan yapılandırmayı yeniden yükleyebilirsiniz.

Edge Microgateway çalışıyorsa (sıfır kesinti süresi seçeneği):

  1. Edge Microgateway yapılandırmasını yeniden yükleyin:
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Burada:

    • org, Edge kuruluşunuzun adıdır (kuruluş yöneticisi olmanız gerekir).
    • env, kuruluşunuzdaki bir ortamdır (test veya prod gibi).
    • key, daha önce configure komutu tarafından döndürülen anahtardır.
    • secret, daha önce configure komutu tarafından döndürülen anahtardır.

    Örnek

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

Edge Microgateway durdurulursa:

  1. Edge Microgateway'i yeniden başlatın:
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    Burada:

    • org, Edge kuruluşunuzun adıdır (kuruluş yöneticisi olmanız gerekir).
    • env, kuruluşunuzdaki bir ortamdır (test veya prod gibi).
    • key, daha önce configure komutu tarafından döndürülen anahtardır.
    • secret, daha önce configure komutu tarafından döndürülen anahtardır.

    Örnek

    edgemicro start -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

Aşağıda bir yapılandırma dosyası örneği verilmiştir. Yapılandırma dosyası ayarları hakkında ayrıntılı bilgi için Edge Microgateway yapılandırma referansı başlıklı makaleyi inceleyin.

edge_config:
  bootstrap: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test
  jwt_public_key: 'https://docs-test.apigee.net/edgemicro-auth/publicKey'
  managementUri: 'https://api.enterprise.apigee.com'
  vaultName: microgateway
  authUri: 'https://%s-%s.apigee.net/edgemicro-auth'
  baseUri: >-
    https://edgemicroservices.apigee.net/edgemicro/%s/organization/%s/environment/%s
  bootstrapMessage: Please copy the following property to the edge micro agent config
  keySecretMessage: The following credentials are required to start edge micro
  products: 'https://docs-test.apigee.net/edgemicro-auth/products'
edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  config_change_poll_interval: 600
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
headers:
  x-forwarded-for: true
  x-forwarded-host: true
  x-request-id: true
  x-response-time: true
  via: true
oauth:
  allowNoAuthorization: false
  allowInvalidAuthorization: false
  verify_api_key_url: 'https://docs-test.apigee.net/edgemicro-auth/verifyApiKey'
analytics:
  uri: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/axpublisher/organization/docs/environment/test

Ortam değişkenlerini ayarlama

Edge kuruluşunuz ve ortamınız için değerler gerektiren komut satırı arayüzü komutları ile Edge Microgateway'i başlatmak için gereken anahtar ve gizli anahtar şu ortam değişkenlerinde depolanabilir:

  • EDGEMICRO_ORG
  • EDGEMICRO_ENV
  • EDGEMICRO_KEY
  • EDGEMICRO_SECRET

Bu değişkenleri ayarlamak isteğe bağlıdır. Bunları ayarlarsanız Edge Microgateway'i yapılandırmak ve başlatmak için komut satırı arayüzünü (CLI) kullanırken değerlerini belirtmeniz gerekmez.

Edge Microgateway sunucusunda SSL'yi yapılandırma

Microgateway sunucusunu SSL kullanacak şekilde yapılandırabilirsiniz. Örneğin, SSL yapılandırıldığında Edge Microgateway üzerinden "https" protokolüyle API'leri şu şekilde çağırabilirsiniz:

https://localhost:8000/myapi

Microgateway sunucusunda SSL'yi yapılandırmak için aşağıdaki adımları uygulayın:

  1. openssl yardımcı programını veya tercih ettiğiniz başka bir yöntemi kullanarak SSL sertifikası ve anahtarı oluşturun ya da alın.
  2. Edge Microgateway yapılandırma dosyasına edgemicro:ssl özelliğini ekleyin. Seçeneklerin tam listesi için aşağıdaki tabloya bakın. Edge Microgateway yapılandırmasını değiştirme hakkında ayrıntılı bilgi için Yapılandırma değişiklikleri yapma başlıklı makaleyi inceleyin. Örneğin:
     edgemicro:
         ssl:
             key: <absolute path to the SSL key file>
             cert: <absolute path to the SSL cert file>
             passphrase: admin123 #option added in v2.2.2
             rejectUnauthorized: true #option added in v2.2.2
  3. Edge Microgateway'i yeniden başlatın. Düzenlediğiniz yapılandırma dosyasına (varsayılan dosya veya çalışma zamanı yapılandırma dosyası) bağlı olarak Yapılandırma değişiklikleri yapma bölümünde açıklanan adımları uygulayın.

Aşağıda, yapılandırma dosyasının SSL yapılandırılmış edgemicro bölümüne bir örnek verilmiştir:

edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
  ssl:
    key: /MyHome/SSL/em-ssl-keys/server.key
    cert: /MyHome/SSL/em-ssl-keys/server.crt
    passphrase: admin123 #option added in v2.2.2
    rejectUnauthorized: true #option added in v2.2.2

Desteklenen tüm sunucu seçeneklerinin listesi aşağıda verilmiştir:

Seçenek Açıklama
key ca.key dosyasının yolu (PEM biçiminde).
cert ca.cert dosyasının yolu (PEM biçiminde).
pfx İstemcinin özel anahtarını, sertifikasını ve CA sertifikalarını PFX biçiminde içeren bir pfx dosyasının yolu.
passphrase Özel anahtar veya PFX için parola dizesi.
ca PEM biçiminde güvenilir sertifikaların listesini içeren dosyanın yolu.
ciphers Kullanılacak şifreleri açıklayan ve ":" ile ayrılmış bir dize.
rejectUnauthorized Doğru ise sunucu sertifikası, sağlanan CA'lar listesine göre doğrulanır. Doğrulama başarısız olursa bir hata döndürülür.
secureProtocol Kullanılacak SSL yöntemi. Örneğin, SSL'yi 3. sürüme zorlamak için SSLv3_method.
servername SNI (Sunucu Adı Göstergesi) TLS uzantısının sunucu adı.

İstemci SSL/TLS seçeneklerini kullanma

Edge Microgateway'i, hedef uç noktalara bağlanırken TLS veya SSL istemcisi olacak şekilde yapılandırabilirsiniz. Microgateway yapılandırma dosyasında, SSL/TLS seçeneklerini ayarlamak için targets öğesini kullanın.

Bu örnekte, tüm ana makinelere uygulanacak ayarlar verilmiştir:

targets:
   ssl:
     client:
       key: /Users/jdoe/nodecellar/twowayssl/ssl/client.key
       cert: /Users/jdoe/nodecellar/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

Bu örnekte, ayarlar yalnızca belirtilen ana makineye uygulanır:

targets:
   host: 'myserver.example.com'
   ssl:
     client:
       key: /Users/myname/twowayssl/ssl/client.key
       cert: /Users/myname/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

TLS için bir örnek:

targets:
   host: 'myserver.example.com'
   tls:
     client:
       pfx: /Users/myname/twowayssl/ssl/client.pfx
       passphrase: admin123
       rejectUnauthorized: true

Desteklenen tüm istemci seçeneklerinin listesi aşağıda verilmiştir:

Seçenek Açıklama
pfx İstemcinin özel anahtarını, sertifikasını ve CA sertifikalarını PFX biçiminde içeren bir pfx dosyasının yolu.
key ca.key dosyasının yolu (PEM biçiminde).
passphrase Özel anahtar veya PFX için parola dizesi.
cert ca.cert dosyasının yolu (PEM biçiminde).
ca PEM biçiminde güvenilir sertifikaların listesini içeren dosyanın yolu.
ciphers Kullanılacak şifreleri açıklayan ve ":" ile ayrılmış bir dize.
rejectUnauthorized Doğru ise sunucu sertifikası, sağlanan CA'lar listesine göre doğrulanır. Doğrulama başarısız olursa bir hata döndürülür.
secureProtocol Kullanılacak SSL yöntemi. Örneğin, SSL'yi 3. sürüme zorlamak için SSLv3_method.
servername SNI (Sunucu Adı Göstergesi) TLS uzantısının sunucu adı.

Özel bir kimlik doğrulama hizmeti kullanma

Edge Microgateway, OAuth2 kimlik doğrulaması için varsayılan olarak Apigee Edge'de dağıtılan bir proxy kullanır. Bu proxy, edgemicro configure komutunu ilk kez çalıştırdığınızda dağıtılır. Varsayılan olarak bu proxy'nin URL'si, Edge Microgateway yapılandırma dosyasında aşağıdaki gibi belirtilir:

authUri: https://myorg-myenv.apigee.net/edgemicro-auth

Kimlik doğrulama için kendi özel hizmetinizi kullanmak istiyorsanız yapılandırma dosyasındaki authUri değerini hizmetinizi işaret edecek şekilde değiştirin. Örneğin, kimlik doğrulamak için LDAP kullanan bir hizmetiniz olabilir.

Günlük dosyalarını yönetme

Edge Microgateway, her istek ve yanıtla ilgili bilgileri günlüğe kaydeder. Günlük dosyaları, hata ayıklama ve sorun giderme için yararlı bilgiler sağlar.

Günlük dosyalarının depolandığı yer

Günlük dosyaları varsayılan olarak /var/tmp dizininde depolanır.

Varsayılan günlük dosyası dizinini değiştirme

Günlük dosyalarının depolandığı dizin, Edge Microgateway yapılandırma dosyasında belirtilir. Yapılandırma değişiklikleri yapma hakkında ayrıntılı bilgi için Yapılandırma değişiklikleri yapma başlıklı makaleyi inceleyin.

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

Farklı bir günlük dosyası dizini belirtmek için dir değerini değiştirin.

Günlükleri konsola gönderme

Günlük bilgilerinin günlük dosyası yerine standart çıkışa gönderilmesi için günlük kaydını yapılandırabilirsiniz. to_console işaretini aşağıdaki gibi "true" olarak ayarlayın:

edgemicro:
  logging:
    to_console: true  

Bu ayar etkinleştirildiğinde günlükler standart çıkışa gönderilir. Şu anda günlükleri hem stdout'a hem de bir günlük dosyasına gönderemezsiniz.

Günlük kaydı düzeyini ayarlama

Şu günlük düzeylerini ayarlayabilirsiniz: info, warn ve error. Bilgi düzeyi önerilir. Tüm API isteklerini ve yanıtlarını günlüğe kaydeder ve varsayılan seçenektir.

Değişiklik günlüğü aralıklarını değiştirme

Bu aralıkları Edge Microgateway yapılandırma dosyasında yapılandırabilirsiniz. Yapılandırma değişiklikleri yapma hakkında ayrıntılı bilgi için Yapılandırma değişiklikleri yapma başlıklı makaleyi inceleyin.

Yapılandırılabilir özellikler şunlardır:

  • stats_log_interval: (varsayılan: 60) İstatistik kaydının API günlük dosyasına yazıldığı saniye cinsinden aralık.
  • rotate_interval: (varsayılan: 24) Günlük dosyalarının döndürüldüğü saat cinsinden aralık. Örneğin:
edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

Not: Arşivlenen günlük dosyaları sıkıştırılmaz. Aralık başladığında yeni bir zaman damgasıyla yeni bir günlük dosyası oluşturulur.

İyi günlük dosyası bakım uygulamaları

Günlük dosyası verileri zaman içinde biriktiğinden Apigee, aşağıdaki uygulamaları benimsemenizi önerir:

Günlük dosyası adlandırma kuralı

Her Edge Microgateway örneği üç tür günlük dosyası oluşturur:

  • api: Edge Microgateway üzerinden geçen tüm istekleri ve yanıtları günlüğe kaydeder. API sayaçları (istatistikler) ve hatalar da bu dosyaya kaydedilir.
  • err: stderr'e gönderilen her şeyi günlüğe kaydeder.
  • out: stdout'a gönderilen her şeyi günlüğe kaydeder.

Adlandırma kuralı şu şekildedir:

edgemicro-<Host Name>-<Instance ID>-<Log Type>.log

Örneğin:

edgemicro-mymachine-local-MTQzNTgNDMxODAyMQ-api.log
edgemicro-mymachine-local-MTQzNTg1NDMODAyMQ-err.log
edgemicro-mymachine-local-mtqzntgndmxodaymq-out.log

Günlük dosyası içerikleri hakkında

Eklenme tarihi: v2.3.3

Varsayılan olarak, günlük kaydı hizmeti indirilen proxy'lerin, ürünlerin ve JSON Web Jetonu'nun (JWT) JSON'sini atlar. Bu nesneleri günlük dosyalarına çıkarmak istiyorsanız Edge Microgateway'i başlattığınızda DEBUG=* değerini ayarlayın. Örneğin:

DEBUG=* edgemicro start -o docs -e test -k abc123 -s xyz456

"api" günlük dosyasının içeriği

"api" günlük dosyası, Edge Microgateway üzerinden istek ve yanıt akışı hakkında ayrıntılı bilgiler içerir. "api" günlük dosyaları şu şekilde adlandırılır:

edgemicro-mymachine-local-MTQzNjIxOTk0NzY0Nw-api.log

Edge Microgateway'e yapılan her istek için "api" günlük dosyasında dört etkinlik yakalanır:

  • Müşteriden gelen istek
  • Hedefe giden istek yapıldı
  • Hedefin yanıtı
  • İstemciye giden yanıt

Bu ayrı girişlerin her biri, günlük dosyalarının daha kompakt hale getirilmesine yardımcı olmak için kısa bir gösterimle temsil edilir. Aşağıda, dört etkinliğin her birini temsil eden dört örnek giriş verilmiştir. Günlük dosyasında aşağıdaki gibi görünürler (satır numaraları yalnızca belgede referans amaçlıdır, günlük dosyasında görünmez).

(1) 1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
(2) 1436403888665 info treq m=GET, u=/, h=127.0.0.18080, i=0
(3) 1436403888672 info tres s=200, d=7, i=0
(4) 1436403888676 info res s=200, d=11, i=0

Bunları tek tek inceleyelim:

1. Müşteriden gelen istek örneği:

1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
  • 1436403888651: Unix tarih damgası
  • info: Bağlama bağlıdır. Günlük düzeyine bağlı olarak bilgi, uyarı veya hata olabilir. İstatistik kaydı için stats, uyarılar için warn veya hatalar için error olabilir.
  • req: Etkinliği tanımlar. Bu durumda, istemciden isteyin.
  • m: İstekte kullanılan HTTP fiili.
  • u: URL'nin temel yoldan sonraki kısmı.
  • h: Edge Microgateway'in dinlediği ana makine ve bağlantı noktası numarası.
  • r: İstemci isteğinin geldiği uzak ana makine ve bağlantı noktası.
  • i: İstek kimliği. Dört etkinlik girişinin tümü bu kimliği paylaşır. Her isteğe benzersiz bir istek kimliği atanır. Günlük kayıtlarını istek kimliğine göre ilişkilendirmek, hedefin gecikme süresi hakkında değerli bilgiler sağlayabilir.
  • d: İsteğin Edge Microgateway tarafından alınmasından bu yana geçen süre (milisaniye cinsinden). Yukarıdaki örnekte, hedefin 0 numaralı istek için yanıtı 7 milisaniye sonra alındı (3. satır) ve yanıt, istemciye 4 milisaniye daha sonra gönderildi (4. satır). Diğer bir deyişle, toplam istek gecikmesi 11 milisaniyedir. Bunun 7 milisaniyesi hedef, 4 milisaniyesi ise Edge Microgateway tarafından harcanmıştır.

2. Hedefe gönderilen giden istek örneği:

1436403888665 info treq m=GET, u=/, h=127.0.0.1:8080, i=0
  • 1436403888651: Unix tarih damgası
  • info: Bağlama bağlıdır. Günlük düzeyine bağlı olarak bilgi, uyarı veya hata olabilir. İstatistik kaydı için stats, uyarılar için warn veya hatalar için error olabilir.
  • treq: Etkinliği tanımlar. Bu durumda hedef istek.
  • m: Hedef istekte kullanılan HTTP fiili.
  • u: URL'nin temel yoldan sonraki kısmı.
  • h: Arka uç hedefinin ana makine ve bağlantı noktası numarası.
  • i: Günlük girişinin kimliği. Dört etkinlik girişinin tümü bu kimliği paylaşır.

3. Hedef tarafından gönderilen yanıt örneği

1436403888672 info tres s=200, d=7, i=0

1436403888651: Unix tarih damgası

  • info: Bağlama bağlıdır. Günlük düzeyine bağlı olarak bilgi, uyarı veya hata olabilir. İstatistik kaydı için stats, uyarılar için warn veya hatalar için error olabilir.
  • tres: Etkinliği tanımlar. Bu durumda hedef yanıt.
  • s: HTTP yanıt durumu.
  • d: Milisaniye cinsinden süre. Hedefin API çağrısı için harcadığı süre.
  • i: Günlük girişinin kimliği. Dört etkinlik girişinin tümü bu kimliği paylaşır.

4. İstemciye gönderilen yanıt örneği

1436403888676 info res s=200, d=11, i=0

1436403888651: Unix tarih damgası

  • info: Bağlama bağlıdır. Günlük düzeyine bağlı olarak bilgi, uyarı veya hata olabilir. İstatistik kaydı için stats, uyarılar için warn veya hatalar için error olabilir.
  • res: Etkinliği tanımlar. Bu durumda istemciye yanıt verilir.
  • s: HTTP yanıt durumu.
  • d: Milisaniye cinsinden süre. Bu, hedef API'nin harcadığı süre ve Edge Microgateway'in harcadığı süre dahil olmak üzere API çağrısının harcadığı toplam süredir.
  • i: Günlük girişinin kimliği. Dört etkinlik girişinin tümü bu kimliği paylaşır.

Günlük dosyası programı

Günlük dosyaları, rotate_interval yapılandırma özelliği tarafından belirtilen aralıkta döndürülür. Rotasyon aralığı sona erene kadar aynı günlük dosyasına girişler eklenmeye devam eder. Ancak Edge Microgateway her yeniden başlatıldığında yeni bir UID alır ve bu UID ile yeni bir günlük dosyası grubu oluşturur. Günlük dosyası bakımıyla ilgili iyi uygulamalar başlıklı makaleyi de inceleyin.

Edge Microgateway yapılandırma referansı

Yapılandırma dosyasının konumu

Bu bölümde açıklanan yapılandırma özellikleri, Edge Microgateway yapılandırma dosyasında bulunur. Yapılandırma değişiklikleri yapma hakkında ayrıntılı bilgi için Yapılandırma değişiklikleri yapma başlıklı makaleyi inceleyin.

edge_config özellikleri

Bu ayarlar, Edge Microgateway örneği ile Apigee Edge arasındaki etkileşimi yapılandırmak için kullanılır.

  • bootstrap: (varsayılan: yok) Apigee Edge'de çalışan Edge Microgateway'e özel bir hizmeti işaret eden URL. Edge Microgateway, Apigee Edge ile iletişim kurmak için bu hizmeti kullanır. Bu URL, ortak/özel anahtar çiftini oluşturma komutunu çalıştırdığınızda döndürülür: edgemicro genkeys. Ayrıntılar için Edge Microgateway'i kurma ve yapılandırma başlıklı makaleyi inceleyin.
  • jwt_public_key: (varsayılan: yok) Apigee Edge'de dağıtılan Edge Microgateway proxy'sine işaret eden bir URL. Bu proxy, istemcilere imzalı erişim jetonları vermek için kimlik doğrulama uç noktası olarak kullanılır. Bu URL, proxy'yi dağıtma komutunu (edgemicro configure) çalıştırdığınızda döndürülür. Ayrıntılar için Edge Microgateway'i kurma ve yapılandırma başlıklı makaleyi inceleyin.

edgemicro özellikleri

Bu ayarlar, Edge Microgateway işlemini yapılandırır.

  • port: (varsayılan: 8000) Edge Microgateway işleminin dinlediği bağlantı noktası numarası.
  • max_connections: (varsayılan: -1) Edge Microgateway'in alabileceği maksimum eşzamanlı gelen bağlantı sayısını belirtir. Bu sayı aşılırsa aşağıdaki durum döndürülür:

    res.statusCode = 429; // Too many requests
  • max_connections_hard: (varsayılan: -1) Edge Microgateway'in bağlantıyı kapatmadan önce alabileceği maksimum eşzamanlı istek sayısı. Bu ayar, hizmet reddi saldırılarını engellemek için tasarlanmıştır. Genellikle max_connections değerinden daha büyük bir sayıya ayarlayın.
  • günlüğe kaydetme:
    • level: (varsayılan: error)
      • info: Bir Edge Microgateway örneğinden geçen tüm istekleri ve yanıtları günlüğe kaydeder.
      • warn: Yalnızca uyarı mesajlarını günlüğe kaydeder.
      • error: Yalnızca hata mesajlarını günlüğe kaydeder.
    • dir: (varsayılan: /var/tmp) Günlük dosyalarının depolandığı dizin.
    • stats_log_interval: (varsayılan: 60) İstatistik kaydının API günlük dosyasına yazıldığı saniye cinsinden aralık.
    • rotate_interval: (varsayılan: 24) Günlük dosyalarının döndürüldüğü saat cinsinden aralık.
  • Eklentiler: Eklentiler, Edge Microgateway'e işlevsellik ekler. Eklenti geliştirme hakkında ayrıntılı bilgi için Özel eklentiler geliştirme başlıklı makaleyi inceleyin.
  • dir: ./gateway dizininden ./plugins dizinine giden göreli yol veya mutlak yol.
  • sequence: Edge Microgateway örneğinize eklenecek eklenti modüllerinin listesi. Modüller burada belirtilen sırayla yürütülür.
  • debug: Edge Microgateway işlemine uzaktan hata ayıklama ekler.
    • port: Dinlenecek bağlantı noktası numarası. Örneğin, IDE hata ayıklayıcınızı bu bağlantı noktasını dinleyecek şekilde ayarlayın.
    • args: Hata ayıklama işleminin bağımsız değişkenleri. Örneğin: args --nolazy
  • config_change_poll_interval: (varsayılan: 600 saniye) Edge Microgateway, düzenli olarak yeni bir yapılandırma yükler ve herhangi bir değişiklik olursa yeniden yükleme işlemi gerçekleştirir. Sorgulama, Edge'de yapılan değişiklikleri (ürünlerde, mikro ağ geçidi kullanan proxy'lerde vb. yapılan değişiklikler) ve yerel yapılandırma dosyasında yapılan değişiklikleri alır.
  • disable_config_poll_interval: (varsayılan: false) Otomatik değişiklik yoklamasını devre dışı bırakmak için true olarak ayarlayın.

headers özellikleri

Bu ayarlar, belirli HTTP üstbilgilerinin nasıl ele alınacağını yapılandırır.

  • x-forwarded-for: (varsayılan: true) x-forwarded-for başlıklarının hedefe iletilmesini önlemek için false olarak ayarlayın.
  • x-forwarded-host: (varsayılan: true) x-forwarded-host başlıklarının hedefe iletilmesini önlemek için false olarak ayarlayın.
  • x-request-id: (varsayılan: true) x-request-id başlıklarının hedefe iletilmesini önlemek için false olarak ayarlayın.
  • x-response-time: (varsayılan: true) x-response-time üstbilgilerinin hedefe iletilmesini önlemek için false olarak ayarlayın.
  • via: (varsayılan: true) Via üstbilgilerinin hedefe iletilmesini önlemek için false olarak ayarlayın.

oauth özellikleri

Bu ayarlar, istemci kimlik doğrulamasının Edge Microgateway tarafından nasıl zorunlu kılındığını yapılandırır.

  • allowNoAuthorization: (varsayılan: false) True değerine ayarlanırsa API çağrılarının, herhangi bir yetkilendirme başlığı olmadan Edge Microgateway'den geçmesine izin verilir. Authorization başlığının zorunlu olması için bu değeri false (varsayılan) olarak ayarlayın.
  • allowInvalidAuthorization: (varsayılan: false) True değerine ayarlanırsa Yetkilendirme başlığında iletilen jeton geçersiz veya süresi dolmuş olsa bile API çağrılarının geçmesine izin verilir. Geçerli jetonlar gerektirmek için bu değeri false (yanlış) olarak ayarlayın (varsayılan).
  • authorization-header: (varsayılan: Authorization: Bearer) Erişim jetonunu Edge Microgateway'e göndermek için kullanılan üstbilgi. Hedefin, Authorization üstbilgisini başka bir amaçla kullanması gereken durumlarda varsayılan değeri değiştirmek isteyebilirsiniz.
  • api-key-header: (varsayılan: x-api-key) Edge Microgateway'e API anahtarı iletmek için kullanılan başlığın veya sorgu parametresinin adı. API anahtarı kullanma başlıklı makaleyi de inceleyebilirsiniz.
  • keepAuthHeader: (varsayılan: false) True olarak ayarlanırsa istekte gönderilen Authorization başlığı hedefe iletilir (korunur).

Eklentiye özel özellikler

Her bir eklentinin yapılandırılabilir özellikleri hakkında ayrıntılı bilgi için Eklentileri kullanma başlıklı makaleyi inceleyin.

Filtreleme proxy'leri

Bir Edge Microgateway örneğinin hangi mikro ağ geçidi uyumlu proxy'leri işleyeceğini filtreleyebilirsiniz. Edge Microgateway başlatıldığında, ilişkili olduğu kuruluştaki tüm mikro ağ geçidi uyumlu proxy'leri indirir. Mikro ağ geçidinin işleyeceği proxy'leri sınırlamak için aşağıdaki yapılandırmayı kullanın. Örneğin, bu yapılandırma, mikro ağ geçidinin işleyeceği proxy'leri üç ile sınırlar: edgemicro_proxy-1, edgemicro_proxy-2 ve edgemicro_proxy-3:

proxies:
  - edgemicro_proxy-1
  - edgemicro_proxy-2
  - edgemicro_proxy-3

Analiz verilerini maskeleme

Aşağıdaki yapılandırma, istek yolu bilgilerinin Edge analizlerinde gösterilmesini engeller. İstek URI'sini ve/veya istek yolunu maskelemek için mikro ağ geçidi yapılandırmasına aşağıdakileri ekleyin. URI'nin, isteğin ana makine adı ve yol bölümlerinden oluştuğunu unutmayın.

analytics:
  mask_request_uri: 'string_to_mask'
  mask_request_path: 'string_to_mask'

Hata ayıklama ve sorun giderme

Hata ayıklayıcıya bağlanma

Edge Microgateway'i node-inspector gibi bir hata ayıklayıcıyla çalıştırabilirsiniz. Bu, özel eklentilerle ilgili sorunları giderme ve hata ayıklama için kullanışlıdır.

  1. Edge Microgateway'i hata ayıklama modunda yeniden başlatın. Bunu yapmak için başlatma komutunun başına DEBUG=* ekleyin. Örneğin:

    DEBUG=* edgemicro start -o myorg -e test -k db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s 6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed
  2. Hata ayıklayıcınızı başlatın ve hata ayıklama işlemi için bağlantı noktası numarasını dinleyecek şekilde ayarlayın.
  3. Artık Edge Microgateway kodunda adım adım ilerleyebilir, kesme noktaları ayarlayabilir, ifadeleri izleyebilir ve daha fazlasını yapabilirsiniz.

Hata ayıklama moduyla ilgili standart Node.js işaretlerini belirtebilirsiniz. Örneğin, --nolazy, zaman uyumsuz kodda hata ayıklamaya yardımcı olur.

Günlük dosyaları kontrol ediliyor

Sorun yaşıyorsanız yürütme ayrıntıları ve hata bilgileri için günlük dosyalarını inceleyin. Ayrıntılı bilgi için Günlük dosyalarını yönetme başlıklı makaleyi inceleyin.

API anahtarı güvenliğini kullanma

API anahtarları, Edge Microgateway'e istek gönderen istemcilerin kimliğini doğrulamak için basit bir mekanizma sağlar. Edge Microgateway kimlik doğrulama proxy'sini içeren bir Apigee Edge ürününden tüketici anahtarı (istemci kimliği olarak da bilinir) değerini kopyalayarak API anahtarı alabilirsiniz.

Anahtarların önbelleğe alınması

API anahtarları, önbelleğe alınan hamiline ait jetonlarla değiştirilir. Edge Microgateway'e gelen isteklerde Cache-Control: no-cache başlığını ayarlayarak önbelleğe almayı devre dışı bırakabilirsiniz.

Apigee Edge Private Cloud 15.07 sürümünü kullanıyorsanız gerekli geçici çözüm

Edge Private Cloud 15.07'de API anahtarı güvenliğini kullanmak için burada açıklanan geçici çözümü uygulamanız gerekir. Geçici çözüm için edgemicro-auth proxy'sindeki bir Node.js dosyasında bir satırı değiştirmeniz ve Edge Microgateway'i yeniden başlatmanız gerekir.

Geçici çözümü Edge kullanıcı arayüzünde uygulama

Bu prosedür, işlemi tamamladığınızda edgemicro start komutunu yeniden çalıştırmanızı gerektirir.

  1. Edge kullanıcı arayüzünde, edgemicro-auth proxy'sini proxy düzenleyicide açın.
  2. Develop (Geliştirme) sekmesini seçin.
  3. Navigator'da, Scripts bölümünde verify-api-key.js adlı JavaScript dosyasını açın.
  4. 109. satıra gidin:

    api_product_list: apigeeToken.app && apigeeToken.app.apiproducts ? apigeeToken.app.apiproducts : []
  5. "api_product_list:" ifadesinden sonraki kısmı, kullanmak istediğiniz API anahtarlarıyla ilişkili ürün adlarının "sabit kodlu" bir dizisiyle değiştirin. Örneğin, "Ürün-1" ve "Ürün-2" içeren bir geliştirici uygulamasından anahtar kullanmak istiyorsanız satırı şu şekilde kodlarsınız:

    api_product_list: ["Product-1", "Product-2"]
  6. Kaydet'i tıklayın.
  7. edgemicro start komutunu yürütün.

Yerel Edge Microgateway kod tabanında uygulama

Bu prosedürde, edgemicro configure komutunu ve ardından edgemicro start komutunu yeniden çalıştırmanız gerekir.

  1. <microgateway-root-dir>/edge/auth/api/controllers/verify-api-key.js dosyasını açın. Burada <microgateway-root-dir>, npm install komutunu çalıştırdığınızda Edge Microgateway'in yüklendiği dizindir.
  2. 109. satıra gidin:

    api_product_list: apigeeToken.app && apigeeToken.app.apiproducts ? apigeeToken.app.apiproducts : []
  3. "api_product_list:" ifadesinden sonraki kısmı, kullanmak istediğiniz API anahtarlarıyla ilişkili ürün adlarının "sabit kodlu" bir dizisiyle değiştirin. Örneğin, "Ürün-1" ve "Ürün-2" içeren bir geliştirici uygulamasından anahtar kullanmak istiyorsanız satırı şu şekilde kodlarsınız:

    api_product_list: ["Product-1", "Product-2"]
  4. Dosyayı kaydedin.
  5. edgemicro configure komutunu yürütün. (Edge Private Cloud kullanıyorsanız edgemicro private configure.) Bu komut, edgemicro-auth proxy'sini yeniden dağıtır.
  6. edgemicro start komutunu yürütün.

OAuth2 jeton güvenliğini kullanma

Proxy istekleriyle OAuth jetonu kullanma hakkında ayrıntılı bilgi için Secure Edge Microgateway başlıklı makaleyi inceleyin.

API anahtarı kullanma

Proxy istekleriyle API anahtarlarını kullanma hakkında ayrıntılı bilgi için Secure Edge Microgateway başlıklı makaleyi inceleyin.

API anahtarı adını yapılandırma

Varsayılan olarak, API anahtarı üstbilgisi veya sorgu parametresi için x-api-key adı kullanılır. Yapılandırma değişiklikleri yapma bölümünde açıklandığı gibi, yapılandırma dosyasında bu varsayılan değeri değiştirebilirsiniz. Örneğin, adı apiKey olarak değiştirmek için:

oauth:
 allowNoAuthorization: false
 allowInvalidAuthorization: false
 api-key-header: apiKey