Süre sonu uyarılarını ayarlama

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

Bir ortamdaki TLS sertifikasının süresi dolmak üzereyken bildirim göstermek için bir TLS süre sonu uyarısı kullanın.

TLS sertifikaları hakkında

TLS (Taşıma Katmanı Güvenliği), bir web sunucusu ile tarayıcı veya uygulama gibi bir web istemcisi arasında şifrelenmiş bağlantı oluşturmaya yönelik standart güvenlik teknolojisidir. Şifrelenmiş bağlantılar, sunucu ile istemci arasında geçen tüm verilerin gizli kalmasını sağlar.

TLS sertifikası, TLS işlemindeki bir varlığı tanımlayan dijital bir dosyadır. Edge, aşağıdakiler için TLS'yi yapılandırmak üzere bir TLS sertifikası kullanır:

TLS sertifikasında geçerlilik bitiş tarihi vardır. Bir TLS sertifikasının süresi dolarsa siz sertifikayı güncelleyene kadar TLS bağlantısı başarısız olur. Bu, sertifika güncellenene kadar API'nize yapılan tüm isteklerin başarısız olacağı anlamına gelir.

Süre sonu uyarıları hakkında

Bir sertifikanın süresinin dolmasını ve API'nize yapılan isteklerin başarısız olmasını beklemek yerine, bir ortamdaki herhangi bir TLS sertifikasının süresi dolmak üzereyken bir bildirim almak için süre sonu uyarısı kullanın. Uyarı tetiklendikten sonra, müşterilerinizin hizmette herhangi bir kesinti yaşamaması için sertifikayı güncelleyebilirsiniz.

Uyarıyı yapılandırırken tek bir sertifika değil, belirli bir ortam belirtin. Dağıtılan herhangi bir sertifika, belirtilen zaman aralığında sona erecek şekilde planlandığında uyarı tetiklenir.

Geçerlilik süresi uyarısının aşağıdaki şekilde olmasını sağlayabilirsiniz:

  • Sertifikaların süresinin dolmasına 1 gün kala
  • Sertifikaların süresinin dolmasına 14 gün kala
  • Sertifikaların süresinin dolmasına 30 gün kala
Uyarılar hakkında daha fazla bilgi için Uyarıları ve bildirimleri ayarlama başlıklı makaleyi inceleyin.

Geçerlilik sonu uyarıları ve bildirimleri ekleyin

Geçerlilik sonu uyarıları ve bildirimleri eklemek için:
  1. Edge kullanıcı arayüzünde Analiz > Uyarı Kuralları'nı tıklayın.
  2. +Uyarı'yı tıklayın.
  3. Uyarıyla ilgili aşağıdaki genel bilgileri girin:
    Alan Açıklama
    Uyarı Adı Uyarının adı. Tetikleyiciyi açıklayan ve sizin için anlamlı olacak bir ad kullanın. Ad 128 karakterden uzun olamaz.
    Açıklama Uyarının açıklaması.
    Uyarı Türü TLS Geçerlilik Süresi'ni seçin. Daha fazla bilgi için Uyarı türleri hakkında bölümünü inceleyin.
    Ortam Açılır listeden ortamı seçin.
    Durum Uyarıyı etkinleştirmek veya devre dışı bırakmak için açma/kapatma düğmesini kullanın.
  4. Uyarıyı tetikleyecek koşul için eşiği ve boyutu tanımlayın.
    Koşul Alanı Açıklama
    Eşik

    Süresi dolmak üzere olan sertifikalar için zaman aralığını yapılandırın. Bir sertifikanın süresi dolmak üzere olduğunda uyarı almak için aşağıdaki yöntemlerden yararlanabilirsiniz:

    • 1 gün
    • 14 gün
    • 30 gün
    Boyut Boyutlar, ortamdaki herhangi bir TLS sertifikasına karşılık gelen Tüm TLS Sertifikaları değerine sabitlenir.
  5. Uyarı bildirimi eklemek için + Bildirim'i tıklayın.
    Bildirim Ayrıntıları Açıklama
    Kanal Kullanmak istediğiniz bildirim kanalını seçin ve hedefi belirtin: Email, Slack, PagerDuty veya Webhook.
    Hedef Seçilen kanal türüne göre hedefi belirtin:
    • E-posta - E-posta adresi (ör. joe@company.com)
    • Slack - https://hooks.slack.com/services/T00000000/B00000000/XXXXX gibi Slack kanalı URL'si
    • PagerDuty - PagerDuty kodu (ör. abcd1234efgh56789)
    • Webhook - Webhook URL'si (ör. https://apigee.com/test-webhook)

      Not: Bildirim başına yalnızca bir hedef belirtebilirsiniz. Aynı kanal türü için birden fazla hedef belirlemek üzere ek bildirimler ekleyin.
  6. Başka bildirimler eklemek için önceki adımı tekrarlayın.
  7. Bildirim eklediyseniz aşağıdaki alanları ayarlayın:
    Alan Açıklama
    Başucu Kitabı (İsteğe bağlı) Tetiklenen uyarıları çözmek üzere önerilen işlemlerin kısa bir açıklamasını sağlayan serbest biçimli metin alanı. En iyi uygulamalara başvurduğunuz dahili wiki veya topluluk sayfanızın bağlantısını da belirtebilirsiniz. Bu alandaki bilgiler bildirime dahil edilir. Bu alandaki içerik 1.500 karakteri aşamaz.
    Klape Bildirim gönderme sıklığı. Açılır listeden bir değer seçin.
  8. Kaydet'i tıklayın.

Uyarıları Etkinlikler kontrol panelinde görüntüleme

Edge bir uyarı koşulu algıladığında bu koşulu otomatik olarak Edge kullanıcı arayüzündeki Etkinlikler kontrol paneline kaydeder. Etkinlikler kontrol panelinde görüntülenen etkinliklerin listesi hem sabit hem de sertifikalı tüm uyarıları içerir.

Bir uyarıyı görüntülemek için:

  1. Edge kullanıcı arayüzünde Analiz > Etkinlikler'i tıklayın. Yeni Etkinlikler kontrol paneli görünür:

  2. Etkinlikler kontrol panelini şu ölçütlere göre filtreleyin:

    • Ortam
    • Bölge
    • Dönem
  3. Uyarıyı daha ayrıntılı bir şekilde incelemek için Etkinlik kontrol panelinde, süresi dolan sertifikayı içeren Anahtar Deposu'nu gösteren bir satır seçin. Anahtar Deposu sayfasından yeni bir sertifika yükleyebilir ve süresi dolmak üzere olan sertifikayı silebilirsiniz.

Uyarı API'lerini süre sonu uyarılarıyla kullan

Geçerlilik sonu uyarılarını oluşturmak ve yönetmek için kullandığınız API'lerin çoğu, sabit uyarılarla kullandığınız API'lerle aynıdır. Aşağıdaki uyarı API'leri, hem sabit hem de sona erme tarihi uyarıları için aynı şekilde çalışır:

Ancak bazı API'lerin, anormallik uyarılarını desteklemek için kullanılan ek özellikleri vardır. Örneğin:

  • Uyarı al: Sabit ve anormallik uyarıları dahil olmak üzere tüm uyarıları listeler.
  • Uyarı oluştur: Düzeltildi veya anormallik uyarısı oluşturun.
  • Bir uyarıyı güncelleme - Düzeltilmiş veya anormal bir uyarı tanımını güncelleyin.

Süre sonu uyarısı oluşturma veya güncelleme

Süre sonu uyarısı oluşturmak veya güncellemek için şu anda sabit bir uyarıda yaptığınız gibi API'leri kullanın. Bir süre sonu uyarısı oluşturmak veya güncellemek için kullanılan API çağrısının gövdesi, sabit bir uyarı için kullanılanla aynıdır ancak aşağıdaki değişiklikler söz konusudur:

  • Uyarının süre sonu uyarısı olduğunu belirtmek için aşağıdaki yeni özellikleri eklemeniz gerekir:

    "alertType": "cert"
"alertSubType": "certfixed"

    Bu özelliklerin varsayılan değerleri şunlardır:

    "alertType": "runtime"
"alertSubType": "fixed"

  • conditions dizisinde:

    • metrics özelliği yalnızca expiration değerlerini alır.
    • Sertifika geçerlilik süresinin saniye cinsinden zaman aralığını maksimum 30 gün olacak şekilde belirtmek için gracePeriodSeconds özelliğini kullanın.
    • threshold, durationSeconds ve comparator özellikleri desteklenmez.
  • conditions dizisinin dimensions öğesinde:
    • certificate özelliğinin değerini ANY olarak ayarlamanız gerekir.
    • proxy özelliğinin değerini ALL olarak ayarlamanız gerekir.
    • statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName özellikleri desteklenmiyor.
  • reportEnabled özelliği, süre sonu uyarıları için desteklenmez.

Aşağıdaki örnek API çağrısı, üretim ortamındaki herhangi bir cery'nin süresi sonraki 30 gün içinde sona erdiğinde tetiklenen bir süre sonu uyarısı oluşturur. Uyarı tetiklendiğinde, belirtilen e-posta adresine bir bildirim gönderilir:

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
  "organization":"myorg",
  "name":"My Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

$ACCESS_TOKEN öğesini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi için cURL kullanma konusuna bakın.

Süre sonu uyarıları al

Varsayılan olarak Get Alerts API'si, hem sabit hem de süresi dolan tüm tanımlı uyarılar hakkında bilgi döndürür. Bu API, sonuçları filtrelemenizi sağlamak için artık sorgu parametrelerini alıyor:

  • enabled - true yalnızca etkinleştirilen uyarıların döndürüleceğini belirtiyorsa. Varsayılan değer: false.
  • alertType - Döndürülecek uyarının türünü belirtir. runtime, varsayılan ve cert değerlerine izin verilir.
  • alertSubType - Döndürülecek uyarı alt türünü belirtir. Varsayılan değer ayarlanmaz. Yani tüm uyarı alt türlerini döndürür. Süre sonu uyarılarını döndürmek için certfixed değerini belirtin.

Örneğin, yalnızca myorg adlı kuruluş için etkinleştirme uyarılarını döndürmek amacıyla aşağıdaki API çağrısını kullanın:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

Aşağıdaki çağrı, hem etkin hem de devre dışı olan yalnızca süre sonu uyarılarını döndürüyor:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'

$ACCESS_TOKEN öğesini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi için cURL kullanma konusuna bakın.