İçeriğe geç
Belgeler menüsüOlay şeması ve kipler

Olay şeması. Olaylarınız veri olarak tanımlanır.

Her uygulama kendi olay kataloğunu panelden tanımlar. Postlip Metrics’te sabit bir olay listesi yoktur: olay adları, özellikleri ve anlamları uygulamanın verisidir ve her mesaj bu katalogla doğrulanır.

Olay ve özellik tanımları

Bir olay tanımı adını, açıklamasını, iş rolünü, durumunu ve özelliklerini taşır. Her özelliğin:

  • tipi (string, number, integer, boolean, datetime, currency, money, enum, object, array),
  • zorunlu olup olmadığı ve kısıtları (değer listesi, en çok uzunluk, en az/en çok değer),
  • kişisel veri sınıfı (none, pseudonymous, personal, sensitive) ve eylemi (izin ver, özetle, at, reddet) vardır.

Kişi ve hesap özellikleri

identify ile gelen kişi özellikleri (traits) ve group ile gelen hesap özellikleri ayrı tanımlanır ve aynı kurallarla doğrulanır.

Durumlar

DurumAnlamı
TaslakTanım üzerinde çalışılıyor; henüz doğrulamaya katılmaz.
AktifTanım geçerli; olay buna göre doğrulanır.
Kullanımdan kalkıyorOlay hâlâ kabul edilir ama yerine başka bir olay kullanılmalı; üretilen tiplerde @deprecated.
EngelliOlay reddedilir (event_blocked).

Doğrulama kipleri

Kip uygulama başına seçilir ve tanımlı olmayan olay ve özelliklere ne olacağını belirler. Tanımlı olanlar her kipte tanıma göre denetlenir.

KipTanımsız olayNe zaman
strictReddedilir (event_unplanned, property_unplanned); sebebi canlı akışta görünür.Şeması oturmuş, yayındaki uygulamalar.
lenientKabul edilir, “Planlanmamış” işaretlenir ve Keşfedilen kutusuna düşer.Varsayılan.
discoverKabul edilir ve kendiliğinden bir taslak tanım açılır.Kurulumun ilk günleri.

Keşfedilen olaylar ve sürüm geçmişi

  • Tanımsız gelen olaylar Keşfedilen kutusunda toplanır; Tanım olarak ekle ile tanıma dönüşür ya da yok sayılır.
  • Şemadaki her değişiklik bir revizyondur; değişiklik geçmişi kim, ne zaman ve neyi değiştirdiğini önceki ve sonraki değerle tutar.

Dışa aktarım ve CI

  • Her olayın JSON Schema belgesi: GET /v1/apps/{appId}/event-definitions/{eventId}/json-schema.
  • Bütün şema tek pakette: GET /v1/apps/{appId}/schema.
  • metrics pull şemadan TypeScript tipleri ve tipli bir track üretir; metrics validate örnek olayları CI’da denetler.