Skip to content

Commit 6ec28d4

Browse files
committed
Fix drop-events doc formatting to match standard CDP template
- Add templateId to frontmatter - Wrap Configuration/FAQ/snippets in HideOnCDPIndex - Add standard PostHogMaintained and FeedbackQuestions snippets - Remove showTitle that was causing sidebar issues - Add Installation section for consistency
1 parent b688220 commit 6ec28d4

File tree

1 file changed

+39
-17
lines changed

1 file changed

+39
-17
lines changed

contents/docs/cdp/transformations/drop-events.mdx

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,48 @@
11
---
2-
title: Drop Events
3-
showTitle: true
2+
title: Drop events
3+
templateId:
4+
- template-drop-events
45
---
5-
import { CalloutBox } from 'components/Docs/CalloutBox'
66

7-
PostHog's drop events transformation allows you to selectively discard events from being ingested based on specific criteria.
8-
## Overview
7+
import FeedbackQuestions from "../_snippets/feedback-questions.mdx"
8+
import PostHogMaintained from "../_snippets/posthog-maintained.mdx"
9+
import { CalloutBox } from 'components/Docs/CalloutBox'
910

10-
The drop events transformation permanently removes events from your data pipeline, preventing them from being stored or processed by PostHog.
11+
Selectively discard events from being ingested based on specific criteria. Dropped events are permanently removed from your data pipeline, preventing them from being stored or processed by PostHog.
1112

1213
<CalloutBox icon="IconPiggyBank" title="Impact on usage & billing" type="info">
1314

14-
Events that are dropped using a transformation **do not count towards your usage/billing**.
15+
Events that are dropped using a transformation **do not count towards your usage/billing**.
1516

16-
While we encourage you to [instrument custom events](/docs/getting-started/send-events#2-capture-custom-events) and [configure autocapture](/docs/product-analytics/autocapture) to only capture the events you need long term, a **Drop Events** transformation can serve as a temporary solution to reduce usage immediately (vs. waiting for your next deployment cycle to modify custom events or configuration).
17+
While we encourage you to [instrument custom events](/docs/getting-started/send-events#2-capture-custom-events) and [configure autocapture](/docs/product-analytics/autocapture) to only capture the events you need long term, a **Drop Events** transformation can serve as a temporary solution to reduce usage immediately (vs. waiting for your next deployment cycle to modify custom events or configuration).
1718

1819
It can also be useful when you want more granular control over _bundled_ autocapture events such as excluding a [specific app lifecycle events](/docs/product-analytics/autocapture#react-native-navigation-and-lifecycle-autocapture) and only capturing the ones you need.
1920

2021
</CalloutBox>
2122

23+
## Installation
24+
25+
1. In PostHog, click the [Data pipeline](https://us.posthog.com/pipeline/overview) tab in the left sidebar.
26+
2. Click the [Transformations](https://us.posthog.com/pipeline/transformations) tab.
27+
3. Search for **Drop events** and click **+ Create**.
28+
4. Configure your filters to target the events you want to drop.
29+
5. Press **Create & Enable** to start dropping matching events.
30+
31+
<HideOnCDPIndex>
32+
2233
## Configuration
2334

2435
The drop events transformation uses filters to target specific events for removal.
2536

2637
### Filtering options
2738

2839
1. **Event matching**: Target specific event types by name (e.g., `$pageview`, `user_signed_up`)
29-
3. **Property filters**: Further refine your filters with property conditions:
40+
2. **Property filters**: Further refine your filters with property conditions:
3041
- Match on any event property
3142
- Supports operators like equals, contains, greater than, etc.
3243
- Apply property filters globally across all events or specifically to individual event types
3344

34-
#### How to use the filters
45+
### How to use the filters
3546

3647
The drop events transformation uses two types of filters that work together:
3748

@@ -43,7 +54,7 @@ The drop events transformation uses two types of filters that work together:
4354
2. **Property filters**: These filters use AND logic and are applied after the event matching. ALL property conditions must be met for an event to be dropped. For example, if you set:
4455
- `browser is set`
4556
- `Country Name is set`
46-
57+
4758
Only events that have BOTH properties matching these conditions will be dropped.
4859

4960
![Drop events based on property filters](https://res.cloudinary.com/dmukukwp6/image/upload/Property_Filter_And_2dc645185c.png)
@@ -53,7 +64,7 @@ The drop events transformation uses two types of filters that work together:
5364
- If you select "All events" and add a property filter "browser is set", it will drop ALL events that have the browser property set
5465
- If you also add specific event matches like `$pageview` and `$pageleave`, it will drop:
5566
- All `$pageview` events
56-
- All `$pageleave` events
67+
- All `$pageleave` events
5768
- Any other events that have the browser property set
5869

5970
![Drop events based on combined filters](https://res.cloudinary.com/dmukukwp6/image/upload/Both_Event_Filter_And_Property_Filter_9b5360cdd4.png)
@@ -86,11 +97,22 @@ Before enabling your drop events transformation in production, use the built-in
8697
3. Run the test to see if the event would be dropped
8798
4. Iterate on your filters until you're satisfied with the results
8899

89-
## Important considerations
100+
## FAQ
101+
102+
### Is the source code for this transformation available?
103+
104+
PostHog is open-source and so are all the transformations on the platform. The [source code](https://github.com/PostHog/posthog/blob/master/posthog/cdp/templates/drop_events/template_drop_events.py) is available on GitHub.
105+
106+
### What happens to dropped events?
107+
108+
Dropped events are permanently deleted and cannot be recovered. They are removed before ingestion, so they won't appear in any analytics, cohorts, or exports.
109+
110+
### How do I monitor what's being dropped?
111+
112+
Check the metrics and logs tabs regularly to ensure the transformation is working as expected. The metrics tab shows how many events have been processed and dropped.
90113

91-
- **Permanence**: Dropped events are permanently deleted and cannot be recovered
92-
- **Monitoring**: Check the metrics and logs tabs regularly to ensure the transformation is working as expected
114+
<PostHogMaintained />
93115

94-
## Learn more
116+
<FeedbackQuestions />
95117

96-
- [PostHog filtering documentation](/docs/product-analytics/trends/filters)
118+
</HideOnCDPIndex>

0 commit comments

Comments
 (0)