Skip to content

Commit 14384e4

Browse files
Merge pull request #6514 from segmentio/DOC-911
Source overview updates [DOC-911]
2 parents 9fc6e0c + 666b128 commit 14384e4

File tree

3 files changed

+22
-10
lines changed

3 files changed

+22
-10
lines changed
Binary file not shown.
Loading

src/connections/sources/index.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ analytics.identify('user_123', {
4949
{% endcomment %}
5050

5151
> info "If you don't see the source you're looking for in our catalog"
52-
> If a tool is not listed as a supported source in our [catalog](https://segment.com/catalog/){:target='_blank’}, then it is not possible to incorporate the integration out-of-the-box within a Segment workspace. However, as an alternative, you can use the [HTTP API](/docs/connections/sources/catalog/libraries/server/http-api/) source to collect data from the tool's API. You can also use [Functions](/docs/connections/functions/) to send or receive data from other tools.
52+
> If a tool is not listed as a supported source in Segment's [catalog](https://segment.com/catalog/){:target='_blank’}, then it is not possible to incorporate the integration out-of-the-box within a Segment workspace. However, as an alternative, you can use the [HTTP API](/docs/connections/sources/catalog/libraries/server/http-api/) source to collect data from the tool's API. You can also use [Functions](/docs/connections/functions/) to send or receive data from other tools.
5353
5454
## Types of sources
5555

@@ -79,18 +79,30 @@ Event streams sources collect data from your website or app to monitor user acti
7979

8080
### Source Overview
8181

82-
When viewing the Source Overview page for an event stream source, you can view a line chart and breakdown table that reflects the volume and details of the events that Segment ingested from your source.
82+
The Source Overview page for an event stream source shows you a [pipeline view](#pipeline-view) of all events Segment receives from your source, events that failed on ingest, events that are filtered at the source level, and "eligible events", which are the events that will flow into your destinations. If you select one of the steps in the pipeline view, you can see a line chart that reflects the fluctuations in volume alongside a [breakdown table](#breakdown-table) that has more details about the events impacted by the selected step.
8383

84-
You can use the time picker located on the Source Overview page to specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you’d like to see data.
84+
#### Pipeline view
8585

86-
![A screenshot of the Source Overview page for an Android source.](images/source-overview.jpeg)
86+
The pipeline view shows each of the four steps Segment encounters when processing data from your source:
8787

88-
The breakdown table displays the following details:
89-
* **Event type**: The Segment Spec event type (Track call vs. Identify call, for example).
90-
* **Event name**: The event name, provided by you or the source. You should only expect to see track calls with event names. If you see unnamed events in the breakdown table, it's because for other specs, you're either identifying users/groups or tracking what page/screen the user is on. Both of which do not have event names. The exception to this is if you provide a name in the Page call. Named Page calls also show up in this section with the name of the Page as the event name.
91-
<!-- NOT SUPPORTED IN CURRENT VERSION: ADD IN ONCE THIS IS SUPPORTED* **App version**: The app/release version, provided by you or the source-->
92-
* **Event count**: How many of each event was successfully received by your source.
93-
* **% Change**: Insight into how the event counts differ from the last comparable time range as a percentage.
88+
- **Events successfully received**: All events that Segment received from your source.
89+
- **Failed on ingest**: Events that failed at the Tracking API level. For more information about errors that might cause events to fail on ingest, see Delivery Overview's [Troubleshooting](/docs/connections/delivery-overview/#troubleshooting) documentation.
90+
- **Filtered at source**: Events that were filtered out by source schema controls, Tracking Plans, or a common JSON schema.
91+
- **Eligible events**: Eligible events are the events that flow downstream to your Segment destinations. This value is read-only, but you can see the events that flow downstream to a particular destination using [Delivery Overview](/docs/connections/delivery-overview).
92+
93+
> success ""
94+
> You can use the time picker located on the Source Overview page to specify a time period (last 10 minutes, 1 hour, 24 hours, 7 days, 2 weeks, or a custom date range over the last two weeks) for which you’d like to see data. Segment sets the time picker to show data for the last 24 hours by default.
95+
96+
![A screenshot of the Source Overview page for an Go source, with the Failed on ingest step selected.](images/source-overview.png)
97+
98+
#### Breakdown table
99+
100+
The breakdown table displays three tabs, **Event type**, **Event name**, and **App version**.
101+
* **Event type**: The Segment Spec event type (Track call vs. Identify call, for example). _This tab also contains a "% change" metric, which displays how the event counts differ from the last comparable time range, represented as a percentage._
102+
* **Event name**: The event name, provided by you or the source.
103+
* **App version**: The app/release version, provided by you or the source.
104+
105+
Each of these tabs displays an event count, which is the total number of events that Segment received in a particular step.
94106

95107
### Website libraries
96108

0 commit comments

Comments
 (0)