Tracer events

Tracer emits its public JSON business facts as CloudEvents 1.0 in binary content mode over Kafka. Tracer is the separately deployed Midaz component and the sole producer of the studio.lerian.tracer.* contract on this page.

CloudEvents envelope

Every public JSON fact uses the shared envelope below. The headers carry routing and schema information. The Kafka value carries the JSON data object.

Header	Presence and value
`ce-specversion`	Always `1.0`.
`ce-id`	Always; opaque producer-defined event identifier.
`ce-source`	Always `tracer`.
`ce-type`	Always `studio.lerian.tracer.<resource>.<event>`.
`ce-time`	Always; RFC 3339 emission timestamp.
`ce-resourcetype`	Always; the resource token from the definition key.
`ce-eventtype`	Always; the event token from the definition key.
`ce-subject`	Always `p.ID` for these 12 contracts.
`ce-tenantid`	Always present. Your tenant ID, or the literal `default` when the event has no tenant.
`ce-schemaversion`	`1.1.0` for `limit.created` and `limit.updated`. `1.0.0` for the other 10 public JSON facts.
`ce-datacontenttype`	`application/json`.

Topics, manifest, and routing

The application topic identifies Midaz Tracer, not an individual event. Route a record by ce-resourcetype and ce-eventtype, and validate ce-schemaversion before decoding its data value.

Facts: lerian.streaming.tracer
Route DLQ: lerian.streaming.tracer.dlq
Manifest: GET /v1/streaming/manifest exposes the public JSON catalog and topic mapping, including while publication is off.

Delivery and failure semantics

Publication is disabled until STREAMING_ENABLED=true and broker configuration succeeds. When enabled, Tracer emits after the business-state change. It does not use a transactional outbox.

Policy: every public JSON definition is a fact with direct delivery, on_routable_failure DLQ handling, and fallback_on_circuit_open.
Actual Tracer boundary: because Tracer has no outbox, the circuit-open fallback cannot persist an event. Emit paths log and swallow publication errors instead of returning them to the business command.
Consumer requirement: broker delivery is at least once for published records. Make handlers idempotent and deduplicate with (ce-source, ce-id).

Complete `data` contracts

These TypeScript-style declarations mirror the CloudEvent data JSON tags in Midaz. Every field name is its JSON name. ? means the field has omitempty. | null means the field is nullable and never absent. A source-type comment preserves the inventory type exactly. All fields in these 12 Tracer payloads are present (omitempty: false). Nullable fields still carry null when absent.

limit.activated

Definition key: limit.activated (LimitActivatedDefinition)Event: studio.lerian.tracer.limit.activatedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: ActivateLimitCommand successfully activates a limit.Subject: p.ID

// limit.activated
type LimitActivatedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

limit.created

Definition key: limit.created (LimitCreatedDefinition)Event: studio.lerian.tracer.limit.createdTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.1.0 (application/json)Fires when: CreateLimitCommand successfully creates a limit.Subject: p.ID

type RuleScopePayload = { // Go: RuleScopePayload
  segmentId: string | null // *string; wire null: true; omitempty: false
  portfolioId: string | null // *string; wire null: true; omitempty: false
  accountId: string | null // *string; wire null: true; omitempty: false
  merchantId: string | null // *string; wire null: true; omitempty: false
  transactionType: string | null // *string; wire null: true; omitempty: false
  subType: string | null // *string; wire null: true; omitempty: false
}

// limit.created
type LimitCreatedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  limitType: string // string; wire null: false; omitempty: false
  asset: string // string; wire null: false; omitempty: false
  scopes: RuleScopePayload[] // []RuleScopePayload; wire null: false; omitempty: false
  activeTimeStart: string | null // *string; wire null: true; omitempty: false
  activeTimeEnd: string | null // *string; wire null: true; omitempty: false
  customStartDate: string | null // *string; wire null: true; omitempty: false
  customEndDate: string | null // *string; wire null: true; omitempty: false
  resetTime: string | null // *string; wire null: true; omitempty: false
  resetAt: string | null // *string; wire null: true; omitempty: false
  createdAt: string // string; wire null: false; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

limit.deactivated

Definition key: limit.deactivated (LimitDeactivatedDefinition)Event: studio.lerian.tracer.limit.deactivatedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: DeactivateLimitCommand successfully deactivates a limit.Subject: p.ID

// limit.deactivated
type LimitDeactivatedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

limit.deleted

Definition key: limit.deleted (LimitDeletedDefinition)Event: studio.lerian.tracer.limit.deletedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: DeleteLimitCommand successfully deletes a limit.Subject: p.ID

// limit.deleted
type LimitDeletedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  deletedAt: string // string; wire null: false; omitempty: false
}

limit.drafted

Definition key: limit.drafted (LimitDraftedDefinition)Event: studio.lerian.tracer.limit.draftedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: DraftLimitCommand successfully moves a limit to DRAFT.Subject: p.ID

// limit.drafted
type LimitDraftedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

limit.updated

Definition key: limit.updated (LimitUpdatedDefinition)Event: studio.lerian.tracer.limit.updatedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.1.0 (application/json)Fires when: UpdateLimitCommand successfully updates a limit.Subject: p.ID

type RuleScopePayload = { // Go: RuleScopePayload
  segmentId: string | null // *string; wire null: true; omitempty: false
  portfolioId: string | null // *string; wire null: true; omitempty: false
  accountId: string | null // *string; wire null: true; omitempty: false
  merchantId: string | null // *string; wire null: true; omitempty: false
  transactionType: string | null // *string; wire null: true; omitempty: false
  subType: string | null // *string; wire null: true; omitempty: false
}

// limit.updated
type LimitUpdatedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  limitType: string // string; wire null: false; omitempty: false
  asset: string // string; wire null: false; omitempty: false
  scopes: RuleScopePayload[] // []RuleScopePayload; wire null: false; omitempty: false
  activeTimeStart: string | null // *string; wire null: true; omitempty: false
  activeTimeEnd: string | null // *string; wire null: true; omitempty: false
  customStartDate: string | null // *string; wire null: true; omitempty: false
  customEndDate: string | null // *string; wire null: true; omitempty: false
  resetTime: string | null // *string; wire null: true; omitempty: false
  resetAt: string | null // *string; wire null: true; omitempty: false
  createdAt: string // string; wire null: false; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

rule.activated

Definition key: rule.activated (RuleActivatedDefinition)Event: studio.lerian.tracer.rule.activatedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: ActivateRuleService successfully activates a rule.Subject: p.ID

// rule.activated
type RuleActivatedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  activatedAt: string | null // *string; wire null: true; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

rule.created

Definition key: rule.created (RuleCreatedDefinition)Event: studio.lerian.tracer.rule.createdTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: CreateRuleCommand successfully creates a rule.Subject: p.ID

type RuleScopePayload = { // Go: RuleScopePayload
  segmentId: string | null // *string; wire null: true; omitempty: false
  portfolioId: string | null // *string; wire null: true; omitempty: false
  accountId: string | null // *string; wire null: true; omitempty: false
  merchantId: string | null // *string; wire null: true; omitempty: false
  transactionType: string | null // *string; wire null: true; omitempty: false
  subType: string | null // *string; wire null: true; omitempty: false
}

// rule.created
type RuleCreatedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  action: string // string; wire null: false; omitempty: false
  scopes: RuleScopePayload[] // []RuleScopePayload; wire null: false; omitempty: false
  createdAt: string // string; wire null: false; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

rule.deactivated

Definition key: rule.deactivated (RuleDeactivatedDefinition)Event: studio.lerian.tracer.rule.deactivatedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: DeactivateRuleService successfully deactivates a rule.Subject: p.ID

// rule.deactivated
type RuleDeactivatedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  deactivatedAt: string | null // *string; wire null: true; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

rule.deleted

Definition key: rule.deleted (RuleDeletedDefinition)Event: studio.lerian.tracer.rule.deletedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: DeleteRuleService successfully deletes a rule.Subject: p.ID

// rule.deleted
type RuleDeletedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  deletedAt: string // string; wire null: false; omitempty: false
}

rule.drafted

Definition key: rule.drafted (RuleDraftedDefinition)Event: studio.lerian.tracer.rule.draftedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: DraftRuleService successfully moves a rule to DRAFT.Subject: p.ID

// rule.drafted
type RuleDraftedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

rule.updated

Definition key: rule.updated (RuleUpdatedDefinition)Event: studio.lerian.tracer.rule.updatedTopic: lerian.streaming.tracerRoute DLQ: lerian.streaming.tracer.dlqSchema: 1.0.0 (application/json)Fires when: UpdateRuleCommand successfully updates a rule.Subject: p.ID

type RuleScopePayload = { // Go: RuleScopePayload
  segmentId: string | null // *string; wire null: true; omitempty: false
  portfolioId: string | null // *string; wire null: true; omitempty: false
  accountId: string | null // *string; wire null: true; omitempty: false
  merchantId: string | null // *string; wire null: true; omitempty: false
  transactionType: string | null // *string; wire null: true; omitempty: false
  subType: string | null // *string; wire null: true; omitempty: false
}

// rule.updated
type RuleUpdatedDataV1 = {
  id: string // string; wire null: false; omitempty: false
  status: string // string; wire null: false; omitempty: false
  action: string // string; wire null: false; omitempty: false
  scopes: RuleScopePayload[] // []RuleScopePayload; wire null: false; omitempty: false
  createdAt: string // string; wire null: false; omitempty: false
  updatedAt: string // string; wire null: false; omitempty: false
}

Emitted event index

Definition key	`ce-type`	Schema	Subject	Fires when
`limit.activated`	`studio.lerian.tracer.limit.activated`	`1.0.0`	`p.ID`	`ActivateLimitCommand` successfully activates a limit.
`limit.created`	`studio.lerian.tracer.limit.created`	`1.1.0`	`p.ID`	`CreateLimitCommand` successfully creates a limit.
`limit.deactivated`	`studio.lerian.tracer.limit.deactivated`	`1.0.0`	`p.ID`	`DeactivateLimitCommand` successfully deactivates a limit.
`limit.deleted`	`studio.lerian.tracer.limit.deleted`	`1.0.0`	`p.ID`	`DeleteLimitCommand` successfully deletes a limit.
`limit.drafted`	`studio.lerian.tracer.limit.drafted`	`1.0.0`	`p.ID`	`DraftLimitCommand` successfully moves a limit to DRAFT.
`limit.updated`	`studio.lerian.tracer.limit.updated`	`1.1.0`	`p.ID`	`UpdateLimitCommand` successfully updates a limit.
`rule.activated`	`studio.lerian.tracer.rule.activated`	`1.0.0`	`p.ID`	`ActivateRuleService` successfully activates a rule.
`rule.created`	`studio.lerian.tracer.rule.created`	`1.0.0`	`p.ID`	`CreateRuleCommand` successfully creates a rule.
`rule.deactivated`	`studio.lerian.tracer.rule.deactivated`	`1.0.0`	`p.ID`	`DeactivateRuleService` successfully deactivates a rule.
`rule.deleted`	`studio.lerian.tracer.rule.deleted`	`1.0.0`	`p.ID`	`DeleteRuleService` successfully deletes a rule.
`rule.drafted`	`studio.lerian.tracer.rule.drafted`	`1.0.0`	`p.ID`	`DraftRuleService` successfully moves a rule to DRAFT.
`rule.updated`	`studio.lerian.tracer.rule.updated`	`1.0.0`	`p.ID`	`UpdateRuleCommand` successfully updates a rule.

Getting started

Validations API

Rules API

Limits API

Audit Events API

Dashboards API

Error handling

Events

CloudEvents envelope

Topics, manifest, and routing

Delivery and failure semantics

Complete `data` contracts

Emitted event index

​CloudEvents envelope

​Topics, manifest, and routing

​Delivery and failure semantics

​Complete data contracts

​Emitted event index

CloudEvents envelope

Topics, manifest, and routing

Delivery and failure semantics

Complete `data` contracts

Emitted event index