@artsy/cohesion

团结

Artsy的分析计划

• 状态 : 发展中
• GitHub : (中文(简体) ) https://github.com/artsy/cohesion (英语)
• 文档 : https://cohesion.artsy.net (中文(简体) )
• 锡族数字 : https://circleci.com/gh/artsy/cohesion (英语)
• 国家预防机制数字 : 软件包的更新在成功与主机合并时自动发布. 加那利在PR上可以从特色分支获得.
• 点数人数字 : 韩德, (中文(简体) ), 穆尼尔

捐款

所需经费: 雅伦

设置 :

yarn install

运行测试 :

yarn test

生成文件 :

yarn docs

要在本地查看文件, 请访问全部文件路径 docs/index.html 在浏览器中,即, file:///Users/<MY_USER>/<MY_LOCAL_DIRECTORY>/cohesion/doc/index.html

司马

这个 /Schema 目录代表了Arthy的分析方案,并描述了对Redshift和September所消耗数据的期望.

这个计划由Artsy的数据团队维护,工程师不应该期望会更改这些文件.

有效分析事件描述于 /Schema/Events/index.ts和单个事件计划 Schema/Events 目录, 由关切分隔 .

全部允许的值的打字, 如 ContextModule,出口给工程师用于消耗项目.

添加新事件到计划( 用于数据分析)

1. 单位 Schema/Events,添加新事件的名称。 这个名称定义了Redshift中相应的下游表的名称,并且应该使用 lowerCamelCase 命名大会.

// Schema/Events/index.ts

export enum ActionType {
  ...
  myNewEvent = "myNewEvent",
  ...
}

2. 单位 Schema/Events 目录,创建新的界面,描述新事件的形状,因为它是在部分/红移中接收的.

• 界面名称应当匹配 ActionType 在步骤1中创建,但使用 UpperCamelCase 命名大会.
• 这个 action 键需要,并且应当匹配 ActionType 在步骤1中创建.
• 如果您的事件使用了尚未在计划中使用的值, 如新 ContextModule,将新值添加到Schema目录中的现有打字.

// Schema/Events/MyNewEvent.ts

export interface MyNewEvent {
  action: ActionType.myNewEvent
  context_module: ContextModule
  optional_property?: string
  required_property: number
}

3. 单位 Schema/Events/index.ts,在有效事件主列表中添加新界面, Event

4. 添加带有示例的描述性注释来解释您新事件的用途 。 我们的文档是从编码注释中自动生成的,请在 typedoc 文档。 。 。 .

5. 如果您创建了任何新文件,请向 Schema/index.ts 像这样:

// Schema/index.ts

export * from "./Events/MyNewEvent"

6. 公关你的变化。 合并后, 将更新计划, 您的新事件和值将提供给此套件的消费者 .