Skip to content

Add trigger_deleted and knowledge_table_deleted OTEL audit events to streaming events docs#712

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1332
Open

Add trigger_deleted and knowledge_table_deleted OTEL audit events to streaming events docs#712
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1332

Conversation

@claude

@claude claude Bot commented Jul 10, 2026

Copy link
Copy Markdown

Summary

  • Adds trigger_deleted audit event to the Trigger events section, documenting the trigger ID, trigger type (recurring, tool_trigger, or external_relay), and optional integration provider for relay-type triggers
  • Adds knowledge_table_deleted audit event to the Knowledge events section, documenting the knowledge table ID
  • Both events follow the existing deletion tombstone event pattern and note they are only emitted for organizations with the customer OTEL integration configured

These events are part of a series of deletion tombstone events for core platform entities, added in PR #15762 to relevance-api-node.

Linear issue: https://linear.app/relevance/issue/TSP-1332/

Test plan

  • Verify the new event sections render correctly on the docs site
  • Confirm table formatting matches existing audit event tables
  • Check that heading capitalization follows sentence case convention

…audit events

Adds two new audit event types to the streaming events documentation,
following the existing pattern for deletion tombstone events.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Jul 10, 2026
@linear

linear Bot commented Jul 10, 2026

Copy link
Copy Markdown

TSP-1332

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 Product terms (agent, tool, workforce, trigger, knowledge) lowercased throughout all event descriptions; one heading using title case ("PII Redaction").
🟢 Technical clarity 8/10 The "Only emitted for organizations with the customer OTEL integration configured" qualifier appears exclusively on the two new events but not on any existing delete events — creates an implication that the others differ.
🟢 Non-technical clarity 8/10 Good overview and PII analogy. Inherently a technical reference page, so baseline jargon is unavoidable.
🟡 Structure 7/10 Two separate ### Prerequisites subsections on the same page; ### Supported events and its child sections (### Agent events, ### Tool events, etc.) share the same H3 level.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment — not per file.

Overall vibe: The new trigger_deleted and knowledge_table_deleted sections slot in cleanly and the attribute tables are well-structured. The main drag is a systematic capitalization issue that runs across the entire event descriptions section — every product term (Agent, Tool, Workforce, Trigger, Knowledge) is lowercased in the "Emitted when…" lines, which contradicts CLAUDE.md's rule. The two newly added events also carry an unexplained qualifier that doesn't appear on equivalent existing events.

🔧 Issues (5)
  • enterprise/streaming-events.mdx:88 — Heading ## PII Redaction (Enterprise feature)## PII redaction (Enterprise feature). "Redaction" is not a proper noun.

  • enterprise/streaming-events.mdx:250–380 — Systematic: every "Emitted when…" description uses lowercase product terms. CLAUDE.md requires capitalization when referring to Relevance AI product features. Fix throughout:

    • "a new agent is created" → "a new Agent is created"
    • "an agent's configuration is updated" → "an Agent's configuration is updated"
    • "a new tool is created" → "a new Tool is created"
    • "a new workforce is created" → "a new Workforce is created"
    • "a trigger is permanently deleted" → "a Trigger is permanently deleted" (new)
    • "a knowledge table is permanently deleted" → "a Knowledge table is permanently deleted" (new)
    • Same pattern applies to all remaining event descriptions in these sections.
  • enterprise/streaming-events.mdx:415 — "Traces track execution flows for agents, workforces" → "for Agents, Workforces" (product terms).

  • enterprise/streaming-events.mdx:365, 375 — "Only emitted for organizations with the customer OTEL integration configured." appears on trigger_deleted and knowledge_table_deleted only — not on agent_deleted, tool_deleted, workforce_deleted, or any other event. Since the whole page is about the OTEL integration (events are meaningless without it), this qualifier either applies to every event or to none. Either remove it, or if these events genuinely require something extra (e.g., a newer integration version), clarify what's different about them.

  • enterprise/streaming-events.mdx:144 — Second ### Prerequisites subsection (inside ## PII Redaction (Enterprise feature)) creates two identically-named sections on the page. Convert to an <Info> callout: "Before configuring PII redaction, ensure OTEL log shipping is enabled and the jsonl_to_otel_json transformation is applied."

🧩 Component suggestions (1)
  • enterprise/streaming-events.mdx:120–131 — The <CardGroup cols={3}> for supported PII entities has 10 cards with only a code-value title (e.g., EMAIL_ADDRESS) and an icon — no body text. Cards without body text are visual bullets, not navigable items. Replace with a two-column table (| Entity type | What it detects |) so readers can see what each entity actually covers (e.g., EMAIL_ADDRESS → email addresses in text, PERSON → full names). That would also avoid the awkward situation of a card titled US_SSN with a credit-card icon.
🏗️ Page structure (1)
  • enterprise/streaming-events.mdx### Supported events and its subsections (### Agent events, ### Tool events, ### Workforce events, etc.) all sit at H3 — same level as the parent. Subsections should use #### so the hierarchy is ## Logs → ### Supported events → #### Agent events. Same issue applies to ### Supported spans and its children (### \invoke_agent`, ### `chat`, etc.) under ## Traces`. This is pre-existing across the file; the new Trigger events and Knowledge events sections correctly follow the established (broken) pattern — fix holistically.
⚠️ Contradictions (0)

No contradictions found. The 30-day staging bucket purge window is stated consistently between streaming-events.mdx and data-retention.mdx, and both pages link to each other accurately.

🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~1,167

Files read: enterprise/streaming-events.mdx (612 lines), enterprise/data-retention.mdx (389 lines), enterprise/analytics.mdx (166 lines)

@mintlify

mintlify Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Jul 10, 2026, 5:09 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant