Azure SRE Aracısı'nda Azure DevOps wiki bilgisi

İnceleme sırasında acentenizin ekibinizin prosedür dokümanlarına ve yöntemlerine başvurması için Azure DevOps wiki'lerinizi bağlayın. Wiki içeriği dizine eklenir ve aranabilir ve aracınız otomatik olarak doğru sayfayı bulur. Bağlayıcı hem yönetilen kimlik hem de kişisel erişim belirteci (PAT) kimlik doğrulamasını destekler.

Sorun: bilgiler olaylar sırasında kullanılmaz

Ekibiniz, Azure DevOps wiki'lerinde runbook'lar, sorun giderme kılavuzları ve operasyonel yordamlar yazmak için yüzlerce saat yatırım yapar. Ama bir olay (alarm) 03:00'te tetiklendiğinde, kimse wiki'yi açıp arama yapmaz. Çağrıdaki mühendis bir düzine sekme açar, Azure İzleyici'yi denetler ve bunu bellekten fark eder veya yükseltir. Tam olarak bu durum için yazılan belgelere dokunulmaz.

Bilgi var. Sorun, wiki'ye değil, gerçek sorun bağlamında doğru zamanda doğru sayfaya erişimdir.

SRE Aracısı bu sorunu nasıl çözer?

Azure DevOps wiki'nizi bir kez bağlayın; aracınız her araştırma sırasında bu wiki'yi otomatik olarak arar:

  1. Wiki sayfalarınızı dizinler — Azure DevOps wiki'nizdeki tüm sayfaları tarar ve dizinler.
  2. Bağlamsal aramalar — Bir soru sorduğunuzda veya bir olay meydana geldiğinde, temsilciniz wiki'nizi diğer bilgi kaynaklarıyla birlikte arar.
  3. Belirli sayfalara başvurular — Yanıtlar, özgün wiki sayfasına geri bağlanan alıntıları içerir.
  4. Güncelleştirmeleri alır — Güncelleştirilmiş wiki içeriğini yeniden dizine almak için bağlayıcıyı yeniden bağlayın veya yenileyin.

Önce ve sonra

Scenario Önce Sonra
Olay yanıtı Aramadaki kişi olaylar sırasında wiki'de arama yapmaz Yazılımınız her sorgu için wiki'de otomatik olarak arama yapar.
Bilgi erişimi Wiki'deki bilgiler 03:00'da kullanılmamaya devam ediyor Runbook'lar tam olarak gerektiğinde ortaya çıkar
Uyum Süreci Yeni ekip üyeleri hangi wiki sayfasının denetleneceklerini bilmiyor Temsilciniz deneyimden bağımsız olarak ilgili sayfayı bulur
Arama kalitesi Wiki araması için doğru anahtar sözcüklerin bilinmesi gerekir Aracınız bağlamı anlar ve ilgili içeriği bulur

Bunu farklı kılan nedir?

Statik dosya yüklemelerinden farklı olarak wiki'niz canlı kalır. Ekibiniz Azure DevOps'taki bir runbook'u güncelleştirdiğinde, aracınız değişiklikleri alır. Dosyaları yeniden yüklemeniz gerekmez.

Tam metin wiki aramasının aksine, aracınız bağlamı anlar. Anahtar sözcüklerle eşleşmiyor. Bunun yerine sorunuzu ilgili wiki içeriğiyle ilişkilendirerek Azure İzleyici'deki canlı telemetri verileriyle, Kusto günlükleriyle ve diğer bağlı kaynaklarla birleştirir.

Dış MCP tabanlı wiki erişiminin aksine, yerleşik Belgeler bağlayıcısı dış sunucu kurulumu gerektirmez. Wiki URL'sini ve kimlik doğrulamasını sağlarsınız ve gerisini aracınız işler.

Nasıl çalışır?

Belgeler bağlayıcısı (Azure DevOps hizmet türü), wiki sayfalarınızda gezinir ve arama için dizin oluşturur. Temsilciniz bir sorgu aldığında, dizine alınmış içeriği, karşıya yüklenen dosyalar, web sayfaları ve bağlı depolar gibi diğer bilgi kaynakları ile birlikte arar.

Bağlayıcı iki tür Azure DevOps içeriğini destekler:

İçerik türü URL deseni Dizine alınanlar
Wiki https://dev.azure.com/{org}/{project}/_wiki/wikis/{wiki-name} Tüm wiki sayfaları (Markdown)
Wiki (kapsamlı) .../_wiki/wikis/{wiki-name}/{pageId}/Page-Name Belirli sayfa ve alt sayfaları
Git kaynağı https://dev.azure.com/{org}/{project}/_git/{repo} Metin dosyaları (Markdown, belgeler, kod)
Eski wiki https://{org}.visualstudio.com/{project}/_wiki/wikis/{wiki-name} Yukarıdakiyle aynı (eski URL biçimi)

Uyarı

Wiki URL'sine bir sayfa kimliği eklediğinizde, bağlayıcı yalnızca bu sayfayı ve alt sayfalarını dizine alır. Bu yaklaşım, tüm wikinizi dizine eklemeden, /Operations veya /Runbooks gibi belirli bölümleri hedeflemek için kullanışlıdır.

Belge eşitleme nasıl çalışır?

Temsilciniz bağlandıktan sonra belge dizininizi otomatik olarak güncel tutar. Hiçbir şeyi el ile yeniden yüklemeniz gerekmez.

Görünüş Ayrıntılar
Eşitleme sıklığı 24 saatte bir otomatik gezinme
Desteklenen biçimler .md, .txt, .rst, .adoc, , .asciidoc, .wiki, .textile, , .org, .htm, .html, .json, .yaml, .yml.xml, .csv (15 dosya biçimi)
Dizin oluşturma işlemi Belgeler semantik arama için parçalara ayrılır, gömülür ve dizine eklenir.
Güncelleştirmeler Deponuzdaki değişiklikler bir sonraki eşitleme döngüsünde el ile eylem gerektirmeden alınır

Aracınız her belgeyi anlamsal olarak anlamlı öbeklere bölerek, vektör eklemeleri oluşturarak ve bir arama dizininde depolayarak işler. Bir sorgu geldiğinde, aracınız tüm dizinlenmiş öbekler arasında anlamsal bir arama gerçekleştirir ve tam anahtar sözcük eşleşmelerinden bağımsız olarak en uygun bölümleri alır.

Ekibiniz runbook'ları güncelleştirebilir, yeni yordamlar ekleyebilir veya wiki sayfalarını yeniden düzenleyebilir ve aracınız bu değişiklikleri 24 saat içinde yansıtır.

Önkoşullar

Gereksinim Ayrıntılar
Azure DevOps wiki'si Azure DevOps projenizde içerik içeren bir wiki
Kimlik Doğrulaması Yönetilen kimlik (önerilen) veya kişisel erişim belirteci (PAT)
İzinler Wiki'ye okuma erişimi

Kimlik doğrulama seçenekleri

Aşağıdaki tabloda Azure DevOps wiki bağlayıcısı için kullanılabilir kimlik doğrulama yöntemleri açıklanmaktadır.

Yöntem En iyi kullanım alanı: Nasıl çalışır?
Yönetilen kimlik Üretim ortamları Temsilcinizin sistem tarafından atanan veya kullanıcı tarafından atanan yönetilen kimliğini kullanır. Kimliğin Azure DevOps kuruluşunuzda kullanıcı olarak eklenmesini gerektirir.
Kişisel erişim belirteci (PAT) Hızlı kurulum, test etme Azure DevOps'ta Kod (Okuma) kapsamıyla pat oluşturun.

Örnek: Bir olay sırasında çalışma kitabı kullanma

İşlemler wiki'nizi bağladıktan sonra aracınıza şu soruyu sorun:

Our payment service is returning 503 errors. What does our runbook say to do?

Aracınız wiki'nizde arama yapıp "Ödeme Hizmeti Sorun Giderme" sayfasını bulur ve belgelenmiş yordamla yanıt verir. Yanıt, Azure DevOps'taki özgün wiki sayfasına geri bağlanan bir alıntı içerir.

Sonraki adım