wistroni40-dmc

v1.0.12

Published

2 years ago

DMC Template

Downloads

0High
0Medium
0Low

steveylin

wistron i40 typescript

wistroni40-dmc

Install

npm i wistroni40-dmc --save

Feature

Logger
- 建立抽象日誌轉接器，提供客製日誌功能
- 建立 Log4js 日誌轉接器
Storage
- 建立備援儲存功能，提供資料保存
- 建立 Local Storage 的備援儲存功能
CRON
- 建立抽象排程執行器，提供客製設定排程工作
- 建立 ElasticSearch 查詢排程執行器
Consumer
- 建立 Consumer 抽象類別，提供客製 Consumer 轉接器
- 建立 Kafka Consumer 轉接器
- 建立 MQTT Consumer 轉接器
- 建立 CRON Consumer 轉接器
- 建立複合式 Consumer 轉接器，可插入多個轉接器，介接多個數據來源
- 建立 Consumer 資料解析策略
  - 建立 Kafka Confluent Avro 資料解析策略
  - 建立 Kafka JSON 資料解析策略
  - 建立 MQTT JSON 資料解析策略
  - 建立 ElasticSearch Hits 資料解析策略
  - 建立 ElasticSearch 聚合資料解析策略
Producer
- 建立 Producer 抽象類別，提供客製 Producer 轉接器
- 建立 Kafka Producer 轉接器
- 建立 HTTP Post 轉接器
- 建立 MQTT Producer 轉接器
Initializer
- 建立抽象初始化程序，實作該類可將要監控的數據加入至報警資料當中，同時也可以定期更新，去添加或移除不再監控範圍的資料
Alarm
- 建立抽象報警流程範本，只需繼承並實作(或覆寫)對應屬性及方法，即可發送報警
- 建立抽象報警狀態物件，只需繼承並實作對應方法，即可讓報警自動升級或解除
- 報警流程範本內建時間驅動(Timer-Driven)、資料驅動(Data-Driven)及混合驅動 (Mixin-Driven)，三種驅動報警的類型
- 報警流程範本內建失敗重新拋送機制，當上拋失敗，可設定重新拋送次數及間格時間，進行重拋
- 報警流程範本內建備援機制，當服務終止，會保存之前報警的升級紀錄，避免重新啟動後，誤拋報警資料

Example

Alarm API

Alarm 物件提供報警狀態紀錄物件以及報警流程範本

Alarm State (Abstract Class)

Alarm State 提供報警升級條件的功能，各等級的報警僅需要實作其升級或解除的邏輯，繼承 AlarmState，實作以下內容

Properties
- level
Methods
- change

import { Alarm, AlarmLevel, AlarmState } from 'wistroni40-dmc';
import { Enviroment } from '../models';
import { Level4State } from './level4.state';

/**
 * 未達報警狀態
 */
export class NoneState extends AlarmState {
  /**
   * 報警等級
   */
  public level: AlarmLevel = null;

  constructor() {
    super('NONE.STATE');
  }

  /**
   * 更新報警
   *
   * @method public
   * @param alarm 報警狀態
   */
  public change(alarm: Alarm<Enviroment>): void | Promise<void> {
    if (/** 達報警升級條件 **/)) {
      alarm.updateLevel(new Level4State());
    }
  }
}

Alarm Template (Abstract Class)

Alarm Template 提供報警流程的實作，僅需將特定 Properties 與 Methods 實作完成，即可讓報警自動升級、自動保存與自動發送

Constructor

| 參數 | 型別 | 說明 | | ------- | :---------: | :------------------------------------------- | | id | string | 報警服務 ID，同時也作為備援資料保存的 Key 值 | | options | AlarmConfig | 報警流程配置 |

import { AlarmTemplate } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * @param id      報警服務 ID
   * @param options 報警流程配置
   */
  constructor(
    protected id: string,
    protected options: AlarmConfig = new AlarmConfigEntity(),
  ) {
    super(id, options);
  }
}

Properties

alarmTrigger

報警觸發器，提供報警資料觸發機制

| 型別 | 實作 | | ------------------------------- | :--: | | AlarmTriggerStrategy<D> | ✔️ |

Timer Driven 時間驅動

作為 By Time 升級報警的驅動方式

import { AlarmTemplate, TimerTriggerStrategy } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 報警觸發器
   *
   * @description 建構值提供 CRON
   */
  protected alarmTrigger: AlarmTriggerStrategy = new TimerTriggerStrategy(
    '*/1 * * * * *',
  );
}

Data Driven 資料驅動

作為 By Status 或 By Pcs 升級報警的驅動方式

import { AlarmTemplate, DataTriggerStrategy } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 報警觸發器
   */
  protected alarmTrigger: AlarmTriggerStrategy = new DataTriggerStrategy();
}

Mixin Driven 混合驅動

結合時間驅動(Timer-Driven )與資料驅動(Data-Driven)的報警驅動方式

import { AlarmTemplate, MixinTriggerStrategy } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 報警觸發器
   */
  protected alarmTrigger: AlarmTriggerStrategy = new MixinTriggerStrategy(
    '*/1 * * * * *',
  );
}

publishedLocation

報警發送位置

| 型別 | 實作 | | ------ | :--: | | string | ✔️ |

import { AlarmTemplate } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 報警發送位置
   */
  protected publishedLocation: string;

  /**
   * @param id 報警服務 ID
   */
  constructor(protected id = 'power-meter') {
    super(id);
    this.publishedLocation = 'http://localhost:4000';
  }
}

Methods

init()

覆寫: ✔️

初始化，提供報警開始時初始狀態的功能

import { AlarmTemplate } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 初始化
   *
   * @override
   * @method public
   */
  public async init(): Promise<void> {
    // TODO
  }
}

consumer()

實作: ✔️

取得資料消費者

| 參數 | 型別 | 說明 | | ------ | :----------------------------------: | :------------- | | Return | Promise<Consumer<D>> | 回傳資料消費者 |

import { AlarmTemplate } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 取得資料消費者
   *
   * @method public
   * @return 回傳資料消費者
   */
  public async consumer(): Promise<Consumer<S>> {
    const client = mqtt.connect('mqtt://localhost:1883');
    const topic = 'wks/cim/t1/femii/alarm/dev/enviroment/#';
    return new MqttConsumerAdapter(client, topic);
  }
}

resolve()

實作: ✔️

解析消費資料，目前內建以下解析策略

MqttPayloadStrategy: MQTT 訂閱資料解析
ConfluentConsumeStrategy: Kafka Confluent Avro 資料解析
JsonConsumeStrategy: Kafka JSON 資料解析

| 參數 | 型別 | 說明 | | ------- | :----------------: | :------------------- | | message | <S> | 消費資料 | | Return | Promise<T> | 回傳解析後的消費資料 |

import { AlarmTemplate } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 解析消費資料
   *
   * @method public
   * @param message 消費資料
   * @return 回傳解析後的消費資料
   */
  public async resolve(message: S): Promise<T> {
    return new MqttPayloadStrategy().resolve(message);
  }
}

exclude()

覆寫: ✔️

該筆資料是否要排除

| 參數 | 型別 | 說明 | | ------ | :---------: | :---------------------------------------------- | | entity | <T> | 資料實體 | | Return | boolean | 回傳該筆資料是否要排除，true: 排除、false: 保留 |

import { AlarmTemplate } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 該筆資料是否要排除
   *
   * @override
   * @method public
   * @param entity 資料實體
   * @return 回傳該筆資料是否要排除
   */
  public exclude(entity: T): boolean {
    return /** 可根據資料或其他因素決定是否要保留該筆資料 */;
  }
}

keyBy()

實作: ✔️

取得資料 Key 值，該值可以做報警所需的 Sync ID

| 參數 | 型別 | 說明 | | ------ | :---------: | :-------------- | | entity | <T> | 資料實體 | | Return | string | 回傳資料 Key 值 |

import { AlarmTemplate } from 'wistroni40-dmc';

class AlarmService extends AlarmTemplate {
  /**
   * 取得資料Key值
   *
   * @method public
   * @param entity 資料實體
   * @return 回傳資料Key值
   */
  public keyBy(entity: T): string {
    return `${entity.Plant}.${entity.Building}.${entity.NAME}`;
  }
}