Orbit
Orbit Zaman Çizelgesi Açıklamaları
Annotations let you write context onto a project's timeline: the incident that started at 2am, the release that changed the checkout flow, the feature flag someone flipped. Six months later they are…
Ek açıklamalar sayesinde bir projenin zaman çizelgesine bağlam yazabilirsiniz: saat 2'de başlayan olay, ödeme akışını değiştiren yayın, birinin çevirdiği özellik bayrağı. Altı ay sonra bunlar, içinde gizemli bir adım olan bir grafik ile açıklayabileceğiniz bir grafik arasındaki farktır.
Ek Açıklamalar Nerede Bulunur
Orbit'i açın, projeyi tıklayın ve proje sekmesi şeridindeki Gözlenebilirlik grubu altından Timeline seçeneğini seçin. Sayfa Timeline annotations başlığına sahiptir ve kendisini dağıtım zaman çizelgenize olayları, yayınları, kilometre taşlarını ve notları işaretlemek olarak tanımlar.
Beş Tür
| Tür | Şu amaçlar için kullanın |
|---|---|
| Incident | Bir şey bozuldu. Kesintiler, düşürülmüş performans, veri sorunları |
| Release | Anlamlı bir gönderim, özellikle açıklamaya değer |
| Milestone | Hatırlanmaya değer bir an: lansmanın ilk günü, ilk bin kullanıcı, tamamlanan göç |
| Flag flip | Bir özellik bayrağı açıldı veya kapandı, bu dağıtıma benzer bir değişikliktir ancak dağıtım içermez |
| Note | Yazılmaya değer başka her şey |
Flag flip belirli bir nedenden dolayı kendi türüne sahip olmalıdır. Bir bayrak değişikliği, dağıtım olmadan üretimdeki davranışı değiştirir, bu nedenle dağıtım geçmişinde hiçbir iz bırakmaz. Performans dağıtım olmayan bir gün içinde hareket ettiğinde, çoğu zaman bir bayrak değişikliği cevaptır ve yalnızca bir ek açıklama size bunu söyleyecektir.
Ek Açıklama Oluşturma
- New annotation (Yeni ek açıklama) tıklayın.
- Kind seçeneğini seçin.
- Occurred at seçeneğini ayarlayın. Varsayılan olarak şimdiye ayarlanmıştır ve bunu geriye doğru yazabilirsiniz.
- Title yazın, en fazla 200 karakter.
- İsteğe bağlı olarak Body yazın, notlar, bağlantılar veya olay sonrası analiz metni için en fazla 4000 karakter.
- Create tıklayın.
Geriye doğru yazma önemlidir. Zamanınız olduğunda ek açıklamayı yazın ve zamanı şeyin gerçekten gerçekleştiği zamana ayarlayın, böylece zaman çizelgesinde doğru yerde yer alır.
Cevabı kategoriye değil, başlığa koyun. "AU müşterileri için ödeme zaman aşımına uğruyor" bir listede faydalıdır; "Incident" değildir ve tür rozeti bunu zaten söyler.
Filtreleme
En üstteki filtre çubuğu All (Tümü) ve her türü sunar. Incident (Olay) olarak filtrelemek, projenizin olaylar geçmişini tek bir görünümde verir, bu tam olarak üç aylık bir inceleme yazarken veya yinelenen bir sorunun gerçekten yinelenen olup olmadığını anlarken istediğiniz şeydir.
Bir Dağıtıma Sabitleme
Bir ek açıklama, tek başına durmak yerine belirli bir dağıtıma eklenebilir. Bu, bir sonucu bir nedene bağlamanın yoludur: ek açıklama, buna neden olan dağıtım ile birlikte hareket eder.
Bunu, iyi görünen ve bir saat sonra sorun yaratan dağıtımın klasik örüntüsü için kullanın. Olayı bu dağıtıma sabitleyin ve bağlantı kalıcı olarak kaydedilir, birinin hafızasında yaşamak yerine.
Olaylar Yayımlanmıştır
Olay ek açıklamaları, Show recent incidents (Son olayları göster) açık olarak etkinleştirilirse, genel durum sayfanız için olaylar bölümünün kaynağıdır.
Herkesin bir olay ek açıklamasını okuyabileceğini varsayın. Buna müşteri adları, kimlik bilgileri, iç sistem ayrıntıları veya suçlama koymayın. Müşteri tarafından karşıya konulan hesabı olay ek açıklamasında yazın ve iç ayrıntıyı bir not ek açıklamasına veya kendi olay sonrası analiz belgenize tutun. Bkz. Orbit Status Page.
İyi Bir Olay Ek Açıklaması Yazma
Olay sırasında kısa ve gerçekçi tutun:
- Müşterinin kullandığı şekilde ne etkilenir.
- Şüphelendiğiniz değil, bildiğiniz şey.
- Sonra ne zaman güncelleyeceğiniz.
Sonra, çözüm içeren bir body ekleyin: nedeni ne oldu, ne onu düzeltti ve bunu yineleme neyi engeller. Bu, ek açıklamayı kötü bir saatin anlık görüntüsü yerine kalıcı bir kayda dönüştürür.
Yumuşatma dürtüsüne karşı koyun. "Ödeme 40 dakika boyunca kullanılamadı" hem genel bir ifade hem de kendi kaydınız olarak "bazı müşteriler aralıklı sorunlar yaşamış olabilirler" ifadesinden daha iyi yaşlanır.
Silme
Her ek açıklamanın bir silme denetimi vardır. Onay, basitçe bunun geri alınamayacağını söyler.
Yazım hatalarını ve tekrarları silin. Olayları, utanç verici oldukları için silmeyin: zaman çizelgesinin değeri tam olması ve kötü günleri kaldırılmış bir geçmiş desenler hakkında size hiçbir şey söyleyemez.
Zaman Çizelgesini Grafiklerinize Karşı Okuma
Ek açıklamalar, bunları bir metriğin yanına koyduğunuzda geri ödeme verir:
- Web Vitals'ta adım değişikliği. Aynı gün için yayın veya bayrak değişikliği zaman çizelgesini kontrol edin: bkz. Orbit Web Vitals.
- Yapı süresinde sıçrama. Bağımlılık yükseltmesi veya monoRepo yeniden yapılandırması gibi bir kilometre taşı arayın: bkz. Orbit Build Insights.
- Başarısız dağıtımların kümesi. Bir olay ek açıklaması genellikle bunu açıklar ve bir tane yoksa, bu kendi başına bilinmeye değerdir.
Ek Açıklamaları Otomatik Olarak Oluşturma
Ek açıklamalar Orbit API aracılığıyla oluşturulabilir, bu da kendi araçlarınızın bunları yazabileceği anlamına gelir. Kuruluma değer iki örüntü vardır:
- Uyarı sisteminiz birini sayfalandırdığında bir Incident (Olay) ek açıklaması açar, böylece zaman çizelgesi birinin bunu hatırlamalarını beklemeden doldurulur.
- Özellik bayrağı araçlarınız her değişiklikte bir Flag flip (Bayrak değişikliği) ek açıklaması yazar, bu bu kaydı tutmanın tek güvenilir yoludur.
Kimlik doğrulama ve uç nokta referansı için bkz. Orbit API Tokens and the REST API.
İnşa Etmeye Değer Alışkanlıklar
Olay başına bir ek açıklama, body'de güncellenmesi. Aynı olayı izleyen beş ek açıklama değil. Zaman çizelgesi bir bakışta okunabilir olmalıdır.
Sıkıcı kazanları da açıklayın. Bant genişliğinizin düştüğü hafta yanında "Görüntüleri kenara taşındı", işin yapılmaya değer olduğunu nasıl kanıtladığınızı gösterir.
Aynı gün yazın. Bir hafta sonra yazılı bir ek açıklama daha belirsiz ve genellikle zaman hakkında yanlıştır.
Sorun Giderme
Ek açıklama durum sayfasında değil. Türü Incident değildir veya durum sayfası ayarlarında Show recent incidents (Son olayları göster) anahtarı kapalıdır.
Başlık kesildi. Başlıklar 200 karakterde sınırlandırılmıştır. Ayrıntıyı body'ye koyun.
Zaman çizelgesinde yanlış yerde görünür. Occurred at değeri, yazıldığında değil, olayın gerçekleştiği zamandır. Doğru zamanla silerek yeniden oluşturun.
Hiçbir şey listelenmez. Henüz hiçbir ek açıklama oluşturulmamıştır. Boş durum sizi bir yayın, olay veya kilometre taşını işaretlemeye isteklendirir.
Sonra Nereye Gideceksiniz
- Orbit Status Page olayları müşterilerinize yayımlamak için.
- Orbit Releases etiket tabanlı sürüm geçmişi için.
- Orbit Project Analytics ek açıklamaların açıkladığı grafikler için.