Skip to content

Commit b76c847

Browse files
author
markzegarelli
authored
Merge pull request #1572 from segmentio/svls/kill-schema-defaults
Remove Schema Defaults documentation
2 parents e58f0a9 + 4dd4f23 commit b76c847

File tree

4 files changed

+1
-201
lines changed

4 files changed

+1
-201
lines changed

src/connections/destination-data-control.md

Lines changed: 0 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -38,109 +38,3 @@ If you no longer want to track an event, you can either remove it from your code
3838
![](/docs/protocols/images/event-filters.png)
3939

4040
Once you block an event in Segment, we'll stop forwarding it to all of your Destinations, including your warehouses. You can remove it from your code at your leisure. In addition to blocking track calls, Business plan customers can block all Page and Screen calls, as well as Identify traits and Group properties. 
41-
42-
---
43-
44-
45-
46-
## How do I prevent new data from being allowed by default?
47-
48-
If you've solidified your tracking plan and don't want any rogue events finding their way to your warehouses and end tools, we recommend activating our new feature, **Schema Defaults**. When you lock your schema, or set your Schema Defaults to "Block," Segment will automatically prevent these calls from being sent downstream. You can activate this for new events—including `track`, `page`, and `screen` calls—or for new `identify` traits and `group` properties. 
49-
50-
Locking your schema only takes a few seconds and will protect your data from un-spec'd events or tracking errors. To configure your Schema Defaults, go to your Schema page, and then select "General" from the left-hand navigation.
51-
52-
![](images/schema-defaults.png)
53-
54-
55-
**Overview of Schema Default Settings**
56-
57-
**Default**
58-
59-
**Allow**
60-
61-
**Block**
62-
63-
**New Events**
64-
65-
All new events will be allowed in Segment and sent to all Destinations.
66-
67-
No new events will be allowed in Segment or sent to your Destinations. Any event that is already being tracked and part of your Schema will not be impacted.
68-
69-
**New Group Properties**
70-
71-
All new group properties will be allowed in Segment and sent to all Destinations.
72-
73-
No new group properties will be allowed in Segment or sent to your Destinations.
74-
75-
**New Identify Traits**
76-
77-
All new identify traits will be allowed in Segment and sent to all Destinations.
78-
79-
No new identify traits will be allowed in Segment or sent to your Destinations.
80-
81-
**Example: Order Completed**
82-
83-
For example, if you set your Schema Defaults for New Events to "Block," and a new event, `Order Completed`, is tracked, Segment will automatically block the event and it will not be sent to your warehouse or downstream tools. The event will continue to be blocked until you actively choose to allow it.
84-
85-
You will need to upgrade to the latest [iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#install-the-sdk) and/or [Android](/docs/connections/sources/catalog/libraries/mobile/android/#step-1-install-the-library) SDKs for Schema Defaults to apply to events sent from mobile sources. 
86-
87-
## **What is considered a "new" event?**
88-
89-
New events refer to events that have not previously been sent to a given Source. Let's say you've only sent the following events from your Javascript source:
90-
91-
* `Products Searched`
92-
93-
* `Product List Viewed`
94-
95-
* `Product List Filtered`
96-
97-
98-
Your Schema Default setting will not have any impact on these three events because they are not considered new. You can manually block them, but your Schema Default setting will not change the status of these events. 
99-
100-
Here's what will happen the first time a new event, `Promotion Viewed`, is sent to this Source:
101-
102-
* **Schema Default Set to Allow:** `Promotion Viewed` will be "allowed," which means the event will be sent to all enabled Destinations.
103-
104-
* **Schema Default Set to Block:** `Promotion Viewed` will be "blocked," which means the event will not be sent to any Destinations.
105-
106-
107-
## **What happens to blocked events and properties? **
108-
109-
When an event or property is blocked, the name of the event or property will be added to your Schema page, but no data will be tracked. By default, data from blocked events and properties is not recoverable. You can always re-enable the event or property if you want to begin tracking it going forward.
110-
111-
If you're concerned about permanently discarding data from blocked events, you can use advanced settings to forward these events to a designated Source. From there, you can send your data to a separate S3 bucket or warehouse for further analysis. That way if you decide you _do_ want the data in your downstream tools, you can ask Segment to Replay the data into your server-side Destinations. If you choose to route blocked events, this will contribute to your MTU count. 
112-
113-
**How do I forward blocked events?**
114-
115-
First, you will want to create a new Source to receive data from blocked Events and Traits. This Source should only be configured to received blocked data, so make sure it isn't receiving data from anywhere else. We recommend creating a new "Javascript" source and naming it "Blocked Data from \[Source Name\]." 
116-
117-
After you have created a new source, go to the Schema page for your primary Source and then select "General" from the left-hand navigation. Under "Advanced Settings," you will see two options:
118-
119-
* Block and discard: select this option if you want to permanently discard data from blocked Events and Traits.
120-
121-
* Forward: select this option if you would like to forward data from blocked Events and Traits to a separate source.
122-
123-
124-
Select "Forward," and then select the new Source you created to receive blocked data. **As a reminder, if you choose to route blocked events, this will contribute to your MTU count. **
125-
126-
## **How am I charged for blocked events? **
127-
128-
Your bill is based on the number of Monthly Tracked Users (MTU). MTUs are the number of identified and anonymous users that you track with Segment. We only count users once per month, even if they perform multiple actions across your site or app. In most cases, blocked events will have no impact on your MTU count. If you choose to route blocked events, this will contribute to your MTU count. 
129-
130-
## **How do I configure notifications?**
131-
132-
While protecting the integrity of your data is helpful, we also want to flag any blocked events for you, so you can make any needed changes in your code or approve a new event. Source notifications will alert you when a new event is blocked due to your Schema Defaults. You can view these notifications in the Activity Feed in the app or subscribe to email notifications. 
133-
134-
You can view these notifications in the Activity Feed in the app or subscribe to email notifications. To subscribe to email notifications, go to your workspace settings, then click "Notification Settings," and subscribe to notifications for Sources by entering your email address and clicking "Save Changes." You can enter multiple email addresses separated by a comma.
135-
136-
## **When should I lock my schema? **
137-
138-
Whether you're just about to implement a new spec or you have been tracking the same events for years, Schema Defaults make it easy to protect your data and fix data quality issues.
139-
140-
Here are a few signs you may be ready to lock your schema:
141-
142-
* You are concerned about developers implementing rogue events
143-
144-
* You want to actively approve which events are tracked and routed to your downstream Destinations
145-
146-
* You have created a tracking plan and want to use Segment to enforce it

src/guides/filtering-data.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -68,25 +68,6 @@ The events filtered out of individual destinations using this method still arriv
6868

6969
**Integration filters are all-or-nothing for each event.** If you require more detailed control over which events are sent to specific destinations, you can use Destination Filters to inspect the event payload, and conditionally drop the data or forward it to the destination.
7070

71-
## Schema Defaults
72-
73-
Schema defaults allow you to prevent unexpected or malformed data from a Source from getting into your downstream destinations. When you set your Schema Defaults to **Block**, Segment automatically prevents new Events from being sent to destinations. You can activate this for new events (including `track`, `page`, and `screen` events) or for new `identify` traits and `group` properties.
74-
75-
Data blocked using schema defaults is permanently discarded, and cannot be recovered or replayed through Segment. You can forward blocked data to a new Source, but these events count toward your account MTU limits, and may not be worth saving.
76-
77-
Schema Defaults are only available to Business Tier customers.
78-
79-
You can find the Schema Defaults in the **Settings** tab for each Source, in **Schema Configuration** section.
80-
81-
![](images/schema-defaults.png)
82-
83-
**Schema Defaults Blocking Limitations**
84-
You cannot use Schema defaults if the source is connected to a Tracking Plan. If you're using Protocols and Tracking Plans, use [Protocols Tracking Plan Blocking](#protocols-tracking-plan-blocking-and-property-omission) to perform the same blocking. Learn more in the [Protocols Schema Configuration documentation](/docs/protocols/enforce/schema-configuration/).
85-
86-
**Track** events blocked by Schema filters are not delivered to either device-mode or cloud-mode Destinations. That means if you send a blocked event from a client-side library like Analytics.js, it is not delivered to any device-mode Destinations.
87-
88-
**Identify** and **Group** call traits blocked by Schema filters are **only** blocked from delivering to cloud-mode Destinations. Since device-mode destinations are connected directly to the user's device and don't pass through the Segment filters first, they still receive all traits regardless of whether they are blocked in the Segment Schema.
89-
9071
## Schema Event Filters
9172

9273
You can use Schema Event Filters to discard and permanently remove Page, Screen and Track events from event-based sources, preventing them from reaching any destinations or warehouses. Use this if you know that you'll never want to access this data again. This functionality is similar to filtering with the Integrations object, however it can be changed from within the Segment app without touching any code.

src/protocols/schema.md

Lines changed: 0 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -54,78 +54,3 @@ Segment Business tier customers can block track calls from delivering to specifi
5454

5555

5656
![](images/asset_d3SRmkWy.gif)
57-
58-
## Schema Defaults
59-
60-
Whether you're just about to implement a new spec or you have been tracking the same events for years, Schema Defaults make it easy to protect your data and fix data quality issues.
61-
62-
Schema Defaults offers a quick and easy way to prevent unexpected or erroneous events from reaching your destinations. When you set Schema Defaults to **Block**, Segment automatically prevents new calls from being sent downstream. You can activate this for new events—including `track`, `page`, and `screen` calls, or for new `identify` traits and `group` properties.
63-
64-
Locking your schema only takes a few seconds and prevents new rogue events from polluting your Destinations. To configure Schema Defaults, go to your source Settings page, and select **Schema Configuration** from the left-hand navigation.
65-
66-
### When should I lock my schema?
67-
68-
Here are a few signs you may be ready to lock your schema:
69-
70-
- You are concerned about developers implementing rogue events
71-
- You want to actively approve which events are tracked and routed to your downstream Destinations
72-
- You have created a tracking plan and want to use Segment to enforce it
73-
74-
![](images/asset_A8jUVuph.gif)
75-
76-
77-
### Overview of Schema Default settings
78-
79-
| Setting | Allow | Block |
80-
| -------------------- | -------------------------------------------------------------------- | --------------------------------- |
81-
| New Events | All new events are allowed in Segment and sent to all Destinations.| No new events are allowed in Segment or sent to your cloud and device-mode Destinations. Any event that is already being tracked and part of your Schema is not impacted. |
82-
| New Group Properties | All new group properties are allowed in Segment and sent to all Destinations. | No new group properties are allowed in Segment or sent to your cloud-mode Destinations. Device-mode destinations **do** receive blocked traits. |
83-
| New Identify Traits | All new identify traits are allowed in Segment and sent to all Destinations. | No new identify traits are allowed in Segment or sent to your cloud-mode Destinations. Device-mode destinations **do** receive blocked traits.|
84-
85-
86-
### Schema Default Blocking support across connection modes
87-
88-
Track events blocked by Schema filters are prevented from delivering to both device-mode and cloud-mode Destinations. That means if you send a blocked event from a client side library like Analytics.js, it is not delivered to any device-mode Destinations.
89-
90-
Identify and group call traits blocked by Schema filters **only** blocked from delivering to cloud-mode Destinations. Device-mode destinations receive all traits regardless of whether they are blocked in Schema.
91-
92-
93-
94-
### What is considered a "new" event?
95-
96-
New events refer to events that have not previously been sent to a given Source. Let's say you've only sent the following events from your Javascript source:
97-
98-
- `Products Searched`
99-
100-
- `Product List Viewed`
101-
102-
- `Product List Filtered`
103-
104-
Your Schema Default setting does not block these three events because they are not considered new. You can manually block them, but your Schema Default setting does not change the status of these events. 
105-
106-
Here's what happens the first time a new event, `Promotion Viewed`, is sent to this Source:
107-
108-
- **Schema Default Set to Allow:** `Promotion Viewed` is allowed, which means the event is sent to all enabled Destinations.
109-
110-
- **Schema Default Set to Block:** `Promotion Viewed` is blocked, which means the event is not sent to any Destinations.
111-
112-
113-
## Blocked Track Event forwarding
114-
115-
If you're concerned about permanently discarding blocked track events, you can forward blocked track events to a new Segment Source. To enable, go to Source Settings > Schema Configuration and select which Source you want to forward track events to from the drop down. We recommend [creating a new Source](https://segment.com/docs/guides/general/what-is-a-source/) for forwarded events to avoid contaminating production data.
116-
117-
![](images/advanced-settings.png)
118-
119-
**NOTE: Only blocked `.track()` events are forwarded to the source. `.identify()` and `.group()` events are not forwarded.**
120-
121-
**BILLING NOTE: Events forwarded to a Segment Source count towards your MTU counts. Blocking and discarding events do not contribute to your MTU counts.**
122-
123-
## Blocked event billing
124-
125-
Your bill is based on the number of Monthly Tracked Users (MTU). MTUs are the number of identified and anonymous users that you track with Segment. We only count users once per month, even if they perform multiple actions across your site or app. In most cases, blocked events have no impact on your MTU count as they are not stored or sent downstream. If you enable Blocked Event Forwarding, the forwarded events contribute to your MTU count.
126-
127-
## Blocked event notifications
128-
129-
While protecting the integrity of your data is helpful with event blocking and Schema Defaults, we offer proactive notifications to flag new blocked events so you can make any needed changes in your code or approve a new event.
130-
131-
Your workspace notifications alert you when a new event is blocked due to your Schema Defaults. You can enable notifications in the [Notification Settings](https://app.segment.com/goto-my-workspace/settings/notifications) of your workspace.

src/protocols/validate/connect-sources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ With your Tracking Plan is complete, it's time to apply the Tracking Plan to one
1313

1414
From this menu, you will be redirected to a workflow to select a Source from your workspace. Note that a Source can only have one tracking plan applied to it. You *can't* select a Source that already has a Tracking Plan connected to it, but you *can* apply a Tracking Plan to multiple sources.
1515

16-
After selecting a Source, you will be shown the consequences of connecting your Tracking Plan. In many cases, there will be no consequences. However, if you've enabled Schema Defaults, events previously allowed will now be blocked if they are not included in the Tracking Plan. If you've blocked specific events, those events will now be allowed until you enable Blocking in the Tracking Plan settings.
16+
After selecting a Source, you will be shown the consequences of connecting your Tracking Plan.
1717

1818
**IMPORTANT: Make sure to read through the consequences of connecting a source!**
1919

0 commit comments

Comments
 (0)