system-prompts-and-models-o.../docs/ws5-connector-events-metrics.md
Sami Assiri b4531f0a4c feat(tier1): docs-governance CI, evidence gate, closure artifacts, trust/execution docs
- Replace repo-preflight with docs-governance workflow and check_docs_links.py
- Class B bundle: require correlation_id for external_*; AuditMetadata trace fields
- Root-safe TIER1 §2; optional .githooks pre-push for main
- Add RELEASE_READINESS_MATRIX_AR, SOURCE_OF_TRUTH_INDEX, operational severity, external index
- ExecWeeklyGovernanceContract; expand trust-fabric, execution-fabric, ADR-0001, ws5, Saudi overlays
- Wire MASTER TOC, enterprise-readiness, completion-program, architecture_brief paths

Made-with: Cursor
2026-04-16 16:46:36 +03:00

3.0 KiB
Raw Blame History

WS5 — Connector facade, events, semantic metrics (completion)

Connector facade standard (required for new integrations)

Each connector MUST document: contract, version, retry, timeout, idempotency key, approval policy hook, audit field mapping, observability hooks, rollback notes.
Pattern reference: governance/connectors-and-data-plane.md.

Rule: No new agent path may call a vendor SDK directly for a production integration; add a facade module under salesflow-saas/backend/app/services/integrations/ (or agreed package) with tests.

Event envelope and schema registry

  • Envelope fields: see governance/events-and-schema.md.
  • Registry: start with versioned JSON Schema under docs/schemas/events/ (create per event family) before adopting a hosted registry.

Semantic metrics dictionary

Authoritative definitions: semantic-metrics-dictionary.md. Application code must import metric keys from a single module once introduced (WS5 follow-up PR).

Lineage / catalog

Single choice documented in lineage-catalog-choice.md until an ADR changes it.


Dual connector strategy (runtime tools vs data movement)

Layer Purpose Examples Governance
Runtime tool connectors LLM/agent tool calls during a session (read/write bounded) MCP tools, built-in HTTP tools behind facade Decision plane + tool verification + allowlists
Data movement connectors Scheduled/batch replication or sync between systems ELT/CDC-style pipelines (Airbyte-class) Execution plane ownership, SLAs, backfill runbooks

Rule: never confuse the two in architecture diagrams — they share “connector” language but have different failure domains, retention, and approval classes.

MCP Tasks / async operations (watchlist)

Long-running MCP operations (tasks that outlive a single HTTP interaction) MUST have: visible status polling or webhook, timeout, idempotency key, and an owner in semantic-metrics-dictionary.md or the connector runbook. Track vendor-specific “MCP Tasks” behavior as V1V2 severity candidates when SLAs slip — see governance/operational-severity-model.md. External overview: references/tier1-external-index.md (Airbyte MCP).


Great Expectations (GE) as a release gate

When GE is in-path:

  • Tie checkpoint success explicitly to RELEASE_READINESS_MATRIX_AR.md (row: schema adherence / data quality) and to promotion of workflows that consume the underlying datasets.
  • Failed checkpoints are V2 by default if customer reports or downstream models consume the data; V3 if PII/regulated fields are involved.

Reference: GE checkpoints — references/tier1-external-index.md.