Orbit समयरेखा टिप्पणियाँ

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…

Annotations आपको एक प्रोजेक्ट की timeline पर context लिखने देते हैं: वह घटना जो 2am को शुरू हुई, वह release जिसने checkout flow को बदला, वह feature flag जिसे किसी ने फ्लिप किया। छः महीने बाद ये एक रहस्यमय step वाले चार्ट और एक ऐसे चार्ट के बीच का अंतर हैं जिसे आप समझा सकते हैं।

Annotations कहाँ होते हैं

Orbit खोलें, प्रोजेक्ट पर क्लिक करें, और प्रोजेक्ट tab strip में Observability group के तहत Timeline चुनें। पृष्ठ Timeline annotations शीर्षक वाला है और खुद को आपकी deployment timeline पर incidents, releases, milestones और notes को चिह्नित करने के रूप में वर्णित करता है।

Orbit प्रोजेक्ट के लिए Timeline annotations पृष्ठ

पाँच प्रकार

प्रकार	इसका उपयोग इसके लिए करें
Incident	कुछ टूट गया। Outages, degraded performance, data समस्याएँ
Release	एक सार्थक shipment, विशेष रूप से एक जो समझाने लायक हो
Milestone	याद रखने लायक क्षण: launch day, पहले हज़ार users, एक migration पूरी हुई
Flag flip	एक feature flag चालू या बंद किया गया, जो एक deploy-shaped change है बिना deploy के
Note	कुछ और भी लिखने लायक

Flag flip के लिए एक विशिष्ट कारण से अपना प्रकार है। एक flag change production में व्यवहार को बदलता है बिना deployment के, इसलिए यह deploy history में कोई निशान नहीं छोड़ता है। जब performance किसी ऐसे दिन पर move होता है जिस दिन कोई deploys नहीं हैं, तो flag flip अक्सर उत्तर है, और केवल एक annotation ही आपको बताएगा।

Annotation बनाना

New annotation पर क्लिक करें।
Kind चुनें।
Occurred at सेट करें। यह default रूप से अभी है, और आप इसे backdate कर सकते हैं।
एक Title लिखें, 200 characters तक।
वैकल्पिक रूप से एक Body लिखें, 4000 characters तक, notes, links या postmortem text के लिए।
Create पर क्लिक करें।

Backdating महत्वपूर्ण है। Annotation को लिखें जब आपके पास समय हो, और समय को तब सेट करें जब चीज़ वास्तव में हुई थी, ताकि वह timeline पर सही जगह पर आए।

उत्तर को category में नहीं, title में डालें। "Checkout timing out for AU customers" एक list में उपयोगी है; "Incident" नहीं है, और kind badge पहले से ही कहता है।

फ़िल्टर करना

शीर्ष पर फ़िल्टर bar All के साथ-साथ हर प्रकार प्रदान करता है। Incident के लिए फ़िल्टर करने से आपको एक view में प्रोजेक्ट के लिए एक incident history मिलता है, जो ठीक वही है जो आप quarterly review लिखते समय या यह पता लगाते समय चाहते हैं कि क्या एक recurring problem वास्तव में recurring है।

एक Deployment के लिए Anchoring

एक annotation को एक विशिष्ट deployment से जोड़ा जा सकता है बजाय अकेले खड़े होने के। यह कैसे आप एक परिणाम को एक कारण से जोड़ते हैं: annotation उस deployment के साथ यात्रा करता है जिसने इसे caused किया।

इसे classic pattern के लिए उपयोग करें कि एक deploy जो ठीक दिख रहा था और एक घंटे बाद एक समस्या का कारण बना। incident को उस deployment से anchor करें और connection स्थायी रूप से दर्ज किया जाता है, बजाय किसी की memory में रहने के।

Incidents प्रकाशित होते हैं

Incident annotations आपके public status page के incidents section के लिए source हैं, यदि आपके पास Show recent incidents को चालू के साथ enabled है।

मान लीजिए कि कोई भी एक incident annotation को पढ़ सकता है। इसमें customer names, credentials, internal system details या blame मत डालें। incident annotation में customer-facing account लिखें और internal detail को एक note annotation या अपने स्वयं के postmortem document में रखें। Orbit Status Page देखें।

एक अच्छा Incident Annotation लिखना

Incident के दौरान, इसे short और factual रखें:

क्या प्रभावित है, ऐसे terms में जो एक customer उपयोग करेगा।
जो आप जानते हैं, जो आप suspect करते हैं वह नहीं।
जब आप अगले को update करेंगे।

बाद में, resolution के साथ एक body जोड़ें: कारण क्या था, क्या इसे fixed किया, और क्या इसे recurring होने से बचाता है। यह annotation को एक बुरी घंटे की एक snapshot की बजाय एक permanent record में बदल देता है।

softening करने की urge को resist करें। "Checkout 40 मिनट के लिए unavailable था" बेहतर ages करता है "कुछ customers को intermittent issues का experience हो सकता है" की तुलना में, एक public statement और आपके अपने record दोनों के रूप में।

हटाना

हर annotation के पास एक delete control है। Confirmation बस यह कहता है कि यह undo नहीं किया जा सकता।

Typos और duplicates को delete करें। Incidents को delete मत करें क्योंकि वे embarrassing हैं: timeline की value यह है कि यह complete है, और एक history जिससे bad days हटाई गई हैं कोई भी pattern के बारे में आपको कुछ नहीं बता सकती।

अपने Charts के विरुद्ध Timeline को पढ़ना

Annotations तब pay off होते हैं जब आप उन्हें एक metric के बगल में रखते हैं:

Web Vitals में एक step change। Timeline को same day पर एक release या flag flip के लिए check करें: Orbit Web Vitals देखें।
Build duration में एक jump। एक milestone जैसे एक dependency upgrade या एक monorepo restructure के लिए देखें: Orbit Build Insights देखें।
Failed deploys का एक cluster। एक incident annotation आमतौर पर इसे समझाता है, और यदि एक नहीं है, तो वह स्वयं जानने लायक है।

Annotations को स्वचालित रूप से बनाना

Annotations को Orbit API के माध्यम से बनाया जा सकता है, जिसका अर्थ है कि आपका स्वयं का tooling उन्हें लिख सकता है। दो patterns setup करने लायक हैं:

आपकी alerting system एक Incident annotation को खोलता है जब यह किसी को page करता है, इसलिए timeline को बिना किसी को इसे याद करने के लिए populate किया जाता है।
आपकी feature-flag tooling हर change पर एक Flag flip annotation लिखता है, जो उस record को रखने का एकमात्र reliable तरीका है।

Authentication और endpoint reference के लिए Orbit API Tokens and the REST API देखें।

बनाने लायक आदतें

One annotation per event, body में updated। एक ही incident को track करने वाले पाँच annotations नहीं। Timeline एक glance पर readable होना चाहिए।

Boring wins को भी annotate करें। "Moved images to the edge" उस week के बगल में जब आपकी bandwidth dropped थी कि कैसे आप prove करते हैं कि काम करना लायक था।

इसे same day लिखें। एक week बाद लिखा गया annotation vaguer है और आमतौर पर समय के बारे में गलत है।

समस्या निवारण

Annotation status page पर नहीं है। इसकी kind Incident नहीं है, या Show recent incidents switch status page settings पर off है।

Title truncated था। Titles 200 characters पर cap होते हैं। Detail को body में डालें।

यह timeline पर गलत जगह पर दिखाई देता है। Occurred at value वह है जब event हुआ था, जब आपने इसे लिखा नहीं। Delete करें और सही समय के साथ recreate करें।

कुछ नहीं listed है। अभी तक कोई annotations नहीं बनाए गए हैं। Empty state आपको एक release, incident या milestone को mark करने के लिए prompt करता है।

अगले जाने के लिए कहाँ

Orbit Status Page अपने customers को incidents publish करने के लिए।
Orbit Releases tag-based version history के लिए।
Orbit Project Analytics वह charts के लिए जिन्हें annotations समझाते हैं।