Telemetry关键技术

syntax = "proto3";                          //proto版本定义为v3版本。
package huawei_dialout;                     //本包名称为huawei_dialout。
service gRPCDataservice {                   //服务名称为gRPCDataservice。
    rpc dataPublish(stream serviceArgs) returns(stream serviceArgs) {};                 //方法为dataPublish，双向流，提供数据推送方法。入参是serviceArgs数据流。
}
message serviceArgs {                       //消息格式描述。
    int64 ReqId = 1;                        //请求ID，GPB编码时编号为1。
    oneof MessageData {
        bytes data = 2;         //表示承载GPB编码格式的采样数据。
        string data_json = 4;   //表示承载JSON编码格式的采样数据。
    }
    string errors = 3;         //产生错误时的描述信息，GPB编码时编号为3。
}

syntax = "proto3";                   //proto版本定义为v3版本。
package huawei_dialin;               //本包名称为huawei_dialin。
service gRPCConfigOper {             //服务名称为gRPCConfigOper。
    rpc Subscribe(SubsArgs) returns(stream SubsReply) {};  //方法为Subscribe，服务端流模式，提供动态订阅方法。入参SubsArgs包含订阅的参数。
    rpc Cancel(CancelArgs) returns(CancelReply) {};  //方法为Cancel，一问一答模式，提供取消动态订阅方法。入参CancelArgs包含取消订阅的参数。
}
message Path {                //Path消息结构。
    string path = 1;          //订阅的sensor-path。
}
message SubsArgs {            //订阅请求参数。
    uint64 request_id = 1;    //请求ID，由调用者传入。
    uint32 encoding = 2;      //编码类型。0：GPB编码；1：JSON编码。
    repeated Path path = 5;   //订阅的path结构。
    uint64 sample_interval = 6;  //采样周期。
    uint64 heartbeat_interval = 7;  //冗余抑制的抑制周期，当suppress_redundant为1时才生效。
    bool suppress_redundant = 8;  //冗余抑制，当数据内容不变时，抑制采样数据上报。0：不启用；1：启用。
}
message SubsReply {               //订阅响应参数。
    uint32 subscription_id = 1;   //成功返回订阅ID，失败返回0。
    uint64 request_id = 2;        //带回对应订阅请求的request_id。
    string response_code = 3;     //返回码，成功为200。
    oneof MessageData {
        bytes message = 4;        //表示承载GPB编码格式的采样数据。
        string message_json = 5;  //表示承载JSON编码格式的采样数据。
    }
}
message CancelArgs {              //取消订阅请求参数。
    uint64 request_id = 1;        //请求ID，由调用者传入。
    uint32 subscription_id = 2;   //需要取消的订阅ID。
}
message CancelReply {             //取消订阅响应参数。
    uint64 request_id = 1;        //请求ID，由调用者传入。
    string response_code = 2;     //返回码，成功为200。
    string message = 3;           //错误描述。
}

syntax = "proto3";         //proto版本定义为v3版本。
package telemetry;         //本包名称为telemetry。
message Telemetry {        //Telemetry消息结构定义。
   string node_id_str = 1;    //设备名称。
   string subscription_id_str = 2;   //订阅名称，静态配置订阅时的订阅名称，GPB编码时编码为2。
   string sensor_path = 3;           //订阅路径，GPB编码时编码为3。
   string proto_path = 13;           //采样路径path对应在proto文件中的message路径。
   uint64 collection_id = 4;         //标识采样轮次，GPB编码时编码为4。
   uint64 collection_start_time = 5;//标识采样轮次开始时间，GPB编码时编码为5。
   uint64 msg_timestamp = 6;        //生成本消息的时间戳，GPB编码时编码为6。
   TelemetryGPBTable data_gpb = 7; //承载的数据由TelemetryGPBTable定义，GPB编码时编码为7。
   uint64 collection_end_time = 8;  //标识采样轮次结束时间，GPB编码时编码为8。
   uint32 current_period = 9;       //采样精度，单位是毫秒，GPB编码时编码为9。
   string except_desc = 10;        //异常描述信息，采样异常时用于上报异常信息，GPB编码时编码为10。
   string product_name = 11;       //产品名称。
   enum Encoding {
    Encoding_GPB = 0;        //表示GPB数据编码格式。
    Encoding_JSON = 1;       //表示JSON数据编码格式。
  };
  Encoding encoding =12;    //数据编码格式。为GPB时，data_gpb字段有效，否则data_str字段有效。
  string data_str = 14;   //数据编码非GPB时有效，否则为空。
}
message TelemetryGPBTable {           //TelemetryGPBTable消息结构定义。
  repeated TelemetryRowGPB row = 1;     //数组定义，标识数据是TelemetryRowGPB结构的重复，GPB编码时编码为1。
}
message TelemetryRowGPB {
uint64 timestamp = 1;            //采样当前实例的时间戳，GPB编码时编码为1。
bytes content = 11;              //承载的采样实例数据，GPB编码时编码为11，需要结合sensor_path字段，才可以判断此处会以哪个proto文件编码。
}
message TelemetrySelfDefinedEvent {
  string path = 1;         //触发自定义事件的采样路径，描述content的解析方法。
  string proto_path = 13;  //采样路径path对应在proto文件中的message路径。
  uint32 level = 2;        //自定义事件的级别。
  string description = 3;  //自定义事件的描述信息。
  string fieldName = 4;    //触发自定义事件的字段名称。
  uint32 fieldValue = 5;   //触发自定义事件时该字段的取值。
  TelemetrySelfDefineThresTable data_threshold = 6;  //触发自定义事件时阈值过滤条件。
  enum ThresholdRelation {
      ThresholdRelation_INVALID = 0; //未配置多个阈值条件间关系。
      ThresholdRelation_AND = 1; //阈值间关系为与。
      ThresholdRelation_OR = 2; //阈值间关系为或。
  }
  ThresholdRelation thresholdRelation = 7;   //触发自定义事件时多个阈值过滤条件间关系。
  bytes content = 8;       //触发自定义事件的采样数据内容。
}
message TelemetrySelfDefineThresTable {
  repeated TelemetryThreshold row = 1;   //包含多个阈值条件。
}
message TelemetryThreshold {
  uint32 thresholdValue = 1;  //配置下发的阈值。
  enum ThresholdOpType {
      ThresholdOpType_EQ = 0; //上送数据的实际值等于配置数据阈值。
      ThresholdOpType_GT = 1; //上送数据的实际值大于配置数据阈值。
      ThresholdOpType_GE = 2; //上送数据的实际值大于等于配置数据阈值。
      ThresholdOpType_LT = 3; //上送数据的实际值小于配置数据阈值。
      ThresholdOpType_LE = 4; //上送数据的实际值小于等于配置数据阈值。
  }
  ThresholdOpType thresholdOpType = 2; //表示设备上的阈值条件。
}