Google Cloud Apigee destek kayıtları için en iyi uygulamalar

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

Apigee X belgelerini görüntülüyorsunuz.
Apigee Edge belgelerini inceleyin.

Destek kaydında ayrıntılı ve gerekli bilgileri sağlamak, Google Cloud Apigee Destek Ekibi'nin size hızlı ve etkili bir şekilde yanıt vermesini kolaylaştırır. Destek kaydınızda önemli ayrıntılar eksikse daha fazla bilgi istememiz gerekir. Bu da birden fazla kez iletişime geçmemizi gerektirebilir. Bu işlem daha uzun sürer ve sorunların çözümünde gecikmelere neden olabilir. Bu En İyi Uygulamalar Kılavuzu, teknik destek kaydınızı daha hızlı çözebilmemiz için ihtiyaç duyduğumuz bilgileri size bildirir.

Sorunu açıklama

Sorun, ne olduğu ve ne olmasının beklendiğiyle ilgili ayrıntıların yanı sıra ne zaman ve nasıl gerçekleştiğiyle ilgili bilgileri içermelidir. İyi bir Apigee destek kaydı, Apigee ürünlerinin her biri için aşağıdaki temel bilgileri içermelidir:

Temel bilgiler Açıklama Public Cloud için Apigee Edge Private Cloud için Apigee Edge
Ürün Varsa sürüm bilgileri de dahil olmak üzere sorunun gözlemlendiği belirli Apigee ürünü.
  • Sürüm
Sorun Ayrıntıları Varsa hata mesajının tamamı da dahil olmak üzere sorunun ana hatlarıyla belirtildiği net ve ayrıntılı sorun açıklaması.
  • Hata mesajı
  • İzleme aracı çıkışı
  • Sorunu yeniden oluşturma adımları
  • API isteğini/komutunu tamamlama
  • Hata mesajı
  • İzleme aracı çıkışı
  • Sorunu yeniden oluşturma adımları
  • API isteğini/komutunu tamamlama
  • Bileşen teşhis günlükleri
Zaman Sorunun başladığı ve ne kadar sürdüğü zaman damgası.
  • Sorunun meydana geldiği tarih, saat ve saat dilimi
  • Sorunun süresi
  • Sorunun meydana geldiği tarih, saat ve saat dilimi
  • Sorunun süresi
Kurulum Sorunun gözlemlendiği ayrıntılı bilgiler.
  • Kuruluş adı
  • Ortam adı
  • API proxy adı
  • Düzeltme
  • Ağ topolojisi
  • Edge bileşeni başarısız

Aşağıdaki bölümlerde bu kavramlar daha ayrıntılı olarak açıklanmaktadır.

Ürün

Public Cloud'da Apigee Edge ve Private Cloud'da Apigee Edge gibi farklı Apigee ürünleri olduğundan sorun yaşadığınız ürünle ilgili spesifik bilgilere ihtiyacımız var.

Aşağıdaki tabloda, NE YAPMALISINIZ? sütununda eksiksiz bilgi, NE YAPMAMALISINIZ? sütununda ise eksik bilgi gösterilen bazı örnekler verilmiştir:

Yapılması Gerekenler YAPMAYIN
OAuth2 API proxy'sinin dağıtımı Herkese Açık Cloud kuruluşumuzda başarısız oldu ...

API proxy'sinin dağıtımı başarısız oldu

(Sorunu gördüğünüz Apigee ürününü öğrenmemiz gerekir.)

Yükleme, Edge Private Cloud 4.50.00 sürümünde aşağıdaki hatayla başarısız oldu:

Private Cloud kurulumumuzda yükleme başarısız oldu.

(Sürüm bilgileri eksik)

Sorun Ayrıntıları

Hata mesajı (varsa) ve beklenen ve gözlemlenen gerçek davranış dahil olmak üzere gözlemlenen sorun hakkında kesin bilgi verin.

Aşağıdaki tabloda, NE YAPMALISINIZ? sütununda eksiksiz bilgi ve NE YAPMAMALISINIZ? sütununda eksik bilgi gösteren bazı örnekler verilmiştir:

Yapılması Gerekenler YAPMAYIN

Yeni edgemicro proxy'si edgemicro_auth şu hatayla başarısız oluyor:

{"error":"missing_authorization","error_description":"Missing Authorization header"}

Bugün oluşturulan yeni edgemicro proxy çalışmıyor

(Proxy adı bilinmiyor. Proxy'nin hata mı yoksa beklenmedik bir yanıt mı döndürdüğü net değil.)

Müşterilerimiz, API proxy'sine istek gönderirken aşağıdaki hata mesajıyla birlikte 500 hataları alıyor:

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

Müşterilerimiz, API proxy'sine istek gönderirken 500 hataları alıyor.

(500 hatası olduğunu bildirmek, sorunu araştırmamız için yeterli bilgi sağlamaz. Gerçek hata mesajını ve gözlemlenen hata kodunu bilmemiz gerekiyor.)

Saat

Zaman çok önemli bir bilgidir. Destek mühendisinin bu sorunu ilk ne zaman fark ettiğinizi, ne kadar sürdüğünü ve sorunun devam edip etmediğini bilmesi önemlidir.

Sorunu çözen destek mühendisi saat diliminizde olmayabilir. Bu nedenle, zamanla ilgili göreceli ifadeler sorunun teşhis edilmesini zorlaştırır. Bu nedenle, sorunun gözlemlendiği zamanla ilgili tam bilgi sağlamak için tarih ve saat damgası için ISO 8601 biçiminin kullanılması önerilir.

Aşağıdaki tabloda, DOs sütununda sorunun oluştuğu doğru saat ve süreyi, DON'Ts sütununda ise sorunun ne zaman oluştuğuyla ilgili belirsiz veya net olmayan bilgileri gösteren bazı örnekler verilmiştir:

Yapılması Gerekenler YAPMAYIN
Dün 2020-11-06 17:30 PDT ile 2020-11-06 17:35 PDT arasında çok sayıda 503s gözlemlendi...

Dün saat 17:30'da 5 dakika boyunca çok sayıda 503s tespit edildi.

(Zımni tarihi kullanmak zorundayız ve bu sorunun hangi saat diliminde gözlemlendiği de net değil.)

2020-11-09 15:30 IST ile 2020-11-09 18:10 IST arasında aşağıdaki API proxy'lerinde yüksek gecikmeler gözlemlendi ...

Geçen hafta bazı API proxy'lerinde yüksek gecikmeler gözlemlendi.

(Bu sorunun son hafta hangi gün ve ne kadar süreyle gözlemlendiği net değil.)

Kurulum

Sorunu tam olarak nerede gördüğünüzle ilgili ayrıntıları öğrenmemiz gerekiyor. Kullandığınız ürüne bağlı olarak aşağıdaki bilgilere ihtiyacımız var:

  • Apigee Cloud kullanıyorsanız birden fazla kuruluşunuz olabilir. Bu nedenle, sorunu gözlemlediğiniz kuruluşu ve diğer ayrıntıları bilmemiz gerekir:
    • Kuruluş ve ortam adları
    • API proxy adı ve revizyon numaraları (API isteği hataları için)
  • Private Cloud kullanıyorsanız desteklenen birçok yükleme topolojisinden birini kullanıyor olabilirsiniz. Bu nedenle, veri merkezi ve düğüm sayısı gibi ayrıntılar da dahil olmak üzere hangi topolojiyi kullandığınızı bilmemiz gerekiyor.

Aşağıdaki tabloda, NE YAPMALISINIZ? sütununda eksiksiz bilgi ve NE YAPMAMALISINIZ? sütununda eksik bilgi gösteren bazı örnekler verilmiştir:

Yapılması Gerekenler YAPMAYIN

401 2020-11-06 09:30 CST tarihinden itibaren Edge Public Cloud'da hatalar artmıştır.

Edge kurulum ayrıntıları:

Başarısız API'nin ayrıntıları şunlardır:
  Kuruluş adları: myorg
  Ortam adları: test
  API proxy adları: myproxy
  Düzeltme numaraları: 3

Hata:

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

401 Hata sayısı arttı.

(Kullanılan ürün, sorunun gözlemlendiği tarih veya kurulum ayrıntıları hakkında bilgi vermez.)

Ek ağ geçidi düğümleri eklendikten sonra Edge Private Cloud 4.19.06 sürümünde Mesaj İşlemcisi başlatılamıyor.

Teşhis günlükleri:
Mesaj İşlemcisi günlükleri eklendi.

Ağ topolojisi:
Ek düğümleri içeren network-topology.png dosyasını ekledim.

Ek ağ geçidi düğümleri eklendikten sonra Edge Private Cloud 4.19.06 sürümünde Mesaj İşlemcisi başlatılamıyor.

(Mesaj İşleyen Günlükleri ve ağ topolojisi eksik.)

Faydalı yapılar

Gözlemlediğiniz davranışı tam olarak anlamamıza ve bu konuda daha fazla bilgi edinmemize yardımcı olacağından, sorunla ilgili yapıları bize iletmeniz çözüm sürecini hızlandırır.

Bu bölümde, tüm Apigee ürünleri için yararlı olan bazı yapı taşları açıklanmaktadır:

Tüm Apigee ürünleri için ortak yapılardır.

Aşağıdaki yapı taşları tüm Apigee ürünleri için yararlıdır: Public Cloud'da Apigee Edge ve Private Cloud'da Apigee Edge:

Yapı Açıklama
İzleme aracı çıkışı İzleme aracı çıkışı, Apigee ürünleri üzerinden akan API istekleriyle ilgili ayrıntılı bilgiler içerir. Bu, 4XX, 5XX gibi çalışma zamanı hataları ve gecikme sorunları için yararlıdır.
Ekran görüntüleri Ekran görüntüleri, gözlemlenen gerçek davranışın veya hatanın bağlamını aktarmaya yardımcı olur. Kullanıcı arayüzünde veya Analytics'te gözlemlenen hata veya sorunlar için faydalıdır.
HAR (Http ARchive) HAR, kullanıcı arayüzüyle ilgili sorunları gidermek için HTTP oturumu araçları tarafından yakalanan bir dosyadır. Bu, Chrome, Firefox veya Internet Explorer gibi tarayıcılar kullanılarak yakalanabilir.
tcpdumps tcpdump aracı, ağ üzerinden aktarılan veya alınan TCP/IP paketlerini yakalar. Bu, TLS el sıkışma hataları, 502 hataları ve gecikme sorunları gibi ağla ilgili tüm sorunlar için yararlıdır.

Private Cloud için Apigee Edge'e yönelik ek yapı taşları

Private Cloud için Apigee Edge'de, sorunların daha hızlı teşhis edilmesini sağlayacak bazı ek yapıların kullanılması gerekebilir.

Yapı Açıklama
Ağ topolojisi Tüm veri merkezleri, düğümler ve her düğüme yüklenen bileşenler dahil olmak üzere özel bulut kurulumunuzu açıklayan Edge kurulum topolojisi şeması.
Edge bileşeni teşhis günlükleri Mesaj İşlemcisi, Yönlendirici veya Cassandra gibi belirli bir Apigee Edge bileşeniyle ilgili teşhis günlükleri.
Yükleme Yapılandırma Dosyası Apigee Edge'i yüklerken veya yükseltirken kullanılan sessiz yapılandırma dosyası.

Bu dosya, yükleme veya taşımayla ilgili sorunlarla karşılaşıldığında tüm ayarların doğru olup olmadığını doğrulamak için kullanışlıdır.

Yığın dökümleri Yığın dökümleri, Java bellek sürecinin anlık görüntüsüdür. Bu, belirli Edge bileşenlerinde yüksek hafıza kullanımı veya OutOfMemory hataları görüldüğünde faydalıdır.
Mesaj dizisi dökümleri İleti dizisi dökümü, çalışan bir Java işleminin tüm ileti dizilerinin anlık görüntüsüdür.

Bu, belirli Edge bileşenlerinde yüksek CPU veya yük gözlemlendiğinde faydalıdır.

Destek kaydı şablonları ve örnek destek kayıtları

Bu bölümde, bu dokümanda açıklanan en iyi uygulamalara göre farklı ürünler için destek kaydı şablonları ve örnek destek kayıtları sağlanmaktadır:

Apigee Edge Public Cloud

Şablon

Bu bölümde, Public Cloud'da Apigee Edge için örnek bir şablon sağlanmaktadır.

Sorun:

<Provide detailed description of the problem or the behaviour being observed at your end. Mümkünse ürün adını ve sürümünü ekleyin.>

Hata mesajı:

<Include the complete error message observed (if any)>

Sorunun başlangıç zamanı (ISO 8601 biçiminde):

Sorunun bitiş zamanı (ISO 8601 biçiminde):

Apigee kurulum ayrıntıları:
  Kuruluş adları:
  Ortam adları:
  API proxy adları:
  Düzeltme numaraları:

Sorunu yeniden oluşturma adımları:

<Mümkünse sorunun yeniden üretilmesi için uygulanacak adımları sağlayın>

Teşhis bilgileri:

<List of files attached>

Örnek olay

Bu bölümde, Apigee Cloud (Google Cloud'da Apigee/Public Cloud'da Apigee Edge) için örnek bir destek kaydı sağlanmaktadır.

Sorun:

Herkese Açık Bulut kuruluşumuzda çok sayıda 503 Hizmet Kullanılamıyor hatası görüyoruz. Sorunu inceleyip çözebilir veya nasıl çözeceğimiz konusunda bize yardımcı olabilir misiniz?

Hata mesajı:

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

Sorunun başlangıç zamanı (ISO 8601 biçiminde): 2020-10-04 06:30 IST

Sorunun sona erme zamanı (ISO 8601 biçiminde): Sorun devam ediyor.

Apigee Cloud kurulum ayrıntıları:
  Kuruluş adları: myorg
  Ortam adları: dev
  API proxy adları: myproxy
  Düzeltme numaraları: 3

Sorunu yeniden oluşturma adımları:

Sorunu yeniden oluşturmak için aşağıdaki curl komutunu çalıştırın:

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

Teşhis bilgileri:

İzleme aracı çıkışı (trace-503.xml)

Private Cloud için Apigee Edge

Şablon

Bu bölümde, Private Cloud için Apigee Edge'e ait örnek bir şablon sağlanmaktadır.

Sorun:

<Provide detailed description of the problem or the behaviour being observed at your end. Mümkünse ürün adını ve sürümünü ekleyin.>

Hata mesajı:

<Include the complete error message observed (if any)>

Sorunun başlangıç zamanı (ISO 8601 biçiminde):

Sorunun bitiş zamanı (ISO 8601 biçiminde):

Edge Private Cloud kurulum ayrıntıları:

<Veri merkezleri ve düğümler dahil olmak üzere Özel Bulutunuzun kurulumunu açıklayan ağ topolojisini ekleyin>

Sorunu yeniden oluşturma adımları:

<Mümkünse sorunun yeniden üretilmesi için uygulanacak adımları sağlayın>

Teşhis bilgileri

<List of files attached>

Örnek olay

Bu bölümde, Private Cloud için Apigee Edge'e ait örnek bir durum sağlanmaktadır.

Sorun:

Linux RHEL 7.6'da Edge Private Cloud 4.19.06 kapsamında 10. düğüme Apigee Management Server'ı yüklerken aşağıdaki hatayla karşılaşıyoruz.

Hata mesajı:

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

Sorunun başlangıç zamanı (ISO 8601 biçiminde):

Sorunun bitiş zamanı (ISO 8601 biçiminde): Geçerli değil

Edge Private Cloud kurulum ayrıntıları:

network-topology.png dosyasını ekledim

Sorunu yeniden oluşturma adımları:

Yukarıdaki hatayla sonuçlanan komut:

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

Teşhis bilgileri:

Aşağıdaki dosyalar eklenmiştir:

  • output.txt , hata mesajı da dahil olmak üzere yukarıdaki komutun tam çıkışını içerir
  • Yönetim sunucusu günlükleri ve
  • Yapılandırma dosyası NonProdConfig.txt