Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

This wiki details the architecture of enabling reporting framework to operate at scale. It discusses the high level design problems to be solved and introduces the proposed architecture for the same. 

Key Design Problems

TBA

...

Reporting Architecture

...

Druid Architecture

...

Druid Data Model

Raw Telemetry

15objectidobjectidContent Id16objecttypeobjecttypeContent Type17185354statecode


Dimension in Druid

Field in Telemetry

Description

Data Type

1etsetsEvent timestampLong
2

eid

eid

Event Id

String

3

syncts

syncts

Sync Timestamp

Long

4@timstamp@timstampSync Timestamp in StringString
5

actor_id

actor.id

Actor Id of the event

String

56

actor_type

actor.type

Type of the actor

String

67

context_channel

context.channel

Channel Id

String

78

context_pdata_id

context.pdata.id

Producer Id

String

89

context_pdata_pid

context.pdata.pid

Producer Process Id

String

910context_pdata_vercontext.pdata.verProducer version numberString
1011

context_env

context.env

Context Environment

String

1112

context_sid

context.sid

Session Id

String

1213

context_did

context.did

Device Id

String

1314

context_cdata_type

context.cdata.type

Correlation Data Type

Array[String]

1415

context_cdata_id

context.cdata.id

Correlation Data Id

Array[String]

16context_rollup_l1context.rollup.l1Context level 1 rollupString
17context_rollup_l2context.rollup.l2Context level 2 rollupString
18

object_version

object.ver

Content Version

String

context_rollup_l3context.rollup.l3Context level 3 rollupString
19context_rollup_l4context.rollup.l4Context level 4 rollupString
20

object_id

object.id

Content Id

String

21

object_type

object.type

Content Type

String

22

object_version

object.ver

Content Version

String

23object_rollup_l1object.rollup.l1Content level 1 rollupString
24object_rollup_l2object.rollup.l2Content level 2 rollupString
25object_rollup_l3object.rollup.l3Content level 3 rollupString
26object_rollup_l4object.rollup.l4Content level 4 rollupString
27

tags

tags

Tags

Array[String]

1928

edata_type

edata.type

Event type

String

2029

edata_subtype

edata.subtype

Event subtype

String

2130

edata_mode

edata.mode

START event Mode of start

String

2231

edata_pageid

edata.pageid

Unique pageid

String

2332

edata_uri

edata.uri

IMPRESSION event Relative URI of the content

String

2433

edata_id

edata.id

Event data Id

String

2534

edata_duration

edata.duration

Duration of the event

Double

2635

edata_index

edata.index

ASSESS event Index of the question within a content

Integer

2736

edata_pass

edata.pass

ASSESS event Field to identify pass or fail for assessments

String

2837

edata_score

edata.score

ASSESS event Assessment score

Double

2938

edata_resvalues

edata.resvalues

ASSESS event Assessment results

Array[Object]

3039

edata_item_id

edata.item.id

ASSESS event Assessment item id

String

3140

edata_item_title

edata.item.title

ASSESS event Assessment item title

String

3241

edata_item_maxscore

edata.item.maxscore

ASSESS event Assessment item max score

Double

3342

edata_target_id

edata.target.id

ASSESS event Assessment item target id

String

3443

edata_target_type

edata.target.type

ASSESS event Assessment item target type

String

3544

edata_rating

edata.rating

FEEDBACK event Ratings

Integer

3645

edata_comments

edata.comments

FEEDBACK event Comments

String

3746

edata_dir

edata.dir

SHARE event direction

String

3847

edata_items_id

edata.items.id

SHARE event shared item ids

Array[String]

3948

edata_items_type

edata.items.type

SHARE item types

Array[String]

4049

edata_items_origin_id

edata.items.origin.id

SHARE event source id

Array[String]

4150

edata_items_origin_type

edata.items.origin.type

SHARE event source type

Array[String]

4251

edata_items_to_id

edata.items.to.id

SHARE event destination id

Array[String]

4352

edata_items_to_type

edata.items.to.type

SHARE event destination type

Array[String]

4453

edata_state

edata.state

AUDIT event current state

String

4554

edata_prevstate

edata.prevstate

AUDIT event previous state

String

4655

edata_size

edata.size

SEARCH event result size

Integer

4756

edata_filters_dialcodes

edata.filters.dialcodes

SEARCH event List of dialcodes

Array[String]

4857edata_topn_identifieredata.topn.identifierSEARCH event topn resultsArray[String]
4958edata_visits_objidedata.visits.objidIMPRESSION event unique id for object visitedArray[String]
5059edata_visits_objtypeedata.visits.objtypeIMPRESSION event type of object visitedArray[String]
5160edata_visits_objveredata.visits.objverIMPRESSION event version of object visitedArray[String]
5261edata_visits_indexedata.visits.indexIMPRESSION event index of object within listArray[Integer]Array[Integer]
62

device_loc_state

devicedata.state

State location information for the device

String

63

device_loc_state_code

devicedata.statestatecode

State location ISO code information for the device

String

64

device_loc_iso_state_code

devicedata.iso3166statecodeState ISO-3166 code information for the deviceString
5565

device_loc_city

devicedata.city

City location information for the device

String

5666

device_loc_country_code

devicedata.countrycode

Country ISO code information for the device

String

5767

device_loc_country

devicedata.country

Country location information for the device

String

5868device_osdevicedata.osDevice OS nameString
5969device_makedevicedata.makeDevice make and modelString
6070device_iddevicedata.idPhysical device id if available from OSString
6171device_memdevicedata.memTotal memory in mbInteger
6272device_idiskdevicedata.idiskTotal interanl diskInteger
6373device_ediskdevicedata.ediskTotal external diskInteger
6474device_scrndevicedata.scrnScreen size in inchesInteger
6575device_cameradevicedata.cameraPrimary & secondary camera specString
6676device_cpudevicedata.cpuProcessor nameString
6777device_simsdevicedata.simsNumber of sim cardsInteger
6878device_uaspec_agentdevicedata.uaspec.agentUser agent of the browserString
6979device_uaspec_verdevicedata.uaspec.verUser agent version of the browserString
7080device_uaspec_systemdevicedata.uaspec.systemUser agent system identification of the browserString
7181device_uaspec_platformdevicedata.uaspec.platformUser agent client platform of the browserString
7282device_uaspec_rawdevicedata.uaspec.rawRaw user agent of the browserString
7383device_first_accessdevicedata.firstaccessFirst access of the deviceLong (Epoch)
7484content_namecontentdata.nameName of the contentString
7585content_object_typecontentdata.objecttypeType of the contentString
7686content_typecontentdata.contenttypeType of the resourceString
7787content_media_typecontentdata.mediatypeType of the media of the resourceString
7888content_languagecontentdata.languageList of languages in the contentArray[String]
7989content_mediumcontentdata.mediumLanguage medium of the boardArray[String]
8090content_mimetypecontentdata.mimetypeMimetype of the resource in the contentString
8191content_frameworkcontentdata.framework
String
8292content_boardcontentdata.boardBoard of affiliationString
8393content_statuscontentdata.statusStatus of the content - Draft, Published etc.String
8494content_versioncontentdata.pkgversionVersion of the contentDouble
8595content_last_submitted_oncontentdata.lastsubmittedonLast submitted date of the contentLong (Epoch)
8696content_last_published_oncontentdata.lastpublishedonLast submitted date of the contentLong (Epoch)
8797content_last_updated_oncontentdata.lastupdatedonLast updated date of the contentLong (Epoch)
8898user_grade_listuserdata.gradelistList of grades taughtArray[String]
8999user_language_listuserdata.languagelistList of languages knownArray[String]
90100user_subject_listuserdata.subjectlistList of subjects taughtArray[String]
91101user_typeuserdata.typeType of userString
92102user_loc_stateuserdata.stateState info of the userString
93103user_loc_districtuserdata.districtDistrict info of the userString
94104user_loc_blockuserdata.blockBlock info of the userString
95105dialcode_channeldialcodedata.channelChannel for which dialcode is generatedString
96106dialcode_batchcodedialcodedata.batchcodeBatch for which dialcode belongs toString
97107dialcode_publisherdialcodedata.publisherPublisher of the dialcodeString
98108dialcode_generated_ondialcodedata.generatedonDialcode generated onLong (Epoch)
99109dialcode_published_ondialcodedata.publishedonDialcode published onLong (Epoch)
100110dialcode_statusdialcodedata.statusStatus of the dialcodeString
101111dialcode_object_typedialcodedata.objecttypeObject type - DialCode as a valueString

Summary Events


Dimension in Druid

Field in Summary event

Description

Data Type

1etsetsEvent timestampLong
2

eid

eid

Event Id

String

3

ver

ver

Version

String

4

syncts

syncts

Sync timestamp

Long

5

uid

uid

User Id

String

6

context_date_range_from

context.date_range.from

Start Date for the summary

Long (Epoch)

7

context_date_range_to

context.date_range.to

End Date for the summary

Long (Epoch)

8

context_rollup_l1

context.rollup.l1

Context level1 rollup

String

9

context_rollup_l2

context.rollup.l2

Context level2 rollup

String

10

context_rollup_l3

context.rollup.l3

Context level3 rollup

String

11

context_rollup_l4

context.rollup.l4

Context level4 rollup

String

12

dimension_channel

dimensions.channel

Channel Id as dimension from raw telemetry

String

13

dimensions_did

dimensions.did

Device Id as dimension from raw telemetry

String

14

dimensions_pdata_id

dimensions.pdata.id

Producer Id as dimension from raw telemetry

String

15

dimensions_pdata_pid

dimensions.pdata.pid

Producer Process Id as dimension from raw telemetry

String

16dimensions_pdata_verdimensions.pdata.verProducer Process Ver as dimension from raw telemetryString
17

dimensions_sid

dimensions.sid

Session Id as dimension

String

18

dimensions_type

dimensions.type

Type of summary

String

19

dimensions_mode

dimensions.mode

Mode of action in the session

String

20

object_id

object.id

Content Id

String

21

object_type

object.type

Content Type

String

22

object_version

object.ver

Content version

String

23

object_rollup_l1

object.rollup.l1

Object level1 rollup

String

24

object_rollup_l2

object.rollup.l2

Object level2 rollup

String

25

object_rollup_l3

object.rollup.l3

Object level3 rollup

String

26

object_rollup_l4

object.rollup.l4

Object level4 rollup

String

27

tags

tags

Tags attached to a summary event

Array[String]

28

edata_time_spent

edata.eks.time_spent

Time spent in the session excluding idle time

Double

29

edata_time_difference

edata.eks.time_diff

Total time in a session including idle time

Double

30

edata_interaction_count

edata.eks.interact_events_count

Total count of interact events in a session

Long

31

edata_env_summary_env

edata.eks.env_summary.env

High level env within the app

(content, domain, resources, community)

Array[String]

32

edata_env_summary_count

edata.eks.env_summary.count

Count of times the environment has been visited

Array[Integer]

33

edata_env_summary_time_spent

edata.eks.env_summary.time_spent

Time spent per env

Array[Double]

34

edata_page_summary_id

edata.eks.page_summary.id

Page id

Array[String]

35

edata_page_summary_type

edata.eks.page_summary.type

Type of page e.g. view/edit

Array[String]

36edata_page_summary_envedata.eks.page_summary.envEnv of pageArray[String]
37

edata_page_summary_visit_count

edata.eks.page_summary.visit_count

Number of times each page was visited

Array[Integer]

38

edata_page_summary_time_spent

edata.eks.page_summary.time_spent

Time taken per page

Array[Double]

39

edata_item_responses_item_id

edata.eks.item_responses.itemId

Question Id passed in the ASSESS event

Array[String]

40

edata_item_responses_time_spent

edata.eks.item_responses.timeSpent

Time spent in seconds from ASSESS event

Array[Double]

41

edata_item_responses_pass

edata.eks.item_responses.pass

Pass response for a question from ASSESS event

Array[String]

42

edata_item_responses_score

edata.eks.item_responses.score

Score from ASSESS event

Array[Integer]

43

edata_item_responses_max_score

edata.eks.item_responses.maxScore

Max Score from ASSESS event

Array[Integer]

44

edata_item_responses_timestamp

edata.eks.item_responses.time_stamp

Timestamp for each response from ASSESS event

Array[Long (Epoch)]

45

device_loc_state

devicedata.state

State location information for the device

String

46

device_loc_state_code

devicedata.statecode

State ISO code information for the device

String

47

device_loc_iso_state_code

devicedata.iso3166statecodeState ISO-3166 code information for the deviceString
48

device_loc_city

devicedata.city

City location information for the device

String

4849

device_loc_country_code

devicedata.countrycode

Country ISO code information for the device

String

4950

device_loc_country

devicedata.country

Country location information for the device

String

5051device_osdevicedata.osDevice OS nameString
5152device_makedevicedata.makeDevice make and modelString
5253device_iddevicedata.idPhysical device id if available from OSString
5354device_memdevicedata.memTotal memory in mbInteger
5455device_idiskdevicedata.idiskTotal interanl diskInteger
5556device_ediskdevicedata.ediskTotal external diskInteger
5657device_scrndevicedata.scrnScreen size in inchesInteger
5758device_cameradevicedata.cameraPrimary & secondary camera specString
5859device_cpudevicedata.cpuProcessor nameString
5960device_simsdevicedata.simsNumber of sim cardsInteger
6061device_uaspec_agentdevicedata.uaspec.agentUser agent of the browserString
6162device_uaspec_verdevicedata.uaspec.verUser agent version of the browserString
6263device_uaspec_systemdevicedata.uaspec.systemUser agent system identification of the browserString
6364device_uaspec_platformdevicedata.uaspec.platformUser agent client platform of the browserString
6465device_uaspec_rawdevicedata.uaspec.rawRaw user agent of the browserString
6566device_first_accessdevicedata.firstaccessFirst access of the deviceLong (Epoch)
6667content_namecontentdata.nameName of the contentString
6768content_object_typecontentdata.objecttypeType of the contentString
6869content_typecontentdata.contenttypeType of the resourceString
6970content_media_typecontentdata.mediatypeType of media of the contentString
7071content_languagecontentdata.languageList of languagesArray[String]
7172content_mediumcontentdata.mediumLanguage medium of the boardString
7273content_mimetypecontentdata.mimetypeMimetype of the contentString
7374content_frameworkcontentdata.framework
String
7475content_boardcontentdata.boardBoard of affiliationString
7576content_statuscontentdata.statusStatus of the content - Draft, Published etc.String
7677content_versioncontentdata.pkgversionVersion of the contentDouble
7778content_last_submitted_oncontentdata.lastsubmittedonLast submitted date of the contentLong (Epoch)
7879content_last_published_oncontentdata.lastpublishedonLast published date of the contentLong (Epoch)
7980content_last_updated_oncontentdata.lastupdatedonLast updated date of the contentLong (Epoch)
8081user_grade_listuserdata.gradelistList of grades taughtArray[String]
8182user_language_listuserdata.languagelistList of languages knownArray[String]
8283user_subject_listuserdata.subjectlistList of subjects taughtArray[String]
8384user_typeuserdata.typeType of the userString
8485user_loc_stateuserdata.stateState info of the userString
8586user_loc_districtuserdata.districtDistrict info of the userString
8687user_loc_blockuserdata.blockBlock info of the userString
Aggregates

Granularity → DAY

Druid field name

Druid source field

Aggregate Type

total_interactions

interaction_count

SUM

total_time_spent

time_spent

SUM

total_sessionsmidCOUNT





...

Report JSON Spec

JSON Schema

Code Block
languagejs
[{
    id: String, // Required. Report ID.
    label: String, // Required. Report Label (will be shown up as menu)
    title: String, // Optional. Report title. Defaults to report label
    description: String, // Optional. Report description. HTML text can be included as description
    dataSource: String, // Required. Location of the data source to show the report. Can be an expression. For ex: /<report_id>/{{channel}}/report.json
    charts: [{ // Optional
 		datasets: [{
			data: Array[Number], // Required if `dataExpr` is not provided. Array of Number. Data points to show in the chart
			dataExpr: String, // Required if `data` is not provided. Expression pointing to the data in dataSource. For ex: {{data.noOfDownloads}}
			label: String // Required. Label to display on the chart
		}],
		labels: Array[String], // Required if `labelsExpr` is not provided. Labels to show on the x-axis
		labelsExpr: String, // Required if `labels` is not provided. Expression pointing to the data in dataSource. For ex: {{data.Date}}
		chartType: String, // Optional. Defaults to line. Available types - line, bar, radar, pie, polarArea & doughnut
		colors: [""], // Optional. Color to show for each dataset. Defaults to ["#024F9D"].
		options: { // Optional. options for display. Full set of options look at https://valor-software.com/ng2-charts/
			responsive: Boolean, // Defaults to true
			...
		}, 
		legend: Boolean // Optional. Whether to show the legend below/above the chart. Defaults to true and position to top.
    }],
    table: { // Optional
        "columns": Array[String], // Required if `columnsExpr` is not provided. Columns to show.
        "values": Array[Array[String]], // Required if `valuesExpr` is not provided. Column data.
        "columnsExpr": String, // Required if `columns` is not provided. Expression pointing to the data in dataSource. For ex: {{keys}}
        "valuesExpr": String // Required if `values` is not provided. Expression pointing to the data in dataSource. For ex: {{tableData}}
    },
    downloadUrl: String // Location to download the data as CSV
}]

...