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

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

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 eksik olduğunda daha fazla bilgi istememiz gerekir. Bu durumda, birden fazla kez iletişime geçmemiz gerekebilir. Bu işlem daha uzun sürer ve sorunların çözülmesinde gecikmelere yol açabilir. Bu En İyi Uygulamalar Kılavuzu, teknik destek kaydınızı daha hızlı çözmek için ihtiyaç duyduğumuz bilgileri size bildirir.

Sorunu açıklama

Bir sorun, ne olduğu ve ne olmasının beklendiği ile ilgili ayrıntıları açıklayan bilgilerin yanı sıra sorunun ne zaman ve nasıl gerçekleştiğini 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 Apigee Edge for Private Cloud
Ürün Sorunun gözlemlendiği belirli Apigee ürünü (varsa sürüm bilgileri dahil).
  • Sürüm
Sorun Ayrıntıları Sorunu özetleyen net ve ayrıntılı bir açıklama. Varsa hata mesajının tamamı da bu açıklamaya dahil edilmelidir.
  • Hata mesajı
  • İzleme aracı çıktısı
  • Sorunu yeniden oluşturma adımları
  • API isteğini/komutunu tamamlayın
  • Hata mesajı
  • İzleme aracı çıktısı
  • Sorunu yeniden oluşturma adımları
  • API isteğini/komutunu tamamlayın
  • Bileşen teşhis günlükleri
Zaman Sorunun başladığı zaman damgası ve ne kadar sürdüğü.
  • 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 yerle ilgili ayrıntılı bilgiler.
  • Kuruluş adı
  • Ortam adı
  • API proxy'sinin adı
  • Düzeltme
  • Ağ topolojisi
  • Başarısız Edge bileşeni

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

Ürün

Apigee Edge on Public Cloud ve Apigee Edge on Private Cloud olmak üzere farklı Apigee ürünleri vardır. Bu nedenle, hangi üründe sorun yaşandığıyla ilgili ayrıntılı bilgiye ihtiyacımız var.

Aşağıdaki tabloda, Yapılacaklar sütununda tam bilgileri, Yapılmayacaklar sütununda ise eksik bilgileri gösteren bazı örnekler verilmiştir:

YAPILMASI GEREKENLER YAPILMAMASI GEREKENLER
API proxy'sinin OAuth2 dağıtımı Public 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ü bilmemiz gerekir.)

Edge Private Cloud sürüm 4.50.00'da yükleme aşağıdaki hatayla başarısız oldu: ...

Özel bulut kurulumumuzda yükleme başarısız oldu.

(Sürüm bilgileri eksik)

Sorun Ayrıntıları

Gözlemlenen sorunla ilgili olarak hata mesajı (varsa) ve gözlemlenen beklenen ve gerçek davranış da dahil olmak üzere kesin bilgileri verin.

Aşağıdaki tabloda, Yapılacaklar sütununda tam bilgileri, Yapılmayacaklar sütununda ise eksik bilgileri gösteren bazı örnekler verilmiştir:

YAPILMASI GEREKENLER YAPILMAMASI GEREKENLER

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'si ç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 istekte bulunurken 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 istekte bulunurken 500 hataları alıyor.

(Yalnızca 500 hatalarını iletmek, sorunu araştırmamız için yeterli bilgiyi sağlamaz. Gözlemlenen gerçek hata mesajını ve 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 hâlâ devam edip etmediğini bilmesi önemlidir.

Sorunu çözen destek mühendisi sizin 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 kesin bilgileri sağlamak için tarih ve zaman damgası için ISO 8601 biçiminin kullanılması önerilir.

Aşağıdaki tabloda, Yapılması Gerekenler sütununda sorunun oluştuğu doğru zaman ve süre, Yapılmaması Gerekenler sütununda ise sorunun oluştuğu zamanla ilgili belirsiz veya net olmayan bilgiler gösteren bazı örnekler verilmiştir:

YAPILMASI GEREKENLER YAPILMAMASI GEREKENLER
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 gözlemlendi.

(Tarihi tahmin etmek zorunda kalıyoruz 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ındaki dönemde aşağıdaki API proxy'lerinde yüksek gecikme süreleri gözlemlendi: ...

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

(Bu sorunun geçen 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ı bilmemiz gerekiyor. Kullandığınız ürüne bağlı olarak aşağıdaki bilgilere ihtiyacımız vardır:

  • Apigee Cloud kullanıyorsanız birden fazla kuruluşunuz olabilir. Bu nedenle, sorunu gözlemlediğiniz kuruluş ve diğer ayrıntılar hakkında bilgiye ihtiyacımız var:
    • Kuruluş ve ortam adları
    • API proxy'si adı ve düzeltme numaraları (API isteği hataları için)
  • Özel bulut kullanıyorsanız desteklenen birçok kurulum 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 gerekir.

Aşağıdaki tabloda, Yapılacaklar sütununda tam bilgileri, Yapılmayacaklar sütununda ise eksik bilgileri gösteren bazı örnekler verilmiştir:

YAPILMASI GEREKENLER YAPILMAMASI GEREKENLER

401 2020-11-06 09:30 CST tarihinden itibaren Edge Public Cloud'da hatalar arttı.

Edge kurulumu ayrıntıları:

Başarısız olan API'nin ayrıntıları aşağıdaki gibidir:
  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 Hatalar arttı.

(Sorun gözlemlenirken kullanılan ürün, sorun gözlemlenmeye başlandığı zaman veya kurulum ayrıntıları hakkında bilgi verilmez.)

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

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

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

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

(Mesaj İşleyici günlükleri ve ağ topolojisi eksik.)

Faydalı yapılar

Sorunla ilgili yapıtları bize iletmeniz, gözlemlediğiniz davranışın tam olarak ne olduğunu anlamamıza ve bu konuda daha fazla bilgi edinmemize yardımcı olacağından çözüm sürecini hızlandırır.

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

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

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

Yapı Açıklama
Trace aracının çıktısı İzleme aracı çıkışı, Apigee ürünlerinden geçen API istekleriyle ilgili ayrıntılı bilgiler içerir. Bu, 4XX, 5XX ve gecikme sorunları gibi çalışma zamanı hataları 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ü veya Analytics'te görülen hatalar ya da sorunlar için faydalıdır.
HAR (Http ARchive) HAR, kullanıcı arayüzüyle ilgili sorunları ayıklamak 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.

Apigee Edge Private Cloud için ek yapılar

Apigee Edge for Private Cloud için sorunların daha hızlı teşhis edilmesini sağlayacak bazı ek öğelere ihtiyacımız olabilir.

Yapı Açıklama
Ağ topolojisi Her düğüme yüklenen tüm veri merkezleri, düğümler ve bileşenler dahil olmak üzere özel bulut kurulumunuzu açıklayan Edge yükleme topolojisi diyagramı.
Edge bileşeni teşhis günlükleri Message Processor, Router veya Cassandra gibi belirli bir Apigee Edge bileşeniyle ilgili teşhis günlükleri.
Yükleme Yapılandırma Dosyası Apigee Edge yüklenirken veya yükseltilirken kullanılan sessiz yapılandırma dosyası.

Bu dosya, yükleme veya taşıma sorunlarıyla karşılaşılan durumlarda 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 bellek kullanımı veya OutOfMemory hataları görülüyorsa yararlıdır.
İş parçacığı dökümleri İş parçacığı dökümü, çalışan bir Java işleminin tüm iş parçacıklarının anlık görüntüsüdür.

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

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

Bu bölümde, bu belgede açıklanan en iyi uygulamalara dayalı olarak farklı ürünler için vaka şablonları ve örnek vakalar verilmektedir:

Public Cloud'da Apigee Edge

Şablon

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

Sorun:

<Provide detailed description of the problem or the behaviour being observed at your end. Ürün adını ve sürümünü ekleyin (geçerli olduğu durumlarda).>

Hata mesajı:

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

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

Sorun bitiş zamanı (ISO 8601 biçimi):

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

Yeniden üretim adımları:

<Mümkünse sorunu yeniden oluşturma adımlarını 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 kullanım alanı sunulmaktadır.

Sorun:

Public Cloud kuruluşumuzda çok sayıda 503 Hizmet Kullanılamıyor hatası görüyoruz. Lütfen sorunu inceleyip çözebilir veya nasıl çözebileceğimiz konusunda bize tavsiyede bulunabilir misiniz?

Hata mesajı:

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

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

Sorunun bitiş zamanı (ISO 8601 biçimi): Sorun hâlâ devam ediyor.

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

Yeniden üretim 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ı çıktısı (trace-503.xml)

Apigee Edge for Private Cloud

Şablon

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

Sorun:

<Provide detailed description of the problem or the behaviour being observed at your end. Ürün adını ve sürümünü ekleyin (geçerli olduğu durumlarda).>

Hata mesajı:

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

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

Sorun bitiş zamanı (ISO 8601 biçimi):

Edge Private Cloud kurulum ayrıntıları:

<Attach the network topology describing the setup of your Private Cloud including data centers and nodes>

Yeniden üretim adımları:

<Mümkünse sorunu yeniden oluşturma adımlarını sağlayın>

Teşhis bilgileri

<List of files attached>

Örnek olay

Bu bölümde, Apigee Edge Private Cloud için örnek bir kullanım alanı verilmektedir.

Sorun:

Linux RHEL 7.6'da Edge Private Cloud 4.19.06'nın bir parçası olarak 10 numaralı 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çimi): Ne zaman yükleme yapsak oluyor.

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

Edge Private Cloud kurulum ayrıntıları:

network-topology.png dosyasını ekledim.

Yeniden üretim adımları:

Yukarıdaki hataya neden olan komut şudur:

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

Teşhis bilgileri:

Aşağıdaki dosyaları ekledi:

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