米萨-基尼斯

提供一个接口来创建发送到AWS Kinesis的跟踪事件.

所需资源

• 节点 第18段,国家预防机制版本第10段

发展

安装依赖性 :

npm install @babbel/miza-kinesis --save

构建

npm run build

测试

npm test

使用量

跟踪单个事件配置 :

const config = {
  appName: 'application-name',
  kinesisStream: {
    arn: 'Kinesis arn',
    connectTimeout: 1000,
    maxRetries: 10,
  },
  ipv4: '127.0.0.1', // optional
  endpoint: 'http://localhost:4568', // localstack only
};

代码示例

const events = require('@babbel/miza-kinesis');

const emitEvent = events(config);

const event = {
  name: 'request:performed',
  meta: {
    // ...
  },
  // ... more
};

try {
  const data = await emitEvent(event);
  console.log(data)
}
catch(error) {
  console.error(error);
}

用于跟踪多个事件的配置 :

const config = {
  appName: 'application-name',
  kinesisStream: {
    arn: 'Kinesis arn',
    httpOptions: {
      connectTimeout: 1000,
      timeout: 1000,
    },
    maxRetries: 10,
  },
  ipv4: '127.0.0.1', // optional
  endpoint: 'http://localhost:4568', // localstack only
  type: 'BATCH',
};

代码示例

const events = require('@babbel/miza-kinesis');

const emitEvent = events(config);

const events = [
  {
    name: 'request:performed',
    meta: {
      // ...
    },
  },
  {
    name: 'data:saved',
    meta: {
      // ...
    },
  },
];

try {
  const data = await emitEvent(event);
  console.log(data)
}
catch(error) {
  console.error(error);
}

配置格式如下:

• appName - 说吧 所需经费 在事件元数据中添加,以通知其来源
• kinesisStream.arn - 说吧 所需经费 Kinesis ARN 事件发送地点
• kinesisStream.httpOptions - 说吧 选项 在 AWS SDK 中指定的 https://docs.aws.amazon.com/AWS-JavaScriptSDK/latest/AWS/Kinesis.html 页面存档备份,存于互联网档案馆
• kinesisStream.maxRetries - 说吧 选项 尝试请求的最大重试量。 见AWS. Kinesis.max 检索更多信息.
• config.maxRetries 尝试失败请求的最大重试量.
• ipv4 - 说吧 选项 发送事件的机器 ip
• endpoint - 说吧 仅本地存储 我们建议在开发环境中 使用本地软件服务 Kinesis( 来自 Localstack) 将在地点响应 http://localhost:4568。为了与 Kinesis 合作,需要向 AWS-sdk 配置提供位置(端点).
• partitionKey - 说吧 选项 用于在流中以硬度组合数据的密钥.

emitEvent 返回以下任何一种格式的数据: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Kinesis.html#putRecord-property (中文(简体) ) 或者说 https://docs.aws.amazon.com/AWS-JavaScriptSDK/latest/AWS/Kinesis.html#putRecords-property (中文(简体) )

event 您可以在此检查规格 : https://coeffects.incur.babbel.com/wiki/display/PM/Event+ 特写

events 一系列事件

发布新版本

为了创建发布:

1. 添加关于变化的细节 CHANGELOG.md
2. 版本的新更改
   • 手动更新版本 :
     1. 更新版本为 package.json 您的特性分支
     2. 用新版本标记最后的承诺
        1. git tag v1.x.x
        2. git push origin v1.x.x
   • 自动版本更新 :
     1. 使用 npm version
3. 合并为主!
   1. 新版本在每次合并时自动发布到 npm master

许可证

麻省理工学院有执照 见 自由主义 详细情况.