Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

feat(workflows): report transactional emails sent in the usage report (#124322)

Harley Alexander42f2ec72424b
diff --git a/posthog/tasks/test/__snapshots__/test_usage_report.ambr b/posthog/tasks/test/__snapshots__/test_usage_report.ambr
index 7f5230ba1312..85bb1e3d3b92 100644
--- a/posthog/tasks/test/__snapshots__/test_usage_report.ambr
+++ b/posthog/tasks/test/__snapshots__/test_usage_report.ambr
@@ -41,6 +41,21 @@
# name: TestFeatureFlagsUsageReport.test_usage_report_decide_requests.100
'''
+ SELECT team_id,
+ SUM(count) as count
+ FROM app_metrics2
+ WHERE app_source='hog_flow'
+ AND instance_id = 'transactional_email'
+ AND metric_name IN ('billable_invocation')
+ AND metric_kind IN ('email')
+ AND timestamp >= '2022-01-10 00:00:00'
+ AND timestamp < '2022-01-10 23:59:59'
+ GROUP BY team_id
+ '''
+# ---
+# name: TestFeatureFlagsUsageReport.test_usage_report_decide_requests.101
+ '''
+
SELECT team_id,
argMax(patterns, pattern_version) AS count
FROM
diff --git a/posthog/tasks/test/test_usage_report.py b/posthog/tasks/test/test_usage_report.py
index 33727a4c1d25..0399697a20b8 100644
--- a/posthog/tasks/test/test_usage_report.py
+++ b/posthog/tasks/test/test_usage_report.py
@@ -107,6 +107,7 @@ from products.warehouse_sources.backend.facade.models import (
ExternalDataSource,
)
from products.warehouse_sources.backend.facade.types import ExternalDataSourceType
+from products.workflows.backend.facade.contracts import TRANSACTIONAL_EMAIL_ACTION_ID
from ee.api.test.base import LicensedTestMixin
from ee.clickhouse.materialized_columns.columns import materialize
@@ -3554,9 +3555,17 @@ class TestHogFunctionUsageReports(ClickhouseDestroyTablesMixin, TestCase, Clickh
create_app_metric2(
team_id=self.org_1_team_2.id,
app_source="hog_flow",
+ instance_id=TRANSACTIONAL_EMAIL_ACTION_ID,
metric_name="billable_invocation",
metric_kind="email",
- count=15,
+ count=9,
+ )
+ create_app_metric2(
+ team_id=self.org_1_team_2.id,
+ app_source="hog_flow",
+ metric_name="billable_invocation",
+ metric_kind="email",
+ count=6,
)
create_app_metric2(
team_id=self.org_1_team_2.id,
@@ -3593,18 +3602,21 @@ class TestHogFunctionUsageReports(ClickhouseDestroyTablesMixin, TestCase, Clickh
# Push bills as a destination for now, so it counts toward workflow_billable_invocations
# while still reporting separately under workflow_push_sent.
assert org_1_report["workflow_emails_sent_in_period"] == 25 # 10 + 15
+ assert org_1_report["workflow_transactional_emails_sent_in_period"] == 9
assert org_1_report["workflow_push_sent_in_period"] == 12 # 5 + 7
assert org_1_report["workflow_sms_sent_in_period"] == 5 # 3 + 2
assert org_1_report["workflow_billable_invocations_in_period"] == 32 # fetch 8 + 12, push 5 + 7
# Test team 1 workflow metrics
assert org_1_report["teams"]["3"]["workflow_emails_sent_in_period"] == 10
+ assert org_1_report["teams"]["3"]["workflow_transactional_emails_sent_in_period"] == 0
assert org_1_report["teams"]["3"]["workflow_push_sent_in_period"] == 5
assert org_1_report["teams"]["3"]["workflow_sms_sent_in_period"] == 3
assert org_1_report["teams"]["3"]["workflow_billable_invocations_in_period"] == 13 # fetch 8, push 5
# Test team 2 workflow metrics
assert org_1_report["teams"]["4"]["workflow_emails_sent_in_period"] == 15
+ assert org_1_report["teams"]["4"]["workflow_transactional_emails_sent_in_period"] == 9
assert org_1_report["teams"]["4"]["workflow_push_sent_in_period"] == 7
assert org_1_report["teams"]["4"]["workflow_sms_sent_in_period"] == 2
assert org_1_report["teams"]["4"]["workflow_billable_invocations_in_period"] == 19 # fetch 12, push 7
diff --git a/posthog/tasks/usage_report.py b/posthog/tasks/usage_report.py
index bae6fc873bcc..d1dfe979ef89 100644
--- a/posthog/tasks/usage_report.py
+++ b/posthog/tasks/usage_report.py
@@ -95,6 +95,7 @@ from products.warehouse_sources.backend.facade.billing import (
)
from products.warehouse_sources.backend.facade.models import DataWarehouseTable, ExternalDataSchema
from products.warehouse_sources.backend.facade.types import ExternalDataSchemaStatus
+from products.workflows.backend.facade.contracts import TRANSACTIONAL_EMAIL_ACTION_ID
logger = structlog.get_logger(__name__)
logging.getLogger(__name__).setLevel(logging.INFO)
@@ -372,6 +373,8 @@ class UsageReportCounters:
# Workflow metrics
workflow_emails_sent_in_period: int
+ # Report-only: the part of workflow_emails_sent_in_period sent through the transactional email API.
+ workflow_transactional_emails_sent_in_period: int
workflow_push_sent_in_period: int
workflow_sms_sent_in_period: int
workflow_billable_invocations_in_period: int
@@ -2502,6 +2505,28 @@ def get_teams_with_workflow_emails_sent_in_period(
)
+@timed_log()
+@retry(tries=QUERY_RETRIES, delay=QUERY_RETRY_DELAY, backoff=QUERY_RETRY_BACKOFF)
+def get_teams_with_workflow_transactional_emails_sent_in_period(
+ begin: datetime,
+ end: datetime,
+) -> TeamUsageRows:
+ # Every transactional workflow bills its email under the same step id, which outlives a deleted workflow.
+ with tags_context(product=Product.WORKFLOWS, feature=Feature.USAGE_REPORT):
+ return sync_execute(
+ """
+ SELECT team_id, SUM(count) as count
+ FROM app_metrics2
+ WHERE app_source='hog_flow' AND instance_id = %(email_action_id)s AND metric_name IN ('billable_invocation') AND metric_kind IN ('email') AND timestamp >= %(begin)s AND timestamp < %(end)s
+ GROUP BY team_id
+ """,
+ {"begin": begin, "end": end, "email_action_id": TRANSACTIONAL_EMAIL_ACTION_ID},
+ workload=Workload.OFFLINE,
+ settings=CH_BILLING_SETTINGS,
+ ch_user=ClickHouseUser.BILLING,
+ )
+
+
@timed_log()
@retry(tries=QUERY_RETRIES, delay=QUERY_RETRY_DELAY, backoff=QUERY_RETRY_BACKOFF)
def get_teams_with_workflow_push_sent_in_period(
@@ -3299,6 +3324,9 @@ def _get_all_usage_data(
"teams_with_task_sandbox_seconds_in_period": task_sandbox_usage.seconds,
"teams_with_task_sandbox_cpu_core_seconds_in_period": task_sandbox_usage.cpu_core_seconds,
"teams_with_task_sandbox_memory_gib_seconds_in_period": task_sandbox_usage.memory_gib_seconds,
+ "teams_with_workflow_transactional_emails_sent_in_period": get_teams_with_workflow_transactional_emails_sent_in_period(
+ period_start, period_end
+ ),
"teams_with_active_hog_destinations_in_period": get_teams_with_active_hog_destinations_in_period(),
"teams_with_active_hog_transformations_in_period": get_teams_with_active_hog_transformations_in_period(),
"teams_with_logs_records_in_period": logs_records_rows,
@@ -3581,6 +3609,9 @@ def _get_team_report(all_data: dict[str, Any], team: Team) -> UsageReportCounter
team.id, 0
),
workflow_emails_sent_in_period=all_data["teams_with_workflow_emails_sent_in_period"].get(team.id, 0),
+ workflow_transactional_emails_sent_in_period=all_data[
+ "teams_with_workflow_transactional_emails_sent_in_period"
+ ].get(team.id, 0),
workflow_push_sent_in_period=all_data["teams_with_workflow_push_sent_in_period"].get(team.id, 0),
workflow_sms_sent_in_period=all_data["teams_with_workflow_sms_sent_in_period"].get(team.id, 0),
workflow_billable_invocations_in_period=all_data["teams_with_workflow_billable_invocations_in_period"].get(
diff --git a/posthog/temporal/tests/usage_report/test_aggregator.py b/posthog/temporal/tests/usage_report/test_aggregator.py
index 36af147f021b..bd3f262f9689 100644
--- a/posthog/temporal/tests/usage_report/test_aggregator.py
+++ b/posthog/temporal/tests/usage_report/test_aggregator.py
@@ -10,7 +10,7 @@ import gzip
import json
import weakref
import dataclasses
-from collections.abc import Iterator
+from collections.abc import Callable, Iterator
from datetime import UTC, datetime
from typing import Any, cast
@@ -28,6 +28,7 @@ from posthog.temporal.tests.usage_report.test_aggregate_activity import _instanc
from posthog.temporal.usage_report.aggregator import (
add_pre_logs_distinct_patterns_patch_defaults,
add_pre_sandbox_compute_patch_defaults,
+ add_pre_transactional_emails_patch_defaults,
build_manifest,
iter_chunk_lines,
load_all_data,
@@ -167,11 +168,25 @@ def test_load_all_data_defaults_compute_for_pre_patch_workflow_history() -> None
assert all_data["teams_with_sandbox_compute_memory_mib_seconds_in_period"] == {}
-def test_load_all_data_defaults_logs_distinct_patterns_for_pre_patch_workflow_history() -> None:
+ "add_defaults,query_name",
+ [
+ (add_pre_logs_distinct_patterns_patch_defaults, "teams_with_logs_distinct_patterns_in_period"),
+ (add_pre_transactional_emails_patch_defaults, "teams_with_workflow_transactional_emails_sent_in_period"),
+ ],
+)
+def test_load_all_data_defaults_single_query_for_pre_patch_workflow_history(
+ add_defaults: Callable[[dict[str, dict[int, int]], list[RunQueryToS3Result]], None], query_name: str
+) -> None:
all_data: dict[str, dict[int, int]] = {}
- add_pre_logs_distinct_patterns_patch_defaults(all_data, [])
+ add_defaults(all_data, [])
+
+ assert all_data == {query_name: {}}
+
+ patched_data: dict[str, dict[int, int]] = {query_name: {1: 2}}
+ add_defaults(patched_data, [RunQueryToS3Result(query_name=query_name, s3_key="unused", duration_ms=1)])
- assert all_data == {"teams_with_logs_distinct_patterns_in_period": {}}
+ assert patched_data == {query_name: {1: 2}}
def test_load_all_data_does_not_default_compute_for_patched_workflow_history() -> None:
diff --git a/posthog/temporal/tests/usage_report/test_workflow.py b/posthog/temporal/tests/usage_report/test_workflow.py
index 4ab001d07b58..880271f254dc 100644
--- a/posthog/temporal/tests/usage_report/test_workflow.py
+++ b/posthog/temporal/tests/usage_report/test_workflow.py
@@ -8,6 +8,7 @@ can be verified without standing up real ClickHouse / Postgres / S3.
import uuid
import asyncio
import logging
+from collections.abc import Callable
from contextlib import nullcontext
from datetime import UTC, datetime, timedelta
@@ -33,7 +34,7 @@ from posthog.temporal.quota_limiting.run_quota_limiting import (
RunQuotaLimitingWorkflow,
)
from posthog.temporal.usage_report.activities import plan_usage_counters
-from posthog.temporal.usage_report.queries import QUERIES
+from posthog.temporal.usage_report.queries import QUERIES, QuerySpec
from posthog.temporal.usage_report.types import (
AggregateInputs,
AggregateResult,
@@ -50,10 +51,12 @@ from posthog.temporal.usage_report.workflow import (
PARALLEL_COUNTER_QUERIES_PATCH_ID,
QUERY_CONCURRENCY,
SANDBOX_COMPUTE_QUERY_NAME,
+ TRANSACTIONAL_EMAILS_QUERY_NAME,
USAGE_COUNTER_SERVICE_PATCH_ID,
RunUsageReportsWorkflow,
_queries_for_logs_distinct_patterns_patch,
_queries_for_sandbox_compute_patch,
+ _queries_for_transactional_emails_patch,
build_context,
)
from posthog.usage_counters import (
@@ -70,13 +73,17 @@ def test_sandbox_compute_query_is_versioned_for_existing_histories() -> None:
assert SANDBOX_COMPUTE_QUERY_NAME in [spec.name for spec in _queries_for_sandbox_compute_patch(True)]
-def test_logs_distinct_patterns_query_is_versioned_for_existing_histories() -> None:
- assert LOGS_DISTINCT_PATTERNS_QUERY_NAME not in [
- spec.name for spec in _queries_for_logs_distinct_patterns_patch(QUERIES, False)
- ]
- assert LOGS_DISTINCT_PATTERNS_QUERY_NAME in [
- spec.name for spec in _queries_for_logs_distinct_patterns_patch(QUERIES, True)
+ [
+ ("logs_distinct_patterns", _queries_for_logs_distinct_patterns_patch, LOGS_DISTINCT_PATTERNS_QUERY_NAME),
+ ("transactional_emails", _queries_for_transactional_emails_patch, TRANSACTIONAL_EMAILS_QUERY_NAME),
]
+)
+def test_single_query_is_versioned_for_existing_histories(
+ _name: str, queries_for_patch: Callable[[list[QuerySpec], bool], list[QuerySpec]], query_name: str
+) -> None:
+ assert query_name not in [spec.name for spec in queries_for_patch(QUERIES, False)]
+ assert query_name in [spec.name for spec in queries_for_patch(QUERIES, True)]
@parameterized.expand(
diff --git a/posthog/temporal/usage_report/activities.py b/posthog/temporal/usage_report/activities.py
index ee71b62b0cab..df675eda109e 100644
--- a/posthog/temporal/usage_report/activities.py
+++ b/posthog/temporal/usage_report/activities.py
@@ -28,6 +28,7 @@ from posthog.temporal.common.metrics import ExecutionTimeRecorder
from posthog.temporal.usage_report.aggregator import (
add_pre_logs_distinct_patterns_patch_defaults,
add_pre_sandbox_compute_patch_defaults,
+ add_pre_transactional_emails_patch_defaults,
get_org_user_counts,
iter_org_reports,
load_all_data,
@@ -249,6 +250,7 @@ async def aggregate_and_chunk_org_reports(inputs: AggregateInputs) -> AggregateR
all_data = load_all_data(inputs.query_results)
add_pre_sandbox_compute_patch_defaults(all_data, inputs.query_results)
add_pre_logs_distinct_patterns_patch_defaults(all_data, inputs.query_results)
+ add_pre_transactional_emails_patch_defaults(all_data, inputs.query_results)
check_cancelled()
counter_report = load_usage_counter_report(inputs)
all_data.update({field: dict(rows) for field, rows in counter_report.counts.items()})
diff --git a/posthog/temporal/usage_report/aggregator.py b/posthog/temporal/usage_report/aggregator.py
index 276701079f8b..132d9c3866ad 100644
--- a/posthog/temporal/usage_report/aggregator.py
+++ b/posthog/temporal/usage_report/aggregator.py
@@ -56,6 +56,7 @@ _SANDBOX_COMPUTE_DESTINATION_KEYS = (
"teams_with_sandbox_compute_memory_mib_seconds_in_period",
)
_LOGS_DISTINCT_PATTERNS_QUERY_NAME = "teams_with_logs_distinct_patterns_in_period"
+_TRANSACTIONAL_EMAILS_QUERY_NAME = "teams_with_workflow_transactional_emails_sent_in_period"
def load_usage_counter_report(inputs: AggregateInputs) -> UsageCounterReport:
@@ -102,6 +103,13 @@ def add_pre_logs_distinct_patterns_patch_defaults(
all_data[_LOGS_DISTINCT_PATTERNS_QUERY_NAME] = {}
+def add_pre_transactional_emails_patch_defaults(
+ all_data: dict[str, dict[int, int]], query_results: list[RunQueryToS3Result]
+) -> None:
+ if not any(result.query_name == _TRANSACTIONAL_EMAILS_QUERY_NAME for result in query_results):
+ all_data[_TRANSACTIONAL_EMAILS_QUERY_NAME] = {}
+
+
def iter_chunk_lines(
org_reports: Iterable[OrgReport],
instance_metadata: InstanceMetadata,
diff --git a/posthog/temporal/usage_report/queries.py b/posthog/temporal/usage_report/queries.py
index 727852a18c89..59beb4f2acf8 100644
--- a/posthog/temporal/usage_report/queries.py
+++ b/posthog/temporal/usage_report/queries.py
@@ -87,6 +87,7 @@ from posthog.tasks.usage_report import (
get_teams_with_signals_credits_used_in_period,
get_teams_with_survey_responses_count_in_period,
get_teams_with_task_sandbox_usage_in_period,
+ get_teams_with_workflow_transactional_emails_sent_in_period,
get_teams_with_zero_duration_recording_count_in_period,
)
from posthog.usage_counters import UsageCounter, UsageCounterService
@@ -530,6 +531,10 @@ QUERIES: list[QuerySpec] = [
name="teams_with_workflow_emails_sent_in_period",
fn=lambda b, e: UsageCounterService().get_legacy(UsageCounter.WORKFLOW_EMAILS, b, e),
),
+ QuerySpec(
+ name="teams_with_workflow_transactional_emails_sent_in_period",
+ fn=get_teams_with_workflow_transactional_emails_sent_in_period,
+ ),
QuerySpec(
name="teams_with_workflow_push_sent_in_period",
fn=lambda b, e: UsageCounterService().get_legacy(UsageCounter.WORKFLOW_PUSH, b, e),
diff --git a/posthog/temporal/usage_report/workflow.py b/posthog/temporal/usage_report/workflow.py
index 83cd98fa0d23..baf1a5ce400c 100644
--- a/posthog/temporal/usage_report/workflow.py
+++ b/posthog/temporal/usage_report/workflow.py
@@ -58,6 +58,8 @@ PARALLEL_COUNTER_QUERIES_PATCH_ID = "usage-report-parallel-counter-queries-2026-
AGGREGATION_QUEUE_PATCH_ID = "usage-report-aggregation-queue-2026-10"
LOGS_DISTINCT_PATTERNS_QUERY_PATCH_ID = "usage-report-logs-distinct-patterns-query-2026-10"
LOGS_DISTINCT_PATTERNS_QUERY_NAME = "teams_with_logs_distinct_patterns_in_period"
+TRANSACTIONAL_EMAILS_QUERY_PATCH_ID = "usage-report-transactional-emails-query-2026-10"
+TRANSACTIONAL_EMAILS_QUERY_NAME = "teams_with_workflow_transactional_emails_sent_in_period"
def _queries_for_sandbox_compute_patch(patch_applied: bool) -> list[QuerySpec]:
@@ -72,6 +74,12 @@ def _queries_for_logs_distinct_patterns_patch(queries: list[QuerySpec], patch_ap
return [spec for spec in queries if spec.name != LOGS_DISTINCT_PATTERNS_QUERY_NAME]
+def _queries_for_transactional_emails_patch(queries: list[QuerySpec], patch_applied: bool) -> list[QuerySpec]:
+ if patch_applied:
+ return queries
+ return [spec for spec in queries if spec.name != TRANSACTIONAL_EMAILS_QUERY_NAME]
+
+
def build_context(inputs: RunUsageReportsInputs, run_id: str, now: datetime) -> WorkflowContext:
"""Compute the period and S3 layout context. Pure function so it's safe
to call from the workflow body (no real-time access).
@@ -135,6 +143,9 @@ class RunUsageReportsWorkflow(PostHogWorkflow):
queries = _queries_for_logs_distinct_patterns_patch(
queries, workflow.patched(LOGS_DISTINCT_PATTERNS_QUERY_PATCH_ID)
)
+ queries = _queries_for_transactional_emails_patch(
+ queries, workflow.patched(TRANSACTIONAL_EMAILS_QUERY_PATCH_ID)
+ )
if workflow.patched(USAGE_COUNTER_SERVICE_PATCH_ID):
ctx.usage_counter_plan = await workflow.execute_activity(
plan_usage_counters,
diff --git a/products/workflows/backend/facade/contracts.py b/products/workflows/backend/facade/contracts.py
index 1adbe803c266..2b7d24646289 100644
--- a/products/workflows/backend/facade/contracts.py
+++ b/products/workflows/backend/facade/contracts.py
@@ -679,6 +679,10 @@ class WorkflowRef:
has_email_step: bool
+# Engagement tracking and message assets key on this id, so it stays stable across versions.
+TRANSACTIONAL_EMAIL_ACTION_ID: Final[str] = "transactional_email"
+
+
@frozen
class TransactionalEmailContent:
"""What a transactional email's workflow sends, taken from the message template it was made from."""
diff --git a/products/workflows/backend/services/transactional_email_workflows.py b/products/workflows/backend/services/transactional_email_workflows.py
index 733ea49e5649..681435bdf089 100644
--- a/products/workflows/backend/services/transactional_email_workflows.py
+++ b/products/workflows/backend/services/transactional_email_workflows.py
@@ -11,6 +11,7 @@ from posthog.models.integration import Integration
from posthog.models.scoping import with_team_scope
from products.workflows.backend.facade.contracts import (
+ TRANSACTIONAL_EMAIL_ACTION_ID,
TransactionalEmailContent,
TransactionalEmailContentInvalid,
TransactionalEmailSenderUnavailable,
@@ -21,8 +22,6 @@ from products.workflows.backend.models import HogFlow, TeamWorkflowsConfig
from products.workflows.backend.services.hog_flow_writes import create_workflow, update_workflow
TRIGGER_ACTION_ID = "trigger_node"
-# Engagement tracking and message assets key on this id, so it stays stable across versions.
-EMAIL_ACTION_ID = "transactional_email"
EXIT_ACTION_ID = "exit_node"
# The send endpoint passes the recipient as an event property. Liquid output is never parsed again, so an
@@ -41,7 +40,7 @@ def transactional_email_actions(content: TransactionalEmailContent, from_integra
"config": {"type": "api"},
},
{
- "id": EMAIL_ACTION_ID,
+ "id": TRANSACTIONAL_EMAIL_ACTION_ID,
"name": content.name,
"description": "",
"type": "function_email",
@@ -95,8 +94,8 @@ def _content_fields(content: TransactionalEmailContent, from_integration_id: int
"name": content.name,
"actions": actions,
"edges": [
- {"from": TRIGGER_ACTION_ID, "to": EMAIL_ACTION_ID, "type": "continue"},
- {"from": EMAIL_ACTION_ID, "to": EXIT_ACTION_ID, "type": "continue"},
+ {"from": TRIGGER_ACTION_ID, "to": TRANSACTIONAL_EMAIL_ACTION_ID, "type": "continue"},
+ {"from": TRANSACTIONAL_EMAIL_ACTION_ID, "to": EXIT_ACTION_ID, "type": "continue"},
],
# The API serializer derives these two from the actions on every save.
"trigger": actions[0]["config"],
@@ -119,7 +118,7 @@ def resolve_transactional_email_sender(team_id: int, requested_id: int | None) -
def _current_sender(flow: HogFlow) -> int | None:
# The email step is missing when someone edited the workflow directly. The update writes it back.
- email = next((action for action in flow.actions if action.get("id") == EMAIL_ACTION_ID), None)
+ email = next((action for action in flow.actions if action.get("id") == TRANSACTIONAL_EMAIL_ACTION_ID), None)
if email is None:
return None
return email["config"]["inputs"]["email"]["value"]["from"].get("integrationId")