xref: /foundation/distributeddatamgr/pasteboard/pasteboardEvent.yaml

#  Copyright (c) 2022-2023 Huawei Device Co., Ltd.
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.

#####################################################
#     below is the format of defining event         #
#####################################################
#domain: domain name.  [Only one domain name can be defined at the top]
#
#author: the author name who defined this event.
#date: the date when this event was defined, format is YYYY-MM-DD.
#logged: source file which refer to this event.
#usage: the usage of this event.
#//Define event name and event properties.
#@EVENT_NAME: the event definition part begin.
#  // __BASE is used for defining the basic info of the event.
#  // "type" optional values are: FAULT, STATISTICS, SECURITY, BEHAVIOR.
#  // "level" optional values are: CRITICAL, MINOR.
#  // "tag" set tags with may used by subscriber of this event, multiple tags devided by space.
#  // "desc" full description of this event.
#  @PARAMETER: {type: parameter type, arrsize: array length(optional), desc: parameter description}.
#  // follow the __BASE block, each line defines a parameter of this event.
#  // "type" optional values are: INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, FLOAT, DOUBLE, STRING.
#  // "arrsize" of the parameter is an array, set a non-zero value.
#  // "desc" full description of this parameter.

#####################################################
#   Example of some hiviewdfx events definition     #
#####################################################

domain: PASTEBOARD

PASTEBOARD_FAULT:
  __BASE: {type: FAULT, level: CRITICAL, desc: The event is database fault }
  USER_ID: {type: INT32, desc: app id }
  FAULT_CODE: {type: STRING, desc: fault code }

TIME_CONSUMING_STATISTIC: 
  __BASE: {type: STATISTIC, level: MINOR, desc: The event is api visit statistic } 
  PASTEBOARD_STATE: {type: STRING, desc: Pasteboard state }
  NET_TYPE: {type: STRING, desc: net type }
  DATA_LEVLE: {type: STRING, desc: Data level }
  CONSUMING_DATA: {type: STRING, desc: Consuming data }

PASTEBOARD_BEHAVIOUR:
  __BASE: {type: BEHAVIOR, level: MINOR, desc: The event is behaviour record }
  PASTEBOARD_STATE: {type: STRING, desc: The counts of time consuming level one}
  TOP_ONE_APP: {type: STRING, desc: The counts of top one calling pasteboard }
  TOP_TOW_APP: {type: STRING, desc: The counts of top two calling pasteboard }
  TOP_THREE_APP: {type: STRING, desc: The counts of top three calling pasteboard }
  TOP_FOUR_APP: {type: STRING, desc: The counts of top four calling pasteboard }
  TOP_FIVE_APP: {type: STRING, desc: The counts of top five calling pasteboard }
  TOP_SIX_APP: {type: STRING, desc: The counts of top six calling pasteboard}
  TOP_SEVEN_APP: {type: STRING, desc: The counts of top seven calling pasteboard }
  TOP_EIGHT_APP: {type: STRING, desc: The counts of top eight calling pasteboard }
  TOP_NINE_APP: {type: STRING, desc: The counts of top nine calling pasteboard }
  TOP_TEN_APP: {type: STRING, desc: The counts of top ten calling pasteboard }

USE_BEHAVIOUR:
  __BASE: {type: BEHAVIOR, level: MINOR, desc: The event is behaviour record of access }
  PASTEBOARD_STATE: {type: STRING, desc: Pasteboard state }
  BOOTTIME: {type: STRING, desc: Boot time }
  WALLTIME: {type: STRING, desc: Access pasteboard time}
  RESULT: {type: INT32, desc: The result of access pasteboard }
  OPERATE_APP: {type: STRING, desc: The app to access pasteboard }
  PRI_MIME_TYPE: {type: STRING, desc: Primary mime type }
  ISLOCALPASTE: {type: INT32, desc: IsLocalPaste}
  ISREMOTE: {type: INT32, desc: IsRemote }
  SHAREOPTION: {type: STRING, desc: ShareOption }