forked from apache/hertzbeat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
app-api.yml
330 lines (328 loc) · 11.2 KB
/
app-api.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.
# 此监控类型所属类别:service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控
category: service
# 监控应用类型名称(与文件名保持一致) eg: linux windows tomcat mysql aws...
app: api
# The app api i18n name
# app api国际化名称
name:
zh-CN: HTTP API
en-US: HTTP API
# app api所需输入参数定义(根据定义渲染页面UI)
# Input params define for app api(render web ui by the definition)
params:
# field-param field key
# field-变量字段标识符
- field: host
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 主机Host
en-US: Host
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: host
# required-true or false
# 是否是必输项 true-必填 false-可选
required: true
# field-param field key
# field-变量字段标识符
- field: port
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 端口
en-US: Port
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: number
# when type is number, range is required
# 当type为number时,用range表示范围
range: '[0,65535]'
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: true
# default value
# 默认值
defaultValue: 80
# field-param field key
# field-变量字段标识
- field: method
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 请求方式
en-US: Method
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: radio
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: true
# when type is radio checkbox, use option to show optional values {name1:value1,name2:value2}
# 当type为radio单选框, checkbox复选框时, option表示可选项值列表 {name1:value1,name2:value2}
options:
- label: GET
value: GET
- label: POST
value: POST
- label: PUT
value: PUT
- label: DELETE
value: DELETE
# field-param field key
# field-变量字段标识
- field: uri
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 相对路径
en-US: URI
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: text
# when type is text, use limit to limit string length
# 当type为text时,用limit表示字符串限制大小
limit: 200
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# 参数输入框提示信息
# param field input placeholder
placeholder: 'Website uri path(no ip port) EG:/v2/book/bar'
# field-param field key
# field-变量字段标识
- field: ssl
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 启用HTTPS
en-US: HTTPS
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: boolean
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: true
# field-param field key
# field-变量字段标识
- field: timeout
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 超时时间(ms)
en-US: Timeout(ms)
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: number
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# hide param-true or false
# 是否隐藏字段 true or false
hide: true
# field-param field key
# field-变量字段标识
- field: headers
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 请求Headers
en-US: Headers
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: key-value
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# when type is key-value, use keyAlias to config key alias name
# 当字段类型为key-value时, 使用keyAlias配置key的展示别名
keyAlias: Header Name
# when type is key-value, use valueAlias to config value alias name
# 当字段类型为key-value时, 使用valueAlias配置value的展示别名
valueAlias: Header Value
# field-param field key
# field-变量字段标识
- field: params
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 查询Params
en-US: Params
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: key-value
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# when type is key-value, use keyAlias to config key alias name
# 当字段类型为key-value时, 使用keyAlias配置key的展示别名
keyAlias: Param Key
# when type is key-value, use valueAlias to config value alias name
# 当字段类型为key-value时, 使用valueAlias配置value的展示别名
valueAlias: Param Value
# field-param field key
# field-变量字段标识
- field: contentType
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: Content-Type
en-US: Content-Type
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: text
# 参数输入框提示信息
# param field input placeholder
placeholder: 'Request Body Type'
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# hide param-true or false
# 是否隐藏字段 true or false
hide: true
# field-param field key
# field-变量字段标识
- field: payload
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 请求BODY
en-US: BODY
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: textarea
# 参数输入框提示信息
# param field input placeholder
placeholder: 'Available When POST PUT'
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# hide param-true or false
# 是否隐藏字段 true or false
hide: true
# field-param field key
# field-变量字段标识
- field: authType
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 认证方式
en-US: Auth Type
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: radio
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# hide param-true or false
# 是否隐藏字段 true or false
hide: true
# when type is radio checkbox, use option to show optional values {name1:value1,name2:value2}
# 当type为radio单选框, checkbox复选框时, option表示可选项值列表 {name1:value1,name2:value2}
options:
- label: Basic Auth
value: Basic Auth
- label: Digest Auth
value: Digest Auth
# field-param field key
# field-变量字段标识
- field: username
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 用户名
en-US: Username
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: text
# when type is text, use limit to limit string length
# 当type为text时,用limit表示字符串限制大小
limit: 20
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# hide param-true or false
# 是否隐藏字段 true or false
hide: true
# field-param field key
# field-变量字段标识
- field: password
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 密码
en-US: Password
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: password
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# hide param-true or false
# 是否隐藏字段 true or false
hide: true
# field-param field key
# field-变量字段标识
- field: keyword
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 关键字计数
en-US: Keyword Num
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: text
# 参数输入框提示信息
# param field input placeholder
placeholder: 'Input Keyword'
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# hide param-true or false
# 是否隐藏字段 true or false
hide: true
metrics:
- name: summary
priority: 0
fields:
- field: responseTime
type: 0
unit: ms
- field: keyword
type: 0
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: ^_^uri^_^
timeout: ^_^timeout^_^
method: ^_^method^_^
ssl: ^_^ssl^_^
payload: ^_^payload^_^
headers:
content-type: ^_^contentType^_^
^_^headers^_^: ^_^headers^_^
params:
^_^params^_^: ^_^params^_^
authorization:
type: ^_^authType^_^
basicAuthUsername: ^_^username^_^
basicAuthPassword: ^_^password^_^
digestAuthUsername: ^_^username^_^
digestAuthPassword: ^_^password^_^
parseType: website
keyword: ^_^keyword^_^