Skip to content

Commit a485cb5

Browse files
Merge pull request #6865 from segmentio/bcaudillo-patch-7
Add to Protocols FAQ
2 parents d55c280 + dea5928 commit a485cb5

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

src/protocols/faq.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,39 @@ Blocking events within a [Source Schema](/docs/connections/sources/schema/) or [
181181

182182
Warehouse connectors don't use data type definitions for schema creation. The [data types](/docs/connections/storage/warehouses/schema/#data-types) for columns are inferred from the first event that comes in from the source.
183183

184+
### Why are unplanned properties not showing up as blocked in my Source Schema, even though I've set the Schema Configuration to omit them?
185+
186+
Next to the Event Name column in your [Source Schema](/docs/connections/sources/schema/) are two columns: Allowed and Blocked. If you configure your [Schema Configuration](https://segment.com/docs/protocols/enforce/schema-configuration/) to Block Unplanned Events and Omit Properties, the Source Schema only shows a property or trait as blocked when the _entire event is blocked_ because it’s unplanned and not part of the Tracking Plan. The Block Unplanned Events and Omit Properties settings are only be enforced if the property is an unplanned name, not an unplanned value.
187+
188+
To show a blocked value for a property/trait in your Source Schema, you'll need to trigger a violation, which can only be done using the JSON Schema. Once you configure your Schema Configuration to Omit Properties, the property or trait is shown as blocked.
189+
190+
See an example payload below:
191+
192+
```json
193+
"protocols": {
194+
"omitted": [
195+
"newProperty"
196+
],
197+
"omitted_on_violation": [
198+
"integer",
199+
"string"
200+
],
201+
"sourceId": "1234",
202+
"violations": [
203+
{
204+
"type": "Invalid Type",
205+
"field": "properties.integer",
206+
"description": "Invalid type. Expected: integer, given: number"
207+
},
208+
{
209+
"type": "Invalid Type",
210+
"field": "properties.string",
211+
"description": "Invalid type. Expected: string, given: integer"
212+
}
213+
]
214+
```
215+
![A screenshot of the Source Schema page, with an event expanded to display a blocked property, newProperty.](images/protocols-faq-blocked-events.png)
216+
184217
### Can I use schema controls to block events forwarded to my source from another source?
185218

186219
You can only use schema controls to block events at the point that they are ingested into Segment. When you forward an event that Segment has previously ingested from another source, that event bypasses the pipeline that Segment uses to block events and cannot be blocked a second time.
Loading

0 commit comments

Comments
 (0)