使用手册

用户登录

需系统使用用户输入账号名称和密码,默认账号是admin inlong

User login

数据接入

数据接入模块展示目前用户权限内接入系统所有任务列表,可以对这些任务详情查看、编辑更新和删除操作。

点击【新建接入】接入流程,数据接入信息填写有两个步骤:Group 信息、数据流。

Create Group

数据流Group 信息

Group information

接入要求

接入要求需要用户进行选择消息中间件:高吞吐(TUBE)或者高可靠(PULSAR):

  • 高吞吐(InLong TubeMQ):高吞吐消息传输组件,适用于日志类的消息传递。
  • 高可靠(Apache Pulsar):高可靠消息传输组件,适用于计费等场景。

Group 信息

需要用户对接入任务填写基础数据流Group 信息。

  • Group 英文名称:统一小写英文名称,请尽量包含产品名和简洁规范,如pay_base
  • Group 中文名称:Group 的中文描述,便于使用与检索,最多128个字
  • Group 责任人:至少1人,Group 责任人可查看、修改Group 信息,新增和修改所有接入配置项
  • Group 介绍:简短对此次接入任务Group 背景和应用进行介绍:

接入规模

接入规模需要用户预先针对接入数据进行规模判断,以便后续分配计算和存储资源。

数据流

点击【下一步】进入到数据流信息填写步骤,数据流信息填写有四个模块:基础信息、数据来源、数据信息、数据流向。

在数据流流程中可以点击【新建】,创建一个新的数据流信息填写页面:

Create stream

基础信息

需用户对该接入任务中数据流的基础信息进行填写:

  • 数据流ID:前缀根据产品/项目自动生成,这在某个具体的接入中是唯一的,与数据源和入库的表中的数据流ID保持一致
  • 数据流名称:接口信息说明,长度限制为64个英文字符(对应32个中文字符)
  • 数据流责任人:数据流责任人可查看、修改数据流信息,新增和修改所有接入配置项
  • 数据流介绍:数据流简单文本介绍

数据来源

需用户选择该数据流的消息来源,目前支持文件、自主推送两种方式,并且可以在高级选项中补充该数据来源详细信息:

  • 文件:采集数据以文件形式存放,采集机器部署 InLong Agent,根据定制的策略规则进行读取
  • 自主推送:通过 SDK 向消息中间件推送数据

数据信息

需用户填写该数据流中数据相关信息:

Data info

  • 数据格式:数据来源格式,是普通文本类型,或者KV键值对数据
  • 数据编码
  • 源字段分隔符
  • 源数据字段

数据流向

需用户对此任务的流向终流向进行选择,此部分为非必填项,目前支持Hive和自主推送两种:

HIVE流向:

Hive info

  • 目标库:hive数据库名(需要提前准备创建好)
  • 目标表:hive表名
  • 一级分区:hive数据划分hdfs数据一级子目录的字段名
  • 二级分区:hive数据划分hdfs数据一级子目录的字段名
  • 用户名:hiveserver连接账户名
  • 用户密码:hiveserver连接账密码
  • HDFS url:hive底层hdfs连接
  • JDBC url:hiveserver 的jdbcurl
  • 字段相关信息: 源字段名、源字段类型、HIVE字段名、HIVE字段类型、字段描述,并支持删除和新增字段

我的申请

审批管理功能模块目前包含了我的申请和我的审批,管理系统中数据接入和数据消费申请审批全部任务。

My application

展示目前申请人在系统中数据接入、消费提交的任务列表,点击【详情】可以查看目前该任务基础信和审批进程:

申请数据接入详情

Application detail

数据接入任务详细展示目前该申请任务基础信息包括:申请人相关信息、申请接入基础信息,以及目前审批进程节点:

数据消费

数据消费目前不支持直接消费接入数据,需走数据审批流程后方可正常消费数据; 点击【新建消费】,进入数据消费流程,需要对消费信息相关信息进行填写:

消费信息

申请人需在该信息填写模块中逐步填写数据消费申请相关基础消费数据流Group 信息:

Consumer info

  • 消费组名称:消费者的简要名称,必须是小写字母、数字、下划线组成,最后审批会根据简称拼接分配出消费者名称
  • 消费责任人:自行选择责任人,必须至少2人;责任人可查看、修改消费信息
  • 消费目标数据流Group ID:需要选择消费数据的数据流Group ID,可以点击【查询】后,在弹窗页面中选择合适的数据流Group ID,如下图所示:
  • 数据用途:选择数据使用用途
  • 数据用途说明:需申请人根据自身消费场景,简要说明使用的项目和数据的用途

信息填完完成后,点击【提交】后,会将次数据消费流程正式提交待审批人审批后方可生效。