Skip to content

docs(TSP-1323): add workforce_task_deleted audit log event#695

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

docs(TSP-1323): add workforce_task_deleted audit log event#695
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1323

Conversation

@claude

@claude claude Bot commented Jun 24, 2026

Copy link
Copy Markdown

Summary

  • Adds workforce_task_deleted to the Workforce Events section of the streaming events (OpenTelemetry) documentation
  • Documents the relevance_ai.event.workforce_task_id payload field and its correlation with the relevance_ai.workforce.workforce_task_id attribute on workforce execution spans
  • Clarifies this event covers individual task executions (runs), not the workforce definition itself

Changes

File: enterprise/streaming-events.mdx

Added a new tombstone event entry — workforce_task_deleted — modelled after the existing workforce_deleted entry. The event fires when a workforce task is deleted (including bulk deletes, one event per task ID), and is gated by the existing customer_otel configuration.

Linear issue

https://linear.app/relevance/issue/TSP-1323/

🤖 Generated with Claude Code

Documents the new workforce_task_deleted tombstone event under the
Workforce Events section. The event fires when a workforce task
(individual execution run) is deleted, including bulk deletes, emitting
one event per task ID.

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

linear Bot commented Jun 24, 2026

Copy link
Copy Markdown

TSP-1323

@mintlify

mintlify Bot commented Jun 24, 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 Jun 24, 2026, 2:23 AM

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

@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 4/10 Title, sidebarTitle, and ~20 headings throughout are in title case instead of sentence case. Bold label inside a <Note> callout. Bold text used as section sub-headers in two places instead of proper headings.
🟢 Technical clarity 9/10 Detailed, precise attribute tables. Migration warnings for llm_completionchat and gen_ai.tool.definitions type change are well-placed and specific. The new workforce_task_id cross-reference is useful.
🟢 Non-technical clarity 9/10 The "scrub before delivery" analogy for PII redaction is clear. Setup steps are concrete.
🟡 Structure 7/10 "Supported Events" and "Supported Spans" both sit at the same H3 level as their own subsections (Agent events, Tool events, invoke_agent, chat, etc.), which breaks the outline hierarchy.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: Strong reference content — the technical tables, migration warnings, and PII redaction documentation are well-executed and genuinely useful. The main drag is a systemic capitalization problem: virtually every multi-word heading uses title case, which violates CLAUDE.md's sentence case rule and creates a lot of cleanup work. The new workforce_task_deleted event is clean.

🔧 Issues (14)
  • enterprise/streaming-events.mdx:2 — title "Event Streaming for Observability (OpenTelemetry)" → sentence case: "Event streaming for observability (OpenTelemetry)"
  • enterprise/streaming-events.mdx:3 — sidebarTitle "Event Streaming (OpenTelemetry)""Event streaming (OpenTelemetry)"
  • enterprise/streaming-events.mdx:26<Note>**S3 is currently the only supported destination**... — CLAUDE.md prohibits bold labels inside callouts. Drop the bold: <Note>S3 is currently the only supported destination. Support for direct OTEL collector endpoints is on our roadmap.</Note>
  • enterprise/streaming-events.mdx:37### 1. Create an S3 Bucket### 1. Create an S3 bucket
  • enterprise/streaming-events.mdx:47### 2. Configure Bucket Policy### 2. Configure bucket policy
  • enterprise/streaming-events.mdx:76### 3. Provide Configuration to Relevance### 3. Provide configuration to Relevance
  • enterprise/streaming-events.mdx:86## PII Redaction (Enterprise Feature)## PII redaction (enterprise feature) — "Enterprise" here describes a tier, not a proper product name
  • enterprise/streaming-events.mdx:98,106**1. Structured fields (always scrubbed automatically)** and **2. Unstructured text (scrubbed when PII redaction is enabled for your org)** are used as sub-section headers over bullet lists. CLAUDE.md: don't mix bold text with heading formats. Replace with proper #### headings: #### Structured fields (always scrubbed automatically) and #### Unstructured text (scrubbed when PII redaction is enabled)
  • enterprise/streaming-events.mdx:164## Delivery Format## Delivery format
  • enterprise/streaming-events.mdx:199,420### Base Attributes (appears in both Logs and Traces sections) → ### Base attributes
  • enterprise/streaming-events.mdx:215### Log Record Properties### Log record properties
  • enterprise/streaming-events.mdx:397### Resource Attributes### Resource attributes
  • enterprise/streaming-events.mdx:432,445,548### Span Properties, ### Trace Hierarchy, ## Attribute Value Types### Span properties, ### Trace hierarchy, ## Attribute value types
  • enterprise/streaming-events.mdx:567,571### Compatible Observability Platforms### Compatible observability platforms; ### Querying OTEL Data Directly### Querying OTEL data directly
🧩 Component suggestions (3)
  • enterprise/streaming-events.mdx:223–345### Supported Events (H3, no body) is immediately followed by ### Agent Events, ### Tool Events, ### Workforce Events, ### Permission Events — all also H3. These sub-sections should be H4 (####) so the page outline reads: Supported Events → Agent events → Tool events → etc. Currently they appear as siblings, not children. Apply sentence case at the same time: #### Agent events, #### Tool events, #### Workforce events, #### Permission events.
  • enterprise/streaming-events.mdx:458–544 — Same issue in Traces: ### Supported Spans (H3, no body) is followed by ### \invoke_agent`, ### `chat`, ### `multi_agent_system_trigger`, ### `condition_trigger`` all at H3. Drop to H4.
  • enterprise/streaming-events.mdx:118–129<CardGroup cols={3}> listing EMAIL_ADDRESS, PHONE_NUMBER, PERSON, etc. — these are technical identifier constants without links or descriptions. CLAUDE.md explicitly excludes "technical reference lists (data types, status codes, field names)" from CardGroup. A plain bullet list or a single-column table is better here for reference scanning.
✅ Clean files (0)

(no fully clean files — the single changed file has issues)

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

Files read: enterprise/streaming-events.mdx (575 lines), enterprise/analytics.mdx (166 lines), enterprise/data-retention.mdx (393 lines — cross-referenced streaming-events, checked for contradictions)

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