API Reference
apiKey
必填项。
用于发送到 Ohbug 的 API key。每个 apiKey 对应一个 Ohbug 项目。
Ohbug.setup({ apiKey: 'YOUR_API_KEY' })
appVersion
选填项。
应用版本。建议提供应用的版本号/标识符，这对找出引入时间和修复错误十分有帮助。
Ohbug.setup({ appVersion: '8.88.8' })
appType
选填项。
应用类型。如果您多个应用向同一个 Ohbug 项目报告，则可能需要一个标识来区分不同的项目。
Ohbug.setup({ appType: 'client' })
releaseStage
选填项。默认值：production
如果你想区分应用的不同环境（development，production 等），可以设置 releaseStage。
Ohbug.setup({ releaseStage: 'production' })
当然如果你使用了 webpack、rollup 等打包工具，可以直接使用环境变量 NODE_ENV。
Ohbug.setup({ releaseState: process.env.NODE_ENV })
endpoint
选填项。默认值：http://localhost:6660
默认情况下 Ohbug 将所有的 Event 上报至 http://localhost:6660，当然这个 url 可以通过 endpoint 修改。
Ohbug.setup({ endpoint: 'http://localhost:6660' })
maxActions
选填项。默认值：30
将要存储的最大 Action 数。一旦达到最大阈值，最老的 Action 将被删除。
Ohbug.setup({ maxActions: 30 })
为了防止
Action数过大导致Event数据量太过庞大，maxActions设置了最大值100
有关更多
Action相关的文档，可见 Actions
onEvent (hooks)
选填项。默认值：event => event
如果你需要在上报前对 Event 进行修改亦或是阻止上报，onEvent 提供了做到这些事情的能力。
Ohbug.setup({
onEvent: (event, client) => {
// do something
return event
},
})
如果需要阻止上报，在 onEvent 内返回 null 即可。
Ohbug.setup({
onEvent: (event, client) => {
// do something
if (condition) {
// 将阻止上报
return null
}
return event
},
})
请谨慎使用
onEvent回调，在 Ohbug 的扩展系统设计中，当前扩展onEvent所返回的内容将传递给下一个插件。
onNotify (hooks)
选填项。默认值：() => {}
满足你上报后做一些事情的需求。
Ohbug.setup({
onNotify: (event, client) => {
// do something
},
})
logger
选填项。默认值：
const prefix = 'Ohbug'
export const logger = {
log(...args: any[]) {
console.log(prefix, ...args)
},
info(...args: any[]) {
console.info(prefix, ...args)
},
warn(...args: any[]) {
console.warn(prefix, ...args)
},
error(...args: any[]) {
console.error(prefix, ...args)
},
}
默认情况下 Ohbug 产生的日志消息带有 Ohbug 前缀。您可以自定义自己的 logger，或者设置 logger: null 来关闭日志输出。
如果提供 logger，则它必须具有以下方法：log, info, warn, error。
// 关闭日志输出
Ohbug.setup({ logger: null })
// 使用自定义 logger
const myLogger = {
log: function () {},
info: function () {},
warn: function () {},
error: function () {},
}
Ohbug.setup({ logger: myLogger })
user
选填项。
user 选项用于区分不同的用户。它接受如下的数据格式，另外限制最多有 6 项属性。
Ohbug.setup({
user: {
id: '1',
name: 'Ohbug',
email: 'test@ohbug.net',
},
})
有关更多修改
user相关的内容，可参考 更改用户数据
metaData
选填项。
如果你有任何希望与 Event 一起上报的数据，使用 metaData。
Ohbug.setup({
metadata: {
dataType: {
name: 'test_name',
},
},
})
有关更多修改
metaData相关的内容，可参考 Metadata