{modelValue}
} @@ -1101,6 +1116,9 @@ const SchemaForm = defineComponent({ (isSchemaLoading.value || props.recordLoading) && typesDoNotShowSkeleton.includes(props.type), ) + const schemaFormClass = computed( + () => `schema-form ${showSkeleton.value || showLoading.value ? 'is-loading' : ''}`, + ) ;(() => { if (props.form && _.isObject(props.form) && !isEmptyObj(props.form)) { configForm.value = _.cloneDeep(props.form) @@ -1108,14 +1126,11 @@ const SchemaForm = defineComponent({ init() })() - ctx.expose({ configForm, validate, clearValidate, getInitRecord }) + ctx.expose({ configForm, validate, clearValidate, validateField, getInitRecord }) return () => { return ( -
+
-
-
import { DEFAULT_PAGE_SIZE_OPT as defaultPageSizeOpt } from '@/common/constants'
-import { computed, watch, PropType, defineProps, defineEmits } from 'vue'
import MiniPagination from './MiniPagination.vue'
import { PageData } from '@/types/common'
diff --git a/src/components/global-components.ts b/src/components/global-components.ts
new file mode 100644
index 000000000..9f11e94ac
--- /dev/null
+++ b/src/components/global-components.ts
@@ -0,0 +1,35 @@
+import CustomInputPassword from './CustomInputPassword.vue'
+import {
+ CreateButton,
+ TableButton,
+ RefreshButton,
+ SearchButton,
+ ResetButton,
+ ShowMoreButton,
+ LinkButton,
+} from './Buttons'
+import { App } from 'vue'
+
+export default {
+ install(app: App): void {
+ app.component('CustomInputPassword', CustomInputPassword)
+ app.component('CreateButton', CreateButton)
+ app.component('TableButton', TableButton)
+ app.component('RefreshButton', RefreshButton)
+ app.component('SearchButton', SearchButton)
+ app.component('ResetButton', ResetButton)
+ app.component('ShowMoreButton', ShowMoreButton)
+ app.component('LinkButton', LinkButton)
+ },
+}
+
+export {
+ CustomInputPassword,
+ CreateButton,
+ TableButton,
+ RefreshButton,
+ SearchButton,
+ ResetButton,
+ ShowMoreButton,
+ LinkButton,
+}
diff --git a/src/env.d.ts b/src/env.d.ts
new file mode 100644
index 000000000..ed6932663
--- /dev/null
+++ b/src/env.d.ts
@@ -0,0 +1,11 @@
+///
+ helpText: ComputedRef<(string | { type: string; content: string })[]>
helpCode: ComputedRef
} => {
const { t, tl } = useI18nTl('AuthDoc')
@@ -60,6 +57,14 @@ export default (context: {
mongodb: [
tl('authzMongoDBParagraph1'),
`${t('AuthDoc.authzSupportedPlaceholders', [tl('selector')])}${AUTHZ_MONGODB_PLACEHOLDERS}`,
+ tl('authzMongoDBOrderTip'),
+ {
+ type: 'code',
+ content: `{
+ "username": "\${username}",
+ "$orderby": {"info.order": 1}
+}`,
+ },
tl('dataStructureExample'),
],
postgresql: [
@@ -81,9 +86,11 @@ export default (context: {
if (!databaseType) {
return []
}
- let ret = helpTextMap[authType][databaseType]
+ let ret = helpTextMap[authType][databaseType] as (string | { type: string; content: string })[]
if (gateway) {
- ret = ret.map((item) => item.replace(AUTH_PLACEHOLDER_CLIENT_ATTRS, ''))
+ ret = ret.map((item) =>
+ typeof item === 'string' ? item.replace(AUTH_PLACEHOLDER_CLIENT_ATTRS, '') : item,
+ )
}
return ret
})
diff --git a/src/hooks/Auth/useAuthn.ts b/src/hooks/Auth/useAuthn.ts
index 5ab38a74d..2b1200bcc 100644
--- a/src/hooks/Auth/useAuthn.ts
+++ b/src/hooks/Auth/useAuthn.ts
@@ -1,12 +1,7 @@
-import type { Ref, Component } from 'vue'
-import { ref, nextTick } from 'vue'
import { listAuthn, queryAuthnItemMetrics } from '@/api/auth'
import { AuthnItem, Metrics } from '@/types/auth'
-import useSortableTable from '@/hooks/useSortableTable'
import { SortableEvent } from 'sortablejs'
-import useHandleAuthnItem from '@/hooks/Auth/useHandleAuthnItem'
-import useMove from '@/hooks/useMove'
-import useAuth from '@/hooks/Auth/useAuth'
+import jwtIcon from '@/assets/img/jwt.png'
export type AuthnItemInTable = AuthnItem & {
metrics?: Metrics
@@ -51,13 +46,9 @@ export default (): {
authnList.value = res.map((item) => {
const ret: AuthnItemInTable = item
if (ret.mechanism !== 'jwt') {
- try {
- ret.img = require(`@/assets/img/${ret.backend}.png`)
- } catch {
- ret.img = ''
- }
+ ret.img = getImg(`img/${ret.backend}.png`)
} else {
- ret.img = require(`@/assets/img/jwt.png`)
+ ret.img = jwtIcon
}
ret.metrics = metricsMap.value[ret.id]
return item
diff --git a/src/hooks/Auth/useAuthnCreate.ts b/src/hooks/Auth/useAuthnCreate.ts
index 19529643c..907946fd0 100644
--- a/src/hooks/Auth/useAuthnCreate.ts
+++ b/src/hooks/Auth/useAuthnCreate.ts
@@ -1,7 +1,3 @@
-import useSSL from '@/hooks/useSSL'
-import _ from 'lodash'
-import { getPasswordHashAlgorithmObj } from './usePasswordHashAlgorithmData'
-import useProcessAuthData from './useProcessAuthData'
import { LDAPAuthMethod } from '@/types/enum'
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
@@ -47,6 +43,7 @@ export default function useAuthnCreate() {
pool_size: 8,
connect_timeout: '15s',
request_timeout: '5s',
+ max_inactive: '10s',
enable_pipelining: 100,
ssl: createSSLForm(),
}
@@ -169,7 +166,7 @@ export default function useAuthnCreate() {
return getJwtConfig()
}
}
- const create = (config: any, backend: string, mechanism: string) => {
+ const create = (config: any, backend: string | undefined, mechanism: string) => {
let data: any = {}
if (mechanism === 'jwt') {
data = processJwtConfig(config)
@@ -188,7 +185,7 @@ export default function useAuthnCreate() {
data = processLDAPConfig(config)
break
default:
- data = _.cloneDeep(config)
+ data = cloneDeep(config)
break
}
data.backend = backend
diff --git a/src/hooks/Auth/useAuthnType.ts b/src/hooks/Auth/useAuthnType.ts
index 3a263f89f..352fb0872 100644
--- a/src/hooks/Auth/useAuthnType.ts
+++ b/src/hooks/Auth/useAuthnType.ts
@@ -1,4 +1,3 @@
-import { getLabelFromValueInOptionList } from '@/common/tools'
import { AuthnMechanismType } from '@/types/enum'
export const useAuthnMechanismType = (): {
diff --git a/src/hooks/Auth/useAuthz.ts b/src/hooks/Auth/useAuthz.ts
index 61809a991..a2114b4dc 100644
--- a/src/hooks/Auth/useAuthz.ts
+++ b/src/hooks/Auth/useAuthz.ts
@@ -1,10 +1,5 @@
-import type { Component, Ref } from 'vue'
-import { nextTick, ref } from 'vue'
import { listAuthz, queryAuthzItemMetrics } from '@/api/auth'
import { AuthzSourceItem, Metrics } from '@/types/auth'
-import useHandleAuthzItem from '@/hooks/Auth/useHandleAuthzItem'
-import useMove from '@/hooks/useMove'
-import useSortableTable from '@/hooks/useSortableTable'
import { SortableEvent } from 'sortablejs'
export type AuthzItemInTable = AuthzSourceItem & {
@@ -43,7 +38,7 @@ export default (): {
authzList.value = res.sources.map((item) => {
let img = ''
try {
- img = require(`@/assets/img/${item.type}.png`)
+ img = getImg(`img/${item.type}.png`)
} catch (error) {
console.error(error)
}
diff --git a/src/hooks/Auth/useAuthzCreate.ts b/src/hooks/Auth/useAuthzCreate.ts
index 639521b46..fddbe87a9 100644
--- a/src/hooks/Auth/useAuthzCreate.ts
+++ b/src/hooks/Auth/useAuthzCreate.ts
@@ -1,7 +1,3 @@
-import _ from 'lodash'
-import useProcessAuthData from './useProcessAuthData'
-import useSSL from '@/hooks/useSSL'
-
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export default function useAuthzCreate() {
const { createSSLForm, handleSSLDataBeforeSubmit } = useSSL()
@@ -75,6 +71,7 @@ export default function useAuthzCreate() {
pool_size: 8,
connect_timeout: '15s',
request_timeout: '30s',
+ max_inactive: '10s',
enable_pipelining: 100,
ssl: createSSLForm(),
}
@@ -161,7 +158,7 @@ export default function useAuthzCreate() {
data = processRedisConfig(config)
break
default:
- data = _.cloneDeep(config)
+ data = cloneDeep(config)
break
}
data.type = type
diff --git a/src/hooks/Auth/useAuthzManager.ts b/src/hooks/Auth/useAuthzManager.ts
new file mode 100644
index 000000000..f84651515
--- /dev/null
+++ b/src/hooks/Auth/useAuthzManager.ts
@@ -0,0 +1,20 @@
+import { AuthzRuleAction, AuthzRulePermission } from '@/types/typeAlias'
+
+export default () => {
+ const { t, tl } = useI18nTl('Auth')
+ const actionOpts = [
+ { value: AuthzRuleAction.publish, label: tl('publish') },
+ { value: AuthzRuleAction.subscribe, label: tl('subscribe') },
+ { value: AuthzRuleAction.all, label: tl('all') },
+ ]
+
+ const permissionOpts = [
+ { value: AuthzRulePermission.allow, label: t('Base.allow') },
+ { value: AuthzRulePermission.deny, label: t('Base.deny') },
+ ]
+
+ return {
+ actionOpts,
+ permissionOpts,
+ }
+}
diff --git a/src/hooks/Auth/useBannedType.ts b/src/hooks/Auth/useBannedType.ts
index 94689dc59..39dfe1176 100644
--- a/src/hooks/Auth/useBannedType.ts
+++ b/src/hooks/Auth/useBannedType.ts
@@ -1,6 +1,4 @@
import { BannedType } from '@/types/enum'
-import useI18nTl from '../useI18nTl'
-import { getLabelFromValueInOptionList } from '@/common/tools'
export default (): {
typeList: {
diff --git a/src/hooks/Auth/useBuiltInDataUpdateTip.ts b/src/hooks/Auth/useBuiltInDataUpdateTip.ts
index 57a584865..99fb8fb72 100644
--- a/src/hooks/Auth/useBuiltInDataUpdateTip.ts
+++ b/src/hooks/Auth/useBuiltInDataUpdateTip.ts
@@ -1,7 +1,5 @@
import { AuthnItem } from '@/types/auth'
-import { ElMessageBox, MessageBoxData } from 'element-plus'
-import { cloneDeep } from 'lodash'
-import useI18nTl from '../useI18nTl'
+import { MessageBoxData } from 'element-plus'
export default (): {
setRawSetting: (data: AuthnItem) => void
diff --git a/src/hooks/Auth/useDatabaseConfig.ts b/src/hooks/Auth/useDatabaseConfig.ts
index 119f4c7fb..0bc37faf9 100644
--- a/src/hooks/Auth/useDatabaseConfig.ts
+++ b/src/hooks/Auth/useDatabaseConfig.ts
@@ -1,9 +1,7 @@
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
import { DEFAULT_SALT_POSITION } from '@/common/constants'
import { SaltPosition } from '@/types/enum'
-import { watch, ref, computed, SetupContext } from 'vue'
-import { useRoute } from 'vue-router'
-import { isEqual } from 'lodash'
+import { SetupContext } from 'vue'
export default function useDatabaseConfig(
props: {
diff --git a/src/hooks/Auth/useDatabaseConfigForm.ts b/src/hooks/Auth/useDatabaseConfigForm.ts
index 88080ab4d..3154cd456 100644
--- a/src/hooks/Auth/useDatabaseConfigForm.ts
+++ b/src/hooks/Auth/useDatabaseConfigForm.ts
@@ -1,9 +1,5 @@
-import type { ComputedRef, Ref } from 'vue'
-import { computed, ref } from 'vue'
-import useFormRules from '@/hooks/useFormRules'
+import { isJSONString } from '@emqx/shared-ui-utils'
import { FormRules } from 'element-plus'
-import useI18nTl from '../useI18nTl'
-import { usePasswordHashRules } from './usePasswordHashAlgorithmData'
type PropsParams = {
database: string
@@ -67,6 +63,16 @@ export default (props: PropsParams, databaseConfig: any): ReturnData => {
...createMongoCommonFormRules(),
/* For mongo type 'rs' */
replica_set_name: createRequiredRule(tl('replicaSetName')),
+ filter: [
+ {
+ validator(rules, value, callback) {
+ if (!value || isJSONString(value)) {
+ return callback()
+ }
+ callback(new Error(tl('jsonFormatError')))
+ },
+ },
+ ],
}
} else if (isMySQL.value || isPgSQL.value) {
ret = { ...ret, ...createMySQLFormRules() }
diff --git a/src/hooks/Auth/useHTTPConfigForm.ts b/src/hooks/Auth/useHTTPConfigForm.ts
index eafeb546f..4f56b0d96 100644
--- a/src/hooks/Auth/useHTTPConfigForm.ts
+++ b/src/hooks/Auth/useHTTPConfigForm.ts
@@ -1,8 +1,4 @@
-import type { ComputedRef, Ref } from 'vue'
-import { computed, ref } from 'vue'
-import useFormRules from '@/hooks/useFormRules'
import { FormRules } from '@/types/common'
-import useI18nTl from '../useI18nTl'
import { isJSONString } from '@emqx/shared-ui-utils'
export default (): {
diff --git a/src/hooks/Auth/useJWTConfigForm.ts b/src/hooks/Auth/useJWTConfigForm.ts
index fe632727b..50f5e1071 100644
--- a/src/hooks/Auth/useJWTConfigForm.ts
+++ b/src/hooks/Auth/useJWTConfigForm.ts
@@ -1,8 +1,4 @@
import { FormRules } from '@/types/common'
-import type { ComputedRef, Ref } from 'vue'
-import { computed, ref } from 'vue'
-import useFormRules from '../useFormRules'
-import useI18nTl from '../useI18nTl'
export default (): {
formCom: Ref
diff --git a/src/hooks/Auth/useLdapConfigForm.ts b/src/hooks/Auth/useLdapConfigForm.ts
index a1b075572..fc32fe21f 100644
--- a/src/hooks/Auth/useLdapConfigForm.ts
+++ b/src/hooks/Auth/useLdapConfigForm.ts
@@ -1,8 +1,4 @@
-import type { ComputedRef, Ref } from 'vue'
-import { computed, ref } from 'vue'
-import useFormRules from '@/hooks/useFormRules'
import { FormRules } from '@/types/common'
-import useI18nTl from '../useI18nTl'
export default (): {
formCom: Ref
diff --git a/src/hooks/Auth/usePasswordHashAlgorithmData.ts b/src/hooks/Auth/usePasswordHashAlgorithmData.ts
index 899b8643c..294c59456 100644
--- a/src/hooks/Auth/usePasswordHashAlgorithmData.ts
+++ b/src/hooks/Auth/usePasswordHashAlgorithmData.ts
@@ -1,7 +1,4 @@
-import { DEFAULT_SALT_POSITION } from '@/common/constants'
import { HashType } from '@/types/enum'
-import useFormRules from '../useFormRules'
-import useI18nTl from '../useI18nTl'
import { FormRules } from '@/types/common'
interface PasswordHashAlgorithm {
diff --git a/src/hooks/Auth/useProcessAuthData.ts b/src/hooks/Auth/useProcessAuthData.ts
index 64f093cb3..89c852cdd 100644
--- a/src/hooks/Auth/useProcessAuthData.ts
+++ b/src/hooks/Auth/useProcessAuthData.ts
@@ -1,9 +1,7 @@
import { ElMessage as M } from 'element-plus'
-import _ from 'lodash'
-import { getUsefulPasswordHashAlgorithmData } from './usePasswordHashAlgorithmData'
import { parseJSONSafely } from '@emqx/shared-ui-utils'
import { LDAPAuthMethod } from '@/types/enum'
-// import { AUTO_RESTART_INTERVAL_DEFAULT } from '@/common/constants'
+//
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export default function useProcessAuthData() {
@@ -18,7 +16,7 @@ export default function useProcessAuthData() {
const processHttpConfig = (data: any) => {
try {
- const tempData = _.cloneDeep(data)
+ const tempData = cloneDeep(data)
const { body } = data
if (body !== '' && body !== undefined) {
tempData.body = parseJSONSelectively(body)
@@ -31,7 +29,7 @@ export default function useProcessAuthData() {
}
}
const processRedisConfig = (data: any) => {
- const tempData = _.cloneDeep(data)
+ const tempData = cloneDeep(data)
const { redis_type } = data
if (redis_type !== 'sentinel') {
delete tempData.sentinel
@@ -48,7 +46,7 @@ export default function useProcessAuthData() {
}
const processMongoDBConfig = (data: any) => {
try {
- let tempData = _.cloneDeep(data)
+ let tempData = cloneDeep(data)
const { mongo_type, filter } = data
const needDeleteFields = []
if (mongo_type !== 'single') {
@@ -59,7 +57,7 @@ export default function useProcessAuthData() {
if (mongo_type !== 'rs') {
needDeleteFields.push('w_mode', 'r_mode', 'replica_set_name')
}
- tempData = _.omit(tempData, needDeleteFields)
+ tempData = omit(tempData, needDeleteFields)
if (filter !== '' && filter !== undefined) {
tempData.filter = parseJSONSelectively(filter)
} else {
@@ -73,9 +71,9 @@ export default function useProcessAuthData() {
const processLDAPConfig = (data: any) => {
const { method } = data
if (method.type === LDAPAuthMethod.Hash) {
- data.method = _.omit(method, 'bind_password')
+ data.method = omit(method, 'bind_password')
} else if (method.type === LDAPAuthMethod.Bind) {
- data.method = _.omit(method, ['password_attribute', 'is_superuser_attribute'])
+ data.method = omit(method, ['password_attribute', 'is_superuser_attribute'])
}
return data
}
@@ -121,7 +119,7 @@ export default function useProcessAuthData() {
return tempData
}
const processPasswordHashAlgorithmData = (data: any) => {
- const ret = _.cloneDeep(data)
+ const ret = cloneDeep(data)
const isBuiltInDatabase = data.backend === 'built_in_database'
if ('password_hash_algorithm' in ret) {
ret.password_hash_algorithm = getUsefulPasswordHashAlgorithmData(
diff --git a/src/hooks/Auth/useToggleAuthStatus.ts b/src/hooks/Auth/useToggleAuthStatus.ts
index 290e6ce15..2c5c26cd7 100644
--- a/src/hooks/Auth/useToggleAuthStatus.ts
+++ b/src/hooks/Auth/useToggleAuthStatus.ts
@@ -1,9 +1,4 @@
import { updateAuthn, updateAuthz } from '@/api/auth'
-import { ElMessageBox, ElMessage } from 'element-plus'
-import useI18nTl from '../useI18nTl'
-import { AuthnItemInTable } from './useAuthn'
-import { AuthzItemInTable } from './useAuthz'
-import { omit } from 'lodash'
export default (): {
toggleAuthStatus: (
diff --git a/src/hooks/Clients/useClientDetail.ts b/src/hooks/Clients/useClientDetail.ts
index 77a74d986..6ed257717 100644
--- a/src/hooks/Clients/useClientDetail.ts
+++ b/src/hooks/Clients/useClientDetail.ts
@@ -1,9 +1,5 @@
import { Client } from '@/types/client'
-import moment from 'moment'
-import type { ComputedRef, Ref } from 'vue'
-import useDurationStr from '@/hooks/useDurationStr'
-import useI18nTl from '../useI18nTl'
-import { SESSION_NEVER_EXPIRE_TIME } from '@/common/constants'
+import dayjs from 'dayjs'
type GetSessionInfoItem = (msg: string) => string | number | boolean
@@ -31,7 +27,7 @@ export default (
case 'awaiting_rel':
return msg.awaiting_rel_cnt + '/' + msg.awaiting_rel_max
case 'created_at':
- return moment(msg[key]).format('YYYY-MM-DD HH:mm:ss')
+ return dayjs(msg[key]).format('YYYY-MM-DD HH:mm:ss')
case 'heap_size':
return `${msg.heap_size} bytes`
case 'expiry_interval':
diff --git a/src/hooks/Clients/useClientFields.ts b/src/hooks/Clients/useClientFields.ts
index cb4be6aaf..9daa5b761 100644
--- a/src/hooks/Clients/useClientFields.ts
+++ b/src/hooks/Clients/useClientFields.ts
@@ -1,5 +1,3 @@
-import useI18nTl from '../useI18nTl'
-
export default (): {
clientFields: { [key: string]: Array }
snake2pascal: (s: string) => string
diff --git a/src/hooks/Config/useLimiter.ts b/src/hooks/Config/useLimiter.ts
index 7a46e145b..7c78fde2e 100644
--- a/src/hooks/Config/useLimiter.ts
+++ b/src/hooks/Config/useLimiter.ts
@@ -1,5 +1,4 @@
import { FormRules } from '@/types/common'
-import useI18nTl from '../useI18nTl'
export default (): {
limiterRules: FormRules
diff --git a/src/hooks/Config/useListenerDrawer.ts b/src/hooks/Config/useListenerDrawer.ts
index 974b037c3..0a9941285 100644
--- a/src/hooks/Config/useListenerDrawer.ts
+++ b/src/hooks/Config/useListenerDrawer.ts
@@ -1,16 +1,8 @@
import { addGatewayListener, updateGatewayListener } from '@/api/gateway'
import { addListener, queryListenerDetail, updateListener } from '@/api/listener'
-import { GATEWAY_DISABLED_LISTENER_TYPE_MAP, unexposedConfigs } from '@/common/constants'
-import { checkNOmitFromObj, emptyObject, jumpToErrorFormItem } from '@/common/tools'
import { FormRules } from '@/types/common'
import { GatewayName, ListenerType, ListenerTypeForGateway } from '@/types/enum'
import { Listener } from '@/types/listener'
-import { ElMessage, ElMessageBox } from 'element-plus'
-import { assign, cloneDeep, merge, omit } from 'lodash'
-import type { ComputedRef, Ref, WritableComputedRef } from 'vue'
-import { computed, nextTick, ref, watch } from 'vue'
-import useI18nTl from '../useI18nTl'
-import useListenerUtils from './useListenerUtils'
import { isEmptyObj, unflattenObject } from '@emqx/shared-ui-utils'
type Props = Readonly<
@@ -52,6 +44,7 @@ interface useListenerDrawerReturns {
showWSConfig: ComputedRef
listenerFormRules: ComputedRef
submit: () => Promise
+ confirmClose: () => Promise
onDelete: () => void
transPort: (port: string) => string
handleTLSVerifyChange: (val: string | number | boolean) => void
@@ -148,6 +141,34 @@ export default (props: Props, emit: Emit): useListenerDrawerReturns => {
const isLoading = ref(false)
+ let rawListenerRecord = {}
+ let rawListenerCustomConfigs = {}
+ const isRecordChanged = () =>
+ !isEqual(rawListenerRecord, listenerRecord.value) ||
+ !isEqual(rawListenerCustomConfigs, listenerCustomConfigs.value)
+ const confirmClose = async () => {
+ try {
+ const isChanged = isRecordChanged()
+ if (isChanged) {
+ await ElMessageBox({
+ type: 'info',
+ title: t('APIKey.close'),
+ message: t('Base.unloadTip'),
+ showCancelButton: true,
+ confirmButtonText: t('Base.confirm'),
+ showClose: false,
+ closeOnClickModal: false,
+ closeOnPressEscape: false,
+ closeOnHashChange: false,
+ })
+ return Promise.resolve()
+ }
+ return Promise.resolve()
+ } catch (error) {
+ return Promise.reject()
+ }
+ }
+
const loadListenerData = async () => {
if (!props.listener) {
return
@@ -166,6 +187,8 @@ export default (props: Props, emit: Emit): useListenerDrawerReturns => {
if (!isEmptyObj(differences)) {
listenerCustomConfigs.value = unflattenObject(differences)
}
+ rawListenerRecord = cloneDeep(listenerRecord.value)
+ rawListenerCustomConfigs = cloneDeep(listenerCustomConfigs.value)
} catch (error) {
//
} finally {
@@ -358,6 +381,7 @@ export default (props: Props, emit: Emit): useListenerDrawerReturns => {
isCoAP,
SSLConfigKey,
listenerFormRules,
+ confirmClose,
submit,
onDelete,
transPort,
diff --git a/src/hooks/Config/useListenerUtils.ts b/src/hooks/Config/useListenerUtils.ts
index f5a659b1b..d07822ce3 100644
--- a/src/hooks/Config/useListenerUtils.ts
+++ b/src/hooks/Config/useListenerUtils.ts
@@ -1,11 +1,6 @@
-import { SSL_VERIFY_VALUE_MAP, unexposedConfigs } from '@/common/constants'
-import useLimiter from '@/hooks/Config/useLimiter'
import { FormRules } from '@/types/common'
import { ListenerType, ListenerTypeForGateway } from '@/types/enum'
import { Listener } from '@/types/listener'
-import { cloneDeep } from 'lodash'
-import useFormRules from '../useFormRules'
-import useI18nTl from '../useI18nTl'
import parseHoconToObject from 'hocon-parser'
import { isEmptyObj } from '@emqx/shared-ui-utils'
diff --git a/src/hooks/Exhook/useExhookItemStatus.ts b/src/hooks/Exhook/useExhookItemStatus.ts
index a1a656cb1..8e8706b87 100644
--- a/src/hooks/Exhook/useExhookItemStatus.ts
+++ b/src/hooks/Exhook/useExhookItemStatus.ts
@@ -1,6 +1,5 @@
import { ExhookStatus, NodeStatusClass } from '@/types/enum'
import { Exhook } from '@/types/systemModule'
-import useI18nTl from '../useI18nTl'
export default (): {
getTheWorstStatus: (exhook: Exhook) => ExhookStatus
@@ -40,7 +39,7 @@ export default (): {
[ExhookStatus.Disconnected]: t('RuleEngine.disconnected'),
[ExhookStatus.Disabled]: tl('disabled'),
[ExhookStatus.Error]: tl('error'),
- }[status] || 'unknown')
+ })[status] || 'unknown'
const statusTextClass = (status: ExhookStatus): NodeStatusClass =>
({
@@ -49,7 +48,7 @@ export default (): {
[ExhookStatus.Disconnected]: NodeStatusClass.Danger,
[ExhookStatus.Disabled]: NodeStatusClass.Danger,
[ExhookStatus.Error]: NodeStatusClass.Danger,
- }[status] || NodeStatusClass.Danger)
+ })[status] || NodeStatusClass.Danger
return {
getTheWorstStatus,
diff --git a/src/hooks/Exhook/useHandleExhookItem.ts b/src/hooks/Exhook/useHandleExhookItem.ts
index 52877ba7a..e8ffdf47b 100644
--- a/src/hooks/Exhook/useHandleExhookItem.ts
+++ b/src/hooks/Exhook/useHandleExhookItem.ts
@@ -1,10 +1,6 @@
import { moveExhook, deleteExhook as requestDeleteExhook, updateExhook } from '@/api/exhook'
import { TargetPosition } from '@/types/enum'
import { Exhook, ExhookFormForCreate } from '@/types/systemModule'
-import { ElMessage, ElMessageBox } from 'element-plus'
-import { cloneDeep } from 'lodash'
-import { useI18n } from 'vue-i18n'
-import useSSL from '../useSSL'
export default (): {
deleteExhook: (name: string) => Promise
diff --git a/src/hooks/Gateway/useHandleExprotoData.ts b/src/hooks/Gateway/useHandleExprotoData.ts
index 35bf72c34..9fe3ec932 100644
--- a/src/hooks/Gateway/useHandleExprotoData.ts
+++ b/src/hooks/Gateway/useHandleExprotoData.ts
@@ -1,6 +1,3 @@
-import { checkNOmitFromObj } from '@/common/tools'
-import { cloneDeep, omit } from 'lodash'
-
export default (): {
handleExprotoData: (gatewayData: Record) => Record
} => {
diff --git a/src/hooks/Overview/useNodesGraph.ts b/src/hooks/Overview/useNodesGraph.ts
index a72b903bd..71098166b 100644
--- a/src/hooks/Overview/useNodesGraph.ts
+++ b/src/hooks/Overview/useNodesGraph.ts
@@ -1,9 +1,5 @@
-import { numToFixed, waitAMoment } from '@/common/tools'
import { NodeInfo } from '@/types/dashboard'
import { NodeStatus } from '@/types/enum'
-import type { ComputedRef, Ref } from 'vue'
-import { computed, onMounted, onUnmounted, ref, watch } from 'vue'
-import { useStore } from 'vuex'
export interface FlowNodeData {
type: 'core' | 'replicant' | 'background'
diff --git a/src/hooks/Plugins/avroUtils.ts b/src/hooks/Plugins/avroUtils.ts
index d6beacf14..1890faa7d 100644
--- a/src/hooks/Plugins/avroUtils.ts
+++ b/src/hooks/Plugins/avroUtils.ts
@@ -2,7 +2,6 @@
// @ts-ignore
import { jsonToAvro, avroToJson } from 'json-to-avro'
import avro from 'avsc'
-import { ElMessage } from 'element-plus'
/**
* Converts an object to Avro JSON format.
diff --git a/src/hooks/Plugins/useGenPluginFormRules.ts b/src/hooks/Plugins/useGenPluginFormRules.ts
index 817d4c1e2..d45a9c9ed 100644
--- a/src/hooks/Plugins/useGenPluginFormRules.ts
+++ b/src/hooks/Plugins/useGenPluginFormRules.ts
@@ -1,6 +1,5 @@
import { PluginUIConfigForm, Rule } from '@/types/plugin'
import { isEmptyObj } from '@emqx/shared-ui-utils'
-import { computed } from 'vue'
/**
* Checks if a given value is within the specified range.
diff --git a/src/hooks/Plugins/usePluginItem.ts b/src/hooks/Plugins/usePluginItem.ts
index 64e8940a6..d6670609e 100644
--- a/src/hooks/Plugins/usePluginItem.ts
+++ b/src/hooks/Plugins/usePluginItem.ts
@@ -1,11 +1,8 @@
import { uninstallPlugin } from '@/api/plugins'
-import { useI18n } from 'vue-i18n'
-import { ElMessageBox, ElMessage } from 'element-plus'
import { PluginItem } from '@/types/plugin'
import { PluginStatus, StatusCommandSendToPlugin, TargetPosition } from '@/types/enum'
import { updatePluginStatus } from '@/api/plugins'
import { movePluginPosition } from '@/api/plugins'
-import { tryToCompleteURL } from '@/common/tools'
interface FuncRet {
NAME_VERSION_JOINER: string
diff --git a/src/hooks/Plugins/useRenderPluginForm.ts b/src/hooks/Plugins/useRenderPluginForm.ts
index 1f1b9eb3e..14c6da19c 100644
--- a/src/hooks/Plugins/useRenderPluginForm.ts
+++ b/src/hooks/Plugins/useRenderPluginForm.ts
@@ -1,5 +1,3 @@
-import { computed, ref, Ref } from 'vue'
-import { useStore } from 'vuex'
import { isEmptyObj } from '@emqx/shared-ui-utils'
import { AvroEnum, AvroSchema, PluginUIConfigForm, PluginUIConfigs } from '@/types/plugin'
import { getPluginConfigs, getPluginSchema, updatePluginConfigs } from '@/api/plugins'
diff --git a/src/hooks/Rule/KeysInRule.ts b/src/hooks/Rule/KeysInRule.ts
index 2e096318a..3b9078b7e 100644
--- a/src/hooks/Rule/KeysInRule.ts
+++ b/src/hooks/Rule/KeysInRule.ts
@@ -2,7 +2,7 @@ import RuleFunc from './RuleFunc.json'
import RuleField from './RuleField.json'
const funcList = RuleFunc.reduce((arr: Array, { list }): Array => {
- list.forEach(({ name }: { name: string }) => arr.push(name))
+ list?.forEach(({ name }: { name: string }) => arr.push(name))
return arr
}, [])
diff --git a/src/hooks/Rule/RuleFunc.json b/src/hooks/Rule/RuleFunc.json
index 5986e916b..5fde129ed 100644
--- a/src/hooks/Rule/RuleFunc.json
+++ b/src/hooks/Rule/RuleFunc.json
@@ -336,6 +336,16 @@
"required": true
}
]
+ },
+ {
+ "name": "is_empty",
+ "args": [
+ {
+ "name": "Value",
+ "type": "any",
+ "required": true
+ }
+ ]
}
]
},
@@ -756,6 +766,16 @@
"required": true
}
]
+ },
+ {
+ "name": "map_size",
+ "args": [
+ {
+ "name": "Map",
+ "type": "object",
+ "required": true
+ }
+ ]
}
]
},
@@ -1067,6 +1087,26 @@
"required": true
}
]
+ },
+ {
+ "name": "str_utf16_le",
+ "args": [
+ {
+ "name": "Data",
+ "type": "string",
+ "required": true
+ }
+ ]
+ },
+ {
+ "name": "sqlserver_bin2hexstr",
+ "args": [
+ {
+ "name": "Data",
+ "type": "string",
+ "required": true
+ }
+ ]
}
]
},
diff --git a/src/hooks/Rule/action/useActionList.ts b/src/hooks/Rule/action/useActionList.ts
index 80b340a83..bd95f729a 100644
--- a/src/hooks/Rule/action/useActionList.ts
+++ b/src/hooks/Rule/action/useActionList.ts
@@ -1,4 +1,4 @@
-import { getActions } from '@/api/action'
+import { getSimplifiedActions } from '@/api/action'
import { BridgeItem } from '@/types/rule'
export default (): {
@@ -6,7 +6,7 @@ export default (): {
} => {
const getActionList = async (): Promise> => {
try {
- const data = await getActions()
+ const data = await getSimplifiedActions()
return Promise.resolve(data)
} catch (error) {
return Promise.reject(error)
diff --git a/src/hooks/Rule/action/useHandleActionItem.ts b/src/hooks/Rule/action/useHandleActionItem.ts
index 61c0d946f..df74c7cbd 100644
--- a/src/hooks/Rule/action/useHandleActionItem.ts
+++ b/src/hooks/Rule/action/useHandleActionItem.ts
@@ -12,10 +12,6 @@ import {
} from '@/api/action'
import { BridgeType } from '@/types/enum'
import { Action } from '@/types/rule'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import { useRoute } from 'vue-router'
-import { useActionDataHandler } from '../useDataHandler'
type HandleDirectionCallback = (
direction?: number,
diff --git a/src/hooks/Rule/action/useHandleSourceItem.ts b/src/hooks/Rule/action/useHandleSourceItem.ts
index 32d886320..73a09c7b3 100644
--- a/src/hooks/Rule/action/useHandleSourceItem.ts
+++ b/src/hooks/Rule/action/useHandleSourceItem.ts
@@ -10,13 +10,7 @@ import {
getSourceMetrics as requestSourceMetrics,
testSourceConnectivity,
} from '@/api/sources'
-import useI18nTl from '@/hooks/useI18nTl'
import { Source } from '@/types/rule'
-import { ElMessage, ElMessageBox } from 'element-plus'
-import { isFunction } from 'lodash'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import { useActionDataHandler } from '../useDataHandler'
const useHandleSourceItem = (): {
getSourceDetail: (id: string) => Promise
diff --git a/src/hooks/Rule/action/useSourceList.ts b/src/hooks/Rule/action/useSourceList.ts
index eb2e0cf84..b88e4879b 100644
--- a/src/hooks/Rule/action/useSourceList.ts
+++ b/src/hooks/Rule/action/useSourceList.ts
@@ -1,4 +1,4 @@
-import { getSources } from '@/api/sources'
+import { getSimplifiedSources } from '@/api/sources'
import { BridgeItem } from '@/types/rule'
export default (): {
@@ -6,7 +6,7 @@ export default (): {
} => {
const getSourceList = async () => {
try {
- const sourceList: Array = await getSources()
+ const sourceList = await getSimplifiedSources()
return Promise.resolve(sourceList)
} catch (error) {
return Promise.reject(error)
diff --git a/src/hooks/Rule/bridge/useComponentsHandlers.ts b/src/hooks/Rule/bridge/useActionComponentsHandlers.ts
similarity index 85%
rename from src/hooks/Rule/bridge/useComponentsHandlers.ts
rename to src/hooks/Rule/bridge/useActionComponentsHandlers.ts
index a807da51b..90fe62fad 100644
--- a/src/hooks/Rule/bridge/useComponentsHandlers.ts
+++ b/src/hooks/Rule/bridge/useActionComponentsHandlers.ts
@@ -1,11 +1,5 @@
-import useSpecialRuleForPassword from '@/hooks/Rule/bridge/useSpecialRuleForPassword'
-import { SchemaRules } from '@/hooks/Schema/useSchemaFormRules'
-import useFormRules from '@/hooks/useFormRules'
import { BridgeType } from '@/types/enum'
import { Properties, Property } from '@/types/schemaForm'
-import { pick } from 'lodash'
-import { useAvailableProviders } from '../useProvidersForMonaco'
-import useSQLAvailablePlaceholder from '../useSQLAvailablePlaceholder'
type Handler = ({ components, rules }: { components: Properties; rules: SchemaRules }) => {
components: Properties
@@ -62,13 +56,14 @@ export default (
prop.componentProps = Object.assign(prop.componentProps || {}, componentProps)
}
- const { availablePlaceholders } = useSQLAvailablePlaceholder()
const { completionProvider } = useAvailableProviders()
const handleProp = (parm: Property) => {
const walk = (prop: Property) => {
if (prop.properties) {
Object.values(prop.properties).forEach((item) => walk(item))
+ } else if (prop.type === 'array' && prop.items?.properties) {
+ Object.values(prop.items.properties).forEach((item) => walk(item))
} else if (prop.type === 'oneof') {
prop.oneOf?.forEach((item) => walk(item))
} else if (
@@ -114,17 +109,11 @@ export default (
const { qos, retain, payload, topic } = components?.parameters?.properties || {}
if (qos?.type === 'oneof') {
qos.type = 'enum'
- qos.symbols = [
- ...(getSymbolsFromOneOfArr(qos.oneOf) || []),
- '${qos}',
- ...availablePlaceholders.value,
- ]
- setComponentProps(qos, { filterable: true, allowCreate: true })
+ qos.symbols = [...(getSymbolsFromOneOfArr(qos.oneOf) || []), '${qos}']
}
if (retain?.type === 'oneof') {
retain.type = 'enum'
- retain.symbols = [true, false, '${flags.retain}', ...availablePlaceholders.value]
- setComponentProps(retain, { filterable: true, allowCreate: true })
+ retain.symbols = [true, false, '${flags.retain}']
}
// for detect whether it is source or action
if (topic && !payload) {
diff --git a/src/hooks/Rule/bridge/useBridgeTypeValue.ts b/src/hooks/Rule/bridge/useBridgeTypeValue.ts
index 49b4d1008..e652c1961 100644
--- a/src/hooks/Rule/bridge/useBridgeTypeValue.ts
+++ b/src/hooks/Rule/bridge/useBridgeTypeValue.ts
@@ -1,6 +1,3 @@
-import { CONNECTOR_TYPES_WITH_TWO_DIRECTIONS, INGRESS_BRIDGE_TYPES } from '@/common/constants'
-import { getLabelFromValueInOptionList } from '@/common/tools'
-import useI18nTl from '@/hooks/useI18nTl'
import { BridgeDirection, BridgeType } from '@/types/enum'
import { BridgeItem } from '@/types/rule'
@@ -142,7 +139,7 @@ export const useBridgeTypeIcon = (): {
return ''
}
try {
- return require(`@/assets/img/${getBridgeIconKey(type)}.png`)
+ return getImg(`img/${getBridgeIconKey(type)}.png`)
} catch (error) {
console.error(error)
return ''
diff --git a/src/hooks/Rule/bridge/useCheckBeforeSaveAsCopy.ts b/src/hooks/Rule/bridge/useCheckBeforeSaveAsCopy.ts
index 196c3821f..df9b3deca 100644
--- a/src/hooks/Rule/bridge/useCheckBeforeSaveAsCopy.ts
+++ b/src/hooks/Rule/bridge/useCheckBeforeSaveAsCopy.ts
@@ -1,10 +1,3 @@
-import { ENCRYPTED_PWD_REG } from '@/common/constants'
-import { jumpToErrorFormItem } from '@/common/tools'
-import useI18nTl from '@/hooks/useI18nTl'
-import { get } from 'lodash'
-import { ref, Ref } from 'vue'
-import { useBridgeDataHandler } from '../useDataHandler'
-
export default (): {
pwdErrorWhenCoping: Ref
checkLikePwdField: (bridge: any, errorMsg?: string) => Promise
diff --git a/src/hooks/Rule/bridge/useDeleteBridge.ts b/src/hooks/Rule/bridge/useDeleteBridge.ts
index 2dae03063..2700e3538 100644
--- a/src/hooks/Rule/bridge/useDeleteBridge.ts
+++ b/src/hooks/Rule/bridge/useDeleteBridge.ts
@@ -1,18 +1,9 @@
-import useWebhookUtils from '@/hooks/Webhook/useWebhookUtils'
-import useI18nTl from '@/hooks/useI18nTl'
import { BridgeItem } from '@/types/rule'
-import { ElMessage, ElMessageBox } from 'element-plus'
-import { isFunction } from 'lodash'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import useHandleActionItem from '../action/useHandleActionItem'
interface DeleteBridgeResult {
showSecondConfirm: Ref
usingBridgeRules: Ref
currentDeleteBridgeId: Ref
- currentDelName: Ref
- showDeleteWebhookAssociatedTip: Ref
handleDeleteSuc: () => void
handleDeleteBridge: (data: BridgeItem) => Promise
}
@@ -24,8 +15,6 @@ export default (deletedCallBack: () => void): DeleteBridgeResult => {
const usingBridgeRules: Ref> = ref([])
const currentDeleteBridgeId = ref('')
- const currentDelName = ref('')
- const showDeleteWebhookAssociatedTip = ref(false)
const { judgeIsWebhookAction } = useWebhookUtils()
const handleDeleteSuc = () => {
@@ -43,8 +32,6 @@ export default (deletedCallBack: () => void): DeleteBridgeResult => {
const { deleteAction } = useHandleActionItem()
const handleDeleteBridge = async (item: BridgeItem) => {
if (judgeIsWebhookAction(item)) {
- currentDelName.value = item.name
- showDeleteWebhookAssociatedTip.value = true
return
}
if (item.rules?.length) {
@@ -71,8 +58,6 @@ export default (deletedCallBack: () => void): DeleteBridgeResult => {
showSecondConfirm,
usingBridgeRules,
currentDeleteBridgeId,
- currentDelName,
- showDeleteWebhookAssociatedTip,
handleDeleteSuc,
handleDeleteBridge,
}
diff --git a/src/hooks/Rule/bridge/useResourceOpt.ts b/src/hooks/Rule/bridge/useResourceOpt.ts
index 969388905..897d717e0 100644
--- a/src/hooks/Rule/bridge/useResourceOpt.ts
+++ b/src/hooks/Rule/bridge/useResourceOpt.ts
@@ -1,5 +1,4 @@
import { ResourceOpt } from '@/types/rule'
-import { omit } from 'lodash'
export default (): {
createDefaultResourceOptsForm: (config?: {
diff --git a/src/hooks/Rule/bridge/useSchemaBridgePropsLayout.ts b/src/hooks/Rule/bridge/useSchemaBridgePropsLayout.ts
index ed255b23e..bc9fdfcb1 100644
--- a/src/hooks/Rule/bridge/useSchemaBridgePropsLayout.ts
+++ b/src/hooks/Rule/bridge/useSchemaBridgePropsLayout.ts
@@ -1,9 +1,6 @@
import { BridgeType } from '@/types/enum'
-import type { ComputedRef, WritableComputedRef } from 'vue'
-import { computed } from 'vue'
-import useSyncConfiguration from './useSyncConfiguration'
-export const resourceOptFields = [
+export const actionResourceOptFields = [
'start_timeout',
'worker_pool_size',
'request_ttl',
@@ -53,7 +50,7 @@ export default (
'pool_size',
'connect_timeout',
'max_retries',
- ...resourceOptFields,
+ ...actionResourceOptFields,
]
const basicInfoFields = ['name', 'connector', 'description']
diff --git a/src/hooks/Rule/bridge/useSpecialRuleForPassword.ts b/src/hooks/Rule/bridge/useSpecialRuleForPassword.ts
index 4636976a5..80378f464 100644
--- a/src/hooks/Rule/bridge/useSpecialRuleForPassword.ts
+++ b/src/hooks/Rule/bridge/useSpecialRuleForPassword.ts
@@ -1,5 +1,3 @@
-import { ENCRYPTED_PWD_REG } from '@/common/constants'
-import useI18nTl from '@/hooks/useI18nTl'
import { FormItemRule } from '@/types/common'
export default (
diff --git a/src/hooks/Rule/bridge/useSyncConfiguration.ts b/src/hooks/Rule/bridge/useSyncConfiguration.ts
index 24b6877d8..43eadf947 100644
--- a/src/hooks/Rule/bridge/useSyncConfiguration.ts
+++ b/src/hooks/Rule/bridge/useSyncConfiguration.ts
@@ -1,7 +1,4 @@
import { OtherBridge } from '@/types/rule'
-import type { ComputedRef, WritableComputedRef } from 'vue'
-import { computed } from 'vue'
-import { isString, omit } from 'lodash'
/**
* some utils about sync, batch and msg queue configuration
diff --git a/src/hooks/Rule/connector/useComponentsHandlers.ts b/src/hooks/Rule/connector/useConnectorComponentsHandlers.ts
similarity index 86%
rename from src/hooks/Rule/connector/useComponentsHandlers.ts
rename to src/hooks/Rule/connector/useConnectorComponentsHandlers.ts
index c4f5644eb..467570126 100644
--- a/src/hooks/Rule/connector/useComponentsHandlers.ts
+++ b/src/hooks/Rule/connector/useConnectorComponentsHandlers.ts
@@ -1,11 +1,5 @@
-import { DEFAULT_SSL_VERIFY_VALUE, SSL_VERIFY_VALUE_MAP } from '@/common/constants'
-import useSpecialRuleForPassword from '@/hooks/Rule/bridge/useSpecialRuleForPassword'
-import { SchemaRules } from '@/hooks/Schema/useSchemaFormRules'
-import useFormRules from '@/hooks/useFormRules'
-import useSSL from '@/hooks/useSSL'
import { BridgeType } from '@/types/enum'
import { Properties, Property } from '@/types/schemaForm'
-import { pick } from 'lodash'
type Handler = ({ components, rules }: { components: Properties; rules: SchemaRules }) => {
components: Properties
@@ -35,6 +29,7 @@ export default (
): {
getComponentsHandler: () => Handler
} => {
+ const { t } = useI18n()
const { ruleWhenEditing } = useSpecialRuleForPassword(props)
const { createCommonIdRule } = useFormRules()
const addRuleForPassword = (rules: any) => {
@@ -125,6 +120,24 @@ export default (
comRet.keepalive.type = 'duration'
}
+ // Add labels and descriptions for ids and node
+ const getI18nPrefix = (type: string) => `BridgeSchema.${type}.`
+ const setLabelAndDesc = (prop: Property, path: string) => {
+ if (prop) {
+ prop.label = t(`${path}.label`)
+ prop.description = t(`${path}.desc`)
+ }
+ }
+ const i18nPrefix = getI18nPrefix(BridgeType.MQTT)
+ if (comRet?.static_clientids?.items?.properties) {
+ const props = comRet.static_clientids.items.properties
+ if (props.ids) {
+ setLabelAndDesc(props.ids, `${i18nPrefix}ids`)
+ }
+ if (props.node) {
+ setLabelAndDesc(props.node, `${i18nPrefix}node`)
+ }
+ }
return { components: comRet, rules }
}
diff --git a/src/hooks/Rule/connector/useHandleConnectorItem.ts b/src/hooks/Rule/connector/useHandleConnectorItem.ts
index 06a8b49ce..094ca634f 100644
--- a/src/hooks/Rule/connector/useHandleConnectorItem.ts
+++ b/src/hooks/Rule/connector/useHandleConnectorItem.ts
@@ -6,16 +6,7 @@ import {
deleteConnector as requestDelConnector,
reconnectConnector as requestReconnectConnector,
} from '@/api/connector'
-import useTestConnector from '@/hooks/Rule/connector/useTestConnector'
-import useWebhookUtils from '@/hooks/Webhook/useWebhookUtils'
-import useI18nTl from '@/hooks/useI18nTl'
-import useOperationConfirm from '@/hooks/useOperationConfirm'
import { BridgeItem, Connector } from '@/types/rule'
-import { ElMessage } from 'element-plus'
-import { isFunction } from 'lodash'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import { useConnectorDataHandler } from '../useDataHandler'
type NowConnector = Connector | BridgeItem
@@ -34,8 +25,6 @@ interface ConnectorHandlerResult {
isTesting: Ref
testConnectivity: (data: NowConnector) => Promise
showDelTip: Ref
- currentDelName: Ref
- showDeleteWebhookAssociatedTip: Ref
handleDeleteConnector: (data: Connector, callback: () => void | Promise) => Promise
}
@@ -138,18 +127,14 @@ export default (): ConnectorHandlerResult => {
return confirmDel(() => deleteConnector(id))
}
- const currentDelName = ref('')
- const showDeleteWebhookAssociatedTip = ref(false)
const { judgeIsWebhookConnector } = useWebhookUtils()
const handleDeleteConnector = async (
connector: Connector,
callback: () => void | Promise,
) => {
- const { id, actions, sources, name } = connector
+ const { id, actions, sources } = connector
if (judgeIsWebhookConnector(connector)) {
- currentDelName.value = name
- showDeleteWebhookAssociatedTip.value = true
return
}
if ((actions && actions.length) || (sources && sources.length)) {
@@ -180,8 +165,6 @@ export default (): ConnectorHandlerResult => {
isTesting,
testConnectivity,
showDelTip,
- currentDelName,
- showDeleteWebhookAssociatedTip,
handleDeleteConnector,
}
}
diff --git a/src/hooks/Rule/connector/useSchemaConnectorPropsLayout.ts b/src/hooks/Rule/connector/useSchemaConnectorPropsLayout.ts
index 99858113f..4dc22ff94 100644
--- a/src/hooks/Rule/connector/useSchemaConnectorPropsLayout.ts
+++ b/src/hooks/Rule/connector/useSchemaConnectorPropsLayout.ts
@@ -1,9 +1,6 @@
import { BridgeType } from '@/types/enum'
-import type { ComputedRef, WritableComputedRef } from 'vue'
-import { computed } from 'vue'
-import useSyncConfiguration from '../bridge/useSyncConfiguration'
-export const resourceOptFields = [
+export const connectorResourceOptFields = [
'start_timeout',
'worker_pool_size',
'request_ttl',
@@ -46,8 +43,9 @@ export default (
'pool_type',
'pool_size',
'connect_timeout',
+ 'max_inactive',
'max_retries',
- ...resourceOptFields,
+ ...connectorResourceOptFields,
]
const baseFields = ['name', 'description']
diff --git a/src/hooks/Rule/connector/useTestConnector.ts b/src/hooks/Rule/connector/useTestConnector.ts
index c1b3460ef..9bc0a2df9 100644
--- a/src/hooks/Rule/connector/useTestConnector.ts
+++ b/src/hooks/Rule/connector/useTestConnector.ts
@@ -1,8 +1,5 @@
import { testConnectorConnectivity } from '@/api/connector'
import { Connector } from '@/types/rule'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import { useConnectorDataHandler } from '../useDataHandler'
export default (): {
isTesting: Ref
diff --git a/src/hooks/Rule/rule/useDebugRule.ts b/src/hooks/Rule/rule/useDebugRule.ts
index 4c022413f..ffa0b08f1 100644
--- a/src/hooks/Rule/rule/useDebugRule.ts
+++ b/src/hooks/Rule/rule/useDebugRule.ts
@@ -1,8 +1,5 @@
import { addTrace, deleteTrace, getTraceLog, getTraceNodesMsg } from '@/api/diagnose'
import { applyRuleTest } from '@/api/ruleengine'
-import { getKeywordsFromSQL } from '@/common/tools'
-import useI18nTl from '@/hooks/useI18nTl'
-import useSyncPolling from '@/hooks/useSyncPolling'
import { TraceRecord } from '@/types/diagnose'
import {
EventForRule,
@@ -12,16 +9,7 @@ import {
TraceEncodeType,
} from '@/types/enum'
import { BasicRule, BridgeItem, RuleEvent, RuleItem } from '@/types/rule'
-import { ElMessageBox } from 'element-plus'
-import { cloneDeep, debounce, isArray, isEqual, mergeWith, startCase } from 'lodash'
-import moment from 'moment'
-import type { ComputedRef, Ref, WritableComputedRef } from 'vue'
-import { computed, onUnmounted, ref, watch } from 'vue'
-import { useStore } from 'vuex'
-import type { FormattedLog, LogItem } from './useFormatDebugLog'
-import useFormatDebugLog from './useFormatDebugLog'
-import { useRuleUtils } from './useRule'
-import useRuleEvents from './useRuleEvents'
+import dayjs from 'dayjs'
const BYTE_PER_PAGE = Math.pow(2, 30)
@@ -62,7 +50,7 @@ export default (): {
const nowTimestamp = new Date().getTime()
const oneDayLaterTimestamp = nowTimestamp + 24 * 60 * 60 * 1000
const traceData: TraceRecord = {
- name: `DEBUG_RULE_${ruleId}_${moment().format('YYYYMMDD_HHmmssSSS')}`,
+ name: `DEBUG_RULE_${ruleId}_${dayjs().format('YYYYMMDD_HHmmssSSS')}`,
type: 'ruleid',
ruleid: ruleId,
payload_encode: TraceEncodeType.Text,
@@ -382,7 +370,7 @@ export const useMockData = (
const getEventTypeInContext = () => {
const { type, target } = findSourceTypeAndTarget(dataType.value)
if (type === RuleInputType.Event) {
- return dataType.value.match(/(\$events\/)([\w]+)/)?.[2]
+ return dataType.value.match(/\w+$/)?.[0]
}
if (type === RuleInputType.Bridge) {
return `$bridges/${(target as BridgeItem).type}:*`
diff --git a/src/hooks/Rule/rule/useFormatDebugLog.ts b/src/hooks/Rule/rule/useFormatDebugLog.ts
index fd059ae0d..1697434f4 100644
--- a/src/hooks/Rule/rule/useFormatDebugLog.ts
+++ b/src/hooks/Rule/rule/useFormatDebugLog.ts
@@ -1,8 +1,5 @@
-import { getBridgeKey } from '@/common/tools'
-import useI18nTl from '@/hooks/useI18nTl'
import { BridgeType, LogResult, RuleOutput } from '@/types/enum'
import { stringifyObjSafely } from '@emqx/shared-ui-utils'
-import { groupBy, get, omit, startCase } from 'lodash'
/**
* Some Special Log Msg
@@ -68,7 +65,7 @@ export const LogTargetType = {
Republish: RuleOutput.Republish,
Action: RuleOutput.DataBridge,
}
-export type LogTargetTypeValue = typeof LogTargetType[keyof typeof LogTargetType]
+export type LogTargetTypeValue = (typeof LogTargetType)[keyof typeof LogTargetType]
export interface TargetLogInfo {
[key: string]: {
diff --git a/src/hooks/Rule/rule/useRule.ts b/src/hooks/Rule/rule/useRule.ts
index 5021ffad5..317e30ec6 100644
--- a/src/hooks/Rule/rule/useRule.ts
+++ b/src/hooks/Rule/rule/useRule.ts
@@ -5,18 +5,12 @@ import {
RULE_INPUT_EVENT_PREFIX,
TOPIC_EVENT,
} from '@/common/constants'
-import { addNewlineAfterComma, getTypeAndNameFromKey, splitOnComma } from '@/common/tools'
import useBridgeTypeValue, {
typesWithProducerAndConsumer,
useBridgeTypeIcon,
} from '@/hooks/Rule/bridge/useBridgeTypeValue'
import { BridgeType, EventForRule, RuleInputType, RuleOutput, RuleSQLKeyword } from '@/types/enum'
import { BridgeItem, OutputItem, RuleEvent, TestColumnItem } from '@/types/rule'
-import type { ComputedRef } from 'vue'
-import { computed, ref } from 'vue'
-import useRuleEvents from './useRuleEvents'
-import { escapeRegExp } from 'lodash'
-import useI18nTl from '@/hooks/useI18nTl'
export const useRuleUtils = (): {
TOPIC_EVENT: string
@@ -232,18 +226,24 @@ export const useRuleUtils = (): {
}
}
+export const SourceServerType = {
+ MQTTBroker: BridgeType.MQTT,
+}
+
/**
* Unlike RuleInputType, the action here is specific to what type of action it is.
*/
export const RuleSourceType = {
Message: 'message',
Event: 'event',
- MQTTBroker: BridgeType.MQTT,
+ ...SourceServerType,
}
export const useRuleInputs = (): {
getBridgeIdFromInput: (input: string) => string
detectInputType: (from: string) => string
+ isBridgeType: (type: string) => boolean
isNotBridgeSourceTypes: Array
+ sourceServerOptList: Array<{ value: string; label: string }>
sourceOptList: Array<{ value: string; label: string }>
getRuleSourceIcon: (type: string) => string
} => {
@@ -260,7 +260,7 @@ export const useRuleInputs = (): {
const typeLabelMap = {
[RuleSourceType.Message]: tl('messages'),
[RuleSourceType.Event]: tl('event'),
- [RuleSourceType.MQTTBroker]: tl('mqttBroker'),
+ [RuleSourceType.MQTT]: tl('mqttBroker'),
}
const { getBridgeLabelByTypeValue } = useBridgeTypeValue()
const getTypeLabel = (specificType: string): string => {
@@ -271,6 +271,11 @@ export const useRuleInputs = (): {
return ret || specificType
}
+ const sourceServerOptList = Object.entries(SourceServerType).map(([, value]) => ({
+ value,
+ label: getTypeLabel(value),
+ }))
+
const sourceOptList = Object.entries(RuleSourceType).map(([, value]) => ({
value,
label: getTypeLabel(value),
@@ -318,12 +323,12 @@ export const useRuleInputs = (): {
const adjustedType = adjustTypeForSpecialCases(type)
if (isTypeUsingNewIcon(adjustedType)) {
- return require(`@/assets/flowIcon/${adjustedType}.png`)
+ return getImg(`flowIcon/${adjustedType}.png`)
}
if (isBridgeType(type)) {
return getBridgeIcon(type)
}
- return require(`@/assets/img/${adjustedType}.png`)
+ return getImg(`img/${adjustedType}.png`)
} catch (error) {
return ''
}
@@ -332,7 +337,9 @@ export const useRuleInputs = (): {
return {
getBridgeIdFromInput,
detectInputType,
+ isBridgeType,
isNotBridgeSourceTypes,
+ sourceServerOptList,
sourceOptList,
getRuleSourceIcon,
}
diff --git a/src/hooks/Rule/rule/useRuleEvents.ts b/src/hooks/Rule/rule/useRuleEvents.ts
index 4a82c729a..dba08a149 100644
--- a/src/hooks/Rule/rule/useRuleEvents.ts
+++ b/src/hooks/Rule/rule/useRuleEvents.ts
@@ -1,8 +1,5 @@
import { getRuleEvents as queryRuleEvents } from '@/api/ruleengine'
import { RuleEvent } from '@/types/rule'
-import { camelCase } from 'lodash'
-import { useI18n } from 'vue-i18n'
-import { useStore } from 'vuex'
const EVENT_SORT: Array = [
'$events/client_check_authn_complete',
diff --git a/src/hooks/Rule/rule/useRuleForm.ts b/src/hooks/Rule/rule/useRuleForm.ts
index da481eddc..6d5b43cda 100644
--- a/src/hooks/Rule/rule/useRuleForm.ts
+++ b/src/hooks/Rule/rule/useRuleForm.ts
@@ -1,6 +1,3 @@
-import { DEFAULT_FROM, DEFAULT_SELECT } from '@/common/constants'
-import { createRandomString } from '@/common/tools'
-import { useRuleUtils } from '@/hooks/Rule/rule/useRule'
import { BasicRule, RuleItem } from '@/types/rule'
export default (): {
@@ -16,7 +13,7 @@ export default (): {
sql: transSQLFormDataToSQL(DEFAULT_SELECT, [from]),
actions: [],
description: '',
- enable: true
+ enable: true,
})
const getRuleDataForUpdate = ({
diff --git a/src/hooks/Rule/rule/useRuleSourceEvents.ts b/src/hooks/Rule/rule/useRuleSourceEvents.ts
index 2309220b3..fc9e268c9 100644
--- a/src/hooks/Rule/rule/useRuleSourceEvents.ts
+++ b/src/hooks/Rule/rule/useRuleSourceEvents.ts
@@ -1,9 +1,3 @@
-import useI18nTl from '@/hooks/useI18nTl'
-import { camelCase } from 'lodash'
-import { computed } from 'vue'
-import { useStore } from 'vuex'
-import { useRuleUtils } from './useRule'
-
export default (): {
eventDoNotNeedShow: string[]
isMsgPubEvent: (event: string) => boolean
diff --git a/src/hooks/Rule/rule/useRuleStatus.ts b/src/hooks/Rule/rule/useRuleStatus.ts
index dddc9433a..dced7544c 100644
--- a/src/hooks/Rule/rule/useRuleStatus.ts
+++ b/src/hooks/Rule/rule/useRuleStatus.ts
@@ -1,5 +1,4 @@
import { NodeStatusClass } from '@/types/enum'
-import { useI18n } from 'vue-i18n'
export default (): {
getStatusLabel: (enable: boolean | undefined) => string
diff --git a/src/hooks/Rule/useActionAndSourceStatus.ts b/src/hooks/Rule/useActionAndSourceStatus.ts
new file mode 100644
index 000000000..092cc6fc4
--- /dev/null
+++ b/src/hooks/Rule/useActionAndSourceStatus.ts
@@ -0,0 +1,26 @@
+import { ConnectionStatus } from '@/types/enum'
+
+const useActionAndSourceStatus = (): {
+ statusOptList: Array<{ value: ConnectionStatus; label: string }>
+ statusLabelMap: Partial>
+} => {
+ const { t, tl } = useI18nTl('RuleEngine')
+ const statusLabelMap = {
+ [ConnectionStatus.Connected]: tl('actionAvailable'),
+ [ConnectionStatus.Disconnected]: tl('actionUnavailable'),
+ [ConnectionStatus.Connecting]: t('Base.connecting'),
+ [ConnectionStatus.Inconsistent]: t('Base.inconsistent'),
+ }
+ const statusOptList = (Object.entries(statusLabelMap) as [ConnectionStatus, string][]).map(
+ ([key, value]) => ({
+ value: key,
+ label: value,
+ }),
+ )
+ return {
+ statusLabelMap,
+ statusOptList,
+ }
+}
+
+export default useActionAndSourceStatus
diff --git a/src/hooks/Rule/useDataHandler.ts b/src/hooks/Rule/useDataHandler.ts
index 40f950486..a9215430f 100644
--- a/src/hooks/Rule/useDataHandler.ts
+++ b/src/hooks/Rule/useDataHandler.ts
@@ -1,19 +1,16 @@
-import { checkNOmitFromObj } from '@/common/tools'
-import useSSL from '@/hooks/useSSL'
import { BridgeType } from '@/types/enum'
import { Action, Connector } from '@/types/rule'
-import { cloneDeep, get, omit, set } from 'lodash'
const keysDoNotNeedForAPI = [
'node_status',
'status',
'status_reason',
'error',
- 'role',
'idForRuleFrom',
'actions',
'id',
'rules',
+ 'last_modified_at',
]
const keysNeedDel = {
diff --git a/src/hooks/Rule/useProvidersForMonaco.ts b/src/hooks/Rule/useProvidersForMonaco.ts
index 0ccf169bf..6e8ddf2ae 100644
--- a/src/hooks/Rule/useProvidersForMonaco.ts
+++ b/src/hooks/Rule/useProvidersForMonaco.ts
@@ -1,14 +1,6 @@
-import { RULE_INPUT_BRIDGE_TYPE_PREFIX, RULE_INPUT_EVENT_PREFIX } from '@/common/constants'
-import { waitAMoment } from '@/common/tools'
import { BridgeItem, RuleEvent } from '@/types/rule'
-import { camelCase } from 'lodash'
import * as monaco from 'monaco-editor'
-import type { ComputedRef, Ref } from 'vue'
-import { computed, ref } from 'vue'
-import useI18nTl from '../useI18nTl'
import keysInRule from './KeysInRule'
-import useRuleSourceEvents from './rule/useRuleSourceEvents'
-import useSQLAvailablePlaceholder from './useSQLAvailablePlaceholder'
const { syntaxKeys, fieldsCanUse, builtInSQLFuncs, jqFunc } = keysInRule
diff --git a/src/hooks/Rule/useSQLAvailablePlaceholder.ts b/src/hooks/Rule/useSQLAvailablePlaceholder.ts
index b4362b50d..025432f62 100644
--- a/src/hooks/Rule/useSQLAvailablePlaceholder.ts
+++ b/src/hooks/Rule/useSQLAvailablePlaceholder.ts
@@ -1,4 +1,3 @@
-import { RULE_INPUT_BRIDGE_TYPE_PREFIX, RULE_INPUT_EVENT_PREFIX } from '@/common/constants'
import {
getKeyPartsFromSQL,
getRuleSelectionAlias,
@@ -6,12 +5,8 @@ import {
splitOnComma,
trimSpacesAndLFs,
} from '@/common/tools'
-import { useRuleUtils } from '@/hooks/Rule/rule/useRule'
import { RuleInputType } from '@/types/enum'
import { RuleEvent } from '@/types/rule'
-import { escapeRegExp, isUndefined } from 'lodash'
-import type { ComputedRef, Ref } from 'vue'
-import { computed, inject, ref } from 'vue'
// store kafka, rabbit columns...can not get from api like mqtt
const _events: Array = [] as Array
@@ -86,8 +81,8 @@ export default (): {
const itemType = checkIsBridge(item)
? RuleInputType.Bridge
: checkIsTopic(item)
- ? RuleInputType.Topic
- : RuleInputType.Event
+ ? RuleInputType.Topic
+ : RuleInputType.Event
const value =
itemType === RuleInputType.Bridge ? item.replace(ruleInputBridgeReg, '') : item
const targetEvent = getTestTargetEvent(itemType, value, totalEventList.value)
diff --git a/src/hooks/Schema/useItemLabelAndDesc.ts b/src/hooks/Schema/useItemLabelAndDesc.ts
index 302340464..aedc77787 100644
--- a/src/hooks/Schema/useItemLabelAndDesc.ts
+++ b/src/hooks/Schema/useItemLabelAndDesc.ts
@@ -1,4 +1,3 @@
-import { INTEGRATION_SCHEMA_TYPES } from '@/common/constants'
import {
useActionSchema,
useConnectorSchema,
@@ -6,8 +5,6 @@ import {
} from '@/hooks/Rule/bridge/useBridgeTypeValue'
import actionText from '@/schemaText/actionText/index'
import { Property } from '@/types/schemaForm'
-import { isFunction, snakeCase } from 'lodash'
-import { useI18n } from 'vue-i18n'
type GetTextKey = (prop: Property) => string
@@ -15,26 +12,6 @@ const numReg = /_\d/g
const customSnakeCase = (str: string) =>
snakeCase(str).replace(numReg, (match) => match.replace('_', ''))
-const DEFAULT_ZONE = 'emqx_schema'
-const TYPE_ZONE_MAP: Record> = {
- emqx_schema: ['mqtt', 'session', 'sysmon'],
- emqx_conf_schema: ['log'],
- emqx_limiter_schema: ['limiter'],
-}
-
-/**
- * For Log Configuration
- */
-const LOG_DEFAULT_PREFIX = 'common_handler_'
-const LOG_SPECIAL_KEY_PREFIX_MAP = {
- log_overload_kill_: ['mem_size', 'qlen', 'restart_after'],
- log_burst_limit_: ['max_count', 'window_time'],
- log_file_handler_: ['max_size', 'path', 'rotation_size'],
- log_rotation_: ['count'],
-}
-
-const SYS_MON_PREFIX = 'sysmon_'
-
// Bridge
const COMMON_ZONE = 'common'
const COMMON_FIELD_KEYS = Object.keys(actionText.en.common)
@@ -61,47 +38,20 @@ export default (
}
getOptLabel: (key: string) => string
} => {
+ const CONFIG_TEXT_BASE = 'ConfigSchema.'
const { t, te } = useI18n()
+ const testConfigTextKey = (key: string) => te(`${CONFIG_TEXT_BASE}${key}.label`)
const typesUseBridgeText = INTEGRATION_SCHEMA_TYPES
- /**
- * zone is first level
- */
- const getConfigurationTextZone = () =>
- Object.keys(TYPE_ZONE_MAP).find((key) => TYPE_ZONE_MAP[key].includes(props.type)) ||
- DEFAULT_ZONE
-
- const getMQTTAndSessionItemTextKey = ({ path }: Property) =>
- `${getConfigurationTextZone()}.${customSnakeCase(path as string)}`
-
- const getLogItemTextKey = ({ key, path }: Property) => {
- const prefix =
- Object.entries(LOG_SPECIAL_KEY_PREFIX_MAP).find(
- ([, value]) => value.includes(path as string) || value.includes(key as string),
- )?.[0] || LOG_DEFAULT_PREFIX
- return `${getConfigurationTextZone()}.${prefix}${key}`
- }
-
- const getSysMonTextKey = ({ path }: Property) =>
- `${getConfigurationTextZone()}.${SYS_MON_PREFIX}${customSnakeCase(path as string)}`
-
- const getLimiterTextKey = ({ key }: Property) => `${getConfigurationTextZone()}.${key}`
-
- const funcMap: Record = {
- mqtt: getMQTTAndSessionItemTextKey,
- session: getMQTTAndSessionItemTextKey,
- log: getLogItemTextKey,
- sysmon: getSysMonTextKey,
- limiter: getLimiterTextKey,
+ const commonGetConfigItemKey = ({ key, path }: Property) => {
+ const exactKey = `${props.type}_${customSnakeCase(path as string)}`
+ const fullKey = testConfigTextKey(`${exactKey}`) ? `${exactKey}` : (key as string)
+ return fullKey
}
const getConfigurationItemTextKey = (prop: Property) => {
- const func = funcMap[props.type]
- if (func && isFunction(func)) {
- return func(prop)
- }
- return prop.path
+ return commonGetConfigItemKey(prop)
}
const { getTypeByConnectorSchemaRef } = useConnectorSchema()
@@ -119,7 +69,7 @@ export default (
}
const getHotConfText = (prop: Property) => {
- const textKey = 'ConfigSchema.' + getConfigurationItemTextKey(prop)
+ const textKey = CONFIG_TEXT_BASE + getConfigurationItemTextKey(prop)
const descKey = `${textKey}.desc`
if (textKey) {
return {
diff --git a/src/hooks/Schema/useSchemaForm.ts b/src/hooks/Schema/useSchemaForm.ts
index b02384f5d..313351836 100644
--- a/src/hooks/Schema/useSchemaForm.ts
+++ b/src/hooks/Schema/useSchemaForm.ts
@@ -1,12 +1,7 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
+import { PropType } from '@/types/enum'
import { Component, Properties, Property, Schema } from '@/types/schemaForm'
import axios from 'axios'
-import { cloneDeep, get } from 'lodash'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import { useStore } from 'vuex'
-import useSchemaFormRules, { SchemaRules } from './useSchemaFormRules'
-import useSchemaRecord from './useSchemaRecord'
const CONNECTOR_CONF_KEYS = 'connector'
@@ -89,6 +84,13 @@ export default function useSchemaForm(
const getComponentByRef = (data: Schema, ref: string | Array): Component =>
get(data, filter(ref), {})
+ const getIsTemplateFromOneOfArr = (oneof: Property['oneOf']): boolean => {
+ if (!oneof) {
+ return false
+ }
+ return oneof.some((item) => item.is_template)
+ }
+
/**
* Calling it before components are assigned as much as possible will reduce the number of re-renders,
* but because sometimes data such as `format` may be custom modified by the parent component
@@ -110,6 +112,7 @@ export default function useSchemaForm(
}
return property
}
+ const simpleTypes = ['string', 'number', 'boolean', 'integer']
const getComponents = (objForGetComponent: { path?: string; ref?: string | Array }) => {
let lastLabel = ''
/**
@@ -202,6 +205,18 @@ export default function useSchemaForm(
}
return item
}) as Property[]
+ property.is_template = property.is_template ?? getIsTemplateFromOneOfArr(property.oneOf)
+ const isSimpleOneof = oneOf.every(({ type }) => simpleTypes.includes(type))
+ if (isSimpleOneof && property.is_template) {
+ const justWithBoolean =
+ oneOf.length === 2 &&
+ oneOf.every(({ type }) =>
+ [PropType.Boolean, PropType.String].includes(type as PropType),
+ )
+ property.type = justWithBoolean ? 'enum' : 'string'
+ property.symbols = justWithBoolean ? [true, false] : undefined
+ property.default = property.default ?? (justWithBoolean ? '' : undefined)
+ }
}
if (!label) {
property.label = lastLabel
diff --git a/src/hooks/Schema/useSchemaFormRules.ts b/src/hooks/Schema/useSchemaFormRules.ts
index 4ec75ce96..5b236e520 100644
--- a/src/hooks/Schema/useSchemaFormRules.ts
+++ b/src/hooks/Schema/useSchemaFormRules.ts
@@ -1,12 +1,6 @@
-import { transTimeStrToMS } from '@/common/tools'
import { FormRules } from '@/types/common'
import { PropType } from '@/types/enum'
import { Component } from '@/types/schemaForm'
-import { isNumber, isString, isUndefined } from 'lodash'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import useFormRules from '../useFormRules'
-import useI18nTl from '../useI18nTl'
export type SchemaRules = FormRules
diff --git a/src/hooks/Schema/useSchemaRecord.ts b/src/hooks/Schema/useSchemaRecord.ts
index f9b0b5607..23d45ee5b 100644
--- a/src/hooks/Schema/useSchemaRecord.ts
+++ b/src/hooks/Schema/useSchemaRecord.ts
@@ -1,6 +1,5 @@
import { PropType } from '@/types/enum'
import { Properties, Property } from '@/types/schemaForm'
-import { set } from 'lodash'
export default (): {
createInitValueByType: (prop: Property) => any
diff --git a/src/hooks/Webhook/useWebhookForm.ts b/src/hooks/Webhook/useWebhookForm.ts
index 53cca761d..b94c99fe5 100644
--- a/src/hooks/Webhook/useWebhookForm.ts
+++ b/src/hooks/Webhook/useWebhookForm.ts
@@ -1,13 +1,6 @@
-import { WEBHOOK_SUFFIX } from '@/common/constants'
-import { getAPIPath } from '@/common/tools'
-import useRuleForm from '@/hooks/Rule/rule/useRuleForm'
import { BridgeType } from '@/types/enum'
import { ConnectorForm, HTTPBridge } from '@/types/rule'
import { WebhookForm } from '@/types/webhook'
-import { pick } from 'lodash'
-import { useActionSchema } from '../Rule/bridge/useBridgeTypeValue'
-import useSchemaForm from '../Schema/useSchemaForm'
-import useSchemaRecord from '../Schema/useSchemaRecord'
export default (): {
createRawWebhookForm: () => Promise
diff --git a/src/hooks/Webhook/useWebhookItem.ts b/src/hooks/Webhook/useWebhookItem.ts
index 5ff083760..a7b4c0c78 100644
--- a/src/hooks/Webhook/useWebhookItem.ts
+++ b/src/hooks/Webhook/useWebhookItem.ts
@@ -1,14 +1,11 @@
import { deleteAction, putActionEnable } from '@/api/action'
-import { deleteConnector } from '@/api/connector'
+import { deleteConnector, putConnectorEnable } from '@/api/connector'
import { deleteRules, updateRules } from '@/api/ruleengine'
import { WebhookItem } from '@/types/webhook'
import { ElMessage as M, ElMessageBox as MB } from 'element-plus'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import { useI18n } from 'vue-i18n'
export default (): {
- toggleWebhookEnableStatus: (webhook: WebhookItem) => Promise<[any, any]>
+ toggleWebhookEnableStatus: (webhook: WebhookItem) => Promise<[any, any, any]>
deleteLoading: Ref
deleteWebhook: (webhook: WebhookItem) => Promise
} => {
@@ -23,6 +20,7 @@ export default (): {
return await Promise.all([
toggleBridgeEnableStatus(webhook.action.id, enable),
toggleRuleEnableStatus(webhook.rule.id, enable),
+ putConnectorEnable(webhook.connector.id, enable),
])
}
diff --git a/src/hooks/Webhook/useWebhookList.ts b/src/hooks/Webhook/useWebhookList.ts
index 57f7c2252..b07c9e46c 100644
--- a/src/hooks/Webhook/useWebhookList.ts
+++ b/src/hooks/Webhook/useWebhookList.ts
@@ -1,12 +1,8 @@
import { getActions as queryActions } from '@/api/action'
import { getConnectors as queryConnectors } from '@/api/connector'
import { getRules as queryRules } from '@/api/ruleengine'
-import { getAllListData } from '@/common/tools'
import { BridgeItem, Connector, HTTPBridge, RuleItem } from '@/types/rule'
import { WebhookItem } from '@/types/webhook'
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-import useWebhookUtils from './useWebhookUtils'
export default (): {
webhookList: Ref
diff --git a/src/hooks/Webhook/useWebhookUtils.ts b/src/hooks/Webhook/useWebhookUtils.ts
index df243aef4..72ef4b9f0 100644
--- a/src/hooks/Webhook/useWebhookUtils.ts
+++ b/src/hooks/Webhook/useWebhookUtils.ts
@@ -1,5 +1,3 @@
-import { WEBHOOK_SUFFIX } from '@/common/constants'
-import { useBridgeTypeValue } from '@/hooks/Rule/bridge/useBridgeTypeValue'
import { BridgeType, RuleOutput } from '@/types/enum'
import { BridgeItem, Connector, HTTPBridge, OutputItem, RuleItem } from '@/types/rule'
import { WebhookItem } from '@/types/webhook'
@@ -48,11 +46,11 @@ export default (): {
}
const judgeIsWebhookAction = (action: BridgeItem) => {
- const { type, name, connector } = action
- if (!(type === BridgeType.Webhook && webhookTargetReg.test(name))) {
+ const { type, name, rules } = action
+ if (!(type === BridgeType.Webhook && webhookTargetReg.test(name) && rules?.length > 0)) {
return false
}
- return name === connector
+ return rules.some((ruleName: string) => ruleName === name)
}
const judgeOutputsContainWebhook = (rule: RuleItem) => {
diff --git a/src/hooks/useAdaptiveEditor.ts b/src/hooks/useAdaptiveEditor.ts
index 6ffef80a6..f36538e74 100644
--- a/src/hooks/useAdaptiveEditor.ts
+++ b/src/hooks/useAdaptiveEditor.ts
@@ -1,6 +1,3 @@
-import type { Ref } from 'vue'
-import { computed, nextTick, onMounted, onUnmounted, ref, watch } from 'vue'
-
interface UseAdaptiveEditorOptions {
initialContent: Ref
maxHeightRatio?: number
@@ -15,7 +12,7 @@ interface UseAdaptiveEditorReturn {
updateEditorHeight: () => void
}
-export function useAdaptiveEditor({
+export default function useAdaptiveEditor({
initialContent,
maxHeightRatio = 0.9,
minHeight = 100,
@@ -59,5 +56,3 @@ export function useAdaptiveEditor({
updateEditorHeight,
}
}
-
-export default {}
diff --git a/src/hooks/useClusterNodes.ts b/src/hooks/useClusterNodes.ts
index 017c90899..e22983df1 100644
--- a/src/hooks/useClusterNodes.ts
+++ b/src/hooks/useClusterNodes.ts
@@ -1,6 +1,3 @@
-import type { Ref } from 'vue'
-import { ref, reactive } from 'vue'
-import _ from 'lodash'
import { compareVersions } from 'compare-versions'
import { loadNodes } from '@/api/common'
import { NodeInfo } from '@/types/dashboard'
@@ -37,7 +34,7 @@ export default function useClusterNodes(
const handleVersions = (nodes: NodeInfo[]) => {
const versionList = nodes.map((node) => node.version.split('-')[0])
- const uniqueVersions = _.uniq(versionList)
+ const uniqueVersions = uniq(versionList)
versionInfo.isMutiVersion = uniqueVersions.length > 1
if (versionInfo.isMutiVersion) {
versionInfo.latestVersion = uniqueVersions.reduce((latest, version) => {
diff --git a/src/hooks/useCommonConnectionStatus.ts b/src/hooks/useCommonConnectionStatus.ts
index f965a7eb3..b13e7a9ec 100644
--- a/src/hooks/useCommonConnectionStatus.ts
+++ b/src/hooks/useCommonConnectionStatus.ts
@@ -1,4 +1,3 @@
-import useI18nTl from '@/hooks/useI18nTl'
import { ConnectionStatus, NodeStatusClass } from '@/types/enum'
export default (): {
diff --git a/src/hooks/useCopy.ts b/src/hooks/useCopy.ts
index b7f3c481d..c065367f0 100644
--- a/src/hooks/useCopy.ts
+++ b/src/hooks/useCopy.ts
@@ -1,7 +1,4 @@
import copy from 'copy-to-clipboard'
-import { ElMessage } from 'element-plus'
-import { onBeforeUnmount } from 'vue'
-import { useI18n } from 'vue-i18n'
export default function useCopy(callback?: () => void): {
copyText: (text: string) => Promise
diff --git a/src/hooks/useDataNotSaveConfirm.ts b/src/hooks/useDataNotSaveConfirm.ts
index c332760ca..8964a7304 100644
--- a/src/hooks/useDataNotSaveConfirm.ts
+++ b/src/hooks/useDataNotSaveConfirm.ts
@@ -1,11 +1,3 @@
-import useI18nTl from '@/hooks/useI18nTl'
-import { ElMessageBox } from 'element-plus'
-import { isFunction } from 'lodash'
-import { onMounted, onUnmounted, Ref } from 'vue'
-import { onBeforeRouteLeave } from 'vue-router'
-import { useStore } from 'vuex'
-import { isEqual, cloneDeep } from 'lodash'
-
export const useCheckDataChanged = (
nowData: Ref,
): {
diff --git a/src/hooks/useDatePickerShortcuts.ts b/src/hooks/useDatePickerShortcuts.ts
index 82215f64d..ecb6e8523 100644
--- a/src/hooks/useDatePickerShortcuts.ts
+++ b/src/hooks/useDatePickerShortcuts.ts
@@ -1,5 +1,3 @@
-import useI18nTl from './useI18nTl'
-
export default (): {
datePickerShortcuts: {
text: string
diff --git a/src/hooks/useDocLink.ts b/src/hooks/useDocLink.ts
index f70a3a3a5..c04ad5e22 100644
--- a/src/hooks/useDocLink.ts
+++ b/src/hooks/useDocLink.ts
@@ -1,4 +1,3 @@
-import { useI18n } from 'vue-i18n'
import getDocLinks, { DocMap } from '@/common/docLinks'
export default (): { docMap: DocMap } => {
diff --git a/src/hooks/useDurationStr.ts b/src/hooks/useDurationStr.ts
index 79bce1cdb..bb06ebc96 100644
--- a/src/hooks/useDurationStr.ts
+++ b/src/hooks/useDurationStr.ts
@@ -1,5 +1,4 @@
import { TimeUnit } from '@/types/enum'
-import useI18nTl from './useI18nTl'
const timeUnitArr: Array = [
TimeUnit.Millisecond,
diff --git a/src/hooks/useEchartResize.ts b/src/hooks/useEchartResize.ts
index fb709e326..76f01bb9a 100644
--- a/src/hooks/useEchartResize.ts
+++ b/src/hooks/useEchartResize.ts
@@ -1,7 +1,4 @@
-import { waitAMoment } from '@/common/tools'
import { ECharts } from 'echarts'
-import { nextTick, onUnmounted, watch } from 'vue'
-import { useStore } from 'vuex'
export default (): {
addListener: (chart: ECharts) => void
diff --git a/src/hooks/useEditionConfigs.ts b/src/hooks/useEditionConfigs.ts
index 315062757..5bf081361 100644
--- a/src/hooks/useEditionConfigs.ts
+++ b/src/hooks/useEditionConfigs.ts
@@ -1,18 +1,19 @@
-import { IS_ENTERPRISE } from '@/common/constants'
-import { computed, ComputedRef } from 'vue'
-import { useI18n } from 'vue-i18n'
+import enterpriseLogo from '@/assets/img/emqx-logo-enterprise.svg'
+import openSourceLogo from '@/assets/img/emqx-logo-open-source.png'
+import enterpriseBanner from '@/assets/img/login-banner-enterprise.png'
+import openSourceBanner from '@/assets/img/login-banner-open-source.png'
// Configs for different editions
const editionConfigs = {
enterprise: {
title: 'Base.enterpriseEdition',
- banner: require('@/assets/img/login-banner-enterprise.png'),
- logo: require('@/assets/img/emqx-logo-enterprise.svg'),
+ banner: enterpriseBanner,
+ logo: enterpriseLogo,
},
openSource: {
title: 'Base.openSourceEdition',
- banner: require('@/assets/img/login-banner-open-source.png'),
- logo: require('@/assets/img/emqx-logo-open-source.png'),
+ banner: openSourceBanner,
+ logo: openSourceLogo,
},
}
diff --git a/src/hooks/useFillNewRecord.ts b/src/hooks/useFillNewRecord.ts
index dc4fc2b46..e59214d34 100644
--- a/src/hooks/useFillNewRecord.ts
+++ b/src/hooks/useFillNewRecord.ts
@@ -2,7 +2,6 @@
* fill new record by old record, old component and new component
*/
import { Properties } from '@/types/schemaForm'
-import { cloneDeep, get, omit, set } from 'lodash'
interface Val {
components: Properties
diff --git a/src/hooks/useFormRules.ts b/src/hooks/useFormRules.ts
index 2ff16d338..c80a0f1ad 100644
--- a/src/hooks/useFormRules.ts
+++ b/src/hooks/useFormRules.ts
@@ -1,9 +1,5 @@
-import { COMMON_ID_REG } from '@/common/constants'
-import { checkInRange, checkStringWithUnit } from '@/common/tools'
import { InternalRuleItem } from 'async-validator'
import { FormItemRule } from 'element-plus'
-import { isUndefined } from 'lodash'
-import { useI18n } from 'vue-i18n'
export const NO_CHINESE_REG = /^[^\u4e00-\u9fa5]+$/
@@ -61,8 +57,8 @@ export default (): {
min !== undefined && max !== undefined
? t('Rule.errorRange', { min, max })
: min !== undefined
- ? t('Rule.minimumError', { min })
- : t('Rule.maximumError', { max })
+ ? t('Rule.minimumError', { min })
+ : t('Rule.maximumError', { max })
return [{ type: 'number', min, max, message: errorMsg, trigger: 'change' }]
}
diff --git a/src/hooks/useGuide.ts b/src/hooks/useGuide.ts
index 20137d601..4732232af 100644
--- a/src/hooks/useGuide.ts
+++ b/src/hooks/useGuide.ts
@@ -1,6 +1,3 @@
-import { ref } from 'vue'
-import { isFunction } from 'lodash'
-
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export default function useGuide(before?: () => void) {
const activeGuidesIndex = ref([0])
diff --git a/src/hooks/useI18nTl.ts b/src/hooks/useI18nTl.ts
index 237835a28..6b29207a0 100644
--- a/src/hooks/useI18nTl.ts
+++ b/src/hooks/useI18nTl.ts
@@ -1,5 +1,3 @@
-import { useI18n, ComposerTranslation } from 'vue-i18n'
-
export default function useI18nTl(collection: string): {
t: ComposerTranslation
tl: (
diff --git a/src/hooks/useMetrics.ts b/src/hooks/useMetrics.ts
index 37d6d643f..7f6ac73d3 100644
--- a/src/hooks/useMetrics.ts
+++ b/src/hooks/useMetrics.ts
@@ -1,5 +1,3 @@
-import { accAdd, transMemorySizeNumToStr } from '@/common/tools'
-import useEchartResize from '@/hooks/useEchartResize'
import { Metrics } from '@/types/common'
import { BarSeriesOption, ECharts, EChartsOption, PieSeriesOption } from 'echarts'
import 'echarts/lib/chart/bar'
@@ -9,10 +7,7 @@ import 'echarts/lib/component/grid'
import 'echarts/lib/component/title'
import 'echarts/lib/component/tooltip'
import * as echarts from 'echarts/lib/echarts'
-import { get, isUndefined } from 'lodash'
-import moment from 'moment'
-import useI18nTl from './useI18nTl'
-import { ref } from 'vue'
+import dayjs from 'dayjs'
export const enum MetricType {
Green,
@@ -254,17 +249,20 @@ export const useChartDataUtils = (): {
}
const { title, contains: values } = value
let typeCount = 0
- const typeList = values.reduce((ret, key) => {
- const value = get(metrics, key)
- const item = {
- value,
- label: getMetricItemLabel(key, textMap),
- desc: getMetricItemDesc(key, textMap),
- }
- typeCount = accAdd(typeCount, value)
- ret.push(item)
- return ret
- }, [] as Array<{ value: number; label: string; desc?: string }>)
+ const typeList = values.reduce(
+ (ret, key) => {
+ const value = get(metrics, key)
+ const item = {
+ value,
+ label: getMetricItemLabel(key, textMap),
+ desc: getMetricItemDesc(key, textMap),
+ }
+ typeCount = accAdd(typeCount, value)
+ ret.push(item)
+ return ret
+ },
+ [] as Array<{ value: number; label: string; desc?: string }>,
+ )
arr.push({ title, count: typeCount, detail: typeList, type: Number(key) as MetricType })
return arr
}, [] as Array)
@@ -302,7 +300,7 @@ export const useChartDataUtils = (): {
x: createEmptyArray(length),
y: createEmptyArray(length),
})
- const getNow = () => moment().format('HH:mm:ss')
+ const getNow = () => dayjs().format('HH:mm:ss')
const addRateDataItem = (rate: number, rateData: RateData, dataLen: number) => {
rateData.x.push(getNow())
rateData.y.push(rate)
@@ -321,6 +319,38 @@ export const useChartDataUtils = (): {
}
}
+export const useSizeMetric = () => {
+ const getSizeStr = (bytes: number) => transMemorySizeNumToStr(bytes, 2)
+ const numPartReg = /^-?\d+(\.\d+)?/
+ const getSizeNumPart = (size: string) => numPartReg.exec(size)?.[0] || '0'
+ const getSizeUnitPart = (size: string) => size.replace(numPartReg, '') || 'Bytes'
+
+ const getSizeNum = (size: number) => formatNumber(getSizeNumPart(getSizeStr(size)))
+ const getSizeUnit = (size: number) => getSizeUnitPart(getSizeStr(size))
+
+ return {
+ getSizeStr,
+ getSizeNumPart,
+ getSizeUnitPart,
+ getSizeNum,
+ getSizeUnit,
+ }
+}
+
+export const useNodeOpts = () => {
+ const { tl } = useI18nTl('BasicConfig')
+ const CLUSTER = 'cluster'
+ const clusterOpt = { label: tl('cluster'), value: CLUSTER }
+ const getNodeOpts = (nodes: Array) => [
+ clusterOpt,
+ ...nodes.map((node) => ({ value: node, label: node })),
+ ]
+ return {
+ CLUSTER,
+ getNodeOpts,
+ }
+}
+
interface Rate {
unitKey: string
current: string
@@ -394,10 +424,7 @@ export const useBridgeMetrics = (): {
}
export const useActionQueueMetrics = () => {
- const getSizeStr = (bytes: number) => transMemorySizeNumToStr(bytes, 2)
- const numPartReg = /^-?\d+(\.\d+)?/
- const getSizeNumPart = (size: string) => numPartReg.exec(size)?.[0] || '0'
- const getSizeUnitPart = (size: string) => size.replace(numPartReg, '') || 'Bytes'
+ const { getSizeStr, getSizeNumPart, getSizeUnitPart } = useSizeMetric()
const queueBytesDataLength = 20
const completeQueueBytesDataData = (
@@ -453,7 +480,7 @@ export const useActionQueueMetrics = () => {
if (isUndefined(value)) {
return tl('noData')
}
- return `${moment(Number(axisValue)).format('HH:mm:ss')}
${getSizeStr(value)}` + return `${dayjs(Number(axisValue)).format('HH:mm:ss')}
${getSizeStr(value)}` }, }, color: [TYPE_COLOR_MAP[MetricType.Blue]], diff --git a/src/hooks/useOperationConfirm.ts b/src/hooks/useOperationConfirm.ts index 509b2caf2..0c985f43a 100644 --- a/src/hooks/useOperationConfirm.ts +++ b/src/hooks/useOperationConfirm.ts @@ -1,7 +1,4 @@ import type { MessageBoxData } from 'element-plus' -import { ElMessage, ElMessageBox } from 'element-plus' -import { isFunction } from 'lodash' -import useI18nTl from './useI18nTl' export default (): { operationWarning: (confirmText: string, opts?: Record) => Promise
@@ -33,7 +30,7 @@ export default (): {
if (callback && isFunction(callback)) {
await callback()
}
- sucText ?? ElMessage.success(sucText)
+ sucText && ElMessage.success(sucText)
return Promise.resolve()
} catch (error) {
return Promise.reject(error)
diff --git a/src/hooks/usePagination.ts b/src/hooks/usePagination.ts
index 6ac7ad873..2a2fced0d 100644
--- a/src/hooks/usePagination.ts
+++ b/src/hooks/usePagination.ts
@@ -1,6 +1,4 @@
import { PageData } from '@/types/common'
-import type { ComputedRef, Ref, WritableComputedRef } from 'vue'
-import { computed, ref } from 'vue'
export default (): {
page: Ref
diff --git a/src/hooks/usePaginationRemember.ts b/src/hooks/usePaginationRemember.ts
index 1ec5ed20d..0edb34f88 100644
--- a/src/hooks/usePaginationRemember.ts
+++ b/src/hooks/usePaginationRemember.ts
@@ -1,8 +1,5 @@
import { parseJSONSafely } from '@emqx/shared-ui-utils'
import { PageData } from '@/types/common'
-import { omit } from 'lodash'
-import { Ref } from 'vue'
-import { RouteLocationRaw, onBeforeRouteLeave, useRoute, useRouter } from 'vue-router'
const STORE_KEY = 'list_page_params'
diff --git a/src/hooks/usePaginationWithHasNext.ts b/src/hooks/usePaginationWithHasNext.ts
index ef9890dbd..f396f32e9 100644
--- a/src/hooks/usePaginationWithHasNext.ts
+++ b/src/hooks/usePaginationWithHasNext.ts
@@ -1,6 +1,4 @@
import { PageData } from '@/types/common'
-import type { ComputedRef, Ref } from 'vue'
-import { computed, ref } from 'vue'
const generateDefaultPageMeta = (): PageData => ({
limit: 20,
diff --git a/src/hooks/usePaging.ts b/src/hooks/usePaging.ts
index 87320b40e..9a6953ae4 100644
--- a/src/hooks/usePaging.ts
+++ b/src/hooks/usePaging.ts
@@ -1,6 +1,4 @@
import { ListDataWithPagination } from '@/types/common'
-import _ from 'lodash'
-import { ref, Ref } from 'vue'
type ListData = Array
@@ -9,9 +7,9 @@ interface PageMeta {
limit: number
}
-export interface FilterItem {
+export interface DataFilterItem {
key: string
- value: string
+ value: string | boolean | RegExp
}
interface SortFrom {
@@ -26,13 +24,13 @@ export default (): {
setTotalData: (data: ListData) => void
getAPageData: (
pageMeta: PageMeta,
- filters?: Array,
+ filters?: Array,
sortFrom?: SortFrom,
) => ListDataWithPagination
} => {
const totalData: Ref = ref([])
// Use the following six variables to do a cache-like operation to reduce computational overhead
- let latestFiltersString = ''
+ let latestFilters: Array = []
const listAfterFilter: Ref = ref([])
let latestSortFromString: string | undefined = undefined
const listAfterFilterNSort: Ref = ref([])
@@ -46,14 +44,27 @@ export default (): {
chunkList()
}
- const filterList = (filters: Array = []) => {
- latestFiltersString = JSON.stringify(filters)
+ const checkValue = (filterValue: string | boolean | RegExp, value: any) => {
+ if (typeof filterValue === 'string') {
+ const reg = new RegExp(filterValue, 'i')
+ if (Array.isArray(value)) {
+ return value.some((item) => reg.test(item))
+ }
+ return reg.test(value)
+ } else if (isRegExp(filterValue)) {
+ return filterValue.test(value)
+ }
+ return filterValue === value
+ }
+
+ const filterList = (filters: Array = []) => {
+ latestFilters = cloneDeep(filters)
if (filters.length === 0) {
listAfterFilter.value = totalData.value
} else {
- listAfterFilter.value = totalData.value.filter((item) =>
- filters.every(({ key, value }) => item[key]?.indexOf && item[key].indexOf(value) > -1),
- )
+ listAfterFilter.value = totalData.value.filter((item) => {
+ return filters.every(({ key, value: filterValue }) => checkValue(filterValue, item[key]))
+ })
}
}
@@ -63,21 +74,21 @@ export default (): {
listAfterFilterNSort.value = listAfterFilter.value
} else {
latestSortFromString = JSON.stringify(sortFrom)
- listAfterFilterNSort.value = _.orderBy(listAfterFilter.value, [sortFrom.key], [sortFrom.type])
+ listAfterFilterNSort.value = orderBy(listAfterFilter.value, [sortFrom.key], [sortFrom.type])
}
}
const chunkList = (pageSize = DEFAULT_PAGE_SIZE) => {
currentPageSize = pageSize
- currentChunks.value = _.chunk(listAfterFilterNSort.value, currentPageSize)
+ currentChunks.value = chunk(listAfterFilterNSort.value, currentPageSize)
}
const getAPageData = (
pageMeta: PageMeta,
- filters: Array = [],
+ filters: Array = [],
sortFrom?: SortFrom,
) => {
- if (latestFiltersString !== JSON.stringify(filters)) {
+ if (!isEqual(latestFilters, filters)) {
filterList(filters)
sortList(sortFrom)
chunkList(pageMeta.limit)
diff --git a/src/hooks/usePassword.ts b/src/hooks/usePassword.ts
index e6040c6c1..eda665313 100644
--- a/src/hooks/usePassword.ts
+++ b/src/hooks/usePassword.ts
@@ -1,6 +1,3 @@
-import type { Ref } from 'vue'
-import { ref } from 'vue'
-
export default function usePassword(): {
HashOptions: Ref
} {
diff --git a/src/hooks/useRuleFunc.ts b/src/hooks/useRuleFunc.ts
deleted file mode 100644
index afd72248f..000000000
--- a/src/hooks/useRuleFunc.ts
+++ /dev/null
@@ -1,108 +0,0 @@
-import RuleFunc from '@/hooks/Rule/RuleFunc.json'
-import useI18nTl from './useI18nTl'
-
-export const enum ArgumentType {
- Number = 'number',
- Any = 'any',
- Float = 'float',
- Integer = 'integer',
- String = 'string',
- Enum = 'enum',
- Object = 'object',
- Array = 'array',
- Binary = 'binary',
-}
-
-export interface ArgItem {
- name: string
- type: ArgumentType
- required: boolean
- optionalValues?: Array
- /**
- * for type number
- */
- range?: [null | number, null | number]
- default?: string | number
-}
-
-export interface FuncItem {
- name: string
- args: Array
-}
-
-interface GroupFuncData {
- groupLabel: string
- name: string
- value: string
- list: Array
-}
-
-type FuncData = Array
-
-export default (): {
- funcOptList: FuncData
- getFuncItemByName: (name: string) => FuncItem | null
- getFuncGroupByName: (name: string) => string | null
- getArgIndex: (func: FuncItem, groupLabel: string) => number
-} => {
- const { tl } = useI18nTl('Function')
-
- const funcOptList: FuncData = (RuleFunc as FuncData).map(({ groupLabel, list }) => ({
- groupLabel,
- name: tl(groupLabel),
- value: groupLabel,
- list: list.filter((item) => item.args.length) as Array,
- }))
-
- const getFuncItemByName = (name: string): FuncItem | null => {
- for (const { list } of funcOptList) {
- for (const item of list) {
- if (item.name === name) {
- return item
- }
- }
- }
- return null
- }
-
- const getFuncGroupByName = (name: string): string | null => {
- for (const { groupLabel, list } of funcOptList) {
- for (const item of list) {
- if (item.name === name) {
- return groupLabel
- }
- }
- }
- return null
- }
-
- const funcGroupMainArgTypeMap: Record = {
- stringFunc: ArgumentType.String,
- mapFunc: ArgumentType.Object,
- arrFunc: ArgumentType.Array,
- }
- /**
- * Get the index of the most important parameter in a function
- */
- const getArgIndex = (func: FuncItem, groupLabel: string) => {
- const targetArgType = funcGroupMainArgTypeMap[groupLabel]
- let targetIndex = -1
-
- // Find the first parameter of the current group operation type,
- // if not found, it will be placed first by default
- if (targetArgType) {
- targetIndex = func.args.findIndex((item) => item.type === targetArgType)
- } else if (/time/i.test(groupLabel)) {
- targetIndex = func.args.findIndex((item) => /timestamp/i.test(item.name))
- }
- targetIndex = targetIndex > -1 ? targetIndex : 0
- return targetIndex
- }
-
- return {
- funcOptList,
- getFuncItemByName,
- getFuncGroupByName,
- getArgIndex,
- }
-}
diff --git a/src/hooks/useSSL.ts b/src/hooks/useSSL.ts
index 0198b9def..6ee6a1762 100644
--- a/src/hooks/useSSL.ts
+++ b/src/hooks/useSSL.ts
@@ -1,6 +1,4 @@
-import { DEFAULT_SSL_VERIFY_VALUE } from '@/common/constants'
import { SSL } from '@/types/common'
-import { cloneDeep, omit } from 'lodash'
type CreateSSLForm = () => SSL
type HandleSSLDataBeforeSubmit = (data: SSL) => SSL
diff --git a/src/hooks/useShowTextByDifferent.ts b/src/hooks/useShowTextByDifferent.ts
index f4146a4cc..921a53ee3 100644
--- a/src/hooks/useShowTextByDifferent.ts
+++ b/src/hooks/useShowTextByDifferent.ts
@@ -1,9 +1,5 @@
-import type { Ref } from 'vue'
-import { ref, watch } from 'vue'
-import { SHOW_PAYLOAD_BY_WHICH_OPTION_LIST } from '@/common/constants'
import { encode, decode } from 'js-base64'
import { PayloadShowByType } from '@/types/enum'
-import { ElMessage } from 'element-plus'
/**
* format obj str
diff --git a/src/hooks/useSortableTable.ts b/src/hooks/useSortableTable.ts
index 94f3e4bf1..d7869c106 100644
--- a/src/hooks/useSortableTable.ts
+++ b/src/hooks/useSortableTable.ts
@@ -1,6 +1,4 @@
import Sortable, { SortableEvent } from 'sortablejs'
-import type { Ref } from 'vue'
-import { Component, ref } from 'vue'
export default (
onUpdate: (evt: SortableEvent) => void,
diff --git a/src/hooks/useSyncPolling.ts b/src/hooks/useSyncPolling.ts
index 159878d92..640272dcc 100644
--- a/src/hooks/useSyncPolling.ts
+++ b/src/hooks/useSyncPolling.ts
@@ -1,5 +1,3 @@
-import { onUnmounted, ref, Ref } from 'vue'
-
export default (): {
needPolling: Ref
syncPolling: (queryData: () => Promise, interval: number) => Promise
diff --git a/src/hooks/useTwoWayBindingManually.ts b/src/hooks/useTwoWayBindingManually.ts
index 84fbba8a9..3e8cecd40 100644
--- a/src/hooks/useTwoWayBindingManually.ts
+++ b/src/hooks/useTwoWayBindingManually.ts
@@ -1,5 +1,3 @@
-import { get, set } from 'lodash'
-
type Get = typeof get
type Set = typeof set
diff --git a/src/i18n.ts b/src/i18n.ts
index 7ad76b3f5..04c53c9d0 100644
--- a/src/i18n.ts
+++ b/src/i18n.ts
@@ -5,8 +5,8 @@ import { createI18n } from 'vue-i18n'
import zhLocale from 'element-plus/es/locale/lang/zh-cn'
import enLocale from 'element-plus/es/locale/lang/en'
-import schemaTextZh from '@/schemaText/schema-text-zh.json'
-import schemaTextEn from '@/schemaText/schema-text-en.json'
+import schemaTextZh from '@/schemaText/schema-text-zh'
+import schemaTextEn from '@/schemaText/schema-text-en'
import {
enSymbolLabel as symbolLabelEn,
@@ -25,17 +25,25 @@ const lang: { [key: string]: any } = {
...zhLocale,
},
}
-const translations = require.context('./i18n', false, /\.js$/)
-Array.prototype.forEach.call(translations.keys(), (path) => {
- const tran = translations(path).default
- const partKey = path.match(/\w+/)[0] //retrieve the filename as partial keys
- lang.en[partKey] = lang.en[partKey] || {}
- lang.zh[partKey] = lang.zh[partKey] || {}
- Object.keys(tran).forEach((k) => {
- const { en, zh } = tran[k]
- lang.en[partKey][k] = en
- lang.zh[partKey][k] = zh
- })
+
+// Dynamically import all translation files
+const modules = import.meta.glob('./i18n/*.ts')
+
+// Process each module
+Object.keys(modules).forEach((path) => {
+ const partKey = path.match(/\/(\w+)\.ts$/)?.[1] // retrieve the filename as partial keys
+ if (partKey) {
+ modules[path]().then((mod) => {
+ const tran = mod.default
+ lang.en[partKey] = lang.en[partKey] || {}
+ lang.zh[partKey] = lang.zh[partKey] || {}
+ Object.keys(tran).forEach((k) => {
+ const { en, zh } = tran[k]
+ lang.en[partKey][k] = en
+ lang.zh[partKey][k] = zh
+ })
+ })
+ }
})
lang.en.ConfigSchema = schemaTextEn
@@ -48,9 +56,10 @@ lang.en.SchemaSymbolLabel = symbolLabelEn
lang.zh.SchemaSymbolLabel = symbolLabelZh
const i18nInstance = createI18n({
+ legacy: false,
messages: lang,
locale: store.state.lang,
- warnHtmlInMessage: 'off',
+ warnHtmlMessage: false,
})
export const getLocalMessage = (path: string): string => {
diff --git a/src/i18n/APIKey.js b/src/i18n/APIKey.ts
similarity index 100%
rename from src/i18n/APIKey.js
rename to src/i18n/APIKey.ts
diff --git a/src/i18n/Auth.js b/src/i18n/Auth.ts
similarity index 86%
rename from src/i18n/Auth.js
rename to src/i18n/Auth.ts
index 8bc5ad1d0..47c8e9462 100644
--- a/src/i18n/Auth.js
+++ b/src/i18n/Auth.ts
@@ -99,21 +99,57 @@ export default {
zh: '下移',
en: 'Move down',
},
+ nodeCacheSettings: {
+ zh: '外部资源缓存设置',
+ en: 'External Resource Cache Settings',
+ },
+ enableNodeCache: {
+ zh: '启用外部资源缓存',
+ en: 'Enable External Resource Cache',
+ },
+ enableNodeCacheDesc: {
+ zh: '启用外部资源缓存后，EMQX 将缓存外部资源（如 MySQL、MongoDB 等）的查询结果，以提高效率；对于本地数据源，如内置数据库或文件等不进行缓存。',
+ en: 'After enabling external resource cache, EMQX will cache the query results of external resources (such as MySQL, MongoDB, etc.), to improve efficiency; for local data sources, such as built-in databases or file, are not cached.',
+ },
+ nodeCacheMaxCount: {
+ zh: '缓存最大数量',
+ en: 'Maximum Number of Cached Items',
+ },
+ cleanupInterval: {
+ zh: '清理间隔',
+ en: 'Cleanup Interval',
+ },
+ maxMemory: {
+ zh: '最大内存',
+ en: 'Maximum Memory',
+ },
+ statUpdateInterval: {
+ zh: '统计更新间隔',
+ en: 'Statistics Update Interval',
+ },
+ cacheTTL: {
+ zh: '缓存过期时间',
+ en: 'Cache TTL',
+ },
+ nodeCacheStatus: {
+ zh: '外部资源缓存状态',
+ en: 'External Resource Cache Status',
+ },
authzSetting: {
zh: '授权设置',
en: 'Authorization Settings',
},
enableCache: {
- zh: '启用缓存',
- en: 'Enable Cache',
+ zh: '启用客户端缓存',
+ en: 'Enable Client Cache',
},
clearCache: {
- zh: '清除缓存',
- en: 'Clear cache',
+ zh: '清除客户端缓存',
+ en: 'Clear Client Cache',
},
clearCacheDesc: {
- zh: '清除当前所有授权结果缓存。',
- en: 'Clears all current authorization result caches.',
+ zh: '清除当前所有客户端缓存。',
+ en: 'Clears all current client caches.',
},
clearCacheConfirm: {
zh: '是否确认清除缓存',
@@ -175,10 +211,6 @@ export default {
zh: '启用 TLS',
en: 'Enable TLS',
},
- tlsVerify: {
- zh: '验证服务器证书',
- en: 'TLS Verify',
- },
mongoType: {
zh: '部署模式',
en: 'MongoDB Mode',
@@ -187,6 +219,14 @@ export default {
zh: '认证源',
en: 'Auth Source',
},
+ authzMongoLimit: {
+ zh: '记录条数限制',
+ en: 'Record Limit',
+ },
+ authzMongoSkip: {
+ zh: '跳过记录数',
+ en: 'Skip',
+ },
srvRecord: {
zh: 'SRV 记录',
en: 'SRV Record',
@@ -504,8 +544,8 @@ export default {
en: 'Number of times client authorization data is not found. If the authorizer execution fails, the count will also increase',
},
rateUnit: {
- zh: '次/秒 | 次/秒',
- en: 'time/sec | times/sec',
+ zh: '次/秒',
+ en: 'times/sec | time/sec | times/sec',
},
authnRateBarDesc: {
zh: '近一分钟内认证次数趋势',
@@ -525,7 +565,7 @@ export default {
},
importUsers: {
zh: '导入用户',
- en: 'Import users',
+ en: 'Import Users',
},
selectImportMethod: {
zh: '选择导入方式',
@@ -603,4 +643,54 @@ export default {
zh: '成功导入 {total} 条数据',
en: 'Successfully imported {total} records',
},
+
+ // Node Cache Metrics
+ cacheCount: {
+ zh: '缓存条目数',
+ en: 'Cache Entries',
+ },
+ cacheMemory: {
+ zh: '内存占用',
+ en: 'Memory Usage',
+ },
+ cacheHits: {
+ zh: '缓存命中',
+ en: 'Cache Hits',
+ },
+ cacheInserts: {
+ zh: '缓存插入',
+ en: 'Cache Inserts',
+ },
+ cacheMisses: {
+ zh: '缓存未命中',
+ en: 'Cache Misses',
+ },
+ currentRate: {
+ zh: '当前',
+ en: 'current',
+ },
+ last5mRate: {
+ zh: '5 分钟',
+ en: '5 mins',
+ },
+ insertUnit: {
+ zh: '条/秒',
+ en: 'entries/sec | entry/sec | entries/sec',
+ },
+ bytes: {
+ zh: '字节',
+ en: 'bytes',
+ },
+ refresh: {
+ zh: '刷新',
+ en: 'Refresh',
+ },
+ resetNodeCacheStatus: {
+ zh: '重置节点缓存状态',
+ en: 'Reset Node Cache Status',
+ },
+ resetNodeCacheStatusConfirm: {
+ zh: '确定要重置节点缓存状态吗？',
+ en: 'Are you sure you want to reset the node cache status?',
+ },
}
diff --git a/src/i18n/AuthDoc.js b/src/i18n/AuthDoc.ts
similarity index 90%
rename from src/i18n/AuthDoc.js
rename to src/i18n/AuthDoc.ts
index 4ca80f37c..a25d8a789 100644
--- a/src/i18n/AuthDoc.js
+++ b/src/i18n/AuthDoc.ts
@@ -62,6 +62,10 @@ export default {
zh: '{0} 语句支持的占位符有：',
en: 'The {0} supports the following placeholders: ',
},
+ authzMongoDBOrderTip: {
+ zh: '查询器语句支持在第一层级中使用 $orderby 指定排序字段和排序顺序，对查询结果进行排序，排序字段支持嵌套',
+ en: 'The selector statement supports using the $orderby operator in the first level to specify sorting fields and order, sorting the query results. Nested fields are supported in sorting.',
+ },
/* MySQL, PgSQL */
authzSQLParagraph1: {
zh: 'SQL 语句需要从 {0} 中查询出包含 action permission topic 字段的数据列表',
diff --git a/src/i18n/Base.js b/src/i18n/Base.ts
similarity index 92%
rename from src/i18n/Base.js
rename to src/i18n/Base.ts
index 45d9baadd..76bdba9cc 100644
--- a/src/i18n/Base.js
+++ b/src/i18n/Base.ts
@@ -24,8 +24,8 @@ export default {
en: 'Skip',
},
skipTip: {
- zh: '下次登录时将再次提示您修改默认密码，您也可以稍后在系统 > 用户菜单中进行修改。',
- en: 'You will be prompted to change the default password again when you log in next time, and you can also change it later in the System > User.',
+ zh: '下次登录时将再次提示您修改密码，您也可以稍后在系统 > 用户菜单中进行修改。',
+ en: 'You will be prompted to change the password again when you log in next time, and you can also change it later in the System > User.',
},
copied: {
zh: '复制成功！',
@@ -443,6 +443,10 @@ export default {
zh: '为保护账户安全，请修改默认密码：',
en: 'To ensure your account security, we kindly request you to change your default password:',
},
+ expiredPwdTip: {
+ zh: '密码已长时间未修改，为保护账户安全，请定期修改密码：',
+ en: 'Your password has not been modified for a long time. To ensure your account security, please change your password regularly:',
+ },
note: {
zh: '备注',
en: 'Note',
@@ -604,8 +608,8 @@ export default {
en: 'Maximum Rate',
},
enterToCreate: {
- zh: '输入后创建新的自定义条目',
- en: 'Enter to create a new custom item',
+ zh: '输入后创建新的条目',
+ en: 'Enter to create a new item',
},
node: {
zh: '节点',
@@ -643,4 +647,24 @@ export default {
zh: '，',
en: ', ',
},
+ wordBdy: {
+ zh: '',
+ en: ' ',
+ },
+ lastModified: {
+ zh: '更新时间',
+ en: 'Last Modified',
+ },
+ createdAt: {
+ zh: '创建时间',
+ en: 'Created At',
+ },
+ duplicatedInput: {
+ zh: '重复的输入',
+ en: 'Duplicated Input',
+ },
+ tableNo: {
+ zh: '序号',
+ en: 'No.',
+ },
}
diff --git a/src/i18n/BasicConfig.js b/src/i18n/BasicConfig.ts
similarity index 86%
rename from src/i18n/BasicConfig.js
rename to src/i18n/BasicConfig.ts
index 8727c4775..0cf5b3137 100644
--- a/src/i18n/BasicConfig.js
+++ b/src/i18n/BasicConfig.ts
@@ -23,10 +23,6 @@ export default {
zh: '默认',
en: 'Default',
},
- listenerZoneDesc: {
- zh: '监听器所属的配置组，一个 Zone 定义了一组配置项 (比如最大连接数等)，Listener 可以通过该配置项指定使用某个 Zone，以使用该 Zone 下的所有配置。多个 Listener 可以共享同一个 Zone',
- en: 'The configuration group to which the listener belongs. A Zone defines a set of configuration items (such as the maximum number of connections), and a Listener can specify a Zone to use all the configurations in the Zone. Multiple Listeners can share the same Zone.',
- },
mqttPath: {
zh: "WebSocket 连接 URL 中的路径，应以 `/` 开头，并支持子路径。默认情况下，WebSocket 客户端连接的完整 URL 为 `ws://{'{'}ip{'}'}:{'{'}port{'}'}/mqtt`。
支持在路径末尾添加 `/[...]` 表示任意子路径。例如，当设置为 `/mqtt/[...]` 时，可以接受 `/mqtt/org1`、`/mqtt/org1/app1` 等连接。
注意，如果客户端连接的路径与配置不匹配，则连接将在 HTTP 层被拒绝。", en: "The path in the WebSocket connection URL, which should start with `/` and supports subpaths. By default, the full URL of a WebSocket client connection is `ws://{'{'}ip{'}'}:{'{'}port{'}'}/mqtt`.
It is supported to add `/[...] ` at the end of the path to make EMOX accept any subpath. For example, specifying `/mqtt/[...]` would allow clients to connect at paths like `mqtt/org1` or `mqtt/org1/app1`, etc.
NOTE: An unmatched path will cause the client to be rejected immediately at the HTTP laver.", @@ -75,10 +71,6 @@ export default { zh: '邀请成功', en: 'Invite Successfully', }, - clusterType: { - zh: '集群方式', - en: 'Cluster Type', - }, currentNode: { zh: '当前节点', en: 'Current Node', @@ -118,11 +110,11 @@ export default { }, console: { zh: '控制台日志', - en: 'Console Log', + en: 'Console Logs', }, file: { zh: '文件日志', - en: 'File Log', + en: 'File Logs', }, throttling: { zh: '日志限流', diff --git a/src/i18n/Clients.js b/src/i18n/Clients.ts similarity index 97% rename from src/i18n/Clients.js rename to src/i18n/Clients.ts index b2a1206c1..be668abd6 100644 --- a/src/i18n/Clients.js +++ b/src/i18n/Clients.ts @@ -415,6 +415,26 @@ export default { zh: '来自于用户名', en: 'From Username', }, + name: { + zh: '警报名称', + en: 'Alarm Name', + }, + details: { + zh: '告警消息', + en: 'Alarm Message', + }, + message: { + zh: '警报信息', + en: 'Alarm Message', + }, + activated_at: { + zh: '开始时间', + en: 'Activated At', + }, + deactivated_at: { + zh: '解除时间', + en: 'Deactivated At', + }, reason: { zh: '原因', en: 'Reason', diff --git a/src/i18n/Dashboard.js b/src/i18n/Dashboard.ts similarity index 98% rename from src/i18n/Dashboard.js rename to src/i18n/Dashboard.ts index 41db31ec1..b96fe31ef 100644 --- a/src/i18n/Dashboard.js +++ b/src/i18n/Dashboard.ts @@ -283,14 +283,6 @@ export default { zh: '数据指标集成', en: 'Metrics Integration', }, - integrationDesc: { - zh: '集成指标数据外部的监控与告警管理', - en: 'Integrated monitoring and alerting toolkit', - }, - promDesc: { - zh: '使用 Prometheus 采集指标数据', - en: 'Integrated with Prometheus', - }, role: { zh: '角色', en: 'Role', @@ -331,6 +323,14 @@ export default { zh: '过去 7 天', en: 'Last 7 days', }, + resetMonitorData: { + zh: '重置监控数据', + en: 'Reset monitor data', + }, + confirmResetMonitorData: { + zh: '确定重置监控数据？', + en: 'Confirm to reset monitor data?', + }, /* client */ client_connect: { zh: 'client.connect 钩子触发次数', diff --git a/src/i18n/Exhook.js b/src/i18n/Exhook.ts similarity index 97% rename from src/i18n/Exhook.js rename to src/i18n/Exhook.ts index c3f4a1873..317316553 100644 --- a/src/i18n/Exhook.js +++ b/src/i18n/Exhook.ts @@ -95,10 +95,6 @@ export default { zh: '次/秒', en: 'time/sec', }, - nodeMetricsData: { - zh: '节点指标', - en: 'Node Metrics', - }, nodeStatusDesc: { zh: '每个节点上钩子执行指标数据', en: 'Hook execution metrics data on each node', diff --git a/src/i18n/Extension.js b/src/i18n/Extension.ts similarity index 87% rename from src/i18n/Extension.js rename to src/i18n/Extension.ts index 0774ca83e..35fb8e135 100644 --- a/src/i18n/Extension.js +++ b/src/i18n/Extension.ts @@ -11,10 +11,6 @@ export default { zh: '自动订阅', en: 'Auto Subscribe', }, - postpone: { - zh: '延迟发布', - en: 'Delayed Publish', - }, message: { zh: '事件消息', en: 'Event Message', @@ -23,10 +19,6 @@ export default { zh: '消息存储', en: 'Storage', }, - flowControl: { - en: 'Flow Control', - zh: '流控', - }, msgExpiryInterval: { en: 'Message Expiry Interval', zh: '消息过期间隔', @@ -51,6 +43,14 @@ export default { zh: '派发保留消息的最大速率', en: 'The maximum rate of delivering retained messages', }, + maxPublishRate: { + zh: '最大发布速率', + en: 'Max Publish Rate', + }, + maxPublishRateDesc: { + zh: '发布保留消息的最大速率。超过限制发布的消息会被投递，但不会存储为保留消息。', + en: 'The maximum rate of publishing retained messages. Messages that are published over the limit are delivered but not stored as retained.', + }, storageMethod: { zh: '存储方式', en: 'Storage Method', @@ -71,14 +71,6 @@ export default { zh: '启用', en: 'Enable', }, - enableRetained: { - zh: '启用保留消息', - en: 'Enable Retained Messages', - }, - enableDesc: { - zh: '打开或关闭保留消息功能，停用后不会清除已保留消息', - en: 'Enable retainer feature, disabling will not clear the saved retained messages', - }, createDate: { zh: '发布时间', en: 'Created At', @@ -103,14 +95,6 @@ export default { zh: '发布时间', en: 'Publish Time', }, - eventTitleDesc: { - zh: '将设备生命周期事件通过事件主题以 MQTT 消息的形式发布', - en: 'Publish client life cycle events through events topic', - }, - configMsg: { - zh: '配置需要启用的事件消息', - en: 'Configure event messages that need to be enabled', - }, client_connected: { en: 'Clients have already connected', zh: '客户端连接完成', @@ -151,14 +135,6 @@ export default { zh: '正则表达式', en: 'Regex', }, - dataManage: { - zh: '数据管理', - en: 'Manage Data', - }, - builtInDatabase: { - zh: '内置数据库', - en: 'Built-in Database', - }, noExp: { en: 'Never Expire', zh: '永不过期', @@ -227,10 +203,6 @@ export default { zh: '已保留消息', en: 'Retained Messages', }, - retainerDisabled: { - zh: '保留消息功能已禁用，点击跳转到设置页面中开启。', - en: 'Retained message is disabled, click to enable on settings page.', - }, msgExpiryIntervalDesc: { en: 'Message retention time. 0 means message will never be expired', zh: '消息保留时间。0 代表永久保留', diff --git a/src/i18n/Function.js b/src/i18n/Function.ts similarity index 100% rename from src/i18n/Function.js rename to src/i18n/Function.ts diff --git a/src/i18n/Gateway.js b/src/i18n/Gateway.ts similarity index 77% rename from src/i18n/Gateway.js rename to src/i18n/Gateway.ts index 133faf92a..6bbca5b2a 100644 --- a/src/i18n/Gateway.js +++ b/src/i18n/Gateway.ts @@ -11,6 +11,10 @@ export default { zh: '连接', en: 'Connections', }, + currentConnection: { + zh: '连接数', + en: 'Current Connections', + }, listeners: { zh: '监听器', en: 'Listeners', @@ -111,6 +115,48 @@ export default { zh: '挂载点', en: 'MountPoint', }, + mountPointDesc: { + zh: `为客户端在 \`SUBSCRIBE\` 和 \`UNSUBSCRIBE\` 请求、\`PUBLISH\` 消息以及 Will Message（如果在 \`CONNECT\` 数据包中提供）中使用的主题添加静态或模板前缀（例如 \`n1/\` 或 \`{'$'}{'{'}username{'}'}/\`）。
+从发布到相应订阅的消息的主题中将移除此前缀。 + +支持的占位符包括： +- \`{'$'}{'{'}username{'}'}\` +- \`{'$'}{'{'}clientid{'}'}\` +- \`{'$'}{'{'}zone{'}'}\` +- \`{'$'}{'{'}client_attrs.NAME{'}'}\` + +例如，使用 \`mountpoint="{'$'}{'{'}username{'}'}/"\` 时，用户名 \`u1\` 的客户端将出现以下情况： +- 客户端 SUBSCRIBE \`sensors/#\` -> 在代理中内部转换为 \`u1/sensors/#\`。 +- 代理 PUBLISH \`u1/sensors/data\` -> 发送给客户端时变为 \`sensors/data\`。 + +前缀的挂载/卸载应用于： +- \`CONNECT\` 中的 Will +- \`PUBLISH\` +- \`SUBSCRIBE\` +- \`UNSUBSCRIBE\` + +注意：挂载发生在**授权/ACL检查之后**。`, + en: `Adds a static or templated prefix (e.g., \`n1/\` or \`{'$'}{'{'}username{'}'}/\`) to topics used by clients in \`SUBSCRIBE\` and \`UNSUBSCRIBE\` requests, \`PUBLISH\` messages, and Will Message (if supplied in the \`CONNECT\` packet).
+Removes this prefix from topics of messages published to the respective subscriptions. + +The supported placeholders are: +- \`{'$'}{'{'}username{'}'}\` +- \`{'$'}{'{'}clientid{'}'}\` +- \`{'$'}{'{'}zone{'}'}\` +- \`{'$'}{'{'}client_attrs.NAME{'}'}\` + +For example, with \`mountpoint="{'$'}{'{'}username{'}'}/"\`, a client using \`u1\` as username will have: +- Client SUBSCRIBE \`sensors/#\` -> \`u1/sensors/#\` internally in the broker. +- Broker PUBLISH \`u1/sensors/data\` -> \`sensors/data\` sent to the client. + +The prefix mount/unmount is applied to: +- Will in \`CONNECT\` +- \`PUBLISH\` +- \`SUBSCRIBE\` +- \`UNSUBSCRIBE\` + +Note: mounting occurs **after authorization/ACL checks**.`, + }, lType: { zh: '类型', en: 'Type', @@ -148,8 +194,8 @@ export default { en: 'Connection Required', }, connectionRequireDesc: { - zh: '连接模式是非标准协议的特性。启用连接模式时，需要管理连接资源的创建、认证和保活。选择为 false 则进入无连接模式，在此模式下，添加的认证器不会生效。', - en: `Connection mode is a feature of non-standard protocols. When connection mode is enabled, it's essential to manage the creation, authentication, and aliveness of connection resources. When set to false, it enters connectionless mode, and the added authenticator won't take effect.`, + zh: '连接模式是非标准的特性。启用连接模式时，客户端**必须**管理连接资源的创建、认证和保活。选择为 false 则表示客户端对管理连接资源是可选的，支持不创建连接资源，直接进行消息发布和订阅。', + en: `Connection Required is a non-standard feature. When Connection Required is enabled, the client **must** manage the creation, authentication, and keep-alive of connection resources. Selecting false means that the client is optional for managing connection resources and supports not creating connection resources directly for message publishing and subscription.`, }, heartbeat: { zh: '心跳间隔', @@ -215,14 +261,30 @@ export default { zh: '最大连接速率（监听器）', en: 'Max Connection Rate (Listener)', }, + maxConnBurst: { + zh: '最大连接突发速率（监听器）', + en: 'Max Connection Burst (Listener)', + }, + maxConnBurstDesc: { + zh: '在突发情况下当前监听器可以接受的最大连接数量；为空时表示不限制。\n\n例如：`10000/60m` 表示在 60 分钟内，允许接受最多 10000 个连接。', + en: 'The maximum number of connections that can be accepted in a burst by the current listener; empty means no limit.\n\nFor example: `10000/60m` means allowing up to 10000 connections in 60 minutes.', + }, maxMsgPubRate: { zh: '最大消息发布速率（单客户端）', en: 'Max Message Publishing Rate (Per Client)', }, + maxMsgPubBurst: { + zh: '最大消息发布突发速率（单客户端）', + en: 'Max Message Publishing Burst (Per Client)', + }, maxMsgPubTraffic: { zh: '最大消息发布流量（单客户端）', en: 'Max Message Publishing Traffic (Per Client)', }, + maxMsgPubTrafficBurst: { + zh: '最大消息发布流量突发速率（单客户端）', + en: 'Max Message Publishing Traffic Burst (Per Client)', + }, maxConn: { zh: '最大连接数', en: 'Max Connections', diff --git a/src/i18n/General.js b/src/i18n/General.ts similarity index 68% rename from src/i18n/General.js rename to src/i18n/General.ts index fad7f1912..7f2e16c0f 100644 --- a/src/i18n/General.js +++ b/src/i18n/General.ts @@ -131,10 +131,6 @@ export default { zh: '确认重置?', en: 'Confirm to reset', }, - 'banned-clients': { - zh: '黑名单', - en: 'Banned Clients', - }, determineToDeleteTheBannedClient: { zh: '确认解除该黑名单？', en: 'Confirm to unban this banned client?', @@ -259,4 +255,28 @@ export default { zh: '持久会话中消息保留时长，超期的消息不会发送到订阅者。', en: 'The duration of message retention in a persistent session, messages that expire are not delivered to subscribers.', }, + enableForceShutdown: { + zh: '启用强制关闭', + en: 'Enable Force Shutdown', + }, + enableForceShutdownDesc: { + zh: '启用
-- \${'{'}name{'}'}: EMQX 节点的名称。
-- \${'{'}host{'}'}: EMQX 节点主机名。
-例如，当 EMQX 节点名为
-默认值为:
-- \${'{'}name{'}'}: Name of EMQX node.
-- \${'{'}host{'}'}: Host name of EMQX node.
-For example, when the EMQX node name is
-Default value is:
-例如，
-For example, => import('@/views/Base/Layout.vue')
// const Cluster =()=> import('@/views/Config/BasicConfig/Cluster.vue')
@@ -504,6 +502,11 @@ export const routes: Array = [
name: 'mqtt-system-topic',
component: () => import('@/views/Config/BasicConfig/SystemTopics.vue'),
},
+ {
+ path: 'force-shutdown',
+ name: 'mqtt-force-shutdown',
+ component: () => import('@/views/Config/BasicConfig/ForceShutdown.vue'),
+ },
],
},
// log config
@@ -617,7 +620,7 @@ export function toLogin(path?: string): void {
currentPath !== '/login' &&
router.push({
path: '/login',
- query: { to: path ? path : currentPath ?? undefined },
+ query: { to: path ? path : (currentPath ?? undefined) },
})
}
diff --git a/src/schemaText/actionText/action-label-en.json b/src/schemaText/actionText/action-label-en.json
index d48de06dd..4e75b94a9 100644
--- a/src/schemaText/actionText/action-label-en.json
+++ b/src/schemaText/actionText/action-label-en.json
@@ -4,6 +4,7 @@
"ssl": "Enable SSL"
},
"mqtt": {
- "source_topic": "Topic"
+ "source_topic": "Topic",
+ "no_local": "No Local"
}
}
\ No newline at end of file
diff --git a/src/schemaText/actionText/action-label-zh.json b/src/schemaText/actionText/action-label-zh.json
index dcf9507f0..dd3e28727 100644
--- a/src/schemaText/actionText/action-label-zh.json
+++ b/src/schemaText/actionText/action-label-zh.json
@@ -4,6 +4,7 @@
"ssl": "启用SSL"
},
"mqtt": {
- "source_topic": "主题"
+ "source_topic": "主题",
+ "no_local": "禁止本地转发"
}
}
\ No newline at end of file
diff --git a/src/schemaText/actionText/index.ts b/src/schemaText/actionText/index.ts
index 1b87b892a..feaaf36d8 100644
--- a/src/schemaText/actionText/index.ts
+++ b/src/schemaText/actionText/index.ts
@@ -6,7 +6,6 @@ import {
zhIntegrationDesc,
enIntegrationDesc,
} from '@emqx/shared-ui-i18n'
-import { merge } from 'lodash'
import customActionDescEn from './action-desc-en.json'
import customActionDescZh from './action-desc-zh.json'
import customActionLabelEn from './action-label-en.json'
diff --git a/src/schemaText/schema-text-en.json b/src/schemaText/schema-text-en.json
deleted file mode 100644
index 08eec88cd..000000000
--- a/src/schemaText/schema-text-en.json
+++ /dev/null
@@ -1,1378 +0,0 @@
-{
- "emqx_conf_schema": {
- "common_handler_drop_mode_qlen": {
- "desc": "When the number of buffered log events is larger than this value, the new log events are dropped.\nWhen drop mode is activated or deactivated, a message is printed in the logs.",
- "label": "Queue Length before Entering Drop Mode"
- },
- "cluster_mcast_addr": {
- "desc": "Multicast IPv4 address.",
- "label": "Cluster Multicast Address"
- },
- "desc_cluster_dns": {
- "desc": "Service discovery via DNS SRV records.",
- "label": "Cluster DNS"
- },
- "cluster_dns_name": {
- "desc": "The domain name from which to discover peer EMQX nodes' IP addresses.\nApplicable when
\nNote: contents of this file are secret, so it's necessary to set permissions to 600.", - "label": "RPC Keyfile" - }, - "cluster_mcast_recbuf": { - "desc": "Size of the kernel-level buffer for incoming datagrams.", - "label": "Cluster Muticast Sendbuf" - }, - "cluster_autoheal": { - "desc": "If
\n- inet_tcp: IPv4 TCP
\n- inet_tls: IPv4 TLS, works together with
\n
\n
\n
\nThis may be overridden on a per-shard basis in
-
-
-
\n
\n
\nIt is recommended to have more replicant nodes than core nodes.
\nNote: this parameter only takes effect when the
\nNote that this config only takes effect when rpc.port_discovery is set to manual.", - "label": "RPC TCP Server Port" - }, - "desc_console_handler": { - "desc": "Log handler that prints log events to the EMQX console.", - "label": "Console Handler" - }, - "node_applications": { - "desc": "List of Erlang applications that shall be rebooted when the EMQX broker joins the cluster.", - "label": "Application" - }, - "log_burst_limit_max_count": { - "desc": "Maximum number of log events to handle within a `window_time` interval. After the limit is reached, successive events are dropped until the end of the `window_time`.", - "label": "Events Number" - }, - "rpc_tcp_client_num": { - "desc": "Set the maximum number of RPC communication channels initiated by this node to each remote node.", - "label": "RPC TCP Client Num" - }, - "cluster_k8s_address_type": { - "desc": "Address type used for connecting to the discovered nodes.\nSetting
\nNote: this parameter only takes effect when the
\nThis value needs to be defined for manual or static cluster discovery mechanisms.
\nIf an automatic cluster discovery mechanism is being used (such as
\nNote: certificates of all nodes in the cluster must be signed by the same CA.", - "label": "RPC Cacertfile" - }, - "desc_node": { - "desc": "Node name, cookie, config & data directories and the Erlang virtual machine (BEAM) boot parameters.", - "label": "Node" - }, - "cluster_k8s_apiserver": { - "desc": "Kubernetes API endpoint URL.", - "label": "Cluster k8s ApiServer" - }, - "common_handler_supervisor_reports": { - "desc": "Type of supervisor reports that are logged. Defaults to
\n -
.\n -
\nPossible auto-created subdirectories are:
\n- `mnesia/`: EMQX's built-in database directory.
\nFor example, `mnesia/emqx{'@'}127.0.0.1`.
\nThere should be only one such subdirectory.
\nMeaning, in case the node is to be renamed (to e.g. `emqx{'@'}10.0.1.1`),
\nthe old dir should be deleted first.
\n- `configs`: Generated configs at boot time, and cluster/local override configs.
\n- `patches`: Hot-patch beam files are to be placed here.
\n- `trace`: Trace log files.
\n\n**NOTE**: One data dir cannot be shared by two or more EMQX nodes.", - "label": "Node Data Dir" - }, - "cluster_k8s_suffix": { - "desc": "Node name suffix.
\nNote: this parameter is only relevant when
\nThis section of the configuration controls the number of files kept for each log handler.", - "label": "Log Rotation" - }, - "desc_log_overload_kill": { - "desc": "Log overload kill features an overload protection that activates when the log handlers use too much memory or have too many buffered log messages.
\nWhen the overload is detected, the log handler is terminated and restarted after a cooldown period.", - "label": "Log Overload Kill" - }, - "authorization": { - "desc": "Authorization a.k.a. ACL.
\nIn EMQX, MQTT client access control is extremely flexible.
\nAn out-of-the-box set of authorization data sources are supported.\nFor example,
\n'file' source is to support concise and yet generic ACL rules in a file;
\n'built_in_database' source can be used to store per-client customizable rule sets,\nnatively in the EMQX node;
\n'http' source to make EMQX call an external HTTP API to make the decision;
\n'PostgreSQL' etc. to look up clients or rules from external databases", - "label": "Authorization" - }, - "rpc_socket_keepalive_idle": { - "desc": "How long the connections between the brokers should remain open after the last message is sent.", - "label": "RPC Socket Keepalive Idle" - }, - "desc_cluster_call": { - "desc": "Options for the 'cluster call' feature that allows to execute a callback on all nodes in the cluster.", - "label": "Cluster Call" - }, - "cluster_mcast_ports": { - "desc": "List of UDP ports used for service discovery.
\nNote: probe messages are broadcast to all the specified ports.", - "label": "Cluster Multicast Ports" - }, - "log_overload_kill_mem_size": { - "desc": "Maximum memory size that the log handler process is allowed to use.", - "label": "Log Handler Max Memory Size" - }, - "rpc_connect_timeout": { - "desc": "Timeout for establishing an RPC connection.", - "label": "RPC Connect Timeout" - }, - "cluster_etcd_node_ttl": { - "desc": "Expiration time of the etcd key associated with the node.\nIt is refreshed automatically, as long as the node is alive.", - "label": "Cluster Etcd Node TTL" - }, - "rpc_call_receive_timeout": { - "desc": "Timeout for the reply to a synchronous RPC.", - "label": "RPC Call Receive Timeout" - }, - "rpc_socket_recbuf": { - "desc": "TCP tuning parameters. TCP receiving buffer size.", - "label": "RPC Socket Recbuf" - }, - "db_tlog_push_mode": { - "desc": "In sync mode the core node waits for an ack from the replicant nodes before sending the next\ntransaction log entry.", - "label": "Tlog Push Mode" - }, - "node_crash_dump_bytes": { - "desc": "This variable sets the maximum size of a crash dump file in bytes.\nThe crash dump will be truncated if this limit is exceeded.\nIf setting it to 0, the runtime system does not even attempt to write a crash dump file.", - "label": "Crash Dump Bytes" - }, - "rpc_certfile": { - "desc": "Path to TLS certificate file used to validate identity of the cluster nodes.\nNote that this config only takes effect when
\n- If setting to 0 seconds, the runtime system does not even attempt to write the crash dump file. It only terminates.
\n- If setting to a positive value S, wait for S seconds to complete the crash dump file and then terminates the runtime system with a SIGALRM signal.
\n- A negative value causes the termination of the runtime system to wait indefinitely until the crash dump file has been completely written.", - "label": "Crash Dump Seconds" - }, - "log_file_handlers": { - "desc": "File-based log handlers.", - "label": "File Handler" - }, - "node_global_gc_interval": { - "desc": "Periodic garbage collection interval. Set to
\nMost of the time the default config should work,\nbut in case you need to do performance fine-tuning or experiment a bit,\nthis is where to look.", - "label": "RPC" - }, - "rpc_ssl_server_port": { - "desc": "Listening port used by RPC local service.
\nNote that this config only takes effect when rpc.port_discovery is set to manual\nand
\n Here holds the configs to instruct how individual nodes can discover each other.", - "label": "Cluster" - }, - "common_handler_sync_mode_qlen": { - "desc": "As long as the number of buffered log events is lower than this value,\nall log events are handled asynchronously. This means that the client process sending the log event,\nby calling a log function in the Logger API, does not wait for a response from the handler\nbut continues executing immediately after the event is sent.\nIt is not affected by the time it takes the handler to print the event to the log device.\nIf the message queue grows larger than this value,\nthe handler starts handling log events synchronously instead,\nmeaning that the client process sending the event must wait for a response.\nWhen the handler reduces the message queue to a level below the sync_mode_qlen threshold,\nasynchronous operation is resumed.", - "label": "Queue Length before Entering Sync Mode" - }, - "common_handler_formatter": { - "desc": "Choose log formatter.
\n- static: Configure static nodes list by setting
\n- dns: Use DNS A record to discover peer nodes.
\n- etcd: Use etcd to discover peer nodes.
\n- k8s: Use Kubernetes API to discover peer pods.", - "label": "Cluster Discovery Strategy" - }, - "rpc_send_timeout": { - "desc": "Timeout for sending the RPC request.", - "label": "RPC Send Timeout" - }, - "common_handler_single_line": { - "desc": "Print logs in a single line if set to true. Otherwise, log messages may span multiple lines.", - "label": "Single Line Mode" - }, - "rpc_socket_buffer": { - "desc": "TCP tuning parameters. Socket buffer size in user mode.", - "label": "RPC Socket Buffer" - }, - "db_shard_transports": { - "desc": "Allows to tune the transport method used for transaction log replication, on a per-shard basis.
\n
If not specified,\nthe default is to use the value set in
The following events are throttled:
- authorization_permission_denied
- cannot_publish_to_topic_due_to_not_authorized
- cannot_publish_to_topic_due_to_quota_exceeded
- connection_rejected_due_to_license_limit_reached
- dropped_msg_due_to_mqueue_is_full", - "label": "Time Window" - }, - "common_handler_payload_encode": { - "desc": "The encoding method of payload in logs", - "label": "Payload Encode" - } - }, - "emqx_limiter_schema": { - "max_conn_rate": { - "desc": "Maximum connection rate.
\nThis is used to limit the connection rate for this node,\nonce the limit is reached, new connections will be deferred or refused.", - "label": "Maximum Connection Rate" - }, - "messages_rate": { - "desc": "Messages publish rate.
\nThis is used to limit the inbound message numbers for this node,\nonce the limit is reached, the restricted client will slow down and even be hung for a while.", - "label": "Messages Publish Rate" - }, - "bytes_rate": { - "desc": "Data publish rate.
\nThis is used to limit the inbound bytes rate for this node,\nonce the limit is reached, the restricted client will slow down and even be hung for a while.", - "label": "Data Publish Rate" - } - }, - "emqx_schema": { - "fields_mqtt_quic_listener_peer_unidi_stream_count": { - "desc": "Number of unidirectional streams to allow the peer to open.", - "label": "Peer unidi stream count" - }, - "fields_authorization_no_match": { - "desc": "Default access control action if the user or client matches no ACL rules,\nor if no such user or client is found by the configurable authorization\nsources such as built_in_database, an HTTP API, or a query against PostgreSQL.\nFind more details in 'authorization.sources' config.", - "label": "Authorization no match" - }, - "sysmon_top_db_hostname": { - "desc": "Hostname of the PostgreSQL database that collects the data points", - "label": "DB Hostname" - }, - "zones": { - "desc": "A zone is a set of configs grouped by the zone
Currently, the following actions are supported:
See
\nThe certificates in this file are used to verify the TLS peer's certificates.\nAppend new certificates to the file if new CAs are to be trusted.\nThere is no need to restart EMQX to have the updated file loaded, because\nthe system regularly checks if file has been updated (and reload).
\nNOTE: invalidating (deleting) a certificate from the file will not affect\nalready established connections.", - "label": "CACertfile" - }, - "fields_ws_opts_mqtt_path": { - "desc": "WebSocket's MQTT protocol path. So the address of EMQX Broker's WebSocket is:\n
\nFor instance, when connecting to \"server.example.net\", the genuine server\nwhich accepts the connection and performs TLS handshake may differ from the\nhost the TLS client initially connects to, e.g. when connecting to an IP address\nor when the host has multiple resolvable DNS records
\nIf not specified, it will default to the host name string which is used\nto establish the connection, unless it is IP addressed used.
\nThe host name is then also used in the host name verification of the peer\ncertificate.
The special value 'disable' prevents the Server Name\nIndication extension from being sent and disables the hostname\nverification check.", - "label": "Server Name Indication" - }, - "fields_mqtt_quic_listener_retry_memory_limit": { - "desc": "The percentage of available memory usable for handshake connections before stateless retry is used. Calculated as `N/65535`. Default: 65", - "label": "Retry memory limit" - }, - "force_shutdown_max_message_queue_len": { - "desc": "Maximum message queue length.", - "label": "Maximum mailbox queue length of process" - }, - "sys_heartbeat_interval": { - "desc": "Time interval for publishing following heartbeat messages:\n - `$SYS/brokers//uptime`\n - `$SYS/brokers//datetime`"
- },
- "flapping_detect_ban_time": {
- "desc": "How long the flapping clientid will be banned.",
- "label": "Ban Duration"
- },
- "sysmon_top_num_items": {
- "desc": "The number of top processes per monitoring group",
- "label": "Top num items"
- },
- "persistent_session_builtin_session_table": {
- "desc": "Performance tuning options for built-in session table.",
- "label": "Persistent session"
- },
- "mqtt_upgrade_qos": {
- "desc": "Force upgrade of QoS level according to subscription.",
- "label": "Upgrade QoS"
- },
- "mqtt_shared_subscription": {
- "label": "Allowed Shared Subscription"
- },
- "fields_tcp_opts_sndbuf": {
- "desc": "The TCP send buffer (OS kernel) for the connections.",
- "label": "TCP send buffer"
- },
- "sysmon_os_mem_check_interval": {
- "desc": "The time interval for the periodic memory check.",
- "label": "Mem check interval"
- },
- "server_ssl_opts_schema_gc_after_handshake": {
- "desc": "Memory usage tuning. If enabled, will immediately perform a garbage collection after the TLS/SSL handshake.",
- "label": "Perform GC after handshake"
- },
- "fields_mqtt_quic_listener_ssl_options": {
- "desc": "TLS options for QUIC transport",
- "label": "TLS Options"
- },
- "fields_ws_opts_mqtt_piggyback": {
- "desc": "Whether a WebSocket message is allowed to contain multiple MQTT packets.",
- "label": "MQTT Piggyback"
- },
- "base_listener_mountpoint": {
- "desc": "When publishing or subscribing, prefix all topics with a mountpoint string.\nThe prefixed string will be removed from the topic name when the message\nis delivered to the subscriber. The mountpoint is a way that users can use\nto implement isolation of message routing between different listeners.\nFor example if a client A subscribes to `t` with `listeners.tcp.\\.mountpoint`\nset to `some_tenant`, then the client actually subscribes to the topic\n`some_tenant/t`. Similarly, if another client B (connected to the same listener\nas the client A) sends a message to topic `t`, the message is routed\nto all the clients subscribed `some_tenant/t`, so client A will receive the\nmessage, with topic name `t`.
\nSet to `\"\"` to disable the feature.
\n\nVariables in mountpoint string:\n -
\nCiphers (and their ordering) define the way in which the\nclient and server encrypts information over the network connection.\nSelecting a good cipher suite is critical for the\napplication's data security, confidentiality and performance.\n\nThe names should be in OpenSSL string format (not RFC format).\nAll default values and examples provided by EMQX config\ndocumentation are all in OpenSSL format.
\n\nNOTE: Certain cipher suites are only compatible with\nspecific TLS
\n\nNOTE: PSK ciphers are suppressed by 'tlsv1.3' version config
\nIf PSK cipher suites are intended, 'tlsv1.3' should be disabled from
\nPSK cipher suites:
\n\nNOTE: QUIC listener supports only 'tlsv1.3' ciphers", - "label": "" - }, - "fields_mqtt_quic_listener_max_bytes_per_key": { - "desc": "Maximum number of bytes to encrypt with a single 1-RTT encryption key before initiating key update. Default: 274877906944", - "label": "Max bytes per key" - }, - "fields_mqtt_quic_listener_mtu_discovery_search_complete_timeout_us": { - "desc": "The time in microseconds to wait before reattempting MTU probing if max was not reached. Default: 600000000", - "label": "MTU discovery search complete timeout us" - }, - "fields_ws_opts_check_origin_enable": { - "desc": "If
The alarm is cleared only when there's no pending data in
the queue, and at least
This is to avoid clearing and raising the alarm again too often.", - "label": "Sustain duration" - }, - "fields_mqtt_quic_listener_keep_alive_interval_ms": { - "desc": "How often to send PING frames to keep a connection alive.", - "label": "Keep alive interval ms" - }, - "fields_mqtt_quic_listener_handshake_idle_timeout_ms": { - "desc": "How long a handshake can idle before it is discarded", - "label": "Handshake idle timeout ms" - }, - "broker_session_locking_strategy": { - "desc": "Session locking strategy in a cluster.\n - `local`: only lock the session on the current node\n - `one`: select only one remote node to lock the session\n - `quorum`: select some nodes to lock the session\n - `all`: lock the session on all the nodes in the cluster" - }, - "persistent_store_ram_cache": { - "desc": "Maintain a copy of the data in RAM for faster access.", - "label": "RAM cache" - }, - "fields_mqtt_quic_listener_stream_recv_window_default": { - "desc": "Initial stream receive window size. Default: 32678", - "label": "Stream recv window default" - }, - "mqtt_mqueue_priorities": { - "desc": "Topic priorities. Priority number [1-255]. There's no priority table by default, hence all messages are treated equal.
NOTE: Comma and equal signs are not allowed for priority topic names.
NOTE: Messages for topics not in the priority table are treated as either highest or lowest priority depending on the configured value for mqtt.mqueue_default_priority.
Examples:
To configure \"topic/1\" > \"topic/2\":
mqueue_priorities: {'{'}\"topic/1\": 10, \"topic/2\": 8{'}'}", - "label": "Topic Priorities" - }, - "fields_rate_limit_conn_messages_in": { - "desc": "Message limit for the external MQTT connections.", - "label": "connecting messages in" - }, - "fields_rate_limit_max_conn_rate": { - "desc": "Maximum connections per second.", - "label": "Max connection rate" - }, - "alarm_size_limit": { - "desc": "The maximum total number of deactivated alarms to keep as history.
When this limit is exceeded, the oldest deactivated alarms are deleted to cap the total number.", - "label": "Alarm size limit" - }, - "fields_cache_max_size": { - "desc": "Maximum number of cached items.", - "label": "Maximum number of cached items" - }, - "fields_listeners_tcp": { - "desc": "TCP listeners.", - "label": "TCP listeners" - }, - "conn_congestion_enable_alarm": { - "desc": "Enable or disable connection congestion alarm.", - "label": "Enable/disable congestion alarm" - }, - "fields_ws_opts_proxy_port_header": { - "desc": "HTTP header used to pass information about the client port. Relevant when the EMQX cluster is deployed behind a load-balancer.", - "label": "Proxy port header" - }, - "overload_protection_enable": { - "desc": "React on system overload or not.", - "label": "React on system overload or not" - }, - "fields_mqtt_quic_listener_minimum_mtu": { - "desc": "The minimum MTU supported by a connection. This will be used as the starting MTU. Default: 1248", - "label": "Minimum MTU" - }, - "sys_msg_interval": { - "desc": "Time interval of publishing `$SYS` messages." - }, - "mqtt_await_rel_timeout": { - "desc": "Specifies the amount of time to wait for a publish of a QoS 2 message with no PUBREL received. When this limit is reached, EMQX will release the packet ID and also output a warning level log. \nNote: EMQX’s forwarding of the received QoS 2 message is independent from the receiving of PUBREL", - "label": "Max Awaiting PUBREL Timeout" - }, - "common_ssl_opts_schema_verify": { - "desc": "Enable or disable peer verification.", - "label": "Verify peer" - }, - "fields_listeners_ssl": { - "desc": "SSL listeners.", - "label": "SSL listeners" - }, - "fields_deflate_opts_client_max_window_bits": { - "desc": "Specifies the size of the compression context for the client.", - "label": "Client compression max window size" - }, - "common_ssl_opts_schema_keyfile": { - "desc": "PEM format private key file.", - "label": "Keyfile" - }, - "sysmon_os_cpu_high_watermark": { - "desc": "The threshold, as percentage of system CPU load,\n for how much system cpu can be used before the corresponding alarm is raised.", - "label": "CPU high watermark" - }, - "flapping_detect_window_time": { - "desc": "The time window for flapping detection.", - "label": "Window time" - }, - "mqtt_mqueue_default_priority": { - "desc": "Default topic priority, which will be used by topics not in
\nNOTE: The
\nThe certificates in this file should be in reversed order of the certificate\nissue chain. That is, the host's certificate should be placed in the beginning\nof the file, followed by the immediate issuer certificate and so on.\nAlthough the root CA certificate is optional, it should be placed at the end of\nthe file if it is to be added.", - "label": "Certfile" - }, - "mqtt_exclusive_subscription": { - "label": "Allowed Exclusive Subscription" - }, - "mqtt_retain_available": { - "desc": "Whether to enable support for MQTT retained message. When this option is disabled, clients will not be able to publish retained messages.", - "label": "Allowed Retain" - }, - "fields_tcp_opts_reuseaddr": { - "desc": "The SO_REUSEADDR flag for the connections.", - "label": "SO_REUSEADDR" - }, - "sysmon_vm_long_schedule": { - "desc": "When the Erlang VM detect a task scheduled for too long, a warning level 'long_schedule' log is emitted,\nand an MQTT message is published to the system topic
\nThe configuration items under
\nLower values decrease memory usage per connection.", - "label": "Size of the compression state" - }, - "fields_mqtt_quic_listener_send_idle_timeout_ms": { - "desc": "Reset congestion control after being idle for amount of time. Default: 1000", - "label": "Send idle timeout ms" - }, - "base_listener_limiter": { - "desc": "Type of the rate limit.", - "label": "Type of the rate limit" - }, - "persistent_session_store_backend": { - "desc": "Database management system used to store information about persistent sessions and messages.\n- `builtin`: Use the embedded database (mria)", - "label": "Backend" - }, - "alarm_validity_period": { - "desc": "Retention time of deactivated alarms. Alarms are not deleted immediately\nwhen deactivated, but after the retention time.", - "label": "Alarm validity period" - }, - "server_ssl_opts_schema_ocsp_issuer_pem": { - "desc": "PEM-encoded certificate of the OCSP issuer for the server certificate.", - "label": "OCSP Issuer Certificate" - }, - "fields_tcp_opts_active_n": { - "desc": "Specify the {'{'}active, N{'}'} option for this Socket.
\nSee: https://erlang.org/doc/man/inet.html#setopts-2", - "label": "active_n" - }, - "listener_authentication": { - "desc": "Per-listener authentication override.\nAuthentication can be one single authenticator instance or a chain of authenticators as an array.\nWhen authenticating a login (username, client ID, etc.) the authenticators are checked in the configured order.", - "label": "Per-listener authentication override" - }, - "fields_trace_payload_encode": { - "desc": "Determine the format of the payload format in the trace log file.
\n`text`: Text-based protocol or plain text protocol.\n It is recommended when payload is JSON encoded.
\n`hex`: Binary hexadecimal encode. It is recommended when payload is a custom binary protocol.
\n`hidden`: payload is obfuscated as `******`", - "label": "Payload encode" - }, - "mqtt_response_information": { - "desc": "Response Information
UTF-8 string, for creating the response topic, for example, if set to `reqrsp/`, the publisher/subscriber will communite under the topic `reqrsp/`.To disable this feature, input `\"\"` in the text box below.", - "label": "Response Information" - }, - "persistent_session_store_max_retain_undelivered": { - "desc": "The time messages that was not delivered to a persistent session\nis stored before being garbage collected if the node the previous\nsession was handled on restarts of is stopped.", - "label": "Max retain undelivered" - }, - "fields_mqtt_quic_listener_migration_enabled": { - "desc": "Enable clients to migrate IP addresses and tuples. Requires a cooperative load-balancer, or no load-balancer. Default: 1 (Enabled)", - "label": "Migration enabled" - }, - "common_ssl_opts_schema_password": { - "desc": "String containing the user's password. Only used if the private key file is password-protected.", - "label": "Keyfile passphrase" - }, - "common_ssl_opts_schema_hibernate_after": { - "desc": "Hibernate the SSL process after idling for amount of time reducing its memory footprint.", - "label": "hibernate after" - }, - "fields_mqtt_quic_listener_send_buffering_enabled": { - "desc": "Buffer send data instead of holding application buffers until sent data is acknowledged. Default: 1 (Enabled)", - "label": "Send buffering enabled" - }, - "sys_event_client_unsubscribed": { - "desc": "Enable to publish event message that client unsubscribed a topic successfully." - }, - "overload_protection_backoff_new_conn": { - "desc": "When at high load, close new incoming connections.", - "label": "Close new connections" - }, - "server_ssl_opts_schema_ocsp_responder_url": { - "desc": "URL for the OCSP responder to check the server certificate against.", - "label": "OCSP Responder URL" - }, - "mqtt_idle_timeout": { - "desc": "Configure the duration of time that a connection can remain idle (i.e., without any data transfer) before being: \n\n- Automatically disconnected if no CONNECT package is received from the client yet. \n- Put into hibernation mode to save resources if some CONNECT packages are already received.\n\nNote: Please set the parameter with caution as long idle time will lead to resource waste.", - "label": "Idle Timeout" - }, - "fields_mqtt_quic_listener_conn_flow_control_window": { - "desc": "Connection-wide flow control window. Default: 16777216", - "label": "Conn flow control window" - }, - "fields_mqtt_quic_listener_maximum_mtu": { - "desc": "The maximum MTU supported by a connection. This will be the maximum probed value. Default: 1500", - "label": "Maximum MTU" - }, - "sysmon_top_db_name": { - "desc": "PostgreSQL database name", - "label": "DB Name" - }, - "mqtt_strict_mode": { - "desc": "Whether to parse MQTT messages in strict mode.\nIn strict mode, invalid utf8 strings in for example client ID, topic name, etc. will cause the client to be disconnected.", - "label": "Strict Mode" - }, - "shared_subscription_group_strategy": { - "desc": "Per group dispatch strategy for shared subscription.\nThis config is a map from shared subscription group name to the strategy\nname. The group name should be of format `[A-Za-z0-9]`. i.e. no\nspecial characters are allowed." - }, - "fields_deflate_opts_strategy": { - "desc": "Specifies the compression strategy.", - "label": "compression strategy" - }, - "shared_subscription_strategy_enum": { - "desc": "Dispatch strategy for shared subscription.\n- `random`: dispatch the message to a random selected subscriber\n- `round_robin`: select the subscribers in a round-robin manner\n- `round_robin_per_group`: select the subscribers in round-robin fashion within each shared subscriber group\n- `sticky`: always use the last selected subscriber to dispatch,\nuntil the subscriber disconnects.\n- `hash`: select the subscribers by the hash of `clientIds`\n- `local`: send to a random local subscriber. If local\nsubscriber was not found, send to a random subscriber cluster-wide" - }, - "persistent_session_builtin_sess_msg_table": { - "desc": "Performance tuning options for built-in session messages table.", - "label": "Persistent session messages" - }, - "mqtt_mqueue_store_qos0": { - "desc": "Specifies whether to store QoS 0 messages in the message queue while the connection is down but the session remains.", - "label": "Store QoS 0 Message" - }, - "server_ssl_opts_schema_client_renegotiation": { - "desc": "In protocols that support client-initiated renegotiation,\nthe cost of resources of such an operation is higher for the server than the client.\nThis can act as a vector for denial of service attacks.\nThe SSL application already takes measures to counter-act such attempts,\nbut client-initiated renegotiation can be strictly disabled by setting this option to false.\nThe default value is true. Note that disabling renegotiation can result in\nlong-lived connections becoming unusable due to limits on\nthe number of messages the underlying cipher suite can encipher.", - "label": "SSL client renegotiation" - }, - "server_ssl_opts_schema_enable_crl_check": { - "desc": "Whether to enable CRL verification for this listener.", - "label": "Enable CRL Check" - }, - "fields_mqtt_quic_listener_peer_bidi_stream_count": { - "desc": "Number of bidirectional streams to allow the peer to open.", - "label": "Peer bidi stream count" - }, - "fields_mqtt_quic_listener_max_stateless_operations": { - "desc": "The maximum number of stateless operations that may be queued on a worker at any one time. Default: 16", - "label": "Max stateless operations" - }, - "fields_ws_opts_idle_timeout": { - "desc": "Close transport-layer connections from the clients that have not sent MQTT CONNECT message within this interval.", - "label": "WS idle timeout" - }, - "fields_mqtt_quic_listener_max_ack_delay_ms": { - "desc": "How long to wait after receiving data before sending an ACK. Default: 25", - "label": "Max ack delay ms" - }, - "base_listener_zone": { - "desc": "The configuration zone to which the listener belongs.", - "label": "Zone" - }, - "fields_mqtt_quic_listener_handshake_idle_timeout": { - "desc": "How long a handshake can idle before it is discarded.", - "label": "Handshake Idle Timeout" - }, - "force_gc_enable": { - "desc": "Enable forced garbage collection.", - "label": "Enable forced garbage collection" - }, - "fields_ws_opts_allow_origin_absence": { - "desc": "If
\nNOTE: PSK ciphers are suppressed by 'tlsv1.3' version config.
\nIn case PSK cipher suites are intended, make sure to configure\n
\nif 1 the path can be PEER, Intermediate-CA, ROOT-CA;
\nif 2 the path can be PEER, Intermediate-CA1, Intermediate-CA2, ROOT-CA.", - "label": "CACert Depth" - }, - "sysmon_vm_long_gc": { - "desc": "When an Erlang process spends long time to perform garbage collection, a warning level
\nCiphers (and their ordering) define the way in which the\nclient and server encrypts information over the network connection.\nSelecting a good cipher suite is critical for the\napplication's data security, confidentiality and performance.\n\nThe names should be in OpenSSL string format (not RFC format).\nAll default values and examples provided by EMQX config\ndocumentation are all in OpenSSL format.
\n\nNOTE: Certain cipher suites are only compatible with\nspecific TLS
\n\nNOTE: PSK ciphers are suppressed by 'tlsv1.3' version config
\nIf PSK cipher suites are intended, 'tlsv1.3' should be disabled from
\nPSK cipher suites:
\nSee: https://www.haproxy.com/blog/haproxy/proxy-protocol/", - "label": "Proxy protocol" - }, - "mqtt_listener_access_rules": { - "desc": "The access control rules for this listener.
See: https://github.com/emqtt/esockd#allowdeny", - "label": "Access rules" - }, - "server_ssl_opts_schema_enable_ocsp_stapling": { - "desc": "Whether to enable Online Certificate Status Protocol (OCSP) stapling for the listener. If set to true, requires defining the OCSP responder URL and issuer PEM path.", - "label": "Enable OCSP Stapling" - }, - "fields_tcp_opts_send_timeout_close": { - "desc": "Close the connection if send timeout.", - "label": "TCP send timeout close" - }, - "sysmon_os_cpu_check_interval": { - "desc": "The time interval for the periodic CPU check.", - "label": "The time interval for the periodic CPU check" - }, - "sysmon_top_sample_interval": { - "desc": "Specifies how often process top should be collected", - "label": "Top sample interval" - }, - "fields_mqtt_quic_listener_idle_timeout_ms": { - "desc": "How long a connection can go idle before it is gracefully shut down. 0 to disable timeout", - "label": "Idle timeout ms" - }, - "fields_ws_opts_fail_if_no_subprotocol": { - "desc": "If
Note: WeChat applet needs to disable this verification.", - "label": "Fail if no subprotocol" - }, - "mqtt_wildcard_subscription": { - "label": "Allowed Wildcard Subscription" - }, - "server_ssl_opts_schema_ocsp_refresh_interval": { - "desc": "The period to refresh the OCSP response for the server.", - "label": "OCSP Refresh Interval" - }, - "overload_protection_backoff_hibernation": { - "desc": "When at high load, skip process hibernation.", - "label": "Skip hibernation" - }, - "fields_ws_opts_max_frame_size": { - "desc": "The maximum length of a single MQTT packet.", - "label": "Max frame size" - }, - "sys_event_messages": { - "desc": "Client events messages." - }, - "broker_perf_trie_compaction": { - "desc": "Enable trie path compaction.\nEnabling it significantly improves wildcard topic subscribe rate, if wildcard topics have unique prefixes like: 'sensor/{'{'}{'{'}id{'}'}{'}'}/+/', where ID is unique per subscriber.\nTopic match performance (when publishing) may degrade if messages are mostly published to topics with large number of levels.\n\nNOTE: This is a cluster-wide configuration. It requires all nodes to be stopped before changing it." - }, - "sysmon_vm_large_heap": { - "desc": "When an Erlang process consumed a large amount of memory for its heap space,\nthe system will write a warning level
- `random`: dispatch the message to a random selected subscriber
- `round_robin`: select the subscribers in a round-robin manner
- `round_robin_per_group`: select the subscribers in round-robin fashion within each shared subscriber group
- `sticky`: always use the last selected subscriber to dispatch, until the subscriber disconnects.
- `local`: select random local subscriber otherwise select random cluster-wide
- `hash_topic`: select the subscribers by hashing the source topic
- `hash_clientid`: select the subscribers by hashing the `clientIds` of senders" - }, - "mqtt_client_attrs_init": { - "label": "Client Attributes", - "desc": "Set custom attributes on client connection and use them in authentication, authorization, and other functions." - }, - "client_attrs_init_set_as_attr": { - "label": "Attribute" - }, - "client_attrs_init_expression": { - "label": "Attribute Expression", - "desc": "A single-line expression that dynamically extracts attribute values from existing client information can use the following fields:
- `clientid`: client ID
- `username`: user name
- `cn`: CN field of TLS certificate
- `dn`: DN field of TLS certificate
- `user_property.*`: extracts the property value from the `User-Property` of the MQTT CONNECT packet, e.g. `user_property.foo`
You can use predefined string functions to dynamically process the information. For example, to extract the prefix of a dot-separated client ID: `nth(1, tokens(clientid, '.'))`; to extract a partial username: `substr(username, 0, 5)`. You can read more about variform expressions in EMQX docs.
" - }, - "mqtt_keepalive_check_interval": { - "label": "Keep Alive Check Interval", - "desc": "The frequency of checking for incoming MQTT packets determines how often the server will check for new MQTT packets.
If a certain amount of time passes without any packets being sent from the client, this time will be added up.
Once the accumulated time exceeds `keepalive-interval * keepalive-multiplier`, the connection will be terminated.
The default is set to 30 seconds, with a minimum value of 1 second and a maximum value of `keepalive-interval / 2`.
" - }, - "mqtt_shared_subscription_initial_sticky_pick": { - "label": "Shared Subscription Initial Sticky Pick", - "desc": "The strategy to use for the initial subscriber pick when `Shared Subscription Strategy` is `sticky`.
- `random`: Randomly select the subscriber;
- `local`: Randomly select a subscriber on the current node, if there are no subscribers on the current node, then randomly select within the cluster;
- `hash_clientid`: Hash the publisher's client ID to select a subscriber;
- `hash_topic`: Hash the publishing topic to select a subscriber." - } - } -} \ No newline at end of file diff --git a/src/schemaText/schema-text-en.ts b/src/schemaText/schema-text-en.ts new file mode 100644 index 000000000..6bc440c38 --- /dev/null +++ b/src/schemaText/schema-text-en.ts @@ -0,0 +1,269 @@ +export default { + /* MQTT START */ + exclusive_subscription: { + label: 'Allowed Exclusive Subscription', + }, + max_topic_alias: { + label: 'Max Topic Alias', + }, + use_username_as_clientid: { + desc: 'Whether to use Username as Client ID.\nThis setting takes effect later than
UTF-8 string, for creating the response topic, for example, if set to `reqrsp/`, the publisher/subscriber will communite under the topic `reqrsp/`.To disable this feature, input `""` in the text box below.', + label: 'Response Information', + }, + shared_subscription_initial_sticky_pick: { + label: 'Shared Subscription Initial Sticky Pick', + desc: "The strategy to use for the initial subscriber pick when `Shared Subscription Strategy` is `sticky`.
- `random`: Randomly select the subscriber;
- `local`: Randomly select a subscriber on the current node, if there are no subscribers on the current node, then randomly select within the cluster;
- `hash_clientid`: Hash the publisher's client ID to select a subscriber;
- `hash_topic`: Hash the publishing topic to select a subscriber.", + }, + peer_cert_as_username: { + desc: 'Use the CN, DN field in the peer certificate or the entire certificate content as Username. Only works for the TLS connection.\nSupported configurations are the following:\n-
Each client attribute can be initialized as `client_attrs.{'{'}NAME{'}'}`,
where `{'{'}NAME{'}'}` is the name of the attribute specified in the config field `set_as_attr`.
The initialized client attribute will be stored in the `client_attrs` property with the specified name,
and can be used as a variable to render a template for mountpoint, authentication and authorization requests.
For example, use `${'{'}client_attrs.tns{'}'}` to render an HTTP POST body when `set_as_attr = tns`,
or render listener config `moutpoint = ${'{'}client_attrs.tns{'}'}/` for topic namespacing.", + }, + client_attrs_init_set_as_attr: { + label: 'Attribute', + }, + client_attrs_init_expression: { + label: 'Attribute Expression', + desc: "A one line expression to evaluate a set of predefined string functions (like in the rule engine SQL statements).
The expression can be a function call with nested calls as its arguments, or direct variable reference.
So far, it does not provide user-defined variable binding (like `var a=1`) or user-defined functions.
As an example, to extract the prefix of client ID delimited by a dot: `nth(1, tokens(clientid, '.'))`.
The variables pre-bound variables are:
- `clientid`: MQTT Client ID.
- `username`: MQTT Client's username.
- `user_property.{'{'}NAME{'}'}`: User properties in the CONNECT packet.
For TLS clients, connected directly or via proxy-protocol (v2) enabled load balancer,
some extra variables can be used:
- `cn`: Client's TLS certificate common name.
- `dn`: Client's TLS certificate distinguished name (the subject).
- `peersni`: TLS server name indication sent by the client.
You can read more about variform expressions in EMQX docs.", + }, + clientid_override: { + label: 'Client ID Override Expression', + desc: "A one line expression to evaluate a set of predefined string functions (like in the rule engine SQL statements).
The expression can be a function call with nested calls as its arguments, or direct variable reference.
So far, it does not provide user-defined variable binding (like `var a=1`) or user-defined functions.
As an example, to extract the prefix of client ID delimited by a dot: `nth(1, tokens(username, '.'))`.
The variables pre-bound variables are:
- `clientid`: The original MQTT Client ID.
- `username`: MQTT Client's username.
- `client_attrs.{'{'}NAME{'}'}`: Client attributes initialized by per config `client_attrs_init`.
For TLS clients, connected directly or via proxy-protocol (v2) enabled load balancer,
some extra variables can be used:
- `cn`: Client's TLS certificate common name.
- `dn`: Client's TLS certificate distinguished name (the subject).
- `peersni`: TLS server name indication sent by the client.
You can read more about variform expressions in EMQX docs.", + }, + retain_available: { + desc: 'Whether to enable support for MQTT retained message. When this option is disabled, clients will not be able to publish retained messages.', + label: 'Allowed Retain', + }, + message_expiry_interval: { + desc: 'The MQTT message expiry interval. For MQTT v5.0 clients, it is only effective if the Message-Expiry-Interval property is not specified for the message; for MQTT v3.1 and v3.1.1, it always applies. Note that it is not helpful to set this value to a greater value than the MQTT Session Expiry Interval, because once the session expires, all related messages are purged.', + label: 'Message Expiry Interval', + }, + ignore_loop_deliver: { + desc: 'Whether the messages sent by the MQTT v3.1.1/v3.1.0 client will be forwarded to the client itself, similar to `No Local` in MQTT 5.0.', + label: 'Ignore Loop Deliver', + }, + max_qos_allowed: { + label: 'Max QoS Allowed', + }, + max_topic_levels: { + label: 'Max Topic Levels', + }, + peer_cert_as_clientid: { + desc: 'Use the CN, DN field in the peer certificate or the entire certificate content as Client ID. Only works for the TLS connection.\nSupported configurations are the following:\n-
- `random`: dispatch the message to a random selected subscriber
- `round_robin`: select the subscribers in a round-robin manner
- `round_robin_per_group`: select the subscribers in round-robin fashion within each shared subscriber group
- `sticky`: always use the last selected subscriber to dispatch, until the subscriber disconnects.
- `local`: select random local subscriber otherwise select random cluster-wide
- `hash_topic`: select the subscribers by hashing the source topic
- `hash_clientid`: select the subscribers by hashing the `clientIds` of senders', + }, + keepalive_check_interval: { + label: 'Keep Alive Check Interval', + desc: 'The frequency of checking for incoming MQTT packets determines how often the server will check for new MQTT packets.
If a certain amount of time passes without any packets being sent from the client, this time will be added up.
Once the accumulated time exceeds `keepalive-interval * keepalive-multiplier`, the connection will be terminated.
The default is set to 30 seconds, with a minimum value of 1 second and a maximum value of `keepalive-interval / 2`.
', + }, + max_packet_size: { + desc: 'If the size is out of the preset value, EMQX will disconnect the current connection', + label: 'Max Packet Size', + }, + max_conn_rate: { + desc: 'Used to limit the rate at which EMQX accepts connections. Once the limit is reached, EMQX will pause fetching connections from the accept queue, delaying or rejecting new connections. If empty, it means no limit.\n\nFor example:\n\n- `1000/s` means accepting up to 1000 connections per second.\n- `1000/10s` means accepting up to 1000 connections every 10 seconds.', + label: 'Maximum Connection Rate', + }, + max_conn_burst: { + desc: 'The maximum number of connections that can be accepted in a burst. If empty, it means no limit.\n\nFor example: `10000/60m` means allowing up to 10000 connections in 60 minutes.', + label: 'Maximum Connection Burst', + }, + messages_rate: { + desc: 'Used to limit the number of messages a single client can send to EMQX per second, Once the limit is reached, EMQX will pause reading data from the receive-buffer, thus slowing down or even temporarily hanging the sender.\n\nFor example:\n\n- `500/s` means only 500 messages will be received per second, and the remaining messages will be delayed.\n- `500/10s`: Only 500 messages will be received every 10 seconds and the remaining messages will be delayed.', + label: 'Messages Publish Rate', + }, + messages_burst: { + desc: 'Number of messages that can be sent in a burst. If empty, it means no limit.\n\nFor example: `10000/60m` means allowing up to 10000 messages to be sent in 60 minutes.', + label: 'Messages Publish Burst', + }, + bytes_rate: { + desc: 'Used to limit the number of bytes a single client can send to EMQX per second, Once the limit is reached, EMQX will pause reading data from the receive-buffer, thus slowing down or even temporarily hanging the sender.\n\nThe unit of the bytes could be: B, KB, MB, GB.\n\nFor example:\n\n- `500KB/s` means only 500 kilobytes per second will be received, and the remaining bytes will be delayed.\n- `500MB/10s` means only 500 megabytes will be received every 10 seconds, and the remaining bytes will be delayed.', + label: 'Data Publish Rate', + }, + bytes_burst: { + desc: 'Number of bytes that can be sent in a burst. If empty, it means no limit.\n\nFor example: `100MB/60m` means allowing up to 100 megabytes of data to be sent in 60 minutes.', + label: 'Data Publish Burst', + }, + /* MQTT END */ + /* SESSION START */ + max_subscriptions: { + desc: 'Maximum number of subscriptions allowed per client.', + label: 'Max Subscriptions', + }, + upgrade_qos: { + desc: 'Force upgrade of QoS level according to subscription.', + label: 'Upgrade QoS', + }, + max_inflight: { + desc: 'Maximum number of QoS 1 and QoS 2 messages that are allowed to be delivered simultaneously before completing the acknowledgment.', + label: 'Max Inflight', + }, + retry_interval: { + desc: 'Retry interval for QoS 1/2 message delivering.', + label: 'Message Retry Interval', + }, + max_awaiting_rel: { + desc: 'Specifies the maximum number of pending QoS 2 messages in each session until either PUBREL is received or timed out. When this limit is reached, new QoS 2 PUBLISH requests will be rejected with error code 147(0x93).', + label: 'Max Awaiting PUBREL', + }, + await_rel_timeout: { + desc: 'Specifies the amount of time to wait for a publish of a QoS 2 message with no PUBREL received. When this limit is reached, EMQX will release the packet ID and also output a warning level log. \nNote: EMQX’s forwarding of the received QoS 2 message is independent from the receiving of PUBREL', + label: 'Max Awaiting PUBREL Timeout', + }, + session_expiry_interval: { + desc: 'Specifies how long the session will expire after the connection is disconnected, only for non-MQTT 5.0 connections.', + label: 'Session Expiry Interval', + }, + max_mqueue_len: { + desc: 'Maximum allowed queue length when persistent client are disconnected or inflight window is full.', + label: 'Max Message Queue Length', + }, + mqueue_priorities: { + desc: 'Topic priorities. Priority number [1-255]. There\'s no priority table by default, hence all messages are treated equal.
NOTE: Comma and equal signs are not allowed for priority topic names.
NOTE: Messages for topics not in the priority table are treated as either highest or lowest priority depending on the configured value for mqtt.mqueue_default_priority.
Examples:
To configure "topic/1" > "topic/2":
mqueue_priorities: {\'{\'}"topic/1": 10, "topic/2": 8{\'}\'}', + label: 'Topic Priorities', + }, + mqueue_default_priority: { + desc: 'Default topic priority, which will be used by topics not in
-
-
-
The following events are throttled:
- authorization_permission_denied
- cannot_publish_to_topic_due_to_not_authorized
- cannot_publish_to_topic_due_to_quota_exceeded
- connection_rejected_due_to_license_limit_reached
- dropped_msg_due_to_mqueue_is_full', + label: 'Time Window', + }, + /* LOG END */ + /* ALARM START */ + cpu_check_interval: { + desc: 'The time interval for the periodic CPU check.', + label: 'The time interval for the periodic CPU check', + }, + cpu_high_watermark: { + desc: 'The threshold, as percentage of system CPU load,\n for how much system cpu can be used before the corresponding alarm is raised.', + label: 'CPU high watermark', + }, + cpu_low_watermark: { + desc: 'The threshold, as percentage of system CPU load,\n for how much system cpu can be used before the corresponding alarm is cleared.', + label: 'CPU low watermark', + }, + mem_check_interval: { + desc: 'The time interval for the periodic memory check.', + label: 'Mem check interval', + }, + procmem_high_watermark: { + desc: 'The threshold, as percentage of system memory,\n for how much system memory can be allocated by one Erlang process before\n the corresponding alarm is raised.', + label: 'ProcMem high wartermark', + }, + sysmem_high_watermark: { + desc: 'The threshold, as percentage of system memory,\n for how much system memory can be allocated before the corresponding alarm is raised.', + label: 'SysMem high wartermark', + }, + busy_dist_port: { + desc: 'When the RPC connection used to communicate with other nodes in the cluster is overloaded,\nthere will be a
\n注意：此文件内容是私钥，所以需要设置权限为 600。", - "label": "RPC 私钥文件" - }, - "cluster_mcast_recbuf": { - "desc": "接收数据报的内核级缓冲区的大小。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。", - "label": "多播接收数据缓冲区" - }, - "cluster_autoheal": { - "desc": "集群脑裂自动恢复机制开关。", - "label": "节点脑裂自动修复机制" - }, - "log_overload_kill_enable": { - "desc": "日志处理进程过载时为保护自己节点其它的业务能正常，强制杀死日志处理进程。", - "label": "日志处理进程过载保护" - }, - "node_etc_dir": { - "desc": "
\n- inet_tcp: 使用 IPv4
\n- inet_tls: 使用 TLS，需要配合{'@'}\\。其中 可以是 IP 地址，也可以是 FQDN。\n详见 http://erlang.org/doc/reference_manual/distributed.html。",
- "label": "节点名"
- },
- "rpc_port_discovery": {
- "desc": "
\n这可以在
-
-
-
\n
\n
\n建议复制节点多于核心节点。
\n注意：该参数仅在设置
\n只有当 rpc.port_discovery 设置为 manual 时，此配置才会生效。", - "label": "RPC TCP 服务监听端口" - }, - "desc_console_handler": { - "desc": "日志处理进程将日志事件打印到 EMQX 控制台。", - "label": "Console Handler" - }, - "node_applications": { - "desc": "当新EMQX 加入集群时，应重启的Erlang应用程序的列表。", - "label": "应用" - }, - "log_burst_limit_max_count": { - "desc": "在 `window_time` 间隔内处理的最大日志事件数。 达到限制后，将丢弃连续事件，直到 `window_time` 结束。", - "label": "日志事件数" - }, - "rpc_tcp_client_num": { - "desc": "设置本节点与远程节点之间的 RPC 通信通道的最大数量。", - "label": "RPC TCP 客户端数量" - }, - "cluster_k8s_address_type": { - "desc": "当使用 k8s 方式集群时，address_type 用来从 Kubernetes 接口的应答里获取什么形式的 Host 列表。\n指定
\n注意：该参数仅在设置
\n该值需要在手动或静态集群发现机制下设置。
\n如果使用了自动集群发现机制（如
\n注意：集群中所有节点的证书必须使用同一个 CA 签发。", - "label": "RPC CA 证书文件" - }, - "desc_node": { - "desc": "节点名称、Cookie、配置文件、数据目录和 Erlang 虚拟机（BEAM）启动参数。", - "label": "节点" - }, - "cluster_k8s_apiserver": { - "desc": "指定 Kubernetes API Server。如有多个 Server 使用逗号 , 分隔。\n当 cluster.discovery_strategy 为 k8s 时，此配置项才有效。", - "label": "K8s 服务地址" - }, - "common_handler_supervisor_reports": { - "desc": "Supervisor 报告的类型。默认为 error 类型。
\n -
\n- `mnesia/`。EMQX的内置数据库目录。例如，`mnesia/emqx{'@'}127.0.0.1`。
\n如果节点要被重新命名（例如，`emqx{'@'}10.0.1.1`）。旧目录应该首先被删除。
\n- `configs`。在启动时生成的配置，以及集群/本地覆盖的配置。
\n- `patches`: 热补丁文件将被放在这里。
\n- `trace`: 日志跟踪文件。
\n\n**注意**: 一个数据dir不能被两个或更多的EMQX节点同时使用。", - "label": "节点数据目录" - }, - "cluster_k8s_suffix": { - "desc": "当使用 k8s 方式并且 cluster.k8s.address_type 指定为 dns 类型时，可设置 emqx 节点名的后缀。\n与 cluster.k8s.namespace 一起使用用以拼接得到节点名列表。", - "label": "K8s 前缀" - }, - "db_rpc_module": { - "desc": "集群间推送事务日志到复制节点使用的协议。", - "label": "RPC协议" - }, - "cluster_etcd_prefix": { - "desc": "指定 etcd 路径的前缀。每个节点在 etcd 中都会创建一个路径:\nv2/keys///
\n当 cluster.discovery_strategy 为 etcd 时，此配置项才有效。", - "label": "Etcd 路径前缀" - }, - "cluster_mcast_iface": { - "desc": "指定节点发现服务需要绑定到本地 IP 地址。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。", - "label": "多播绑定地址" - }, - "log_burst_limit_window_time": { - "desc": "参考
\n这部分配置，控制每个日志处理进程保留的文件数量。", - "label": "日志轮换" - }, - "desc_log_overload_kill": { - "desc": "日志过载终止，具有过载保护功能。当日志处理进程使用过多内存，或者缓存的日志消息过多时该功能被激活。
\n检测到过载时，日志处理进程将终止，并在冷却期后重新启动。", - "label": "日志过载保护" - }, - "authorization": { - "desc": "授权（ACL）。EMQX 支持完整的客户端访问控制（ACL）。", - "label": "授权" - }, - "rpc_socket_keepalive_idle": { - "desc": "broker 之间的连接在最后一条消息发送后保持打开的时间。", - "label": "RPC Socket Keepalive Idle" - }, - "desc_cluster_call": { - "desc": "集群调用功能的选项。", - "label": "集群调用" - }, - "cluster_mcast_ports": { - "desc": "指定多播端口。如有多个端口使用逗号 , 分隔。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。", - "label": "多播端口" - }, - "log_overload_kill_mem_size": { - "desc": "日志处理进程允许使用的最大内存。", - "label": "日志处理进程允许使用的最大内存" - }, - "rpc_connect_timeout": { - "desc": "建立 RPC 连接的超时时间。", - "label": "RPC 连接超时时间" - }, - "cluster_etcd_node_ttl": { - "desc": "指定 etcd 中节点信息的过期时间。\n当 cluster.discovery_strategy 为 etcd 时，此配置项才有效。", - "label": "Etcd 节点过期时间" - }, - "rpc_call_receive_timeout": { - "desc": "同步 RPC 的回复超时时间。", - "label": "RPC 调用接收超时时间" - }, - "rpc_socket_recbuf": { - "desc": "TCP 调节参数。TCP 接收缓冲区大小。", - "label": "RPC 套接字接收缓冲区大小" - }, - "db_tlog_push_mode": { - "desc": "同步模式下，核心节点等待复制节点的确认信息，然后再发送下一条事务日志。", - "label": "Tlog推送模式" - }, - "node_crash_dump_bytes": { - "desc": "限制崩溃文件的大小，当崩溃时节点内存太大，\n如果为了保存现场，需要全部存到崩溃文件中，此处限制最多能保存多大的文件。\n如果超过此限制，崩溃转储将被截断。如果设置为0，系统不会尝试写入崩溃转储文件。", - "label": "崩溃文件最大容量" - }, - "rpc_certfile": { - "desc": "TLS 证书文件的路径，用于验证集群节点的身份。\n只有当
\n- 如果设置为0秒，运行时会立即终止，不会尝试写入崩溃转储文件。
\n- 如果设置为一个正数 S，节点会等待 S 秒来完成崩溃转储文件，然后用SIGALRM信号终止运行时系统。
\n- 如果设置为一个负值导致运行时系统的终止等待无限期地直到崩溃转储文件已经完全写入。", - "label": "保存崩溃文件最长时间" - }, - "log_file_handlers": { - "desc": "输出到文件的日志处理进程列表", - "label": "File Handler" - }, - "node_global_gc_interval": { - "desc": "系统调优参数，设置节点运行多久强制进行一次全局垃圾回收。禁用设置为
\n大多数情况下，默认的配置应该可以工作，但如果你需要做一些性能优化或者实验，可以尝试调整这些参数。", - "label": "RPC" - }, - "rpc_ssl_server_port": { - "desc": "RPC 本地服务使用的监听SSL端口。
\n只有当 rpc.port_discovery 设置为 manual 且
这里指定了节点之间如何连接。", - "label": "集群" - }, - "common_handler_sync_mode_qlen": { - "desc": "只要缓冲的日志事件的数量低于这个值，所有的日志事件都会被异步处理。\n这意味着，日志落地速度不会影响正常的业务进程，因为它们不需要等待日志处理进程的响应。\n如果消息队列的增长超过了这个值，处理程序开始同步处理日志事件。也就是说，发送事件的客户进程必须等待响应。\n当处理程序将消息队列减少到低于sync_mode_qlen阈值的水平时，异步操作就会恢复。\n默认为100条信息，当等待的日志事件大于100条时，就开始同步处理日志。", - "label": "进入同步模式的队列长度" - }, - "common_handler_formatter": { - "desc": "选择日志格式类型。
\n- static: 配置静态节点。配置几个固定的节点，新节点通过连接固定节点中的某一个来加入集群。
\n- dns: 使用 DNS A 记录的方式发现节点。
\n- etcd: 使用 etcd 发现节点。
\n- k8s: 使用 Kubernetes API 发现节点。", - "label": "集群服务发现策略" - }, - "rpc_send_timeout": { - "desc": "发送 RPC 请求的超时时间。", - "label": "RPC 发送超时时间" - }, - "common_handler_single_line": { - "desc": "如果设置为 true，则单行打印日志。 否则，日志消息可能跨越多行。", - "label": "单行模式" - }, - "rpc_socket_buffer": { - "desc": "TCP 调节参数。用户模式套接字缓冲区大小。", - "label": "RPC 套接字缓冲区大小" - }, - "db_shard_transports": { - "desc": "允许为每个 shard 下的事务日志复制操作的传输方法进行调优。
\n
如果未指定，\n默认是使用
支持的事件如下：
- authorization_permission_denied
- cannot_publish_to_topic_due_to_not_authorized
- cannot_publish_to_topic_due_to_quota_exceeded
- connection_rejected_due_to_license_limit_reached
- dropped_msg_due_to_mqueue_is_full", - "label": "时间窗口" - }, - "common_handler_payload_encode": { - "desc": "日志中 Payload 的编码方式。", - "label": "Payload 编码" - } - }, - "emqx_limiter_schema": { - "max_conn_rate": { - "desc": "最大连接速率。
\n这用于限制此节点的连接速率，\n一旦达到限制，新连接将被推迟或拒绝。", - "label": "最大连接速率" - }, - "messages_rate": { - "desc": "消息发布速率。
\n这用于限制该节点的入站消息数量，\n一旦达到限制，受限客户端的消息发布将会减慢甚至暂停一段时间。", - "label": "消息发布速率" - }, - "bytes_rate": { - "desc": "数据发布速率。
\n这用于限制该节点的入站字节速率，\n一旦达到限制，受限客户端的数据发布将会减慢甚至暂停一段时间。", - "label": "数据发布速率" - } - }, - "emqx_schema": { - "fields_mqtt_quic_listener_peer_unidi_stream_count": { - "desc": "允许对端打开的单向流的数量", - "label": "对端单向流的数量" - }, - "fields_authorization_no_match": { - "desc": "如果用户或客户端不匹配ACL规则，或者从可配置授权源(比如内置数据库、HTTP API 或 PostgreSQL 等。)内未找\n到此类用户或客户端时，模式的认访问控制操作。\n在“授权”中查找更多详细信息。", - "label": "未匹时的默认授权动作" - }, - "sysmon_top_db_hostname": { - "desc": "收集数据点的 PostgreSQL 数据库的主机名。", - "label": "数据库主机名" - }, - "zones": { - "desc": "
目前，支持以下操作：
\n此文件中的证书用于验证TLS对等方的证书。\n如果要信任新 CA，请将新证书附加到文件中。\n无需重启EMQX即可加载更新的文件，因为系统会定期检查文件是否已更新（并重新加载）
\n注意：从文件中失效（删除）证书不会影响已建立的连接。", - "label": "CA 证书文件" - }, - "fields_ws_opts_mqtt_path": { - "desc": "WebSocket 的 MQTT 协议路径。因此，EMQX Broker的WebSocket地址为：\n
\n例如，当连接到 \"server.example.net\" 时，接受连接并执行 TLS 握手的真正服务器可能与 TLS 客户端最初连接到的主机不同，\n例如，当连接到 IP 地址时，或者当主机具有多个可解析的 DNS 记录时
\n如果未指定，它将默认为使用的主机名字符串\n建立连接，除非使用 IP 地址
\n然后，主机名也用于对等机的主机名验证证书
\n特殊值/uptime`\n - `$SYS/brokers//datetime`"
- },
- "flapping_detect_ban_time": {
- "desc": "抖动的客户端将会被禁止登录多长时间。",
- "label": "禁止登录时长"
- },
- "sysmon_top_num_items": {
- "desc": "每个监视组的顶级进程数。",
- "label": "顶级进程数"
- },
- "persistent_session_builtin_session_table": {
- "desc": "用于内建会话表的性能调优参数。",
- "label": "持久会话"
- },
- "mqtt_upgrade_qos": {
- "desc": "投递消息时，是否根据订阅主题时的 QoS 等级来强制提升派发消息的 QoS 等级。",
- "label": "升级 QoS"
- },
- "mqtt_shared_subscription": {
- "label": "允许共享订阅"
- },
- "fields_tcp_opts_sndbuf": {
- "desc": "连接的 TCP 发送缓冲区（OS 内核）。",
- "label": "TCP 发送缓冲区"
- },
- "sysmon_os_mem_check_interval": {
- "desc": "定期内存检查的时间间隔。",
- "label": "内存检查间隔"
- },
- "server_ssl_opts_schema_gc_after_handshake": {
- "desc": "内存使用调优。如果启用，将在TLS/SSL握手完成后立即执行垃圾回收。TLS/SSL握手建立后立即进行GC。",
- "label": "握手后执行GC"
- },
- "fields_mqtt_quic_listener_ssl_options": {
- "desc": "QUIC 传输层的 TLS 选项",
- "label": "TLS 选项"
- },
- "fields_ws_opts_mqtt_piggyback": {
- "desc": "WebSocket消息是否允许包含多个 MQTT 数据包。",
- "label": "MQTT Piggyback"
- },
- "base_listener_mountpoint": {
- "desc": "发布或订阅时，请在所有主题前面加上 mountpoint 字符串。\n\n将消息传递给订阅者时，将从主题名称中删除带前缀的字符串。挂载点是一种用户可以用来实现不同侦听器之间消息路由隔离的方法。\n\n例如，如果客户机 A 使用
\n类似地，如果另一个客户端B（与客户端A连接到同一个侦听器）向主题 't' 发送消息，该消息将路由到所有订阅了'some_租户/t'的客户端，因此客户端 A 将接收主题名为't'的消息
\n\n设置为
\n\nmountpoint 字符串中的变量：\n-
\n密码（及其顺序）定义了客户端和服务器通过网络连接加密信息的方式。\n选择一个好的密码套件对于应用程序的数据安全性、机密性和性能至关重要。\n\n名称应为 OpenSSL 字符串格式（而不是 RFC 格式）。\nEMQX 配置文档提供的所有默认值和示例都是 OpenSSL 格式
\n注意：某些密码套件仅与特定的 TLS
\n注：PSK 的 Ciphers 不支持 tlsv1.3
\n如果打算使用PSK密码套件，
\nPSK 密码套件：\n
\n\n注：QUIC 监听器不支持 tlsv1.3 的 ciphers", - "label": "" - }, - "fields_mqtt_quic_listener_max_bytes_per_key": { - "desc": "在启动密钥更新之前，用单个 1-RTT 加密密钥加密的最大字节数。默认值：274877906944", - "label": "每个密钥的最大字节数" - }, - "fields_mqtt_quic_listener_mtu_discovery_search_complete_timeout_us": { - "desc": "如果没有达到 max ，在重新尝试 MTU 探测之前要等待的时间，单位是微秒。默认值：600000000", - "label": "" - }, - "fields_ws_opts_check_origin_enable": { - "desc": "如果
只有当队列中没有挂起的数据，并且连接至少被堵塞了
报警才会被清除。这是为了避免太频繁地清除和再次发出警报。", - "label": "告警维持时间" - }, - "fields_mqtt_quic_listener_keep_alive_interval_ms": { - "desc": "多长时间发送一次PING帧以保活连接。", - "label": "保持活着的时间间隔 毫秒" - }, - "fields_mqtt_quic_listener_handshake_idle_timeout_ms": { - "desc": "一个握手在被丢弃之前可以空闲多长时间", - "label": "握手空闲超时 毫秒" - }, - "broker_session_locking_strategy": { - "desc": "Session 在集群中的锁策略。\n - `loca`：仅锁本节点的 Session；\n - `one`：任选一个其它节点加锁；\n - `quorum`：选择集群中半数以上的节点加锁；\n - `all`：选择所有节点加锁。" - }, - "persistent_store_ram_cache": { - "desc": "在内存中保持一份数据的副本，以便更快地访问。", - "label": "内存缓存" - }, - "fields_mqtt_quic_listener_stream_recv_window_default": { - "desc": "初始流接收窗口大小。 默认值：32678", - "label": "流接收窗口默认" - }, - "mqtt_mqueue_priorities": { - "desc": "主题优先级。优先级数字[1-255]。默认情况下没有优先级表，因此所有消息都被平等对待。
注意：优先级主题名称中不允许使用逗号和等号。
注意：不在优先级表中的主题的消息将根据 mqtt.mqueue_default_priority 的配置值被视为最高优先级或最低优先级。
示例：
要配置 'topic/1' > 'topic/2'：
mqueue_priorities: {'{'}\"topic/1\": 10, \"topic/2\": 8{'}'}", - "label": "主题优先级" - }, - "fields_rate_limit_conn_messages_in": { - "desc": "外部 MQTT 连接的消息限制。", - "label": "外部 MQTT 连接的消息限制" - }, - "fields_rate_limit_max_conn_rate": { - "desc": "每秒最大连接数。", - "label": "每秒最大连接数" - }, - "alarm_size_limit": { - "desc": "要保留为历史记录的已停用报警的最大总数。当超过此限制时，将删除最旧的停用报警，以限制总数。", - "label": "告警总数限制" - }, - "fields_cache_max_size": { - "desc": "缓存项的最大数量。", - "label": "缓存项的最大数量" - }, - "fields_listeners_tcp": { - "desc": "TCP 监听器。", - "label": "TCP 监听器" - }, - "conn_congestion_enable_alarm": { - "desc": "启用或者禁用连接阻塞告警功能。", - "label": "启用/禁用阻塞告警" - }, - "fields_ws_opts_proxy_port_header": { - "desc": "HTTP 头，用于传递有关客户端端口的信息。当 EMQX 集群部署在负载平衡器后面时，这一点非常重要。", - "label": "客户端端口头" - }, - "overload_protection_enable": { - "desc": "是否对系统过载做出反应。", - "label": "是否对系统过载做出反应" - }, - "fields_mqtt_quic_listener_minimum_mtu": { - "desc": "一个连接所支持的最小MTU。这将被作为起始MTU使用。默认值：1248", - "label": "最小 MTU" - }, - "sys_msg_interval": { - "desc": "发送 `$SYS` 主题的间隔时间。" - }, - "mqtt_await_rel_timeout": { - "desc": "对于未收到 PUBREL 的 QoS 2 消息，将按照指定时间等待重传；超时后 EMQX 将释放 packet ID 并产生一条告警日志。\n注意：EMQX 对消息的转发操作不依赖于 PUBREL收到与否。", - "label": "最大 PUBREL 等待时长" - }, - "common_ssl_opts_schema_verify": { - "desc": "启用或禁用对等验证。", - "label": "对等验证" - }, - "fields_listeners_ssl": { - "desc": "SSL 监听器。", - "label": "SSL 监听器" - }, - "fields_deflate_opts_client_max_window_bits": { - "desc": "指定客户端压缩上下文的大小。", - "label": "压缩窗口大小" - }, - "common_ssl_opts_schema_keyfile": { - "desc": "PEM格式的私钥文件。", - "label": "私钥文件" - }, - "sysmon_os_cpu_high_watermark": { - "desc": "在发出相应警报之前可以使用多少系统 CPU 的阈值，以系统CPU负载的百分比表示。", - "label": "CPU 高水位线" - }, - "flapping_detect_window_time": { - "desc": "抖动检测的时间窗口。", - "label": "时间窗口" - }, - "mqtt_mqueue_default_priority": { - "desc": "默认的主题优先级，不在
\n注意：TLS 1.3不支持
\n此文件中的证书应与证书颁发链的顺序相反。也就是说，主机的证书应该放在文件的开头，\n然后是直接颁发者 CA 证书，依此类推，一直到根 CA 证书。\n根 CA 证书是可选的，如果想要添加，应加到文件到最末端。", - "label": "证书文件" - }, - "mqtt_exclusive_subscription": { - "label": "允许排它订阅" - }, - "mqtt_retain_available": { - "desc": "是否启用对 MQTT 保留消息的支持。禁用此选项时，客户端将无法发布保留消息。", - "label": "启用保留消息" - }, - "fields_tcp_opts_reuseaddr": { - "desc": "连接的 SO_REUSEADDR 标识。", - "label": "SO_REUSEADDR" - }, - "sysmon_vm_long_schedule": { - "desc": "启用后，如果 Erlang VM 调度器出现某个任务占用时间过长时，会触发一条带有 'long_schedule' 关键字的日志。\n同时还会发布一条主题为
\n
\n较低的值会减少每个连接的内存使用。", - "label": "压缩状态大小" - }, - "fields_mqtt_quic_listener_send_idle_timeout_ms": { - "desc": "在闲置一定时间后重置拥堵控制。默认值：1000", - "label": "发送空闲超时毫秒" - }, - "base_listener_limiter": { - "desc": "速率限制类型", - "label": "速率限制类型" - }, - "persistent_session_store_backend": { - "desc": "用于存储持久性会话和信息的数据库管理后端\n- `builtin`: 使用内置的数据库（mria）", - "label": "后端类型" - }, - "alarm_validity_period": { - "desc": "停用报警的保留时间。报警在停用时不会立即删除，而是在保留时间之后删除。", - "label": "告警保留时间" - }, - "server_ssl_opts_schema_ocsp_issuer_pem": { - "desc": "服务器证书的 OCSP 签发者的 PEM 编码证书。", - "label": "OCSP 签发者证书" - }, - "fields_tcp_opts_active_n": { - "desc": "为此套接字指定{'{'}active，N{'}'}选项
\nSee: https://erlang.org/doc/man/inet.html#setopts-2", - "label": "active_n" - }, - "listener_authentication": { - "desc": "监听器认证重载。\n认证配置可以是单个认证器实例，也可以是一个认证器数组组成的认证链。\n执行登录验证时（用户名、客户端 ID 等），将按配置的顺序执行。", - "label": "每个监听器的认证覆盖" - }, - "fields_trace_payload_encode": { - "desc": "确定跟踪日志文件中 Payload 格式。
\n`text`：基于文本的协议或纯文本协议。\n建议在 Payload 为 JSON 编码时使用
\n`hex`：二进制十六进制编码。当 Payload 是自定义二进制协议时，建议使用此选项
\n`hidden`：Payload 被模糊化为 `******`", - "label": "Payload 编码" - }, - "mqtt_response_information": { - "desc": "UTF-8 字符串，用于指定返回给客户端的响应主题，如 `reqrsp/`，此时请求和应答客户端都需要使用 `reqrsp/` 前缀的主题来完成通讯。如希望禁用此功能，请在下方的文字框中输入`\"\"`；仅适用于 MQTT 5.0 客户端。", - "label": "响应信息" - }, - "persistent_session_store_max_retain_undelivered": { - "desc": "如果重新启动时处理上一个会话的节点已停止，则未传递到持久会话的消息在垃圾收集之前会被存储。", - "label": "未投递的消息保留条数" - }, - "fields_mqtt_quic_listener_migration_enabled": { - "desc": "开启客户端地址迁移功能。需要一个支持的负载平衡器，或者没有负载平衡器。默认值：1（已启用）", - "label": "启用地址迁移" - }, - "common_ssl_opts_schema_password": { - "desc": "包含用户密码的字符串。仅在私钥文件受密码保护时使用。", - "label": "密钥文件密码" - }, - "common_ssl_opts_schema_hibernate_after": { - "desc": "在闲置一定时间后休眠 SSL 进程，减少其内存占用。", - "label": "闲置多久后休眠" - }, - "fields_mqtt_quic_listener_send_buffering_enabled": { - "desc": "缓冲发送数据，而不是保留应用缓冲区，直到发送数据被确认。默认值：1（启用）", - "label": "启用发送缓冲功能" - }, - "sys_event_client_unsubscribed": { - "desc": "是否开启客户端已成功取消订阅主题事件消息。" - }, - "overload_protection_backoff_new_conn": { - "desc": "高负载时，拒绝新进来的客户端连接。", - "label": "关闭新连接" - }, - "server_ssl_opts_schema_ocsp_responder_url": { - "desc": "用于检查服务器证书的 OCSP Responder 的 URL。", - "label": "OCSP Responder 的 URL" - }, - "mqtt_idle_timeout": { - "desc": "设置连接被断开或进入休眠状态前的等待时间，空闲超时后\n\n- 如暂未收到客户端的 CONNECT 报文，连接将断开；\n- 如已收到客户端的 CONNECT 报文，连接将进入休眠模式以节省系统资源。\n\n注意：请合理设置该参数值，如等待时间设置过长，可能造成系统资源的浪费。", - "label": "空闲超时" - }, - "fields_mqtt_quic_listener_conn_flow_control_window": { - "desc": "连接的流控窗口。默认：16777216", - "label": "流控窗口" - }, - "fields_mqtt_quic_listener_maximum_mtu": { - "desc": "一个连接所支持的最大MTU。这将是最大的探测值。默认值：1500", - "label": "最大 MTU" - }, - "sysmon_top_db_name": { - "desc": "PostgreSQL 数据库的数据库名", - "label": "数据库名" - }, - "mqtt_strict_mode": { - "desc": "是否以严格模式解析 MQTT 消息。严格模式下，如客户端 ID、主题名称等中包含无效 utf8 字符串，连接将被断开。", - "label": "严格模式" - }, - "shared_subscription_group_strategy": { - "desc": "设置共享订阅组为单位的分发策略。该配置是一个从组名到\n策略名的一个map，组名不得包含 `[A-Za-z0-9]` 之外的特殊字符。" - }, - "fields_deflate_opts_strategy": { - "desc": "指定压缩策略。", - "label": "指定压缩策略" - }, - "shared_subscription_strategy_enum": { - "desc": "共享订阅的分发策略名称。\n- `random`：随机选择一个组内成员；\n- `round_robin`：循环选择下一个成员；\n- `round_robin_per_group`：在共享组内循环选择下一个成员；\n- `sticky`：使用上一次选中的成员；\n- `hash`：根据 ClientID 哈希映射到一个成员；\n- `local`：随机分发到节点本地成成员，如果本地成员不存在，则随机分发到任意一个成员。" - }, - "persistent_session_builtin_sess_msg_table": { - "desc": "优化内置的会话消息表的配置。", - "label": "用于内建会话管理表的性能调优参数" - }, - "mqtt_mqueue_store_qos0": { - "desc": "在连接断开但会话保持期间，是否需要在消息队列中存储 QoS 0 消息。", - "label": "存储 QoS 0 消息" - }, - "server_ssl_opts_schema_client_renegotiation": { - "desc": "在支持客户机发起的重新协商的协议中，这种操作的资源成本对于服务器来说高于客户机。\n这可能会成为拒绝服务攻击的载体。\nSSL 应用程序已经采取措施来反击此类尝试，但通过将此选项设置为 false，可以严格禁用客户端发起的重新协商。\n默认值为 true。请注意，由于基础密码套件可以加密的消息数量有限，禁用重新协商可能会导致长期连接变得不可用。", - "label": "SSL 客户端冲协商" - }, - "server_ssl_opts_schema_enable_crl_check": { - "desc": "是否为该监听器启用 CRL 检查。", - "label": "启用 CRL 检查" - }, - "fields_mqtt_quic_listener_peer_bidi_stream_count": { - "desc": "允许对端打开的双向流的数量", - "label": "对端双向流的数量" - }, - "fields_mqtt_quic_listener_max_stateless_operations": { - "desc": "无状态操作的最大数量，在任何时候都可以在一个工作者上排队。默认值：16", - "label": "最大无状态操作数" - }, - "fields_ws_opts_idle_timeout": { - "desc": "关闭在此间隔内未发送 MQTT CONNECT 消息的客户端的传输层连接。", - "label": "WS 空闲时间" - }, - "fields_mqtt_quic_listener_max_ack_delay_ms": { - "desc": "在收到数据后要等待多长时间才能发送一个ACK。默认值：25", - "label": "最大应答延迟 毫秒" - }, - "base_listener_zone": { - "desc": "监听器所属的配置组。", - "label": "配置组" - }, - "fields_mqtt_quic_listener_handshake_idle_timeout": { - "desc": "一个握手在被丢弃之前可以空闲多长时间。", - "label": "握手空闲超时时间" - }, - "force_gc_enable": { - "desc": "启用强制垃圾回收。", - "label": "启用强制垃圾回收" - }, - "fields_ws_opts_allow_origin_absence": { - "desc": "If
\n注：PSK 的 Ciphers 无法在
\n如果是1，路径可以是 PEER、中间 CA、ROOT-CA；
\n如果是2，则路径可以是PEER、中间 CA1、中间 CA2、ROOT-CA。", - "label": "CA 证书深度" - }, - "sysmon_vm_long_gc": { - "desc": "当系统检测到某个 Erlang 进程垃圾回收占用过长时间，会触发一条带有
\n密码（及其顺序）定义了客户端和服务器通过网络连接加密信息的方式。\n选择一个好的密码套件对于应用程序的数据安全性、机密性和性能至关重要。\n\n名称应为 OpenSSL 字符串格式（而不是 RFC 格式）。\nEMQX 配置文档提供的所有默认值和示例都是 OpenSSL 格式
\n注意：某些密码套件仅与特定的 TLS
\n注：PSK 的 Ciphers 不支持 tlsv1.3
\n如果打算使用PSK密码套件
\nPSK 密码套件：\n
\n详情见: https://www.haproxy.com/blog/haproxy/proxy-protocol/", - "label": "Proxy protocol" - }, - "mqtt_listener_access_rules": { - "desc": "此监听器的访问控制规则。", - "label": "访问控制规则" - }, - "server_ssl_opts_schema_enable_ocsp_stapling": { - "desc": "是否为监听器启用 OCSP Stapling 功能。 如果设置为 true，需要定义 OCSP Responder 的 URL 和证书签发者的 PEM 文件路径。", - "label": "启用 OCSP Stapling" - }, - "fields_tcp_opts_send_timeout_close": { - "desc": "如果发送超时，则关闭连接。", - "label": "TCP 发送超时关闭连接" - }, - "sysmon_os_cpu_check_interval": { - "desc": "定期 CPU 检查的时间间隔。", - "label": "定期 CPU 检查的时间间隔" - }, - "sysmon_top_sample_interval": { - "desc": "指定应收集进程顶部的频率。", - "label": "取样时间" - }, - "fields_mqtt_quic_listener_idle_timeout_ms": { - "desc": "一个连接在被优雅地关闭之前可以空闲多长时间。0 表示禁用超时", - "label": "空闲超时 毫秒" - }, - "fields_ws_opts_fail_if_no_subprotocol": { - "desc": "如果
注意：微信小程序需要禁用此验证。", - "label": "无 subprotocol 则失败" - }, - "mqtt_wildcard_subscription": { - "label": "允许通配符订阅" - }, - "server_ssl_opts_schema_ocsp_refresh_interval": { - "desc": "为服务器刷新OCSP响应的周期。", - "label": "OCSP 刷新间隔" - }, - "overload_protection_backoff_hibernation": { - "desc": "高负载时，跳过进程休眠。", - "label": "跳过休眠" - }, - "fields_ws_opts_max_frame_size": { - "desc": "单个 MQTT 数据包的最大长度。", - "label": "最大数据包长度" - }, - "sys_event_messages": { - "desc": "客户端事件消息。" - }, - "broker_perf_trie_compaction": { - "desc": "是否开启主题表压缩存储。\n启用它会显着提高通配符主题订阅率，如果通配符主题具有唯一前缀，例如：'sensor/{'{'}{'{'}id{'}'}{'}'}/+/'，其中每个订阅者的 ID 是唯一的。\n如果消息主要发布到具有大量级别的主题，则主题匹配性能（发布时）可能会降低。\n\n注意：这是一个集群范围的配置。 它要求在更改之前停止所有节点。" - }, - "sysmon_vm_large_heap": { - "desc": "启用后，当一个 Erlang 进程申请了大量内存，系统会触发一条带有
- `random`：将消息分配给随机选择的订阅者。
- `round_robin`：以循环方式选择订阅者。
- `round_robin_per_group`：在每个共享订阅组内以循环方式选择订阅者。
- `sticky`：始终使用最后选择的订阅者进行调度，直到订阅者断开连接。
- `local`：如果本地订阅者不存在，则选择随机本地订阅者，否则选择随机集群广域订阅者。
- `hash_topic`：通过主题源的哈希值选择订阅者。
- `hash_clientid`：通过对发送者的客户端 ID 进行 Hash 处理来选择订阅者。" - }, - "mqtt_client_attrs_init": { - "label": "客户端属性", - "desc": "在客户端连接时设置自定义属性并将其用于认证、授权等功能中。" - }, - "client_attrs_init_set_as_attr": { - "label": "属性" - }, - "client_attrs_init_expression": { - "label": "属性表达式", - "desc": "一个行表达式，用于从客户端现有信息中动态提取属性值，可以使用以下字段：
- `clientid`：客户端 ID
- `username`：用户名
- `cn`：TLS 证书的 CN 字段
- `dn`：TLS 证书的 DN 字段
- `user_property.*`：从 MQTT CONNECT 数据包的 `User-Property` 中提取属性值，例如 `user_property.foo`
支持使用预定义的字符串函数对信息进行动态处理。例如，要提取由点分隔的客户端 ID 的前缀：`nth(1, tokens(clientid, '.'))`；要截取用户名部分信息：`substr(username, 0, 5)`。您可以在 EMQX 文档中了解有关 variform 表达式的更多信息。
" - }, - "mqtt_keepalive_check_interval": { - "label": "保活检查间隔", - "desc": "检查传入 MQTT 数据包的频率决定了服务器检查新 MQTT 数据包的频率。
如果客户端在一定时间内没有发送任何数据包，这段时间将会累积。
一旦累积时间超过 `keepalive-interval * keepalive-multiplier`，连接将会被终止。
默认值设置为 30 秒，最小值为 1 秒，最大值为 `keepalive-interval / 2`。" - }, - "mqtt_shared_subscription_initial_sticky_pick": { - "label": "共享订阅初始 Sticky 选择策略", - "desc": "当`共享订阅策略`设置为 `sticky` 时，用于初始订阅者选择的策略：
- `random`：随机选择订阅者；
- `local`：随机选择当前节点上的订阅者，如果当前节点上没有订阅者，则在集群内随机选择；
- `hash_clientid`：通过对发布者的客户端ID进行哈希来选择订阅者；
- `hash_topic`：通过对发布主题进行哈希来选择订阅者。" - } - } -} \ No newline at end of file diff --git a/src/schemaText/schema-text-zh.ts b/src/schemaText/schema-text-zh.ts new file mode 100644 index 000000000..ad294f39e --- /dev/null +++ b/src/schemaText/schema-text-zh.ts @@ -0,0 +1,268 @@ +export default { + /* MQTT START */ + exclusive_subscription: { + label: '允许排它订阅', + }, + max_topic_alias: { + label: '最大主题别名数', + }, + use_username_as_clientid: { + desc: '是否使用用户名作为客户端 ID。 作用时间晚于
- `random`：随机选择订阅者；
- `local`：随机选择当前节点上的订阅者，如果当前节点上没有订阅者，则在集群内随机选择；
- `hash_clientid`：通过对发布者的客户端ID进行哈希来选择订阅者；
- `hash_topic`：通过对发布主题进行哈希来选择订阅者。', + }, + peer_cert_as_username: { + desc: '使用对端证书中的 CN、DN 字段或整个证书内容来作为用户名；仅适用于 TLS 连接。\n目前支持：\n-
每个客户端属性可以初始化为 `client_attrs.{'{'}NAME{'}'}`，
其中 `{'{'}NAME{'}'}` 是配置字段 `set_as_attr` 中指定的属性名称。
初始化的客户端属性将存储在带有指定名称的 `client_attrs` 属性中，
并可用作渲染挂载点、身份验证和授权请求的模板变量。
例如，当 `set_as_attr = tns` 时，使用 `${'{'}client_attrs.tns{'}'}` 渲染 HTTP POST 正文，
或渲染监听器配置 `moutpoint = ${'{'}client_attrs.tns{'}'}/` 用于主题命名空间。", + }, + client_attrs_init_set_as_attr: { + label: '属性', + }, + client_attrs_init_expression: { + label: '属性表达式', + desc: "使用行表达式计算一组预定义的字符串函数（类似于规则引擎 SQL 语句）。
表达式可以是带有嵌套调用参数的函数调用，或直接引用变量。
目前不提供用户自定义变量绑定（如 `var a=1`）或用户自定义函数。
例如，要提取以点分隔的客户端 ID 前缀：`nth(1, tokens(clientid, '.'))`。
预绑定的变量有：
- `clientid`：MQTT 客户端 ID。
- `username`：MQTT 客户端的用户名。
- `user_property.{'{'}NAME{'}'}`：CONNECT 数据包中的用户属性。
对于 TLS 客户端，直接连接或通过支持代理协议（v2）的负载均衡器连接，
可以使用一些额外的变量：
- `cn`：客户端 TLS 证书的通用名称。
- `dn`：客户端 TLS 证书的可分辨名称（主题）。
- `peersni`：客户端发送的 TLS 服务器名称指示。
您可以在 EMQX 文档中阅读更多关于 variform 表达式的信息。", + }, + clientid_override: { + label: '客户端 ID 重写表达式', + desc: "使用行表达式计算一组预定义的字符串函数（类似于规则引擎 SQL 语句）。
表达式可以是带有嵌套调用参数的函数调用，或直接引用变量。
目前不提供用户自定义变量绑定（如 `var a=1`）或用户自定义函数。
例如，要提取以点分隔的客户端 ID 前缀：`nth(1, tokens(username, '.'))`。
预绑定的变量有：
- `clientid`：原始 MQTT 客户端 ID。
- `username`：MQTT 客户端的用户名。
- `client_attrs.{'{'}NAME{'}'}`：通过每个配置的 `client_attrs_init` 初始化的客户端属性。
对于 TLS 客户端，直接连接或通过支持代理协议（v2）的负载均衡器连接，
可以使用一些额外的变量：
- `cn`：客户端 TLS 证书的通用名称。
- `dn`：客户端 TLS 证书的可分辨名称（主题）。
- `peersni`：客户端发送的 TLS 服务器名称指示。
您可以在 EMQX 文档中阅读更多关于 variform 表达式的信息。", + }, + retain_available: { + desc: '是否启用对 MQTT 保留消息的支持。禁用此选项时，客户端将无法发布保留消息。', + label: '启用保留消息', + }, + message_expiry_interval: { + desc: 'MQTT 消息的过期时间间隔。对于 MQTT 5.0 版本的客户端，此设置仅在消息未指定 Message-Expiry-Interval 属性时才会生效。对于 MQTT 3.1 和 3.1.1 版本，此设置始终适用。值得注意的是，将此值设定为大于会话过期间隔是无效的，因为一旦会话过期，所有相关消息都将被清除。', + label: '消息过期间隔', + }, + ignore_loop_deliver: { + desc: '设置由 MQTT v3.1.1/v3.1.0 客户端发布的消息是否将转发给其本身；类似 MQTT 5.0 协议中的 `No Local` 选项。', + label: '忽略循环投递', + }, + max_qos_allowed: { + label: '最大 QoS', + }, + max_topic_levels: { + label: '最大主题层级', + }, + peer_cert_as_clientid: { + desc: '使用对端证书中的 CN、DN 字段或整个证书内容来作为客户端 ID。仅适用于 TLS 连接；\n目前支持：\n-
- `random`：将消息分配给随机选择的订阅者。
- `round_robin`：以循环方式选择订阅者。
- `round_robin_per_group`：在每个共享订阅组内以循环方式选择订阅者。
- `sticky`：始终使用最后选择的订阅者进行调度，直到订阅者断开连接。
- `local`：如果本地订阅者不存在，则选择随机本地订阅者，否则选择随机集群广域订阅者。
- `hash_topic`：通过主题源的哈希值选择订阅者。
- `hash_clientid`：通过对发送者的客户端 ID 进行 Hash 处理来选择订阅者。', + }, + keepalive_check_interval: { + label: '保活检查间隔', + desc: '检查传入 MQTT 数据包的频率决定了服务器检查新 MQTT 数据包的频率。
如果客户端在一定时间内没有发送任何数据包，这段时间将会累积。
一旦累积时间超过 `keepalive-interval * keepalive-multiplier`，连接将会被终止。
默认值设置为 30 秒，最小值为 1 秒，最大值为 `keepalive-interval / 2`。', + }, + max_packet_size: { + desc: '允许的最大 MQTT 报文大小，超出此大小后将断开当前客户端连接。', + label: '最大报文大小', + }, + max_conn_rate: { + desc: '用于限制单节点接受连接的速率，达到限制后，EMQX 将暂停从接受队列中获取连接，延迟或拒绝新的连接；为空时表示不限制。\n\n例如：\n\n- `1000/s` 表示每秒最多接受 1000 个连接。\n- `1000/10s` 表示每 10 秒最多接受 1000 个连接。', + label: '最大连接速率', + }, + max_conn_burst: { + desc: '在突发情况下单节点可以接受的最大连接数量；为空时表示不限制。\n\n例如：`10000/60m` 表示在 60 分钟内，允许接受最多 10000 个连接。', + label: '最大连接突发速率', + }, + messages_rate: { + desc: '用于限制单个客户端每秒可以发送给 EMQX 的消息数量，达到限制后，EMQX 将暂停从接收缓冲区读取数据，降低发送者的速度或暂时挂起发送者；为空时表示不限制。\n\n例如：\n\n- `500/s`：每秒最多接收 500 条消息，其余消息将被延迟。\n- `500/10s`：每 10 秒最多接收 500 条消息，其余消息将被延迟。', + label: '消息发布速率', + }, + messages_burst: { + desc: '在突发情况下单个客户端可以发送的最大消息数量；为空时表示不限制。\n\n例如：`10000/60m` 表示在 60 分钟内，允许发送最多 10000 条消息。', + label: '消息发布突发速率', + }, + bytes_rate: { + desc: '用于限制单个客户端每秒可发送给 EMQX 的字节数，达到限制后，EMQX 将暂停从接收缓冲区读取数据，降低发送者的速度或暂时挂起发送者；为空时表示不限制。\n\n字节的单位可以是：B、KB、MB、GB。\n\n例如：\n\n- `500KB/s`：每秒最多接收 500 千字节，其余字节将被延迟。\n- `500MB/10s`：每 10 秒最多接收 500 兆字节，其余字节将被延迟。', + label: '数据发布速率', + }, + bytes_burst: { + desc: '在突发情况下单个客户端允许发送的最大字节数；为空时表示不限制。\n\n例如：`100MB/60m` 表示在 60 分钟内，允许发送最多 100 兆字节的数据。', + label: '数据发布突发速率', + }, + /* MQTT END */ + /* SESSION START */ + max_subscriptions: { + desc: '允许每个客户端建立的最大订阅数量。', + label: '最大订阅数量', + }, + upgrade_qos: { + desc: '投递消息时，是否根据订阅主题时的 QoS 等级来强制提升派发消息的 QoS 等级。', + label: '升级 QoS', + }, + max_inflight: { + desc: '完成应答前，最多允许同时投递的 QoS 1 和 QoS 2 消息数量。', + label: '最大飞行窗口', + }, + retry_interval: { + desc: 'QoS 1/2 消息的重新投递间隔。', + label: '消息重试间隔', + }, + max_awaiting_rel: { + desc: '为每个会话指定未收到 PUBREL 且未超时的最大 QoS 2 消息数量。超过限制后，新的 QoS 2 消息发布会被拒绝，并返回 147(0x93) 错误。', + label: '最大待发 PUBREL 数量', + }, + await_rel_timeout: { + desc: '对于未收到 PUBREL 的 QoS 2 消息，将按照指定时间等待重传；超时后 EMQX 将释放 packet ID 并产生一条告警日志。\n注意：EMQX 对消息的转发操作不依赖于 PUBREL收到与否。', + label: '最大 PUBREL 等待时长', + }, + session_expiry_interval: { + desc: '指定会话将在连接断开后多久过期，仅适用于非 MQTT 5.0 的连接。', + label: '会话过期间隔', + }, + max_mqueue_len: { + desc: '最大消息队列长度。持久客户端断开连接或飞行窗口已满时，允许排队的的最大消息数量。', + label: '最大消息队列长度', + }, + mqueue_priorities: { + desc: "主题优先级。优先级数字[1-255]。默认情况下没有优先级表，因此所有消息都被平等对待。
注意：优先级主题名称中不允许使用逗号和等号。
注意：不在优先级表中的主题的消息将根据 mqtt.mqueue_default_priority 的配置值被视为最高优先级或最低优先级。
示例：
要配置 'topic/1' > 'topic/2'：
mqueue_priorities: {'{'}\"topic/1\": 10, \"topic/2\": 8{'}'}", + label: '主题优先级', + }, + mqueue_default_priority: { + desc: '默认的主题优先级，不在
-
-
-
支持的事件如下：
- authorization_permission_denied
- cannot_publish_to_topic_due_to_not_authorized
- cannot_publish_to_topic_due_to_quota_exceeded
- connection_rejected_due_to_license_limit_reached
- dropped_msg_due_to_mqueue_is_full', + label: '时间窗口', + }, + /* LOG END */ + /* ALARM START */ + cpu_check_interval: { + desc: '定期 CPU 检查的时间间隔。', + label: '定期 CPU 检查的时间间隔', + }, + cpu_high_watermark: { + desc: '在发出相应警报之前可以使用多少系统 CPU 的阈值，以系统CPU负载的百分比表示。', + label: 'CPU 高水位线', + }, + cpu_low_watermark: { + desc: '在解除相应警报之前可以使用多少系统 CPU 的阈值，以系统CPU负载的百分比表示。', + label: 'CPU 低水位线', + }, + mem_check_interval: { + desc: '定期内存检查的时间间隔。', + label: '内存检查间隔', + }, + procmem_high_watermark: { + desc: '在发出相应警报之前，一个Erlang进程可以分配多少系统内存的阈值，以系统内存的百分比表示。', + label: '进程内存高水位线', + }, + sysmem_high_watermark: { + desc: '在发出相应报警之前可以分配多少系统内存的阈值，以系统内存的百分比表示。', + label: '系统内存高水位线', + }, + busy_dist_port: { + desc: '启用后，当用于集群接点之间 RPC 的连接过忙时，会触发一条带有
+ retain?: boolean | 'all'
+ clientid_re?: string
+ username_re?: string
+ ipaddr?: string
}
export interface BuiltInDBItem {
diff --git a/src/types/config.d.ts b/src/types/config.d.ts
index 70f320fbf..b77853ef5 100644
--- a/src/types/config.d.ts
+++ b/src/types/config.d.ts
@@ -1,4 +1,4 @@
-import { ComponentPublicInstance } from 'vue'
+import { EmqxForceShutdown } from './schemas/configs.schemas'
export interface SubTabComponent extends ComponentPublicInstance {
index: number
@@ -80,23 +80,14 @@ export interface ConsoleHandler {
enable: boolean
level: string
time_offset: string
- chars_limit: string
formatter: string
- single_line: boolean
- sync_mode_qlen: number
- drop_mode_qlen: number
- flush_qlen: number
overload_kill: OverloadKill
burst_limit: BurstLimit
- supervisor_reports: string
- max_depth: number
}
export interface OverloadKill {
enable: boolean
- mem_size: string
qlen: number
- restart_after: string
}
export interface BurstLimit {
@@ -115,16 +106,9 @@ export interface Name {
max_size: string
level: string
time_offset: string
- chars_limit: string
formatter: string
- single_line: boolean
- sync_mode_qlen: number
- drop_mode_qlen: number
- flush_qlen: number
overload_kill: OverloadKill2
burst_limit: BurstLimit2
- supervisor_reports: string
- max_depth: number
}
export interface Rotation {
@@ -134,9 +118,7 @@ export interface Rotation {
export interface OverloadKill2 {
enable: boolean
- mem_size: string
qlen: number
- restart_after: string
}
export interface BurstLimit2 {
@@ -189,7 +171,7 @@ export interface Zone {
mqtt: Mqtt
stats: Stats
flapping_detect: FlappingDetect
- force_shutdown: ForceShutdown
+ force_shutdown: EmqxForceShutdown
conn_congestion: ConnCongestion
force_gc: ForceGc
overload_protection: OverloadProtection
@@ -238,12 +220,6 @@ export interface FlappingDetect {
ban_time: string
}
-export interface ForceShutdown {
- enable: boolean
- max_message_queue_len: number
- max_heap_size: string
-}
-
export interface ConnCongestion {
enable_alarm: boolean
min_alarm_sustain_duration: string
diff --git a/src/types/enum.ts b/src/types/enum.ts
index cbcef4fe5..477bd4a05 100644
--- a/src/types/enum.ts
+++ b/src/types/enum.ts
@@ -280,6 +280,7 @@ export enum PropType {
Boolean = 'boolean',
Duration = 'duration',
Number = 'number',
+ Integer = 'integer',
IPPort = 'ip_port',
ByteSize = 'byteSize',
Object = 'object',
diff --git a/src/types/extension.d.ts b/src/types/extension.d.ts
index 68ca42661..064bf0af8 100644
--- a/src/types/extension.d.ts
+++ b/src/types/extension.d.ts
@@ -12,13 +12,13 @@ export interface SysTopics {
}
export interface Retainer {
- enable: boolean
max_payload_size: string
msg_expiry_interval: string
msg_expiry_interval_override: string
allow_never_expire: boolean
msg_clear_interval: string
delivery_rate: string
+ max_publish_rate: string
backend: {
type: string
storage_type: string
diff --git a/src/types/schemas/actions.schemas.ts b/src/types/schemas/actions.schemas.ts
index f58a44be3..88b952af7 100644
--- a/src/types/schemas/actions.schemas.ts
+++ b/src/types/schemas/actions.schemas.ts
@@ -1,5 +1,5 @@
export type PostNodesNodeActionsIdOperation503Code =
- typeof PostNodesNodeActionsIdOperation503Code[keyof typeof PostNodesNodeActionsIdOperation503Code]
+ (typeof PostNodesNodeActionsIdOperation503Code)[keyof typeof PostNodesNodeActionsIdOperation503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostNodesNodeActionsIdOperation503Code = {
@@ -12,7 +12,7 @@ export type PostNodesNodeActionsIdOperation503 = {
}
export type PostNodesNodeActionsIdOperation501Code =
- typeof PostNodesNodeActionsIdOperation501Code[keyof typeof PostNodesNodeActionsIdOperation501Code]
+ (typeof PostNodesNodeActionsIdOperation501Code)[keyof typeof PostNodesNodeActionsIdOperation501Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostNodesNodeActionsIdOperation501Code = {
@@ -25,7 +25,7 @@ export type PostNodesNodeActionsIdOperation501 = {
}
export type PostNodesNodeActionsIdOperation404Code =
- typeof PostNodesNodeActionsIdOperation404Code[keyof typeof PostNodesNodeActionsIdOperation404Code]
+ (typeof PostNodesNodeActionsIdOperation404Code)[keyof typeof PostNodesNodeActionsIdOperation404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostNodesNodeActionsIdOperation404Code = {
@@ -38,7 +38,7 @@ export type PostNodesNodeActionsIdOperation404 = {
}
export type PostNodesNodeActionsIdOperation400Code =
- typeof PostNodesNodeActionsIdOperation400Code[keyof typeof PostNodesNodeActionsIdOperation400Code]
+ (typeof PostNodesNodeActionsIdOperation400Code)[keyof typeof PostNodesNodeActionsIdOperation400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostNodesNodeActionsIdOperation400Code = {
@@ -51,7 +51,7 @@ export type PostNodesNodeActionsIdOperation400 = {
}
export type GetActionsIdMetrics404Code =
- typeof GetActionsIdMetrics404Code[keyof typeof GetActionsIdMetrics404Code]
+ (typeof GetActionsIdMetrics404Code)[keyof typeof GetActionsIdMetrics404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetActionsIdMetrics404Code = {
@@ -69,7 +69,7 @@ export type GetActionsIdMetrics200 = {
}
export type DeleteActionsId503Code =
- typeof DeleteActionsId503Code[keyof typeof DeleteActionsId503Code]
+ (typeof DeleteActionsId503Code)[keyof typeof DeleteActionsId503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteActionsId503Code = {
@@ -82,7 +82,7 @@ export type DeleteActionsId503 = {
}
export type DeleteActionsId404Code =
- typeof DeleteActionsId404Code[keyof typeof DeleteActionsId404Code]
+ (typeof DeleteActionsId404Code)[keyof typeof DeleteActionsId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteActionsId404Code = {
@@ -95,7 +95,7 @@ export type DeleteActionsId404 = {
}
export type DeleteActionsId400Code =
- typeof DeleteActionsId400Code[keyof typeof DeleteActionsId400Code]
+ (typeof DeleteActionsId400Code)[keyof typeof DeleteActionsId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteActionsId400Code = {
@@ -112,7 +112,7 @@ export type DeleteActionsIdParams = {
also_delete_dep_actions?: boolean
}
-export type PutActionsId503Code = typeof PutActionsId503Code[keyof typeof PutActionsId503Code]
+export type PutActionsId503Code = (typeof PutActionsId503Code)[keyof typeof PutActionsId503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutActionsId503Code = {
@@ -124,7 +124,7 @@ export type PutActionsId503 = {
message?: string
}
-export type PutActionsId404Code = typeof PutActionsId404Code[keyof typeof PutActionsId404Code]
+export type PutActionsId404Code = (typeof PutActionsId404Code)[keyof typeof PutActionsId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutActionsId404Code = {
@@ -136,7 +136,7 @@ export type PutActionsId404 = {
message?: string
}
-export type PutActionsId400Code = typeof PutActionsId400Code[keyof typeof PutActionsId400Code]
+export type PutActionsId400Code = (typeof PutActionsId400Code)[keyof typeof PutActionsId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutActionsId400Code = {
@@ -152,7 +152,7 @@ export type PutActionsId200 = BridgeMqttPublisherGetBridgeV2 | BridgeHttpGetBrid
export type PutActionsIdBody = BridgeMqttPublisherPutBridgeV2 | BridgeHttpPutBridgeV2
-export type GetActionsId404Code = typeof GetActionsId404Code[keyof typeof GetActionsId404Code]
+export type GetActionsId404Code = (typeof GetActionsId404Code)[keyof typeof GetActionsId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetActionsId404Code = {
@@ -166,7 +166,8 @@ export type GetActionsId404 = {
export type GetActionsId200 = BridgeMqttPublisherGetBridgeV2 | BridgeHttpGetBridgeV2
-export type GetActionTypes200Item = typeof GetActionTypes200Item[keyof typeof GetActionTypes200Item]
+export type GetActionTypes200Item =
+ (typeof GetActionTypes200Item)[keyof typeof GetActionTypes200Item]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetActionTypes200Item = {
@@ -175,7 +176,7 @@ export const GetActionTypes200Item = {
} as const
export type PostActionsProbe400Code =
- typeof PostActionsProbe400Code[keyof typeof PostActionsProbe400Code]
+ (typeof PostActionsProbe400Code)[keyof typeof PostActionsProbe400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostActionsProbe400Code = {
@@ -189,7 +190,7 @@ export type PostActionsProbe400 = {
export type PostActionsProbeBody = BridgeMqttPublisherPostBridgeV2 | BridgeHttpPostBridgeV2
-export type PostActions400Code = typeof PostActions400Code[keyof typeof PostActions400Code]
+export type PostActions400Code = (typeof PostActions400Code)[keyof typeof PostActions400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostActions400Code = {
@@ -208,7 +209,7 @@ export type PostActionsBody = BridgeMqttPublisherPostBridgeV2 | BridgeHttpPostBr
export type GetActions200Item = BridgeMqttPublisherGetBridgeV2 | BridgeHttpGetBridgeV2
export type PutActionsIdEnableEnable503Code =
- typeof PutActionsIdEnableEnable503Code[keyof typeof PutActionsIdEnableEnable503Code]
+ (typeof PutActionsIdEnableEnable503Code)[keyof typeof PutActionsIdEnableEnable503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutActionsIdEnableEnable503Code = {
@@ -221,7 +222,7 @@ export type PutActionsIdEnableEnable503 = {
}
export type PutActionsIdEnableEnable404Code =
- typeof PutActionsIdEnableEnable404Code[keyof typeof PutActionsIdEnableEnable404Code]
+ (typeof PutActionsIdEnableEnable404Code)[keyof typeof PutActionsIdEnableEnable404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutActionsIdEnableEnable404Code = {
@@ -234,7 +235,7 @@ export type PutActionsIdEnableEnable404 = {
}
export type PostActionsIdOperation503Code =
- typeof PostActionsIdOperation503Code[keyof typeof PostActionsIdOperation503Code]
+ (typeof PostActionsIdOperation503Code)[keyof typeof PostActionsIdOperation503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostActionsIdOperation503Code = {
@@ -247,7 +248,7 @@ export type PostActionsIdOperation503 = {
}
export type PostActionsIdOperation501Code =
- typeof PostActionsIdOperation501Code[keyof typeof PostActionsIdOperation501Code]
+ (typeof PostActionsIdOperation501Code)[keyof typeof PostActionsIdOperation501Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostActionsIdOperation501Code = {
@@ -260,7 +261,7 @@ export type PostActionsIdOperation501 = {
}
export type PostActionsIdOperation404Code =
- typeof PostActionsIdOperation404Code[keyof typeof PostActionsIdOperation404Code]
+ (typeof PostActionsIdOperation404Code)[keyof typeof PostActionsIdOperation404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostActionsIdOperation404Code = {
@@ -273,7 +274,7 @@ export type PostActionsIdOperation404 = {
}
export type PostActionsIdOperation400Code =
- typeof PostActionsIdOperation400Code[keyof typeof PostActionsIdOperation400Code]
+ (typeof PostActionsIdOperation400Code)[keyof typeof PostActionsIdOperation400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostActionsIdOperation400Code = {
@@ -286,7 +287,7 @@ export type PostActionsIdOperation400 = {
}
export type PutActionsIdMetricsReset404Code =
- typeof PutActionsIdMetricsReset404Code[keyof typeof PutActionsIdMetricsReset404Code]
+ (typeof PutActionsIdMetricsReset404Code)[keyof typeof PutActionsIdMetricsReset404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutActionsIdMetricsReset404Code = {
@@ -299,7 +300,7 @@ export type PutActionsIdMetricsReset404 = {
}
export type BridgeNodeStatusStatus =
- typeof BridgeNodeStatusStatus[keyof typeof BridgeNodeStatusStatus]
+ (typeof BridgeNodeStatusStatus)[keyof typeof BridgeNodeStatusStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeNodeStatusStatus = {
@@ -338,38 +339,16 @@ export interface BridgeNodeMetrics {
metrics?: BridgeMetrics
}
-export interface BridgeMqttPublisherPutBridgeV2 {
- local_topic?: string
- parameters: BridgeMqttPublisherActionParameters
- enable?: boolean
- connector: string
- tags?: string[]
- description?: string
- resource_opts?: BridgeMqttPublisherActionResourceOpts
-}
-
export type BridgeMqttPublisherPostBridgeV2Type =
- typeof BridgeMqttPublisherPostBridgeV2Type[keyof typeof BridgeMqttPublisherPostBridgeV2Type]
+ (typeof BridgeMqttPublisherPostBridgeV2Type)[keyof typeof BridgeMqttPublisherPostBridgeV2Type]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeMqttPublisherPostBridgeV2Type = {
mqtt: 'mqtt',
} as const
-export interface BridgeMqttPublisherPostBridgeV2 {
- type: BridgeMqttPublisherPostBridgeV2Type
- name: string
- local_topic?: string
- parameters: BridgeMqttPublisherActionParameters
- enable?: boolean
- connector: string
- tags?: string[]
- description?: string
- resource_opts?: BridgeMqttPublisherActionResourceOpts
-}
-
export type BridgeMqttPublisherGetBridgeV2Status =
- typeof BridgeMqttPublisherGetBridgeV2Status[keyof typeof BridgeMqttPublisherGetBridgeV2Status]
+ (typeof BridgeMqttPublisherGetBridgeV2Status)[keyof typeof BridgeMqttPublisherGetBridgeV2Status]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeMqttPublisherGetBridgeV2Status = {
@@ -380,7 +359,7 @@ export const BridgeMqttPublisherGetBridgeV2Status = {
} as const
export type BridgeMqttPublisherGetBridgeV2Type =
- typeof BridgeMqttPublisherGetBridgeV2Type[keyof typeof BridgeMqttPublisherGetBridgeV2Type]
+ (typeof BridgeMqttPublisherGetBridgeV2Type)[keyof typeof BridgeMqttPublisherGetBridgeV2Type]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeMqttPublisherGetBridgeV2Type = {
@@ -405,7 +384,7 @@ export interface BridgeMqttPublisherGetBridgeV2 {
export type BridgeMqttPublisherActionResourceOptsRequestTtl = 'infinity' | string
export type BridgeMqttPublisherActionResourceOptsQueryMode =
- typeof BridgeMqttPublisherActionResourceOptsQueryMode[keyof typeof BridgeMqttPublisherActionResourceOptsQueryMode]
+ (typeof BridgeMqttPublisherActionResourceOptsQueryMode)[keyof typeof BridgeMqttPublisherActionResourceOptsQueryMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeMqttPublisherActionResourceOptsQueryMode = {
@@ -433,38 +412,40 @@ export interface BridgeMqttPublisherActionParameters {
payload?: string
}
-export interface BridgeHttpPutBridgeV2 {
+export interface BridgeMqttPublisherPutBridgeV2 {
+ local_topic?: string
+ parameters: BridgeMqttPublisherActionParameters
enable?: boolean
connector: string
tags?: string[]
description?: string
- parameters: BridgeHttpParametersOpts
- resource_opts?: BridgeHttpActionResourceOpts
+ resource_opts?: BridgeMqttPublisherActionResourceOpts
}
-export type BridgeHttpPostBridgeV2Type =
- typeof BridgeHttpPostBridgeV2Type[keyof typeof BridgeHttpPostBridgeV2Type]
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const BridgeHttpPostBridgeV2Type = {
- http: 'http',
-} as const
-
-export interface BridgeHttpPostBridgeV2 {
- type: BridgeHttpPostBridgeV2Type
+export interface BridgeMqttPublisherPostBridgeV2 {
+ type: BridgeMqttPublisherPostBridgeV2Type
name: string
+ local_topic?: string
+ parameters: BridgeMqttPublisherActionParameters
enable?: boolean
connector: string
tags?: string[]
description?: string
- parameters: BridgeHttpParametersOpts
- resource_opts?: BridgeHttpActionResourceOpts
+ resource_opts?: BridgeMqttPublisherActionResourceOpts
}
+export type BridgeHttpPostBridgeV2Type =
+ (typeof BridgeHttpPostBridgeV2Type)[keyof typeof BridgeHttpPostBridgeV2Type]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const BridgeHttpPostBridgeV2Type = {
+ http: 'http',
+} as const
+
export type BridgeHttpParametersOptsHeaders = { [key: string]: any }
export type BridgeHttpParametersOptsMethod =
- typeof BridgeHttpParametersOptsMethod[keyof typeof BridgeHttpParametersOptsMethod]
+ (typeof BridgeHttpParametersOptsMethod)[keyof typeof BridgeHttpParametersOptsMethod]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeHttpParametersOptsMethod = {
@@ -484,8 +465,28 @@ export interface BridgeHttpParametersOpts {
request_timeout?: string
}
+export interface BridgeHttpPutBridgeV2 {
+ enable?: boolean
+ connector: string
+ tags?: string[]
+ description?: string
+ parameters: BridgeHttpParametersOpts
+ resource_opts?: BridgeHttpActionResourceOpts
+}
+
+export interface BridgeHttpPostBridgeV2 {
+ type: BridgeHttpPostBridgeV2Type
+ name: string
+ enable?: boolean
+ connector: string
+ tags?: string[]
+ description?: string
+ parameters: BridgeHttpParametersOpts
+ resource_opts?: BridgeHttpActionResourceOpts
+}
+
export type BridgeHttpGetBridgeV2Type =
- typeof BridgeHttpGetBridgeV2Type[keyof typeof BridgeHttpGetBridgeV2Type]
+ (typeof BridgeHttpGetBridgeV2Type)[keyof typeof BridgeHttpGetBridgeV2Type]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeHttpGetBridgeV2Type = {
@@ -493,7 +494,7 @@ export const BridgeHttpGetBridgeV2Type = {
} as const
export type BridgeHttpGetBridgeV2Status =
- typeof BridgeHttpGetBridgeV2Status[keyof typeof BridgeHttpGetBridgeV2Status]
+ (typeof BridgeHttpGetBridgeV2Status)[keyof typeof BridgeHttpGetBridgeV2Status]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeHttpGetBridgeV2Status = {
@@ -520,7 +521,7 @@ export interface BridgeHttpGetBridgeV2 {
export type BridgeHttpActionResourceOptsRequestTtl = 'infinity' | string
export type BridgeHttpActionResourceOptsQueryMode =
- typeof BridgeHttpActionResourceOptsQueryMode[keyof typeof BridgeHttpActionResourceOptsQueryMode]
+ (typeof BridgeHttpActionResourceOptsQueryMode)[keyof typeof BridgeHttpActionResourceOptsQueryMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeHttpActionResourceOptsQueryMode = {
@@ -536,3 +537,22 @@ export interface BridgeHttpActionResourceOpts {
inflight_window?: number
max_buffer_bytes?: string
}
+
+export interface ActionsAndSourcesResponseNodeStatus {
+ node?: string
+ status?: string
+ status_reason?: string
+}
+
+export interface ActionsAndSourcesResponseSummary {
+ enable?: boolean
+ name?: string
+ type?: string
+ description?: string
+ created_at?: number
+ last_modified_at?: number
+ node_status?: ActionsAndSourcesResponseNodeStatus[]
+ rules?: string[]
+ status?: string
+ status_reason?: string
+}
diff --git a/src/types/schemas/authorization.schemas.ts b/src/types/schemas/authorization.schemas.ts
index a54f50d96..83e3dfb0c 100644
--- a/src/types/schemas/authorization.schemas.ts
+++ b/src/types/schemas/authorization.schemas.ts
@@ -1,5 +1,5 @@
export type PostAuthorizationSourcesBuiltInDatabaseRulesAll400Code =
- typeof PostAuthorizationSourcesBuiltInDatabaseRulesAll400Code[keyof typeof PostAuthorizationSourcesBuiltInDatabaseRulesAll400Code]
+ (typeof PostAuthorizationSourcesBuiltInDatabaseRulesAll400Code)[keyof typeof PostAuthorizationSourcesBuiltInDatabaseRulesAll400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostAuthorizationSourcesBuiltInDatabaseRulesAll400Code = {
@@ -12,7 +12,7 @@ export type PostAuthorizationSourcesBuiltInDatabaseRulesAll400 = {
}
export type PutAuthorizationSettings400Code =
- typeof PutAuthorizationSettings400Code[keyof typeof PutAuthorizationSettings400Code]
+ (typeof PutAuthorizationSettings400Code)[keyof typeof PutAuthorizationSettings400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSettings400Code = {
@@ -25,7 +25,7 @@ export type PutAuthorizationSettings400 = {
}
export type PutAuthorizationSettings200DenyAction =
- typeof PutAuthorizationSettings200DenyAction[keyof typeof PutAuthorizationSettings200DenyAction]
+ (typeof PutAuthorizationSettings200DenyAction)[keyof typeof PutAuthorizationSettings200DenyAction]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSettings200DenyAction = {
@@ -34,7 +34,7 @@ export const PutAuthorizationSettings200DenyAction = {
} as const
export type PutAuthorizationSettings200NoMatch =
- typeof PutAuthorizationSettings200NoMatch[keyof typeof PutAuthorizationSettings200NoMatch]
+ (typeof PutAuthorizationSettings200NoMatch)[keyof typeof PutAuthorizationSettings200NoMatch]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSettings200NoMatch = {
@@ -49,7 +49,7 @@ export type PutAuthorizationSettings200 = {
}
export type PutAuthorizationSettingsBodyDenyAction =
- typeof PutAuthorizationSettingsBodyDenyAction[keyof typeof PutAuthorizationSettingsBodyDenyAction]
+ (typeof PutAuthorizationSettingsBodyDenyAction)[keyof typeof PutAuthorizationSettingsBodyDenyAction]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSettingsBodyDenyAction = {
@@ -58,7 +58,7 @@ export const PutAuthorizationSettingsBodyDenyAction = {
} as const
export type PutAuthorizationSettingsBodyNoMatch =
- typeof PutAuthorizationSettingsBodyNoMatch[keyof typeof PutAuthorizationSettingsBodyNoMatch]
+ (typeof PutAuthorizationSettingsBodyNoMatch)[keyof typeof PutAuthorizationSettingsBodyNoMatch]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSettingsBodyNoMatch = {
@@ -73,7 +73,7 @@ export type PutAuthorizationSettingsBody = {
}
export type GetAuthorizationSettings200DenyAction =
- typeof GetAuthorizationSettings200DenyAction[keyof typeof GetAuthorizationSettings200DenyAction]
+ (typeof GetAuthorizationSettings200DenyAction)[keyof typeof GetAuthorizationSettings200DenyAction]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetAuthorizationSettings200DenyAction = {
@@ -82,7 +82,7 @@ export const GetAuthorizationSettings200DenyAction = {
} as const
export type GetAuthorizationSettings200NoMatch =
- typeof GetAuthorizationSettings200NoMatch[keyof typeof GetAuthorizationSettings200NoMatch]
+ (typeof GetAuthorizationSettings200NoMatch)[keyof typeof GetAuthorizationSettings200NoMatch]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetAuthorizationSettings200NoMatch = {
@@ -97,7 +97,7 @@ export type GetAuthorizationSettings200 = {
}
export type DeleteAuthorizationCache400Code =
- typeof DeleteAuthorizationCache400Code[keyof typeof DeleteAuthorizationCache400Code]
+ (typeof DeleteAuthorizationCache400Code)[keyof typeof DeleteAuthorizationCache400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteAuthorizationCache400Code = {
@@ -110,7 +110,7 @@ export type DeleteAuthorizationCache400 = {
}
export type PutAuthorizationSourcesOrder400Code =
- typeof PutAuthorizationSourcesOrder400Code[keyof typeof PutAuthorizationSourcesOrder400Code]
+ (typeof PutAuthorizationSourcesOrder400Code)[keyof typeof PutAuthorizationSourcesOrder400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSourcesOrder400Code = {
@@ -123,7 +123,7 @@ export type PutAuthorizationSourcesOrder400 = {
}
export type DeleteAuthorizationSourcesType400Code =
- typeof DeleteAuthorizationSourcesType400Code[keyof typeof DeleteAuthorizationSourcesType400Code]
+ (typeof DeleteAuthorizationSourcesType400Code)[keyof typeof DeleteAuthorizationSourcesType400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteAuthorizationSourcesType400Code = {
@@ -136,7 +136,7 @@ export type DeleteAuthorizationSourcesType400 = {
}
export type PutAuthorizationSourcesType400Code =
- typeof PutAuthorizationSourcesType400Code[keyof typeof PutAuthorizationSourcesType400Code]
+ (typeof PutAuthorizationSourcesType400Code)[keyof typeof PutAuthorizationSourcesType400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSourcesType400Code = {
@@ -164,7 +164,7 @@ export type PutAuthorizationSourcesTypeBody =
| AuthzApiFile
export type GetAuthorizationSourcesType404Code =
- typeof GetAuthorizationSourcesType404Code[keyof typeof GetAuthorizationSourcesType404Code]
+ (typeof GetAuthorizationSourcesType404Code)[keyof typeof GetAuthorizationSourcesType404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetAuthorizationSourcesType404Code = {
@@ -192,7 +192,7 @@ export type GetAuthorizationSourcesType200 =
| AuthzApiFile
export type PostAuthorizationSourcesTypeMove404Code =
- typeof PostAuthorizationSourcesTypeMove404Code[keyof typeof PostAuthorizationSourcesTypeMove404Code]
+ (typeof PostAuthorizationSourcesTypeMove404Code)[keyof typeof PostAuthorizationSourcesTypeMove404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostAuthorizationSourcesTypeMove404Code = {
@@ -205,7 +205,7 @@ export type PostAuthorizationSourcesTypeMove404 = {
}
export type PostAuthorizationSourcesTypeMove400Code =
- typeof PostAuthorizationSourcesTypeMove400Code[keyof typeof PostAuthorizationSourcesTypeMove400Code]
+ (typeof PostAuthorizationSourcesTypeMove400Code)[keyof typeof PostAuthorizationSourcesTypeMove400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostAuthorizationSourcesTypeMove400Code = {
@@ -218,7 +218,7 @@ export type PostAuthorizationSourcesTypeMove400 = {
}
export type DeleteAuthorizationSourcesBuiltInDatabaseRules400Code =
- typeof DeleteAuthorizationSourcesBuiltInDatabaseRules400Code[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRules400Code]
+ (typeof DeleteAuthorizationSourcesBuiltInDatabaseRules400Code)[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRules400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteAuthorizationSourcesBuiltInDatabaseRules400Code = {
@@ -231,7 +231,7 @@ export type DeleteAuthorizationSourcesBuiltInDatabaseRules400 = {
}
export type DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code =
- typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code]
+ (typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code)[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code = {
@@ -244,7 +244,7 @@ export type DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404 = {
}
export type DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code =
- typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code]
+ (typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code)[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code = {
@@ -257,7 +257,7 @@ export type DeleteAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400 = {
}
export type PutAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code =
- typeof PutAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code[keyof typeof PutAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code]
+ (typeof PutAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code)[keyof typeof PutAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400Code = {
@@ -270,7 +270,7 @@ export type PutAuthorizationSourcesBuiltInDatabaseRulesUsersUsername400 = {
}
export type GetAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code =
- typeof GetAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code[keyof typeof GetAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code]
+ (typeof GetAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code)[keyof typeof GetAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404Code = {
@@ -283,7 +283,7 @@ export type GetAuthorizationSourcesBuiltInDatabaseRulesUsersUsername404 = {
}
export type PostAuthorizationSources400Code =
- typeof PostAuthorizationSources400Code[keyof typeof PostAuthorizationSources400Code]
+ (typeof PostAuthorizationSources400Code)[keyof typeof PostAuthorizationSources400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostAuthorizationSources400Code = {
@@ -311,7 +311,7 @@ export type PostAuthorizationSourcesBody =
| AuthzApiFile
export type GetAuthorizationSourcesTypeStatus404Code =
- typeof GetAuthorizationSourcesTypeStatus404Code[keyof typeof GetAuthorizationSourcesTypeStatus404Code]
+ (typeof GetAuthorizationSourcesTypeStatus404Code)[keyof typeof GetAuthorizationSourcesTypeStatus404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetAuthorizationSourcesTypeStatus404Code = {
@@ -324,7 +324,7 @@ export type GetAuthorizationSourcesTypeStatus404 = {
}
export type GetAuthorizationSourcesTypeStatus400Code =
- typeof GetAuthorizationSourcesTypeStatus400Code[keyof typeof GetAuthorizationSourcesTypeStatus400Code]
+ (typeof GetAuthorizationSourcesTypeStatus400Code)[keyof typeof GetAuthorizationSourcesTypeStatus400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetAuthorizationSourcesTypeStatus400Code = {
@@ -337,7 +337,7 @@ export type GetAuthorizationSourcesTypeStatus400 = {
}
export type DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code =
- typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code]
+ (typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code)[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code = {
@@ -350,7 +350,7 @@ export type DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404 = {
}
export type DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code =
- typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code]
+ (typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code)[keyof typeof DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code = {
@@ -363,7 +363,7 @@ export type DeleteAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400 = {
}
export type PutAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code =
- typeof PutAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code[keyof typeof PutAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code]
+ (typeof PutAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code)[keyof typeof PutAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400Code = {
@@ -376,7 +376,7 @@ export type PutAuthorizationSourcesBuiltInDatabaseRulesClientsClientid400 = {
}
export type GetAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code =
- typeof GetAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code[keyof typeof GetAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code]
+ (typeof GetAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code)[keyof typeof GetAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404Code = {
@@ -389,7 +389,7 @@ export type GetAuthorizationSourcesBuiltInDatabaseRulesClientsClientid404 = {
}
export type PostAuthorizationSourcesBuiltInDatabaseRulesClients400Code =
- typeof PostAuthorizationSourcesBuiltInDatabaseRulesClients400Code[keyof typeof PostAuthorizationSourcesBuiltInDatabaseRulesClients400Code]
+ (typeof PostAuthorizationSourcesBuiltInDatabaseRulesClients400Code)[keyof typeof PostAuthorizationSourcesBuiltInDatabaseRulesClients400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostAuthorizationSourcesBuiltInDatabaseRulesClients400Code = {
@@ -402,7 +402,7 @@ export type PostAuthorizationSourcesBuiltInDatabaseRulesClients400 = {
}
export type PostAuthorizationSourcesBuiltInDatabaseRulesUsers409Code =
- typeof PostAuthorizationSourcesBuiltInDatabaseRulesUsers409Code[keyof typeof PostAuthorizationSourcesBuiltInDatabaseRulesUsers409Code]
+ (typeof PostAuthorizationSourcesBuiltInDatabaseRulesUsers409Code)[keyof typeof PostAuthorizationSourcesBuiltInDatabaseRulesUsers409Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostAuthorizationSourcesBuiltInDatabaseRulesUsers409Code = {
@@ -415,7 +415,7 @@ export type PostAuthorizationSourcesBuiltInDatabaseRulesUsers409 = {
}
export type PostAuthorizationSourcesBuiltInDatabaseRulesUsers400Code =
- typeof PostAuthorizationSourcesBuiltInDatabaseRulesUsers400Code[keyof typeof PostAuthorizationSourcesBuiltInDatabaseRulesUsers400Code]
+ (typeof PostAuthorizationSourcesBuiltInDatabaseRulesUsers400Code)[keyof typeof PostAuthorizationSourcesBuiltInDatabaseRulesUsers400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostAuthorizationSourcesBuiltInDatabaseRulesUsers400Code = {
@@ -465,7 +465,7 @@ export interface MongoTopology {
export type LdapSslServerNameIndication = string | 'disable'
-export type LdapSslLogLevel = typeof LdapSslLogLevel[keyof typeof LdapSslLogLevel]
+export type LdapSslLogLevel = (typeof LdapSslLogLevel)[keyof typeof LdapSslLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LdapSslLogLevel = {
@@ -481,7 +481,7 @@ export const LdapSslLogLevel = {
all: 'all',
} as const
-export type LdapSslVerify = typeof LdapSslVerify[keyof typeof LdapSslVerify]
+export type LdapSslVerify = (typeof LdapSslVerify)[keyof typeof LdapSslVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LdapSslVerify = {
@@ -511,7 +511,7 @@ export interface LdapSsl {
export type EmqxSslClientOptsServerNameIndication = string | 'disable'
export type EmqxSslClientOptsLogLevel =
- typeof EmqxSslClientOptsLogLevel[keyof typeof EmqxSslClientOptsLogLevel]
+ (typeof EmqxSslClientOptsLogLevel)[keyof typeof EmqxSslClientOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxSslClientOptsLogLevel = {
@@ -528,7 +528,7 @@ export const EmqxSslClientOptsLogLevel = {
} as const
export type EmqxSslClientOptsVerify =
- typeof EmqxSslClientOptsVerify[keyof typeof EmqxSslClientOptsVerify]
+ (typeof EmqxSslClientOptsVerify)[keyof typeof EmqxSslClientOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxSslClientOptsVerify = {
@@ -572,7 +572,7 @@ export interface EmqxAuthzSchemaResourceMetrics {
}
export type EmqxAuthzSchemaNodeStatusStatus =
- typeof EmqxAuthzSchemaNodeStatusStatus[keyof typeof EmqxAuthzSchemaNodeStatusStatus]
+ (typeof EmqxAuthzSchemaNodeStatusStatus)[keyof typeof EmqxAuthzSchemaNodeStatusStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxAuthzSchemaNodeStatusStatus = {
@@ -597,7 +597,7 @@ export interface EmqxAuthzSchemaNodeError {
}
export type EmqxAuthzSchemaMetricsStatusFieldsStatus =
- typeof EmqxAuthzSchemaMetricsStatusFieldsStatus[keyof typeof EmqxAuthzSchemaMetricsStatusFieldsStatus]
+ (typeof EmqxAuthzSchemaMetricsStatusFieldsStatus)[keyof typeof EmqxAuthzSchemaMetricsStatusFieldsStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxAuthzSchemaMetricsStatusFieldsStatus = {
@@ -653,7 +653,7 @@ export interface EmqxAuthzApiSourcesSources {
}
export type EmqxAuthzApiSourcesRequestSourcesOrderType =
- typeof EmqxAuthzApiSourcesRequestSourcesOrderType[keyof typeof EmqxAuthzApiSourcesRequestSourcesOrderType]
+ (typeof EmqxAuthzApiSourcesRequestSourcesOrderType)[keyof typeof EmqxAuthzApiSourcesRequestSourcesOrderType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxAuthzApiSourcesRequestSourcesOrderType = {
@@ -692,7 +692,7 @@ export interface EmqxAuthzApiMnesiaRules {
export type EmqxAuthzApiMnesiaRuleItemRetain = boolean | 'all'
export type EmqxAuthzApiMnesiaRuleItemAction =
- typeof EmqxAuthzApiMnesiaRuleItemAction[keyof typeof EmqxAuthzApiMnesiaRuleItemAction]
+ (typeof EmqxAuthzApiMnesiaRuleItemAction)[keyof typeof EmqxAuthzApiMnesiaRuleItemAction]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxAuthzApiMnesiaRuleItemAction = {
@@ -702,7 +702,7 @@ export const EmqxAuthzApiMnesiaRuleItemAction = {
} as const
export type EmqxAuthzApiMnesiaRuleItemPermission =
- typeof EmqxAuthzApiMnesiaRuleItemPermission[keyof typeof EmqxAuthzApiMnesiaRuleItemPermission]
+ (typeof EmqxAuthzApiMnesiaRuleItemPermission)[keyof typeof EmqxAuthzApiMnesiaRuleItemPermission]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxAuthzApiMnesiaRuleItemPermission = {
@@ -740,14 +740,14 @@ export interface ConnectorHttpRequest {
}
export type AuthzRedisSingleRedisType =
- typeof AuthzRedisSingleRedisType[keyof typeof AuthzRedisSingleRedisType]
+ (typeof AuthzRedisSingleRedisType)[keyof typeof AuthzRedisSingleRedisType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzRedisSingleRedisType = {
single: 'single',
} as const
-export type AuthzRedisSingleType = typeof AuthzRedisSingleType[keyof typeof AuthzRedisSingleType]
+export type AuthzRedisSingleType = (typeof AuthzRedisSingleType)[keyof typeof AuthzRedisSingleType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzRedisSingleType = {
@@ -770,7 +770,7 @@ export interface AuthzRedisSingle {
}
export type AuthzRedisSentinelRedisType =
- typeof AuthzRedisSentinelRedisType[keyof typeof AuthzRedisSentinelRedisType]
+ (typeof AuthzRedisSentinelRedisType)[keyof typeof AuthzRedisSentinelRedisType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzRedisSentinelRedisType = {
@@ -778,7 +778,7 @@ export const AuthzRedisSentinelRedisType = {
} as const
export type AuthzRedisSentinelType =
- typeof AuthzRedisSentinelType[keyof typeof AuthzRedisSentinelType]
+ (typeof AuthzRedisSentinelType)[keyof typeof AuthzRedisSentinelType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzRedisSentinelType = {
@@ -802,14 +802,15 @@ export interface AuthzRedisSentinel {
}
export type AuthzRedisClusterRedisType =
- typeof AuthzRedisClusterRedisType[keyof typeof AuthzRedisClusterRedisType]
+ (typeof AuthzRedisClusterRedisType)[keyof typeof AuthzRedisClusterRedisType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzRedisClusterRedisType = {
cluster: 'cluster',
} as const
-export type AuthzRedisClusterType = typeof AuthzRedisClusterType[keyof typeof AuthzRedisClusterType]
+export type AuthzRedisClusterType =
+ (typeof AuthzRedisClusterType)[keyof typeof AuthzRedisClusterType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzRedisClusterType = {
@@ -832,7 +833,7 @@ export interface AuthzRedisCluster {
export type AuthzPostgresqlPrepareStatement = { [key: string]: any }
-export type AuthzPostgresqlType = typeof AuthzPostgresqlType[keyof typeof AuthzPostgresqlType]
+export type AuthzPostgresqlType = (typeof AuthzPostgresqlType)[keyof typeof AuthzPostgresqlType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzPostgresqlType = {
@@ -857,7 +858,7 @@ export interface AuthzPostgresql {
export type AuthzMysqlPrepareStatement = { [key: string]: any }
-export type AuthzMysqlType = typeof AuthzMysqlType[keyof typeof AuthzMysqlType]
+export type AuthzMysqlType = (typeof AuthzMysqlType)[keyof typeof AuthzMysqlType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMysqlType = {
@@ -880,7 +881,7 @@ export interface AuthzMysql {
}
export type AuthzMongoSingleUseLegacyProtocol =
- typeof AuthzMongoSingleUseLegacyProtocol[keyof typeof AuthzMongoSingleUseLegacyProtocol]
+ (typeof AuthzMongoSingleUseLegacyProtocol)[keyof typeof AuthzMongoSingleUseLegacyProtocol]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoSingleUseLegacyProtocol = {
@@ -889,7 +890,8 @@ export const AuthzMongoSingleUseLegacyProtocol = {
false: 'false',
} as const
-export type AuthzMongoSingleWMode = typeof AuthzMongoSingleWMode[keyof typeof AuthzMongoSingleWMode]
+export type AuthzMongoSingleWMode =
+ (typeof AuthzMongoSingleWMode)[keyof typeof AuthzMongoSingleWMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoSingleWMode = {
@@ -898,7 +900,7 @@ export const AuthzMongoSingleWMode = {
} as const
export type AuthzMongoSingleMongoType =
- typeof AuthzMongoSingleMongoType[keyof typeof AuthzMongoSingleMongoType]
+ (typeof AuthzMongoSingleMongoType)[keyof typeof AuthzMongoSingleMongoType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoSingleMongoType = {
@@ -907,7 +909,7 @@ export const AuthzMongoSingleMongoType = {
export type AuthzMongoSingleFilter = { [key: string]: any }
-export type AuthzMongoSingleType = typeof AuthzMongoSingleType[keyof typeof AuthzMongoSingleType]
+export type AuthzMongoSingleType = (typeof AuthzMongoSingleType)[keyof typeof AuthzMongoSingleType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoSingleType = {
@@ -919,6 +921,8 @@ export interface AuthzMongoSingle {
enable?: boolean
collection: string
filter?: AuthzMongoSingleFilter
+ limit?: number
+ skip?: number
mongo_type: AuthzMongoSingleMongoType
server: string
w_mode?: AuthzMongoSingleWMode
@@ -934,7 +938,7 @@ export interface AuthzMongoSingle {
}
export type AuthzMongoShardedUseLegacyProtocol =
- typeof AuthzMongoShardedUseLegacyProtocol[keyof typeof AuthzMongoShardedUseLegacyProtocol]
+ (typeof AuthzMongoShardedUseLegacyProtocol)[keyof typeof AuthzMongoShardedUseLegacyProtocol]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoShardedUseLegacyProtocol = {
@@ -944,7 +948,7 @@ export const AuthzMongoShardedUseLegacyProtocol = {
} as const
export type AuthzMongoShardedWMode =
- typeof AuthzMongoShardedWMode[keyof typeof AuthzMongoShardedWMode]
+ (typeof AuthzMongoShardedWMode)[keyof typeof AuthzMongoShardedWMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoShardedWMode = {
@@ -953,7 +957,7 @@ export const AuthzMongoShardedWMode = {
} as const
export type AuthzMongoShardedMongoType =
- typeof AuthzMongoShardedMongoType[keyof typeof AuthzMongoShardedMongoType]
+ (typeof AuthzMongoShardedMongoType)[keyof typeof AuthzMongoShardedMongoType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoShardedMongoType = {
@@ -962,7 +966,8 @@ export const AuthzMongoShardedMongoType = {
export type AuthzMongoShardedFilter = { [key: string]: any }
-export type AuthzMongoShardedType = typeof AuthzMongoShardedType[keyof typeof AuthzMongoShardedType]
+export type AuthzMongoShardedType =
+ (typeof AuthzMongoShardedType)[keyof typeof AuthzMongoShardedType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoShardedType = {
@@ -974,6 +979,8 @@ export interface AuthzMongoSharded {
enable?: boolean
collection: string
filter?: AuthzMongoShardedFilter
+ limit?: number
+ skip?: number
mongo_type: AuthzMongoShardedMongoType
servers: string
w_mode?: AuthzMongoShardedWMode
@@ -989,7 +996,7 @@ export interface AuthzMongoSharded {
}
export type AuthzMongoRsUseLegacyProtocol =
- typeof AuthzMongoRsUseLegacyProtocol[keyof typeof AuthzMongoRsUseLegacyProtocol]
+ (typeof AuthzMongoRsUseLegacyProtocol)[keyof typeof AuthzMongoRsUseLegacyProtocol]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoRsUseLegacyProtocol = {
@@ -998,7 +1005,7 @@ export const AuthzMongoRsUseLegacyProtocol = {
false: 'false',
} as const
-export type AuthzMongoRsRMode = typeof AuthzMongoRsRMode[keyof typeof AuthzMongoRsRMode]
+export type AuthzMongoRsRMode = (typeof AuthzMongoRsRMode)[keyof typeof AuthzMongoRsRMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoRsRMode = {
@@ -1006,7 +1013,7 @@ export const AuthzMongoRsRMode = {
slave_ok: 'slave_ok',
} as const
-export type AuthzMongoRsWMode = typeof AuthzMongoRsWMode[keyof typeof AuthzMongoRsWMode]
+export type AuthzMongoRsWMode = (typeof AuthzMongoRsWMode)[keyof typeof AuthzMongoRsWMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoRsWMode = {
@@ -1014,7 +1021,8 @@ export const AuthzMongoRsWMode = {
safe: 'safe',
} as const
-export type AuthzMongoRsMongoType = typeof AuthzMongoRsMongoType[keyof typeof AuthzMongoRsMongoType]
+export type AuthzMongoRsMongoType =
+ (typeof AuthzMongoRsMongoType)[keyof typeof AuthzMongoRsMongoType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoRsMongoType = {
@@ -1023,7 +1031,7 @@ export const AuthzMongoRsMongoType = {
export type AuthzMongoRsFilter = { [key: string]: any }
-export type AuthzMongoRsType = typeof AuthzMongoRsType[keyof typeof AuthzMongoRsType]
+export type AuthzMongoRsType = (typeof AuthzMongoRsType)[keyof typeof AuthzMongoRsType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzMongoRsType = {
@@ -1035,6 +1043,8 @@ export interface AuthzMongoRs {
enable?: boolean
collection: string
filter?: AuthzMongoRsFilter
+ limit?: number
+ skip?: number
mongo_type: AuthzMongoRsMongoType
servers: string
w_mode?: AuthzMongoRsWMode
@@ -1051,7 +1061,7 @@ export interface AuthzMongoRs {
ssl?: EmqxSslClientOpts
}
-export type AuthzLdapType = typeof AuthzLdapType[keyof typeof AuthzLdapType]
+export type AuthzLdapType = (typeof AuthzLdapType)[keyof typeof AuthzLdapType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzLdapType = {
@@ -1077,7 +1087,7 @@ export interface AuthzLdap {
export type AuthzHttpPostHeaders = { [key: string]: any }
-export type AuthzHttpPostMethod = typeof AuthzHttpPostMethod[keyof typeof AuthzHttpPostMethod]
+export type AuthzHttpPostMethod = (typeof AuthzHttpPostMethod)[keyof typeof AuthzHttpPostMethod]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzHttpPostMethod = {
@@ -1088,7 +1098,7 @@ export type AuthzHttpPostBody = {
$name?: string
}
-export type AuthzHttpPostType = typeof AuthzHttpPostType[keyof typeof AuthzHttpPostType]
+export type AuthzHttpPostType = (typeof AuthzHttpPostType)[keyof typeof AuthzHttpPostType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzHttpPostType = {
@@ -1116,7 +1126,7 @@ export interface AuthzHttpPost {
export type AuthzHttpGetHeaders = { [key: string]: any }
-export type AuthzHttpGetMethod = typeof AuthzHttpGetMethod[keyof typeof AuthzHttpGetMethod]
+export type AuthzHttpGetMethod = (typeof AuthzHttpGetMethod)[keyof typeof AuthzHttpGetMethod]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzHttpGetMethod = {
@@ -1127,7 +1137,7 @@ export type AuthzHttpGetBody = {
$name?: string
}
-export type AuthzHttpGetType = typeof AuthzHttpGetType[keyof typeof AuthzHttpGetType]
+export type AuthzHttpGetType = (typeof AuthzHttpGetType)[keyof typeof AuthzHttpGetType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzHttpGetType = {
@@ -1153,7 +1163,7 @@ export interface AuthzHttpGet {
headers?: AuthzHttpGetHeaders
}
-export type AuthzBuiltinDbType = typeof AuthzBuiltinDbType[keyof typeof AuthzBuiltinDbType]
+export type AuthzBuiltinDbType = (typeof AuthzBuiltinDbType)[keyof typeof AuthzBuiltinDbType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzBuiltinDbType = {
@@ -1166,7 +1176,7 @@ export interface AuthzBuiltinDb {
max_rules?: number
}
-export type AuthzApiFileType = typeof AuthzApiFileType[keyof typeof AuthzApiFileType]
+export type AuthzApiFileType = (typeof AuthzApiFileType)[keyof typeof AuthzApiFileType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthzApiFileType = {
diff --git a/src/types/schemas/bridges.schemas.ts b/src/types/schemas/bridges.schemas.ts
index 2c3295f9f..415fdc966 100644
--- a/src/types/schemas/bridges.schemas.ts
+++ b/src/types/schemas/bridges.schemas.ts
@@ -334,6 +334,11 @@ export interface EmqxSslClientOpts {
server_name_indication?: EmqxSslClientOptsServerNameIndication
}
+export interface ConnectorMqttStaticClientidEntry {
+ node: string
+ ids: string[]
+}
+
export interface ConnectorMqttIngressRemote {
topic: string
qos?: number
@@ -445,6 +450,7 @@ export interface BridgeMqttPut {
mode?: BridgeMqttPutMode
server: string
clientid_prefix?: string
+ static_clientids?: ConnectorMqttStaticClientidEntry[]
/** @deprecated */
reconnect_interval?: string
proto_ver?: BridgeMqttPutProtoVer
@@ -498,6 +504,7 @@ export interface BridgeMqttPost {
mode?: BridgeMqttPostMode
server: string
clientid_prefix?: string
+ static_clientids?: ConnectorMqttStaticClientidEntry[]
/** @deprecated */
reconnect_interval?: string
proto_ver?: BridgeMqttPostProtoVer
@@ -554,6 +561,7 @@ export interface BridgeMqttGet {
mode?: BridgeMqttGetMode
server: string
clientid_prefix?: string
+ static_clientids?: ConnectorMqttStaticClientidEntry[]
/** @deprecated */
reconnect_interval?: string
proto_ver?: BridgeMqttGetProtoVer
diff --git a/src/types/schemas/configs.schemas.ts b/src/types/schemas/configs.schemas.ts
index 0036c30c8..15c054abd 100644
--- a/src/types/schemas/configs.schemas.ts
+++ b/src/types/schemas/configs.schemas.ts
@@ -1,4 +1,4 @@
-export type PutConfigsLog403Code = typeof PutConfigsLog403Code[keyof typeof PutConfigsLog403Code]
+export type PutConfigsLog403Code = (typeof PutConfigsLog403Code)[keyof typeof PutConfigsLog403Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsLog403Code = {
@@ -10,7 +10,7 @@ export type PutConfigsLog403 = {
message?: string
}
-export type PutConfigsLog400Code = typeof PutConfigsLog400Code[keyof typeof PutConfigsLog400Code]
+export type PutConfigsLog400Code = (typeof PutConfigsLog400Code)[keyof typeof PutConfigsLog400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsLog400Code = {
@@ -23,7 +23,7 @@ export type PutConfigsLog400 = {
message?: string
}
-export type GetConfigsLog404Code = typeof GetConfigsLog404Code[keyof typeof GetConfigsLog404Code]
+export type GetConfigsLog404Code = (typeof GetConfigsLog404Code)[keyof typeof GetConfigsLog404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigsLog404Code = {
@@ -35,7 +35,7 @@ export type GetConfigsLog404 = {
message?: string
}
-export type PutConfigs400Code = typeof PutConfigs400Code[keyof typeof PutConfigs400Code]
+export type PutConfigs400Code = (typeof PutConfigs400Code)[keyof typeof PutConfigs400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigs400Code = {
@@ -47,7 +47,7 @@ export type PutConfigs400 = {
message?: string
}
-export type PutConfigsMode = typeof PutConfigsMode[keyof typeof PutConfigsMode]
+export type PutConfigsMode = (typeof PutConfigsMode)[keyof typeof PutConfigsMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsMode = {
@@ -60,7 +60,7 @@ export type PutConfigsParams = {
ignore_readonly?: boolean
}
-export type GetConfigs500Code = typeof GetConfigs500Code[keyof typeof GetConfigs500Code]
+export type GetConfigs500Code = (typeof GetConfigs500Code)[keyof typeof GetConfigs500Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigs500Code = {
@@ -72,7 +72,7 @@ export type GetConfigs500 = {
message?: string
}
-export type GetConfigs404Code = typeof GetConfigs404Code[keyof typeof GetConfigs404Code]
+export type GetConfigs404Code = (typeof GetConfigs404Code)[keyof typeof GetConfigs404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigs404Code = {
@@ -84,7 +84,7 @@ export type GetConfigs404 = {
message?: string
}
-export type GetConfigs400Code = typeof GetConfigs400Code[keyof typeof GetConfigs400Code]
+export type GetConfigs400Code = (typeof GetConfigs400Code)[keyof typeof GetConfigs400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigs400Code = {
@@ -98,7 +98,7 @@ export type GetConfigs400 = {
export type GetConfigs200Two = { [key: string]: any }
-export type GetConfigsKey = typeof GetConfigsKey[keyof typeof GetConfigsKey]
+export type GetConfigsKey = (typeof GetConfigsKey)[keyof typeof GetConfigsKey]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigsKey = {
@@ -128,7 +128,6 @@ export const GetConfigsKey = {
log: 'log',
mqtt: 'mqtt',
node: 'node',
- opentelemetry: 'opentelemetry',
overload_protection: 'overload_protection',
prometheus: 'prometheus',
psk_authentication: 'psk_authentication',
@@ -150,7 +149,7 @@ export type GetConfigsParams = {
}
export type PostConfigsResetRootname403Code =
- typeof PostConfigsResetRootname403Code[keyof typeof PostConfigsResetRootname403Code]
+ (typeof PostConfigsResetRootname403Code)[keyof typeof PostConfigsResetRootname403Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostConfigsResetRootname403Code = {
@@ -163,7 +162,7 @@ export type PostConfigsResetRootname403 = {
}
export type PostConfigsResetRootname400Code =
- typeof PostConfigsResetRootname400Code[keyof typeof PostConfigsResetRootname400Code]
+ (typeof PostConfigsResetRootname400Code)[keyof typeof PostConfigsResetRootname400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostConfigsResetRootname400Code = {
@@ -181,7 +180,7 @@ export type PostConfigsResetRootnameParams = {
}
export type PutConfigsBroker403Code =
- typeof PutConfigsBroker403Code[keyof typeof PutConfigsBroker403Code]
+ (typeof PutConfigsBroker403Code)[keyof typeof PutConfigsBroker403Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsBroker403Code = {
@@ -194,7 +193,7 @@ export type PutConfigsBroker403 = {
}
export type PutConfigsBroker400Code =
- typeof PutConfigsBroker400Code[keyof typeof PutConfigsBroker400Code]
+ (typeof PutConfigsBroker400Code)[keyof typeof PutConfigsBroker400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsBroker400Code = {
@@ -208,7 +207,7 @@ export type PutConfigsBroker400 = {
}
export type GetConfigsBroker404Code =
- typeof GetConfigsBroker404Code[keyof typeof GetConfigsBroker404Code]
+ (typeof GetConfigsBroker404Code)[keyof typeof GetConfigsBroker404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigsBroker404Code = {
@@ -221,7 +220,7 @@ export type GetConfigsBroker404 = {
}
export type PutConfigsDashboard403Code =
- typeof PutConfigsDashboard403Code[keyof typeof PutConfigsDashboard403Code]
+ (typeof PutConfigsDashboard403Code)[keyof typeof PutConfigsDashboard403Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsDashboard403Code = {
@@ -234,7 +233,7 @@ export type PutConfigsDashboard403 = {
}
export type PutConfigsDashboard400Code =
- typeof PutConfigsDashboard400Code[keyof typeof PutConfigsDashboard400Code]
+ (typeof PutConfigsDashboard400Code)[keyof typeof PutConfigsDashboard400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsDashboard400Code = {
@@ -248,7 +247,7 @@ export type PutConfigsDashboard400 = {
}
export type GetConfigsDashboard404Code =
- typeof GetConfigsDashboard404Code[keyof typeof GetConfigsDashboard404Code]
+ (typeof GetConfigsDashboard404Code)[keyof typeof GetConfigsDashboard404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigsDashboard404Code = {
@@ -261,7 +260,7 @@ export type GetConfigsDashboard404 = {
}
export type PutConfigsAlarm403Code =
- typeof PutConfigsAlarm403Code[keyof typeof PutConfigsAlarm403Code]
+ (typeof PutConfigsAlarm403Code)[keyof typeof PutConfigsAlarm403Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsAlarm403Code = {
@@ -274,7 +273,7 @@ export type PutConfigsAlarm403 = {
}
export type PutConfigsAlarm400Code =
- typeof PutConfigsAlarm400Code[keyof typeof PutConfigsAlarm400Code]
+ (typeof PutConfigsAlarm400Code)[keyof typeof PutConfigsAlarm400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsAlarm400Code = {
@@ -288,7 +287,7 @@ export type PutConfigsAlarm400 = {
}
export type GetConfigsAlarm404Code =
- typeof GetConfigsAlarm404Code[keyof typeof GetConfigsAlarm404Code]
+ (typeof GetConfigsAlarm404Code)[keyof typeof GetConfigsAlarm404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigsAlarm404Code = {
@@ -301,7 +300,7 @@ export type GetConfigsAlarm404 = {
}
export type PutConfigsGlobalZone403Code =
- typeof PutConfigsGlobalZone403Code[keyof typeof PutConfigsGlobalZone403Code]
+ (typeof PutConfigsGlobalZone403Code)[keyof typeof PutConfigsGlobalZone403Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsGlobalZone403Code = {
@@ -314,7 +313,7 @@ export type PutConfigsGlobalZone403 = {
}
export type PutConfigsGlobalZone400Code =
- typeof PutConfigsGlobalZone400Code[keyof typeof PutConfigsGlobalZone400Code]
+ (typeof PutConfigsGlobalZone400Code)[keyof typeof PutConfigsGlobalZone400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsGlobalZone400Code = {
@@ -351,7 +350,7 @@ export type GetConfigsGlobalZone200 = {
}
export type PutConfigsSysmon403Code =
- typeof PutConfigsSysmon403Code[keyof typeof PutConfigsSysmon403Code]
+ (typeof PutConfigsSysmon403Code)[keyof typeof PutConfigsSysmon403Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsSysmon403Code = {
@@ -364,7 +363,7 @@ export type PutConfigsSysmon403 = {
}
export type PutConfigsSysmon400Code =
- typeof PutConfigsSysmon400Code[keyof typeof PutConfigsSysmon400Code]
+ (typeof PutConfigsSysmon400Code)[keyof typeof PutConfigsSysmon400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsSysmon400Code = {
@@ -378,7 +377,7 @@ export type PutConfigsSysmon400 = {
}
export type GetConfigsSysmon404Code =
- typeof GetConfigsSysmon404Code[keyof typeof GetConfigsSysmon404Code]
+ (typeof GetConfigsSysmon404Code)[keyof typeof GetConfigsSysmon404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigsSysmon404Code = {
@@ -391,7 +390,7 @@ export type GetConfigsSysmon404 = {
}
export type PutConfigsSysTopics403Code =
- typeof PutConfigsSysTopics403Code[keyof typeof PutConfigsSysTopics403Code]
+ (typeof PutConfigsSysTopics403Code)[keyof typeof PutConfigsSysTopics403Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsSysTopics403Code = {
@@ -404,7 +403,7 @@ export type PutConfigsSysTopics403 = {
}
export type PutConfigsSysTopics400Code =
- typeof PutConfigsSysTopics400Code[keyof typeof PutConfigsSysTopics400Code]
+ (typeof PutConfigsSysTopics400Code)[keyof typeof PutConfigsSysTopics400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutConfigsSysTopics400Code = {
@@ -418,7 +417,7 @@ export type PutConfigsSysTopics400 = {
}
export type GetConfigsSysTopics404Code =
- typeof GetConfigsSysTopics404Code[keyof typeof GetConfigsSysTopics404Code]
+ (typeof GetConfigsSysTopics404Code)[keyof typeof GetConfigsSysTopics404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetConfigsSysTopics404Code = {
@@ -461,6 +460,8 @@ export interface EmqxSysmonOs {
export interface EmqxSysmon {
vm?: EmqxSysmonVm
os?: EmqxSysmonOs
+ mnesia_tm_mailbox_size_alarm_threshold?: number
+ broker_pool_mailbox_size_alarm_threshold?: number
}
export type EmqxSysTopicsSysHeartbeatInterval = string | 'disabled'
@@ -478,7 +479,7 @@ export type EmqxMqttMaxSubscriptions = 'infinity' | number
export type EmqxMqttMaxMqueueLen = 'infinity' | number
export type EmqxMqttMqueueDefaultPriority =
- typeof EmqxMqttMqueueDefaultPriority[keyof typeof EmqxMqttMqueueDefaultPriority]
+ (typeof EmqxMqttMqueueDefaultPriority)[keyof typeof EmqxMqttMqueueDefaultPriority]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxMqttMqueueDefaultPriority = {
@@ -494,8 +495,10 @@ export type EmqxMqttMaxAwaitingRel = 'infinity' | number
export type EmqxMqttMessageExpiryInterval = 'infinity' | string
+export type EmqxMqttClientidOverride = string | 'disabled'
+
export type EmqxMqttPeerCertAsClientid =
- typeof EmqxMqttPeerCertAsClientid[keyof typeof EmqxMqttPeerCertAsClientid]
+ (typeof EmqxMqttPeerCertAsClientid)[keyof typeof EmqxMqttPeerCertAsClientid]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxMqttPeerCertAsClientid = {
@@ -508,7 +511,7 @@ export const EmqxMqttPeerCertAsClientid = {
} as const
export type EmqxMqttPeerCertAsUsername =
- typeof EmqxMqttPeerCertAsUsername[keyof typeof EmqxMqttPeerCertAsUsername]
+ (typeof EmqxMqttPeerCertAsUsername)[keyof typeof EmqxMqttPeerCertAsUsername]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxMqttPeerCertAsUsername = {
@@ -525,7 +528,7 @@ export type EmqxMqttRetryInterval = string | 'infinity'
export type EmqxMqttServerKeepalive = 'disabled' | number
export type EmqxMqttSharedSubscriptionInitialStickyPick =
- typeof EmqxMqttSharedSubscriptionInitialStickyPick[keyof typeof EmqxMqttSharedSubscriptionInitialStickyPick]
+ (typeof EmqxMqttSharedSubscriptionInitialStickyPick)[keyof typeof EmqxMqttSharedSubscriptionInitialStickyPick]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxMqttSharedSubscriptionInitialStickyPick = {
@@ -536,7 +539,7 @@ export const EmqxMqttSharedSubscriptionInitialStickyPick = {
} as const
export type EmqxMqttSharedSubscriptionStrategy =
- typeof EmqxMqttSharedSubscriptionStrategy[keyof typeof EmqxMqttSharedSubscriptionStrategy]
+ (typeof EmqxMqttSharedSubscriptionStrategy)[keyof typeof EmqxMqttSharedSubscriptionStrategy]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxMqttSharedSubscriptionStrategy = {
@@ -574,6 +577,7 @@ export interface EmqxMqtt {
peer_cert_as_username?: EmqxMqttPeerCertAsUsername
peer_cert_as_clientid?: EmqxMqttPeerCertAsClientid
client_attrs_init?: EmqxClientAttrsInit[]
+ clientid_override?: EmqxMqttClientidOverride
session_expiry_interval?: string
message_expiry_interval?: EmqxMqttMessageExpiryInterval
max_awaiting_rel?: EmqxMqttMaxAwaitingRel
@@ -593,7 +597,7 @@ export interface EmqxLogThrottling {
}
export type EmqxLogFileHandlerPayloadEncode =
- typeof EmqxLogFileHandlerPayloadEncode[keyof typeof EmqxLogFileHandlerPayloadEncode]
+ (typeof EmqxLogFileHandlerPayloadEncode)[keyof typeof EmqxLogFileHandlerPayloadEncode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxLogFileHandlerPayloadEncode = {
@@ -603,7 +607,7 @@ export const EmqxLogFileHandlerPayloadEncode = {
} as const
export type EmqxLogFileHandlerTimestampFormat =
- typeof EmqxLogFileHandlerTimestampFormat[keyof typeof EmqxLogFileHandlerTimestampFormat]
+ (typeof EmqxLogFileHandlerTimestampFormat)[keyof typeof EmqxLogFileHandlerTimestampFormat]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxLogFileHandlerTimestampFormat = {
@@ -613,7 +617,7 @@ export const EmqxLogFileHandlerTimestampFormat = {
} as const
export type EmqxLogFileHandlerFormatter =
- typeof EmqxLogFileHandlerFormatter[keyof typeof EmqxLogFileHandlerFormatter]
+ (typeof EmqxLogFileHandlerFormatter)[keyof typeof EmqxLogFileHandlerFormatter]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxLogFileHandlerFormatter = {
@@ -622,7 +626,7 @@ export const EmqxLogFileHandlerFormatter = {
} as const
export type EmqxLogFileHandlerLevel =
- typeof EmqxLogFileHandlerLevel[keyof typeof EmqxLogFileHandlerLevel]
+ (typeof EmqxLogFileHandlerLevel)[keyof typeof EmqxLogFileHandlerLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxLogFileHandlerLevel = {
@@ -694,7 +698,7 @@ export interface EmqxDurableSessions {
}
export type EmqxConsoleHandlerPayloadEncode =
- typeof EmqxConsoleHandlerPayloadEncode[keyof typeof EmqxConsoleHandlerPayloadEncode]
+ (typeof EmqxConsoleHandlerPayloadEncode)[keyof typeof EmqxConsoleHandlerPayloadEncode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxConsoleHandlerPayloadEncode = {
@@ -704,7 +708,7 @@ export const EmqxConsoleHandlerPayloadEncode = {
} as const
export type EmqxConsoleHandlerTimestampFormat =
- typeof EmqxConsoleHandlerTimestampFormat[keyof typeof EmqxConsoleHandlerTimestampFormat]
+ (typeof EmqxConsoleHandlerTimestampFormat)[keyof typeof EmqxConsoleHandlerTimestampFormat]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxConsoleHandlerTimestampFormat = {
@@ -714,7 +718,7 @@ export const EmqxConsoleHandlerTimestampFormat = {
} as const
export type EmqxConsoleHandlerFormatter =
- typeof EmqxConsoleHandlerFormatter[keyof typeof EmqxConsoleHandlerFormatter]
+ (typeof EmqxConsoleHandlerFormatter)[keyof typeof EmqxConsoleHandlerFormatter]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxConsoleHandlerFormatter = {
@@ -723,7 +727,7 @@ export const EmqxConsoleHandlerFormatter = {
} as const
export type EmqxConsoleHandlerLevel =
- typeof EmqxConsoleHandlerLevel[keyof typeof EmqxConsoleHandlerLevel]
+ (typeof EmqxConsoleHandlerLevel)[keyof typeof EmqxConsoleHandlerLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxConsoleHandlerLevel = {
@@ -763,7 +767,7 @@ export interface EmqxBroker {
session_history_retain?: string
}
-export type EmqxAlarmActionsItem = typeof EmqxAlarmActionsItem[keyof typeof EmqxAlarmActionsItem]
+export type EmqxAlarmActionsItem = (typeof EmqxAlarmActionsItem)[keyof typeof EmqxAlarmActionsItem]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxAlarmActionsItem = {
@@ -778,7 +782,7 @@ export interface EmqxAlarm {
}
export type DashboardSslOptionsLogLevel =
- typeof DashboardSslOptionsLogLevel[keyof typeof DashboardSslOptionsLogLevel]
+ (typeof DashboardSslOptionsLogLevel)[keyof typeof DashboardSslOptionsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DashboardSslOptionsLogLevel = {
@@ -795,7 +799,7 @@ export const DashboardSslOptionsLogLevel = {
} as const
export type DashboardSslOptionsVerify =
- typeof DashboardSslOptionsVerify[keyof typeof DashboardSslOptionsVerify]
+ (typeof DashboardSslOptionsVerify)[keyof typeof DashboardSslOptionsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DashboardSslOptionsVerify = {
diff --git a/src/types/schemas/connectors.schemas.ts b/src/types/schemas/connectors.schemas.ts
index 4571989a4..dbb3b64d0 100644
--- a/src/types/schemas/connectors.schemas.ts
+++ b/src/types/schemas/connectors.schemas.ts
@@ -307,6 +307,11 @@ export interface ConnectorNodeStatus {
status_reason?: string
}
+export interface ConnectorMqttStaticClientidEntry {
+ node: string
+ ids: string[]
+}
+
export interface ConnectorMqttResourceOpts {
health_check_interval?: string
start_after_created?: boolean
@@ -344,6 +349,7 @@ export interface ConnectorMqttPutConnector {
mode?: ConnectorMqttPutConnectorMode
server: string
clientid_prefix?: string
+ static_clientids?: ConnectorMqttStaticClientidEntry[]
/** @deprecated */
reconnect_interval?: string
proto_ver?: ConnectorMqttPutConnectorProtoVer
@@ -398,6 +404,7 @@ export interface ConnectorMqttPostConnector {
mode?: ConnectorMqttPostConnectorMode
server: string
clientid_prefix?: string
+ static_clientids?: ConnectorMqttStaticClientidEntry[]
/** @deprecated */
reconnect_interval?: string
proto_ver?: ConnectorMqttPostConnectorProtoVer
@@ -467,6 +474,7 @@ export interface ConnectorMqttGetConnector {
mode?: ConnectorMqttGetConnectorMode
server: string
clientid_prefix?: string
+ static_clientids?: ConnectorMqttStaticClientidEntry[]
/** @deprecated */
reconnect_interval?: string
proto_ver?: ConnectorMqttGetConnectorProtoVer
diff --git a/src/types/schemas/gatewayListeners.schemas.ts b/src/types/schemas/gatewayListeners.schemas.ts
index e97824746..29ab3b2c4 100644
--- a/src/types/schemas/gatewayListeners.schemas.ts
+++ b/src/types/schemas/gatewayListeners.schemas.ts
@@ -1,5 +1,5 @@
export type PostGatewaysNameListenersIdAuthenticationUsers404Code =
- typeof PostGatewaysNameListenersIdAuthenticationUsers404Code[keyof typeof PostGatewaysNameListenersIdAuthenticationUsers404Code]
+ (typeof PostGatewaysNameListenersIdAuthenticationUsers404Code)[keyof typeof PostGatewaysNameListenersIdAuthenticationUsers404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostGatewaysNameListenersIdAuthenticationUsers404Code = {
@@ -13,7 +13,7 @@ export type PostGatewaysNameListenersIdAuthenticationUsers404 = {
}
export type PostGatewaysNameListenersIdAuthenticationUsers400Code =
- typeof PostGatewaysNameListenersIdAuthenticationUsers400Code[keyof typeof PostGatewaysNameListenersIdAuthenticationUsers400Code]
+ (typeof PostGatewaysNameListenersIdAuthenticationUsers400Code)[keyof typeof PostGatewaysNameListenersIdAuthenticationUsers400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostGatewaysNameListenersIdAuthenticationUsers400Code = {
@@ -26,7 +26,7 @@ export type PostGatewaysNameListenersIdAuthenticationUsers400 = {
}
export type GetGatewaysNameListenersIdAuthenticationUsers404Code =
- typeof GetGatewaysNameListenersIdAuthenticationUsers404Code[keyof typeof GetGatewaysNameListenersIdAuthenticationUsers404Code]
+ (typeof GetGatewaysNameListenersIdAuthenticationUsers404Code)[keyof typeof GetGatewaysNameListenersIdAuthenticationUsers404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListenersIdAuthenticationUsers404Code = {
@@ -40,7 +40,7 @@ export type GetGatewaysNameListenersIdAuthenticationUsers404 = {
}
export type GetGatewaysNameListenersIdAuthenticationUsers400Code =
- typeof GetGatewaysNameListenersIdAuthenticationUsers400Code[keyof typeof GetGatewaysNameListenersIdAuthenticationUsers400Code]
+ (typeof GetGatewaysNameListenersIdAuthenticationUsers400Code)[keyof typeof GetGatewaysNameListenersIdAuthenticationUsers400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListenersIdAuthenticationUsers400Code = {
@@ -58,7 +58,7 @@ export type GetGatewaysNameListenersIdAuthenticationUsersParams = {
}
export type DeleteGatewaysNameListenersIdAuthenticationUsersUid404Code =
- typeof DeleteGatewaysNameListenersIdAuthenticationUsersUid404Code[keyof typeof DeleteGatewaysNameListenersIdAuthenticationUsersUid404Code]
+ (typeof DeleteGatewaysNameListenersIdAuthenticationUsersUid404Code)[keyof typeof DeleteGatewaysNameListenersIdAuthenticationUsersUid404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteGatewaysNameListenersIdAuthenticationUsersUid404Code = {
@@ -72,7 +72,7 @@ export type DeleteGatewaysNameListenersIdAuthenticationUsersUid404 = {
}
export type DeleteGatewaysNameListenersIdAuthenticationUsersUid400Code =
- typeof DeleteGatewaysNameListenersIdAuthenticationUsersUid400Code[keyof typeof DeleteGatewaysNameListenersIdAuthenticationUsersUid400Code]
+ (typeof DeleteGatewaysNameListenersIdAuthenticationUsersUid400Code)[keyof typeof DeleteGatewaysNameListenersIdAuthenticationUsersUid400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteGatewaysNameListenersIdAuthenticationUsersUid400Code = {
@@ -85,7 +85,7 @@ export type DeleteGatewaysNameListenersIdAuthenticationUsersUid400 = {
}
export type PutGatewaysNameListenersIdAuthenticationUsersUid404Code =
- typeof PutGatewaysNameListenersIdAuthenticationUsersUid404Code[keyof typeof PutGatewaysNameListenersIdAuthenticationUsersUid404Code]
+ (typeof PutGatewaysNameListenersIdAuthenticationUsersUid404Code)[keyof typeof PutGatewaysNameListenersIdAuthenticationUsersUid404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysNameListenersIdAuthenticationUsersUid404Code = {
@@ -99,7 +99,7 @@ export type PutGatewaysNameListenersIdAuthenticationUsersUid404 = {
}
export type PutGatewaysNameListenersIdAuthenticationUsersUid400Code =
- typeof PutGatewaysNameListenersIdAuthenticationUsersUid400Code[keyof typeof PutGatewaysNameListenersIdAuthenticationUsersUid400Code]
+ (typeof PutGatewaysNameListenersIdAuthenticationUsersUid400Code)[keyof typeof PutGatewaysNameListenersIdAuthenticationUsersUid400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysNameListenersIdAuthenticationUsersUid400Code = {
@@ -112,7 +112,7 @@ export type PutGatewaysNameListenersIdAuthenticationUsersUid400 = {
}
export type GetGatewaysNameListenersIdAuthenticationUsersUid404Code =
- typeof GetGatewaysNameListenersIdAuthenticationUsersUid404Code[keyof typeof GetGatewaysNameListenersIdAuthenticationUsersUid404Code]
+ (typeof GetGatewaysNameListenersIdAuthenticationUsersUid404Code)[keyof typeof GetGatewaysNameListenersIdAuthenticationUsersUid404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListenersIdAuthenticationUsersUid404Code = {
@@ -126,7 +126,7 @@ export type GetGatewaysNameListenersIdAuthenticationUsersUid404 = {
}
export type GetGatewaysNameListenersIdAuthenticationUsersUid400Code =
- typeof GetGatewaysNameListenersIdAuthenticationUsersUid400Code[keyof typeof GetGatewaysNameListenersIdAuthenticationUsersUid400Code]
+ (typeof GetGatewaysNameListenersIdAuthenticationUsersUid400Code)[keyof typeof GetGatewaysNameListenersIdAuthenticationUsersUid400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListenersIdAuthenticationUsersUid400Code = {
@@ -139,7 +139,7 @@ export type GetGatewaysNameListenersIdAuthenticationUsersUid400 = {
}
export type DeleteGatewaysNameListenersId404Code =
- typeof DeleteGatewaysNameListenersId404Code[keyof typeof DeleteGatewaysNameListenersId404Code]
+ (typeof DeleteGatewaysNameListenersId404Code)[keyof typeof DeleteGatewaysNameListenersId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteGatewaysNameListenersId404Code = {
@@ -153,7 +153,7 @@ export type DeleteGatewaysNameListenersId404 = {
}
export type DeleteGatewaysNameListenersId400Code =
- typeof DeleteGatewaysNameListenersId400Code[keyof typeof DeleteGatewaysNameListenersId400Code]
+ (typeof DeleteGatewaysNameListenersId400Code)[keyof typeof DeleteGatewaysNameListenersId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteGatewaysNameListenersId400Code = {
@@ -166,7 +166,7 @@ export type DeleteGatewaysNameListenersId400 = {
}
export type PutGatewaysNameListenersId404Code =
- typeof PutGatewaysNameListenersId404Code[keyof typeof PutGatewaysNameListenersId404Code]
+ (typeof PutGatewaysNameListenersId404Code)[keyof typeof PutGatewaysNameListenersId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysNameListenersId404Code = {
@@ -180,7 +180,7 @@ export type PutGatewaysNameListenersId404 = {
}
export type PutGatewaysNameListenersId400Code =
- typeof PutGatewaysNameListenersId400Code[keyof typeof PutGatewaysNameListenersId400Code]
+ (typeof PutGatewaysNameListenersId400Code)[keyof typeof PutGatewaysNameListenersId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysNameListenersId400Code = {
@@ -209,7 +209,7 @@ export type PutGatewaysNameListenersIdBody =
| EmqxGatewayApiTcpListener
export type GetGatewaysNameListenersId404Code =
- typeof GetGatewaysNameListenersId404Code[keyof typeof GetGatewaysNameListenersId404Code]
+ (typeof GetGatewaysNameListenersId404Code)[keyof typeof GetGatewaysNameListenersId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListenersId404Code = {
@@ -223,7 +223,7 @@ export type GetGatewaysNameListenersId404 = {
}
export type GetGatewaysNameListenersId400Code =
- typeof GetGatewaysNameListenersId400Code[keyof typeof GetGatewaysNameListenersId400Code]
+ (typeof GetGatewaysNameListenersId400Code)[keyof typeof GetGatewaysNameListenersId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListenersId400Code = {
@@ -244,7 +244,7 @@ export type GetGatewaysNameListenersId200 =
| EmqxGatewayApiTcpListener
export type PostGatewaysNameListeners404Code =
- typeof PostGatewaysNameListeners404Code[keyof typeof PostGatewaysNameListeners404Code]
+ (typeof PostGatewaysNameListeners404Code)[keyof typeof PostGatewaysNameListeners404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostGatewaysNameListeners404Code = {
@@ -258,7 +258,7 @@ export type PostGatewaysNameListeners404 = {
}
export type PostGatewaysNameListeners400Code =
- typeof PostGatewaysNameListeners400Code[keyof typeof PostGatewaysNameListeners400Code]
+ (typeof PostGatewaysNameListeners400Code)[keyof typeof PostGatewaysNameListeners400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostGatewaysNameListeners400Code = {
@@ -287,7 +287,7 @@ export type PostGatewaysNameListenersBody =
| EmqxGatewayApiTcpListener
export type GetGatewaysNameListeners404Code =
- typeof GetGatewaysNameListeners404Code[keyof typeof GetGatewaysNameListeners404Code]
+ (typeof GetGatewaysNameListeners404Code)[keyof typeof GetGatewaysNameListeners404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListeners404Code = {
@@ -301,7 +301,7 @@ export type GetGatewaysNameListeners404 = {
}
export type GetGatewaysNameListeners400Code =
- typeof GetGatewaysNameListeners400Code[keyof typeof GetGatewaysNameListeners400Code]
+ (typeof GetGatewaysNameListeners400Code)[keyof typeof GetGatewaysNameListeners400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListeners400Code = {
@@ -320,7 +320,7 @@ export type GetGatewaysNameListeners200Item =
| EmqxGatewayApiListenersTcpListener
export type PostGatewaysNameListenersIdAuthentication404Code =
- typeof PostGatewaysNameListenersIdAuthentication404Code[keyof typeof PostGatewaysNameListenersIdAuthentication404Code]
+ (typeof PostGatewaysNameListenersIdAuthentication404Code)[keyof typeof PostGatewaysNameListenersIdAuthentication404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostGatewaysNameListenersIdAuthentication404Code = {
@@ -334,7 +334,7 @@ export type PostGatewaysNameListenersIdAuthentication404 = {
}
export type PostGatewaysNameListenersIdAuthentication400Code =
- typeof PostGatewaysNameListenersIdAuthentication400Code[keyof typeof PostGatewaysNameListenersIdAuthentication400Code]
+ (typeof PostGatewaysNameListenersIdAuthentication400Code)[keyof typeof PostGatewaysNameListenersIdAuthentication400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostGatewaysNameListenersIdAuthentication400Code = {
@@ -383,7 +383,7 @@ export type PostGatewaysNameListenersIdAuthenticationBody =
| AuthnBuiltinDb
export type DeleteGatewaysNameListenersIdAuthentication404Code =
- typeof DeleteGatewaysNameListenersIdAuthentication404Code[keyof typeof DeleteGatewaysNameListenersIdAuthentication404Code]
+ (typeof DeleteGatewaysNameListenersIdAuthentication404Code)[keyof typeof DeleteGatewaysNameListenersIdAuthentication404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteGatewaysNameListenersIdAuthentication404Code = {
@@ -397,7 +397,7 @@ export type DeleteGatewaysNameListenersIdAuthentication404 = {
}
export type DeleteGatewaysNameListenersIdAuthentication400Code =
- typeof DeleteGatewaysNameListenersIdAuthentication400Code[keyof typeof DeleteGatewaysNameListenersIdAuthentication400Code]
+ (typeof DeleteGatewaysNameListenersIdAuthentication400Code)[keyof typeof DeleteGatewaysNameListenersIdAuthentication400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteGatewaysNameListenersIdAuthentication400Code = {
@@ -410,7 +410,7 @@ export type DeleteGatewaysNameListenersIdAuthentication400 = {
}
export type PutGatewaysNameListenersIdAuthentication404Code =
- typeof PutGatewaysNameListenersIdAuthentication404Code[keyof typeof PutGatewaysNameListenersIdAuthentication404Code]
+ (typeof PutGatewaysNameListenersIdAuthentication404Code)[keyof typeof PutGatewaysNameListenersIdAuthentication404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysNameListenersIdAuthentication404Code = {
@@ -424,7 +424,7 @@ export type PutGatewaysNameListenersIdAuthentication404 = {
}
export type PutGatewaysNameListenersIdAuthentication400Code =
- typeof PutGatewaysNameListenersIdAuthentication400Code[keyof typeof PutGatewaysNameListenersIdAuthentication400Code]
+ (typeof PutGatewaysNameListenersIdAuthentication400Code)[keyof typeof PutGatewaysNameListenersIdAuthentication400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysNameListenersIdAuthentication400Code = {
@@ -473,7 +473,7 @@ export type PutGatewaysNameListenersIdAuthenticationBody =
| AuthnBuiltinDb
export type GetGatewaysNameListenersIdAuthentication404Code =
- typeof GetGatewaysNameListenersIdAuthentication404Code[keyof typeof GetGatewaysNameListenersIdAuthentication404Code]
+ (typeof GetGatewaysNameListenersIdAuthentication404Code)[keyof typeof GetGatewaysNameListenersIdAuthentication404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListenersIdAuthentication404Code = {
@@ -487,7 +487,7 @@ export type GetGatewaysNameListenersIdAuthentication404 = {
}
export type GetGatewaysNameListenersIdAuthentication400Code =
- typeof GetGatewaysNameListenersIdAuthentication400Code[keyof typeof GetGatewaysNameListenersIdAuthentication400Code]
+ (typeof GetGatewaysNameListenersIdAuthentication400Code)[keyof typeof GetGatewaysNameListenersIdAuthentication400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysNameListenersIdAuthentication400Code = {
@@ -547,7 +547,7 @@ export interface ListenersNodeStatus {
export type LdapSslServerNameIndication = string | 'disable'
-export type LdapSslLogLevel = typeof LdapSslLogLevel[keyof typeof LdapSslLogLevel]
+export type LdapSslLogLevel = (typeof LdapSslLogLevel)[keyof typeof LdapSslLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LdapSslLogLevel = {
@@ -563,7 +563,7 @@ export const LdapSslLogLevel = {
all: 'all',
} as const
-export type LdapSslVerify = typeof LdapSslVerify[keyof typeof LdapSslVerify]
+export type LdapSslVerify = (typeof LdapSslVerify)[keyof typeof LdapSslVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const LdapSslVerify = {
@@ -593,7 +593,7 @@ export interface LdapSsl {
export type GatewayWebsocketMaxFrameSize = number | 'infinity'
export type GatewayWebsocketPiggyback =
- typeof GatewayWebsocketPiggyback[keyof typeof GatewayWebsocketPiggyback]
+ (typeof GatewayWebsocketPiggyback)[keyof typeof GatewayWebsocketPiggyback]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GatewayWebsocketPiggyback = {
@@ -631,7 +631,7 @@ export interface GatewayUdpHealthCheck {
}
export type GatewayDtlsOptsLogLevel =
- typeof GatewayDtlsOptsLogLevel[keyof typeof GatewayDtlsOptsLogLevel]
+ (typeof GatewayDtlsOptsLogLevel)[keyof typeof GatewayDtlsOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GatewayDtlsOptsLogLevel = {
@@ -647,7 +647,8 @@ export const GatewayDtlsOptsLogLevel = {
all: 'all',
} as const
-export type GatewayDtlsOptsVerify = typeof GatewayDtlsOptsVerify[keyof typeof GatewayDtlsOptsVerify]
+export type GatewayDtlsOptsVerify =
+ (typeof GatewayDtlsOptsVerify)[keyof typeof GatewayDtlsOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GatewayDtlsOptsVerify = {
@@ -690,6 +691,7 @@ export interface EmqxTcpOpts {
buffer?: string
high_watermark?: string
nodelay?: boolean
+ nolinger?: boolean
reuseaddr?: boolean
keepalive?: string
}
@@ -697,7 +699,7 @@ export interface EmqxTcpOpts {
export type EmqxSslClientOptsServerNameIndication = string | 'disable'
export type EmqxSslClientOptsLogLevel =
- typeof EmqxSslClientOptsLogLevel[keyof typeof EmqxSslClientOptsLogLevel]
+ (typeof EmqxSslClientOptsLogLevel)[keyof typeof EmqxSslClientOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxSslClientOptsLogLevel = {
@@ -714,7 +716,7 @@ export const EmqxSslClientOptsLogLevel = {
} as const
export type EmqxSslClientOptsVerify =
- typeof EmqxSslClientOptsVerify[keyof typeof EmqxSslClientOptsVerify]
+ (typeof EmqxSslClientOptsVerify)[keyof typeof EmqxSslClientOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxSslClientOptsVerify = {
@@ -750,7 +752,7 @@ export interface EmqxOcsp {
}
export type EmqxListenerWssOptsLogLevel =
- typeof EmqxListenerWssOptsLogLevel[keyof typeof EmqxListenerWssOptsLogLevel]
+ (typeof EmqxListenerWssOptsLogLevel)[keyof typeof EmqxListenerWssOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerWssOptsLogLevel = {
@@ -767,7 +769,7 @@ export const EmqxListenerWssOptsLogLevel = {
} as const
export type EmqxListenerWssOptsVerify =
- typeof EmqxListenerWssOptsVerify[keyof typeof EmqxListenerWssOptsVerify]
+ (typeof EmqxListenerWssOptsVerify)[keyof typeof EmqxListenerWssOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerWssOptsVerify = {
@@ -798,7 +800,7 @@ export interface EmqxListenerWssOpts {
}
export type EmqxListenerSslOptsLogLevel =
- typeof EmqxListenerSslOptsLogLevel[keyof typeof EmqxListenerSslOptsLogLevel]
+ (typeof EmqxListenerSslOptsLogLevel)[keyof typeof EmqxListenerSslOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerSslOptsLogLevel = {
@@ -815,7 +817,7 @@ export const EmqxListenerSslOptsLogLevel = {
} as const
export type EmqxListenerSslOptsVerify =
- typeof EmqxListenerSslOptsVerify[keyof typeof EmqxListenerSslOptsVerify]
+ (typeof EmqxListenerSslOptsVerify)[keyof typeof EmqxListenerSslOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerSslOptsVerify = {
@@ -849,7 +851,7 @@ export interface EmqxListenerSslOpts {
}
export type EmqxDeflateOptsClientContextTakeover =
- typeof EmqxDeflateOptsClientContextTakeover[keyof typeof EmqxDeflateOptsClientContextTakeover]
+ (typeof EmqxDeflateOptsClientContextTakeover)[keyof typeof EmqxDeflateOptsClientContextTakeover]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxDeflateOptsClientContextTakeover = {
@@ -858,7 +860,7 @@ export const EmqxDeflateOptsClientContextTakeover = {
} as const
export type EmqxDeflateOptsServerContextTakeover =
- typeof EmqxDeflateOptsServerContextTakeover[keyof typeof EmqxDeflateOptsServerContextTakeover]
+ (typeof EmqxDeflateOptsServerContextTakeover)[keyof typeof EmqxDeflateOptsServerContextTakeover]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxDeflateOptsServerContextTakeover = {
@@ -867,7 +869,7 @@ export const EmqxDeflateOptsServerContextTakeover = {
} as const
export type EmqxDeflateOptsStrategy =
- typeof EmqxDeflateOptsStrategy[keyof typeof EmqxDeflateOptsStrategy]
+ (typeof EmqxDeflateOptsStrategy)[keyof typeof EmqxDeflateOptsStrategy]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxDeflateOptsStrategy = {
@@ -877,7 +879,7 @@ export const EmqxDeflateOptsStrategy = {
rle: 'rle',
} as const
-export type EmqxDeflateOptsLevel = typeof EmqxDeflateOptsLevel[keyof typeof EmqxDeflateOptsLevel]
+export type EmqxDeflateOptsLevel = (typeof EmqxDeflateOptsLevel)[keyof typeof EmqxDeflateOptsLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxDeflateOptsLevel = {
@@ -900,7 +902,7 @@ export interface EmqxDeflateOpts {
export type EmqxGatewayApiWssListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiWssListenerType =
- typeof EmqxGatewayApiWssListenerType[keyof typeof EmqxGatewayApiWssListenerType]
+ (typeof EmqxGatewayApiWssListenerType)[keyof typeof EmqxGatewayApiWssListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiWssListenerType = {
@@ -930,7 +932,7 @@ export interface EmqxGatewayApiWssListener {
export type EmqxGatewayApiWsListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiWsListenerType =
- typeof EmqxGatewayApiWsListenerType[keyof typeof EmqxGatewayApiWsListenerType]
+ (typeof EmqxGatewayApiWsListenerType)[keyof typeof EmqxGatewayApiWsListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiWsListenerType = {
@@ -959,7 +961,7 @@ export interface EmqxGatewayApiWsListener {
export type EmqxGatewayApiUdpListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiUdpListenerType =
- typeof EmqxGatewayApiUdpListenerType[keyof typeof EmqxGatewayApiUdpListenerType]
+ (typeof EmqxGatewayApiUdpListenerType)[keyof typeof EmqxGatewayApiUdpListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiUdpListenerType = {
@@ -985,7 +987,7 @@ export interface EmqxGatewayApiUdpListener {
export type EmqxGatewayApiTcpListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiTcpListenerType =
- typeof EmqxGatewayApiTcpListenerType[keyof typeof EmqxGatewayApiTcpListenerType]
+ (typeof EmqxGatewayApiTcpListenerType)[keyof typeof EmqxGatewayApiTcpListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiTcpListenerType = {
@@ -1013,7 +1015,7 @@ export interface EmqxGatewayApiTcpListener {
export type EmqxGatewayApiSslListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiSslListenerType =
- typeof EmqxGatewayApiSslListenerType[keyof typeof EmqxGatewayApiSslListenerType]
+ (typeof EmqxGatewayApiSslListenerType)[keyof typeof EmqxGatewayApiSslListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiSslListenerType = {
@@ -1042,7 +1044,7 @@ export interface EmqxGatewayApiSslListener {
export type EmqxGatewayApiDtlsListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiDtlsListenerType =
- typeof EmqxGatewayApiDtlsListenerType[keyof typeof EmqxGatewayApiDtlsListenerType]
+ (typeof EmqxGatewayApiDtlsListenerType)[keyof typeof EmqxGatewayApiDtlsListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiDtlsListenerType = {
@@ -1070,7 +1072,7 @@ export interface EmqxGatewayApiDtlsListener {
export type EmqxGatewayApiListenersUdpListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiListenersUdpListenerType =
- typeof EmqxGatewayApiListenersUdpListenerType[keyof typeof EmqxGatewayApiListenersUdpListenerType]
+ (typeof EmqxGatewayApiListenersUdpListenerType)[keyof typeof EmqxGatewayApiListenersUdpListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiListenersUdpListenerType = {
@@ -1098,7 +1100,7 @@ export interface EmqxGatewayApiListenersUdpListener {
export type EmqxGatewayApiListenersTcpListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiListenersTcpListenerType =
- typeof EmqxGatewayApiListenersTcpListenerType[keyof typeof EmqxGatewayApiListenersTcpListenerType]
+ (typeof EmqxGatewayApiListenersTcpListenerType)[keyof typeof EmqxGatewayApiListenersTcpListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiListenersTcpListenerType = {
@@ -1128,7 +1130,7 @@ export interface EmqxGatewayApiListenersTcpListener {
export type EmqxGatewayApiListenersSslListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiListenersSslListenerType =
- typeof EmqxGatewayApiListenersSslListenerType[keyof typeof EmqxGatewayApiListenersSslListenerType]
+ (typeof EmqxGatewayApiListenersSslListenerType)[keyof typeof EmqxGatewayApiListenersSslListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiListenersSslListenerType = {
@@ -1159,7 +1161,7 @@ export interface EmqxGatewayApiListenersSslListener {
export type EmqxGatewayApiListenersDtlsListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiListenersDtlsListenerType =
- typeof EmqxGatewayApiListenersDtlsListenerType[keyof typeof EmqxGatewayApiListenersDtlsListenerType]
+ (typeof EmqxGatewayApiListenersDtlsListenerType)[keyof typeof EmqxGatewayApiListenersDtlsListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiListenersDtlsListenerType = {
@@ -1214,7 +1216,7 @@ export interface ConnectorHttpRequest {
}
export type AuthnRedisSingleRedisType =
- typeof AuthnRedisSingleRedisType[keyof typeof AuthnRedisSingleRedisType]
+ (typeof AuthnRedisSingleRedisType)[keyof typeof AuthnRedisSingleRedisType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisSingleRedisType = {
@@ -1227,7 +1229,7 @@ export type AuthnRedisSinglePasswordHashAlgorithm =
| AuthnHashBcrypt
export type AuthnRedisSingleBackend =
- typeof AuthnRedisSingleBackend[keyof typeof AuthnRedisSingleBackend]
+ (typeof AuthnRedisSingleBackend)[keyof typeof AuthnRedisSingleBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisSingleBackend = {
@@ -1235,7 +1237,7 @@ export const AuthnRedisSingleBackend = {
} as const
export type AuthnRedisSingleMechanism =
- typeof AuthnRedisSingleMechanism[keyof typeof AuthnRedisSingleMechanism]
+ (typeof AuthnRedisSingleMechanism)[keyof typeof AuthnRedisSingleMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisSingleMechanism = {
@@ -1260,7 +1262,7 @@ export interface AuthnRedisSingle {
}
export type AuthnRedisSentinelRedisType =
- typeof AuthnRedisSentinelRedisType[keyof typeof AuthnRedisSentinelRedisType]
+ (typeof AuthnRedisSentinelRedisType)[keyof typeof AuthnRedisSentinelRedisType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisSentinelRedisType = {
@@ -1273,7 +1275,7 @@ export type AuthnRedisSentinelPasswordHashAlgorithm =
| AuthnHashBcrypt
export type AuthnRedisSentinelBackend =
- typeof AuthnRedisSentinelBackend[keyof typeof AuthnRedisSentinelBackend]
+ (typeof AuthnRedisSentinelBackend)[keyof typeof AuthnRedisSentinelBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisSentinelBackend = {
@@ -1281,7 +1283,7 @@ export const AuthnRedisSentinelBackend = {
} as const
export type AuthnRedisSentinelMechanism =
- typeof AuthnRedisSentinelMechanism[keyof typeof AuthnRedisSentinelMechanism]
+ (typeof AuthnRedisSentinelMechanism)[keyof typeof AuthnRedisSentinelMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisSentinelMechanism = {
@@ -1307,7 +1309,7 @@ export interface AuthnRedisSentinel {
}
export type AuthnRedisClusterRedisType =
- typeof AuthnRedisClusterRedisType[keyof typeof AuthnRedisClusterRedisType]
+ (typeof AuthnRedisClusterRedisType)[keyof typeof AuthnRedisClusterRedisType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisClusterRedisType = {
@@ -1320,7 +1322,7 @@ export type AuthnRedisClusterPasswordHashAlgorithm =
| AuthnHashBcrypt
export type AuthnRedisClusterBackend =
- typeof AuthnRedisClusterBackend[keyof typeof AuthnRedisClusterBackend]
+ (typeof AuthnRedisClusterBackend)[keyof typeof AuthnRedisClusterBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisClusterBackend = {
@@ -1328,7 +1330,7 @@ export const AuthnRedisClusterBackend = {
} as const
export type AuthnRedisClusterMechanism =
- typeof AuthnRedisClusterMechanism[keyof typeof AuthnRedisClusterMechanism]
+ (typeof AuthnRedisClusterMechanism)[keyof typeof AuthnRedisClusterMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnRedisClusterMechanism = {
@@ -1357,7 +1359,7 @@ export type AuthnPostgresqlPasswordHashAlgorithm =
| AuthnHashBcrypt
export type AuthnPostgresqlBackend =
- typeof AuthnPostgresqlBackend[keyof typeof AuthnPostgresqlBackend]
+ (typeof AuthnPostgresqlBackend)[keyof typeof AuthnPostgresqlBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnPostgresqlBackend = {
@@ -1365,7 +1367,7 @@ export const AuthnPostgresqlBackend = {
} as const
export type AuthnPostgresqlMechanism =
- typeof AuthnPostgresqlMechanism[keyof typeof AuthnPostgresqlMechanism]
+ (typeof AuthnPostgresqlMechanism)[keyof typeof AuthnPostgresqlMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnPostgresqlMechanism = {
@@ -1391,14 +1393,14 @@ export interface AuthnPostgresql {
export type AuthnMysqlPasswordHashAlgorithm = AuthnHashSimple | AuthnHashPbkdf2 | AuthnHashBcrypt
-export type AuthnMysqlBackend = typeof AuthnMysqlBackend[keyof typeof AuthnMysqlBackend]
+export type AuthnMysqlBackend = (typeof AuthnMysqlBackend)[keyof typeof AuthnMysqlBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMysqlBackend = {
mysql: 'mysql',
} as const
-export type AuthnMysqlMechanism = typeof AuthnMysqlMechanism[keyof typeof AuthnMysqlMechanism]
+export type AuthnMysqlMechanism = (typeof AuthnMysqlMechanism)[keyof typeof AuthnMysqlMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMysqlMechanism = {
@@ -1423,7 +1425,7 @@ export interface AuthnMysql {
}
export type AuthnMongoSingleUseLegacyProtocol =
- typeof AuthnMongoSingleUseLegacyProtocol[keyof typeof AuthnMongoSingleUseLegacyProtocol]
+ (typeof AuthnMongoSingleUseLegacyProtocol)[keyof typeof AuthnMongoSingleUseLegacyProtocol]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoSingleUseLegacyProtocol = {
@@ -1432,7 +1434,8 @@ export const AuthnMongoSingleUseLegacyProtocol = {
false: 'false',
} as const
-export type AuthnMongoSingleWMode = typeof AuthnMongoSingleWMode[keyof typeof AuthnMongoSingleWMode]
+export type AuthnMongoSingleWMode =
+ (typeof AuthnMongoSingleWMode)[keyof typeof AuthnMongoSingleWMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoSingleWMode = {
@@ -1441,7 +1444,7 @@ export const AuthnMongoSingleWMode = {
} as const
export type AuthnMongoSingleMongoType =
- typeof AuthnMongoSingleMongoType[keyof typeof AuthnMongoSingleMongoType]
+ (typeof AuthnMongoSingleMongoType)[keyof typeof AuthnMongoSingleMongoType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoSingleMongoType = {
@@ -1456,7 +1459,7 @@ export type AuthnMongoSinglePasswordHashAlgorithm =
export type AuthnMongoSingleFilter = { [key: string]: any }
export type AuthnMongoSingleBackend =
- typeof AuthnMongoSingleBackend[keyof typeof AuthnMongoSingleBackend]
+ (typeof AuthnMongoSingleBackend)[keyof typeof AuthnMongoSingleBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoSingleBackend = {
@@ -1464,7 +1467,7 @@ export const AuthnMongoSingleBackend = {
} as const
export type AuthnMongoSingleMechanism =
- typeof AuthnMongoSingleMechanism[keyof typeof AuthnMongoSingleMechanism]
+ (typeof AuthnMongoSingleMechanism)[keyof typeof AuthnMongoSingleMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoSingleMechanism = {
@@ -1496,7 +1499,7 @@ export interface AuthnMongoSingle {
}
export type AuthnMongoShardedUseLegacyProtocol =
- typeof AuthnMongoShardedUseLegacyProtocol[keyof typeof AuthnMongoShardedUseLegacyProtocol]
+ (typeof AuthnMongoShardedUseLegacyProtocol)[keyof typeof AuthnMongoShardedUseLegacyProtocol]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoShardedUseLegacyProtocol = {
@@ -1506,7 +1509,7 @@ export const AuthnMongoShardedUseLegacyProtocol = {
} as const
export type AuthnMongoShardedWMode =
- typeof AuthnMongoShardedWMode[keyof typeof AuthnMongoShardedWMode]
+ (typeof AuthnMongoShardedWMode)[keyof typeof AuthnMongoShardedWMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoShardedWMode = {
@@ -1515,7 +1518,7 @@ export const AuthnMongoShardedWMode = {
} as const
export type AuthnMongoShardedMongoType =
- typeof AuthnMongoShardedMongoType[keyof typeof AuthnMongoShardedMongoType]
+ (typeof AuthnMongoShardedMongoType)[keyof typeof AuthnMongoShardedMongoType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoShardedMongoType = {
@@ -1530,7 +1533,7 @@ export type AuthnMongoShardedPasswordHashAlgorithm =
export type AuthnMongoShardedFilter = { [key: string]: any }
export type AuthnMongoShardedBackend =
- typeof AuthnMongoShardedBackend[keyof typeof AuthnMongoShardedBackend]
+ (typeof AuthnMongoShardedBackend)[keyof typeof AuthnMongoShardedBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoShardedBackend = {
@@ -1538,7 +1541,7 @@ export const AuthnMongoShardedBackend = {
} as const
export type AuthnMongoShardedMechanism =
- typeof AuthnMongoShardedMechanism[keyof typeof AuthnMongoShardedMechanism]
+ (typeof AuthnMongoShardedMechanism)[keyof typeof AuthnMongoShardedMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoShardedMechanism = {
@@ -1570,7 +1573,7 @@ export interface AuthnMongoSharded {
}
export type AuthnMongoRsUseLegacyProtocol =
- typeof AuthnMongoRsUseLegacyProtocol[keyof typeof AuthnMongoRsUseLegacyProtocol]
+ (typeof AuthnMongoRsUseLegacyProtocol)[keyof typeof AuthnMongoRsUseLegacyProtocol]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoRsUseLegacyProtocol = {
@@ -1579,7 +1582,7 @@ export const AuthnMongoRsUseLegacyProtocol = {
false: 'false',
} as const
-export type AuthnMongoRsRMode = typeof AuthnMongoRsRMode[keyof typeof AuthnMongoRsRMode]
+export type AuthnMongoRsRMode = (typeof AuthnMongoRsRMode)[keyof typeof AuthnMongoRsRMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoRsRMode = {
@@ -1587,7 +1590,7 @@ export const AuthnMongoRsRMode = {
slave_ok: 'slave_ok',
} as const
-export type AuthnMongoRsWMode = typeof AuthnMongoRsWMode[keyof typeof AuthnMongoRsWMode]
+export type AuthnMongoRsWMode = (typeof AuthnMongoRsWMode)[keyof typeof AuthnMongoRsWMode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoRsWMode = {
@@ -1595,7 +1598,8 @@ export const AuthnMongoRsWMode = {
safe: 'safe',
} as const
-export type AuthnMongoRsMongoType = typeof AuthnMongoRsMongoType[keyof typeof AuthnMongoRsMongoType]
+export type AuthnMongoRsMongoType =
+ (typeof AuthnMongoRsMongoType)[keyof typeof AuthnMongoRsMongoType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoRsMongoType = {
@@ -1606,14 +1610,15 @@ export type AuthnMongoRsPasswordHashAlgorithm = AuthnHashSimple | AuthnHashPbkdf
export type AuthnMongoRsFilter = { [key: string]: any }
-export type AuthnMongoRsBackend = typeof AuthnMongoRsBackend[keyof typeof AuthnMongoRsBackend]
+export type AuthnMongoRsBackend = (typeof AuthnMongoRsBackend)[keyof typeof AuthnMongoRsBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoRsBackend = {
mongodb: 'mongodb',
} as const
-export type AuthnMongoRsMechanism = typeof AuthnMongoRsMechanism[keyof typeof AuthnMongoRsMechanism]
+export type AuthnMongoRsMechanism =
+ (typeof AuthnMongoRsMechanism)[keyof typeof AuthnMongoRsMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnMongoRsMechanism = {
@@ -1647,7 +1652,7 @@ export interface AuthnMongoRs {
}
export type AuthnLdapDeprecatedBackend =
- typeof AuthnLdapDeprecatedBackend[keyof typeof AuthnLdapDeprecatedBackend]
+ (typeof AuthnLdapDeprecatedBackend)[keyof typeof AuthnLdapDeprecatedBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnLdapDeprecatedBackend = {
@@ -1655,7 +1660,7 @@ export const AuthnLdapDeprecatedBackend = {
} as const
export type AuthnLdapDeprecatedMechanism =
- typeof AuthnLdapDeprecatedMechanism[keyof typeof AuthnLdapDeprecatedMechanism]
+ (typeof AuthnLdapDeprecatedMechanism)[keyof typeof AuthnLdapDeprecatedMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnLdapDeprecatedMechanism = {
@@ -1681,14 +1686,14 @@ export interface AuthnLdapDeprecated {
export type AuthnLdapMethod = AuthnBindMethod | AuthnHashMethod
-export type AuthnLdapBackend = typeof AuthnLdapBackend[keyof typeof AuthnLdapBackend]
+export type AuthnLdapBackend = (typeof AuthnLdapBackend)[keyof typeof AuthnLdapBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnLdapBackend = {
ldap: 'ldap',
} as const
-export type AuthnLdapMechanism = typeof AuthnLdapMechanism[keyof typeof AuthnLdapMechanism]
+export type AuthnLdapMechanism = (typeof AuthnLdapMechanism)[keyof typeof AuthnLdapMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnLdapMechanism = {
@@ -1711,7 +1716,8 @@ export interface AuthnLdap {
method?: AuthnLdapMethod
}
-export type AuthnJwtPublicKeyFrom = typeof AuthnJwtPublicKeyFrom[keyof typeof AuthnJwtPublicKeyFrom]
+export type AuthnJwtPublicKeyFrom =
+ (typeof AuthnJwtPublicKeyFrom)[keyof typeof AuthnJwtPublicKeyFrom]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtPublicKeyFrom = {
@@ -1722,7 +1728,7 @@ export const AuthnJwtPublicKeyFrom = {
export type AuthnJwtPublicKeyVerifyClaims = { [key: string]: any }
export type AuthnJwtPublicKeyMechanism =
- typeof AuthnJwtPublicKeyMechanism[keyof typeof AuthnJwtPublicKeyMechanism]
+ (typeof AuthnJwtPublicKeyMechanism)[keyof typeof AuthnJwtPublicKeyMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtPublicKeyMechanism = {
@@ -1730,7 +1736,7 @@ export const AuthnJwtPublicKeyMechanism = {
} as const
export type AuthnJwtPublicKeyAlgorithm =
- typeof AuthnJwtPublicKeyAlgorithm[keyof typeof AuthnJwtPublicKeyAlgorithm]
+ (typeof AuthnJwtPublicKeyAlgorithm)[keyof typeof AuthnJwtPublicKeyAlgorithm]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtPublicKeyAlgorithm = {
@@ -1748,7 +1754,7 @@ export interface AuthnJwtPublicKey {
enable?: boolean
}
-export type AuthnJwtJwksFrom = typeof AuthnJwtJwksFrom[keyof typeof AuthnJwtJwksFrom]
+export type AuthnJwtJwksFrom = (typeof AuthnJwtJwksFrom)[keyof typeof AuthnJwtJwksFrom]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtJwksFrom = {
@@ -1758,7 +1764,8 @@ export const AuthnJwtJwksFrom = {
export type AuthnJwtJwksVerifyClaims = { [key: string]: any }
-export type AuthnJwtJwksMechanism = typeof AuthnJwtJwksMechanism[keyof typeof AuthnJwtJwksMechanism]
+export type AuthnJwtJwksMechanism =
+ (typeof AuthnJwtJwksMechanism)[keyof typeof AuthnJwtJwksMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtJwksMechanism = {
@@ -1767,7 +1774,7 @@ export const AuthnJwtJwksMechanism = {
export type AuthnJwtJwksHeaders = { [key: string]: any }
-export type AuthnJwtJwksUseJwks = typeof AuthnJwtJwksUseJwks[keyof typeof AuthnJwtJwksUseJwks]
+export type AuthnJwtJwksUseJwks = (typeof AuthnJwtJwksUseJwks)[keyof typeof AuthnJwtJwksUseJwks]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtJwksUseJwks = {
@@ -1789,7 +1796,7 @@ export interface AuthnJwtJwks {
enable?: boolean
}
-export type AuthnJwtHmacFrom = typeof AuthnJwtHmacFrom[keyof typeof AuthnJwtHmacFrom]
+export type AuthnJwtHmacFrom = (typeof AuthnJwtHmacFrom)[keyof typeof AuthnJwtHmacFrom]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtHmacFrom = {
@@ -1799,14 +1806,16 @@ export const AuthnJwtHmacFrom = {
export type AuthnJwtHmacVerifyClaims = { [key: string]: any }
-export type AuthnJwtHmacMechanism = typeof AuthnJwtHmacMechanism[keyof typeof AuthnJwtHmacMechanism]
+export type AuthnJwtHmacMechanism =
+ (typeof AuthnJwtHmacMechanism)[keyof typeof AuthnJwtHmacMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtHmacMechanism = {
jwt: 'jwt',
} as const
-export type AuthnJwtHmacAlgorithm = typeof AuthnJwtHmacAlgorithm[keyof typeof AuthnJwtHmacAlgorithm]
+export type AuthnJwtHmacAlgorithm =
+ (typeof AuthnJwtHmacAlgorithm)[keyof typeof AuthnJwtHmacAlgorithm]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnJwtHmacAlgorithm = {
@@ -1827,7 +1836,7 @@ export interface AuthnJwtHmac {
export type AuthnHttpPostBody = { [key: string]: any }
-export type AuthnHttpPostBackend = typeof AuthnHttpPostBackend[keyof typeof AuthnHttpPostBackend]
+export type AuthnHttpPostBackend = (typeof AuthnHttpPostBackend)[keyof typeof AuthnHttpPostBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHttpPostBackend = {
@@ -1835,7 +1844,7 @@ export const AuthnHttpPostBackend = {
} as const
export type AuthnHttpPostMechanism =
- typeof AuthnHttpPostMechanism[keyof typeof AuthnHttpPostMechanism]
+ (typeof AuthnHttpPostMechanism)[keyof typeof AuthnHttpPostMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHttpPostMechanism = {
@@ -1844,7 +1853,7 @@ export const AuthnHttpPostMechanism = {
export type AuthnHttpPostHeaders = { [key: string]: any }
-export type AuthnHttpPostMethod = typeof AuthnHttpPostMethod[keyof typeof AuthnHttpPostMethod]
+export type AuthnHttpPostMethod = (typeof AuthnHttpPostMethod)[keyof typeof AuthnHttpPostMethod]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHttpPostMethod = {
@@ -1873,14 +1882,15 @@ export interface AuthnHttpPost {
export type AuthnHttpGetBody = { [key: string]: any }
-export type AuthnHttpGetBackend = typeof AuthnHttpGetBackend[keyof typeof AuthnHttpGetBackend]
+export type AuthnHttpGetBackend = (typeof AuthnHttpGetBackend)[keyof typeof AuthnHttpGetBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHttpGetBackend = {
http: 'http',
} as const
-export type AuthnHttpGetMechanism = typeof AuthnHttpGetMechanism[keyof typeof AuthnHttpGetMechanism]
+export type AuthnHttpGetMechanism =
+ (typeof AuthnHttpGetMechanism)[keyof typeof AuthnHttpGetMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHttpGetMechanism = {
@@ -1889,7 +1899,7 @@ export const AuthnHttpGetMechanism = {
export type AuthnHttpGetHeaders = { [key: string]: any }
-export type AuthnHttpGetMethod = typeof AuthnHttpGetMethod[keyof typeof AuthnHttpGetMethod]
+export type AuthnHttpGetMethod = (typeof AuthnHttpGetMethod)[keyof typeof AuthnHttpGetMethod]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHttpGetMethod = {
@@ -1916,7 +1926,7 @@ export interface AuthnHttpGet {
enable_pipelining?: number
}
-export type AuthnHashMethodType = typeof AuthnHashMethodType[keyof typeof AuthnHashMethodType]
+export type AuthnHashMethodType = (typeof AuthnHashMethodType)[keyof typeof AuthnHashMethodType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHashMethodType = {
@@ -1930,7 +1940,7 @@ export interface AuthnHashMethod {
}
export type AuthnBuiltinDbBootstrapType =
- typeof AuthnBuiltinDbBootstrapType[keyof typeof AuthnBuiltinDbBootstrapType]
+ (typeof AuthnBuiltinDbBootstrapType)[keyof typeof AuthnBuiltinDbBootstrapType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnBuiltinDbBootstrapType = {
@@ -1939,7 +1949,7 @@ export const AuthnBuiltinDbBootstrapType = {
} as const
export type AuthnBuiltinDbUserIdType =
- typeof AuthnBuiltinDbUserIdType[keyof typeof AuthnBuiltinDbUserIdType]
+ (typeof AuthnBuiltinDbUserIdType)[keyof typeof AuthnBuiltinDbUserIdType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnBuiltinDbUserIdType = {
@@ -1947,7 +1957,8 @@ export const AuthnBuiltinDbUserIdType = {
username: 'username',
} as const
-export type AuthnBuiltinDbBackend = typeof AuthnBuiltinDbBackend[keyof typeof AuthnBuiltinDbBackend]
+export type AuthnBuiltinDbBackend =
+ (typeof AuthnBuiltinDbBackend)[keyof typeof AuthnBuiltinDbBackend]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnBuiltinDbBackend = {
@@ -1955,7 +1966,7 @@ export const AuthnBuiltinDbBackend = {
} as const
export type AuthnBuiltinDbMechanism =
- typeof AuthnBuiltinDbMechanism[keyof typeof AuthnBuiltinDbMechanism]
+ (typeof AuthnBuiltinDbMechanism)[keyof typeof AuthnBuiltinDbMechanism]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnBuiltinDbMechanism = {
@@ -1977,7 +1988,7 @@ export interface AuthnBuiltinDb {
enable?: boolean
}
-export type AuthnBindMethodType = typeof AuthnBindMethodType[keyof typeof AuthnBindMethodType]
+export type AuthnBindMethodType = (typeof AuthnBindMethodType)[keyof typeof AuthnBindMethodType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnBindMethodType = {
@@ -1990,7 +2001,7 @@ export interface AuthnBindMethod {
}
export type AuthnHashSimpleSaltPosition =
- typeof AuthnHashSimpleSaltPosition[keyof typeof AuthnHashSimpleSaltPosition]
+ (typeof AuthnHashSimpleSaltPosition)[keyof typeof AuthnHashSimpleSaltPosition]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHashSimpleSaltPosition = {
@@ -1999,7 +2010,7 @@ export const AuthnHashSimpleSaltPosition = {
suffix: 'suffix',
} as const
-export type AuthnHashSimpleName = typeof AuthnHashSimpleName[keyof typeof AuthnHashSimpleName]
+export type AuthnHashSimpleName = (typeof AuthnHashSimpleName)[keyof typeof AuthnHashSimpleName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHashSimpleName = {
@@ -2015,7 +2026,8 @@ export interface AuthnHashSimple {
salt_position?: AuthnHashSimpleSaltPosition
}
-export type AuthnHashPbkdf2MacFun = typeof AuthnHashPbkdf2MacFun[keyof typeof AuthnHashPbkdf2MacFun]
+export type AuthnHashPbkdf2MacFun =
+ (typeof AuthnHashPbkdf2MacFun)[keyof typeof AuthnHashPbkdf2MacFun]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHashPbkdf2MacFun = {
@@ -2029,7 +2041,7 @@ export const AuthnHashPbkdf2MacFun = {
sha512: 'sha512',
} as const
-export type AuthnHashPbkdf2Name = typeof AuthnHashPbkdf2Name[keyof typeof AuthnHashPbkdf2Name]
+export type AuthnHashPbkdf2Name = (typeof AuthnHashPbkdf2Name)[keyof typeof AuthnHashPbkdf2Name]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHashPbkdf2Name = {
@@ -2043,7 +2055,8 @@ export interface AuthnHashPbkdf2 {
dk_length?: number
}
-export type AuthnHashBcryptRwName = typeof AuthnHashBcryptRwName[keyof typeof AuthnHashBcryptRwName]
+export type AuthnHashBcryptRwName =
+ (typeof AuthnHashBcryptRwName)[keyof typeof AuthnHashBcryptRwName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHashBcryptRwName = {
@@ -2055,7 +2068,7 @@ export interface AuthnHashBcryptRw {
salt_rounds?: number
}
-export type AuthnHashBcryptName = typeof AuthnHashBcryptName[keyof typeof AuthnHashBcryptName]
+export type AuthnHashBcryptName = (typeof AuthnHashBcryptName)[keyof typeof AuthnHashBcryptName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AuthnHashBcryptName = {
diff --git a/src/types/schemas/gateways.schemas.ts b/src/types/schemas/gateways.schemas.ts
index 6ef83128b..9572b99da 100644
--- a/src/types/schemas/gateways.schemas.ts
+++ b/src/types/schemas/gateways.schemas.ts
@@ -1,5 +1,5 @@
export type PutGatewaysName404Code =
- typeof PutGatewaysName404Code[keyof typeof PutGatewaysName404Code]
+ (typeof PutGatewaysName404Code)[keyof typeof PutGatewaysName404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysName404Code = {
@@ -13,7 +13,7 @@ export type PutGatewaysName404 = {
}
export type PutGatewaysName400Code =
- typeof PutGatewaysName400Code[keyof typeof PutGatewaysName400Code]
+ (typeof PutGatewaysName400Code)[keyof typeof PutGatewaysName400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysName400Code = {
@@ -48,7 +48,7 @@ export type PutGatewaysNameBody =
| EmqxGatewayApiCoap
export type GetGatewaysName404Code =
- typeof GetGatewaysName404Code[keyof typeof GetGatewaysName404Code]
+ (typeof GetGatewaysName404Code)[keyof typeof GetGatewaysName404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysName404Code = {
@@ -68,7 +68,7 @@ export type GetGatewaysName200 =
| EmqxGatewayApiExproto
| EmqxGatewayApiCoap
-export type GetGateways400Code = typeof GetGateways400Code[keyof typeof GetGateways400Code]
+export type GetGateways400Code = (typeof GetGateways400Code)[keyof typeof GetGateways400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGateways400Code = {
@@ -80,7 +80,7 @@ export type GetGateways400 = {
message?: string
}
-export type GetGatewaysStatus = typeof GetGatewaysStatus[keyof typeof GetGatewaysStatus]
+export type GetGatewaysStatus = (typeof GetGatewaysStatus)[keyof typeof GetGatewaysStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetGatewaysStatus = {
@@ -94,7 +94,7 @@ export type GetGatewaysParams = {
}
export type PutGatewaysNameEnableEnable404Code =
- typeof PutGatewaysNameEnableEnable404Code[keyof typeof PutGatewaysNameEnableEnable404Code]
+ (typeof PutGatewaysNameEnableEnable404Code)[keyof typeof PutGatewaysNameEnableEnable404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutGatewaysNameEnableEnable404Code = {
@@ -132,7 +132,7 @@ export interface GatewayStompFrame {
}
export type GatewaySslServerOptsLogLevel =
- typeof GatewaySslServerOptsLogLevel[keyof typeof GatewaySslServerOptsLogLevel]
+ (typeof GatewaySslServerOptsLogLevel)[keyof typeof GatewaySslServerOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GatewaySslServerOptsLogLevel = {
@@ -149,7 +149,7 @@ export const GatewaySslServerOptsLogLevel = {
} as const
export type GatewaySslServerOptsVerify =
- typeof GatewaySslServerOptsVerify[keyof typeof GatewaySslServerOptsVerify]
+ (typeof GatewaySslServerOptsVerify)[keyof typeof GatewaySslServerOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GatewaySslServerOptsVerify = {
@@ -198,7 +198,7 @@ export interface GatewayExprotoGrpcServer {
}
export type GatewayExprotoGrpcHandlerServiceName =
- typeof GatewayExprotoGrpcHandlerServiceName[keyof typeof GatewayExprotoGrpcHandlerServiceName]
+ (typeof GatewayExprotoGrpcHandlerServiceName)[keyof typeof GatewayExprotoGrpcHandlerServiceName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GatewayExprotoGrpcHandlerServiceName = {
@@ -213,7 +213,7 @@ export interface GatewayExprotoGrpcHandler {
}
export type GatewayDtlsOptsLogLevel =
- typeof GatewayDtlsOptsLogLevel[keyof typeof GatewayDtlsOptsLogLevel]
+ (typeof GatewayDtlsOptsLogLevel)[keyof typeof GatewayDtlsOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GatewayDtlsOptsLogLevel = {
@@ -229,7 +229,8 @@ export const GatewayDtlsOptsLogLevel = {
all: 'all',
} as const
-export type GatewayDtlsOptsVerify = typeof GatewayDtlsOptsVerify[keyof typeof GatewayDtlsOptsVerify]
+export type GatewayDtlsOptsVerify =
+ (typeof GatewayDtlsOptsVerify)[keyof typeof GatewayDtlsOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GatewayDtlsOptsVerify = {
@@ -253,6 +254,7 @@ export interface EmqxTcpOpts {
buffer?: string
high_watermark?: string
nodelay?: boolean
+ nolinger?: boolean
reuseaddr?: boolean
keepalive?: string
}
@@ -260,7 +262,7 @@ export interface EmqxTcpOpts {
export type EmqxSslClientOptsServerNameIndication = string | 'disable'
export type EmqxSslClientOptsLogLevel =
- typeof EmqxSslClientOptsLogLevel[keyof typeof EmqxSslClientOptsLogLevel]
+ (typeof EmqxSslClientOptsLogLevel)[keyof typeof EmqxSslClientOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxSslClientOptsLogLevel = {
@@ -277,7 +279,7 @@ export const EmqxSslClientOptsLogLevel = {
} as const
export type EmqxSslClientOptsVerify =
- typeof EmqxSslClientOptsVerify[keyof typeof EmqxSslClientOptsVerify]
+ (typeof EmqxSslClientOptsVerify)[keyof typeof EmqxSslClientOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxSslClientOptsVerify = {
@@ -338,7 +340,7 @@ export interface GatewayDtlsOpts {
}
export type EmqxListenerSslOptsLogLevel =
- typeof EmqxListenerSslOptsLogLevel[keyof typeof EmqxListenerSslOptsLogLevel]
+ (typeof EmqxListenerSslOptsLogLevel)[keyof typeof EmqxListenerSslOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerSslOptsLogLevel = {
@@ -355,7 +357,7 @@ export const EmqxListenerSslOptsLogLevel = {
} as const
export type EmqxListenerSslOptsVerify =
- typeof EmqxListenerSslOptsVerify[keyof typeof EmqxListenerSslOptsVerify]
+ (typeof EmqxListenerSslOptsVerify)[keyof typeof EmqxListenerSslOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerSslOptsVerify = {
@@ -411,7 +413,7 @@ export interface EmqxGatewayApiUpdateMqttsn {
}
export type EmqxGatewayApiUpdateLwm2mUpdateMsgPublishCondition =
- typeof EmqxGatewayApiUpdateLwm2mUpdateMsgPublishCondition[keyof typeof EmqxGatewayApiUpdateLwm2mUpdateMsgPublishCondition]
+ (typeof EmqxGatewayApiUpdateLwm2mUpdateMsgPublishCondition)[keyof typeof EmqxGatewayApiUpdateLwm2mUpdateMsgPublishCondition]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiUpdateLwm2mUpdateMsgPublishCondition = {
@@ -435,7 +437,7 @@ export interface EmqxGatewayApiUpdateLwm2m {
}
export type EmqxGatewayApiUpdateCoapPublishQos =
- typeof EmqxGatewayApiUpdateCoapPublishQos[keyof typeof EmqxGatewayApiUpdateCoapPublishQos]
+ (typeof EmqxGatewayApiUpdateCoapPublishQos)[keyof typeof EmqxGatewayApiUpdateCoapPublishQos]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiUpdateCoapPublishQos = {
@@ -446,7 +448,7 @@ export const EmqxGatewayApiUpdateCoapPublishQos = {
} as const
export type EmqxGatewayApiUpdateCoapSubscribeQos =
- typeof EmqxGatewayApiUpdateCoapSubscribeQos[keyof typeof EmqxGatewayApiUpdateCoapSubscribeQos]
+ (typeof EmqxGatewayApiUpdateCoapSubscribeQos)[keyof typeof EmqxGatewayApiUpdateCoapSubscribeQos]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiUpdateCoapSubscribeQos = {
@@ -457,7 +459,7 @@ export const EmqxGatewayApiUpdateCoapSubscribeQos = {
} as const
export type EmqxGatewayApiUpdateCoapNotifyType =
- typeof EmqxGatewayApiUpdateCoapNotifyType[keyof typeof EmqxGatewayApiUpdateCoapNotifyType]
+ (typeof EmqxGatewayApiUpdateCoapNotifyType)[keyof typeof EmqxGatewayApiUpdateCoapNotifyType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiUpdateCoapNotifyType = {
@@ -482,7 +484,7 @@ export interface EmqxGatewayApiUpdateCoap {
export type EmqxGatewayApiUdpListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiUdpListenerType =
- typeof EmqxGatewayApiUdpListenerType[keyof typeof EmqxGatewayApiUdpListenerType]
+ (typeof EmqxGatewayApiUdpListenerType)[keyof typeof EmqxGatewayApiUdpListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiUdpListenerType = {
@@ -508,7 +510,7 @@ export interface EmqxGatewayApiUdpListener {
export type EmqxGatewayApiTcpListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiTcpListenerType =
- typeof EmqxGatewayApiTcpListenerType[keyof typeof EmqxGatewayApiTcpListenerType]
+ (typeof EmqxGatewayApiTcpListenerType)[keyof typeof EmqxGatewayApiTcpListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiTcpListenerType = {
@@ -534,7 +536,7 @@ export interface EmqxGatewayApiTcpListener {
}
export type EmqxGatewayApiStompName =
- typeof EmqxGatewayApiStompName[keyof typeof EmqxGatewayApiStompName]
+ (typeof EmqxGatewayApiStompName)[keyof typeof EmqxGatewayApiStompName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiStompName = {
@@ -555,7 +557,7 @@ export interface EmqxGatewayApiStomp {
export type EmqxGatewayApiSslListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiSslListenerType =
- typeof EmqxGatewayApiSslListenerType[keyof typeof EmqxGatewayApiSslListenerType]
+ (typeof EmqxGatewayApiSslListenerType)[keyof typeof EmqxGatewayApiSslListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiSslListenerType = {
@@ -588,7 +590,7 @@ export type EmqxGatewayApiMqttsnListenersItem =
| EmqxGatewayApiUdpListener
export type EmqxGatewayApiMqttsnName =
- typeof EmqxGatewayApiMqttsnName[keyof typeof EmqxGatewayApiMqttsnName]
+ (typeof EmqxGatewayApiMqttsnName)[keyof typeof EmqxGatewayApiMqttsnName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiMqttsnName = {
@@ -615,7 +617,7 @@ export type EmqxGatewayApiLwm2mListenersItem =
| EmqxGatewayApiUdpListener
export type EmqxGatewayApiLwm2mUpdateMsgPublishCondition =
- typeof EmqxGatewayApiLwm2mUpdateMsgPublishCondition[keyof typeof EmqxGatewayApiLwm2mUpdateMsgPublishCondition]
+ (typeof EmqxGatewayApiLwm2mUpdateMsgPublishCondition)[keyof typeof EmqxGatewayApiLwm2mUpdateMsgPublishCondition]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiLwm2mUpdateMsgPublishCondition = {
@@ -624,7 +626,7 @@ export const EmqxGatewayApiLwm2mUpdateMsgPublishCondition = {
} as const
export type EmqxGatewayApiLwm2mName =
- typeof EmqxGatewayApiLwm2mName[keyof typeof EmqxGatewayApiLwm2mName]
+ (typeof EmqxGatewayApiLwm2mName)[keyof typeof EmqxGatewayApiLwm2mName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiLwm2mName = {
@@ -649,7 +651,7 @@ export interface EmqxGatewayApiLwm2m {
}
export type EmqxGatewayApiGatewayOverviewStatus =
- typeof EmqxGatewayApiGatewayOverviewStatus[keyof typeof EmqxGatewayApiGatewayOverviewStatus]
+ (typeof EmqxGatewayApiGatewayOverviewStatus)[keyof typeof EmqxGatewayApiGatewayOverviewStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiGatewayOverviewStatus = {
@@ -671,7 +673,7 @@ export interface EmqxGatewayApiGatewayOverview {
}
export type EmqxGatewayApiGatewayNodeStatusStatus =
- typeof EmqxGatewayApiGatewayNodeStatusStatus[keyof typeof EmqxGatewayApiGatewayNodeStatusStatus]
+ (typeof EmqxGatewayApiGatewayNodeStatusStatus)[keyof typeof EmqxGatewayApiGatewayNodeStatusStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiGatewayNodeStatusStatus = {
@@ -681,7 +683,7 @@ export const EmqxGatewayApiGatewayNodeStatusStatus = {
} as const
export type EmqxGatewayApiGatewayNodeStatusNode =
- typeof EmqxGatewayApiGatewayNodeStatusNode[keyof typeof EmqxGatewayApiGatewayNodeStatusNode]
+ (typeof EmqxGatewayApiGatewayNodeStatusNode)[keyof typeof EmqxGatewayApiGatewayNodeStatusNode]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiGatewayNodeStatusNode = {
@@ -696,7 +698,7 @@ export interface EmqxGatewayApiGatewayNodeStatus {
}
export type EmqxGatewayApiGatewayListenerOverviewType =
- typeof EmqxGatewayApiGatewayListenerOverviewType[keyof typeof EmqxGatewayApiGatewayListenerOverviewType]
+ (typeof EmqxGatewayApiGatewayListenerOverviewType)[keyof typeof EmqxGatewayApiGatewayListenerOverviewType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiGatewayListenerOverviewType = {
@@ -719,7 +721,7 @@ export type EmqxGatewayApiExprotoListenersItem =
| EmqxGatewayApiTcpListener
export type EmqxGatewayApiExprotoName =
- typeof EmqxGatewayApiExprotoName[keyof typeof EmqxGatewayApiExprotoName]
+ (typeof EmqxGatewayApiExprotoName)[keyof typeof EmqxGatewayApiExprotoName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiExprotoName = {
@@ -741,7 +743,7 @@ export interface EmqxGatewayApiExproto {
export type EmqxGatewayApiDtlsListenerMaxConnections = 'infinity' | number
export type EmqxGatewayApiDtlsListenerType =
- typeof EmqxGatewayApiDtlsListenerType[keyof typeof EmqxGatewayApiDtlsListenerType]
+ (typeof EmqxGatewayApiDtlsListenerType)[keyof typeof EmqxGatewayApiDtlsListenerType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiDtlsListenerType = {
@@ -769,7 +771,7 @@ export interface EmqxGatewayApiDtlsListener {
export type EmqxGatewayApiCoapListenersItem = EmqxGatewayApiDtlsListener | EmqxGatewayApiUdpListener
export type EmqxGatewayApiCoapPublishQos =
- typeof EmqxGatewayApiCoapPublishQos[keyof typeof EmqxGatewayApiCoapPublishQos]
+ (typeof EmqxGatewayApiCoapPublishQos)[keyof typeof EmqxGatewayApiCoapPublishQos]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiCoapPublishQos = {
@@ -780,7 +782,7 @@ export const EmqxGatewayApiCoapPublishQos = {
} as const
export type EmqxGatewayApiCoapSubscribeQos =
- typeof EmqxGatewayApiCoapSubscribeQos[keyof typeof EmqxGatewayApiCoapSubscribeQos]
+ (typeof EmqxGatewayApiCoapSubscribeQos)[keyof typeof EmqxGatewayApiCoapSubscribeQos]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiCoapSubscribeQos = {
@@ -791,7 +793,7 @@ export const EmqxGatewayApiCoapSubscribeQos = {
} as const
export type EmqxGatewayApiCoapNotifyType =
- typeof EmqxGatewayApiCoapNotifyType[keyof typeof EmqxGatewayApiCoapNotifyType]
+ (typeof EmqxGatewayApiCoapNotifyType)[keyof typeof EmqxGatewayApiCoapNotifyType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiCoapNotifyType = {
@@ -801,7 +803,7 @@ export const EmqxGatewayApiCoapNotifyType = {
} as const
export type EmqxGatewayApiCoapName =
- typeof EmqxGatewayApiCoapName[keyof typeof EmqxGatewayApiCoapName]
+ (typeof EmqxGatewayApiCoapName)[keyof typeof EmqxGatewayApiCoapName]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxGatewayApiCoapName = {
diff --git a/src/types/schemas/listeners.schemas.ts b/src/types/schemas/listeners.schemas.ts
index a55a74900..258ee363d 100644
--- a/src/types/schemas/listeners.schemas.ts
+++ b/src/types/schemas/listeners.schemas.ts
@@ -1,5 +1,5 @@
export type PostListenersId400Code =
- typeof PostListenersId400Code[keyof typeof PostListenersId400Code]
+ (typeof PostListenersId400Code)[keyof typeof PostListenersId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostListenersId400Code = {
@@ -20,7 +20,7 @@ export type PostListenersIdBody =
| ListenersQuicRequiredBind
export type DeleteListenersId404Code =
- typeof DeleteListenersId404Code[keyof typeof DeleteListenersId404Code]
+ (typeof DeleteListenersId404Code)[keyof typeof DeleteListenersId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteListenersId404Code = {
@@ -32,7 +32,8 @@ export type DeleteListenersId404 = {
message?: string
}
-export type PutListenersId404Code = typeof PutListenersId404Code[keyof typeof PutListenersId404Code]
+export type PutListenersId404Code =
+ (typeof PutListenersId404Code)[keyof typeof PutListenersId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutListenersId404Code = {
@@ -45,7 +46,8 @@ export type PutListenersId404 = {
message?: string
}
-export type PutListenersId400Code = typeof PutListenersId400Code[keyof typeof PutListenersId400Code]
+export type PutListenersId400Code =
+ (typeof PutListenersId400Code)[keyof typeof PutListenersId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutListenersId400Code = {
@@ -64,7 +66,8 @@ export type PutListenersId200 =
| ListenersSslRequiredBind
| ListenersQuicRequiredBind
-export type GetListenersId404Code = typeof GetListenersId404Code[keyof typeof GetListenersId404Code]
+export type GetListenersId404Code =
+ (typeof GetListenersId404Code)[keyof typeof GetListenersId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetListenersId404Code = {
@@ -85,7 +88,7 @@ export type GetListenersId200 =
| ListenersQuicRequiredBind
export type PostListenersIdRestart400Code =
- typeof PostListenersIdRestart400Code[keyof typeof PostListenersIdRestart400Code]
+ (typeof PostListenersIdRestart400Code)[keyof typeof PostListenersIdRestart400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostListenersIdRestart400Code = {
@@ -99,7 +102,7 @@ export type PostListenersIdRestart400 = {
}
export type PostListenersIdStart400Code =
- typeof PostListenersIdStart400Code[keyof typeof PostListenersIdStart400Code]
+ (typeof PostListenersIdStart400Code)[keyof typeof PostListenersIdStart400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostListenersIdStart400Code = {
@@ -113,7 +116,7 @@ export type PostListenersIdStart400 = {
}
export type PostListenersIdStop400Code =
- typeof PostListenersIdStop400Code[keyof typeof PostListenersIdStop400Code]
+ (typeof PostListenersIdStop400Code)[keyof typeof PostListenersIdStop400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostListenersIdStop400Code = {
@@ -126,7 +129,7 @@ export type PostListenersIdStop400 = {
message?: string
}
-export type PostListeners400Code = typeof PostListeners400Code[keyof typeof PostListeners400Code]
+export type PostListeners400Code = (typeof PostListeners400Code)[keyof typeof PostListeners400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostListeners400Code = {
@@ -153,7 +156,7 @@ export type PostListenersBody =
| ListenersWithNameSslRequiredBind
| ListenersWithNameTcpRequiredBind
-export type GetListenersType = typeof GetListenersType[keyof typeof GetListenersType]
+export type GetListenersType = (typeof GetListenersType)[keyof typeof GetListenersType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetListenersType = {
@@ -169,7 +172,7 @@ export type GetListenersParams = {
}
export type ListenersWssRequiredBindEnableAuthn =
- typeof ListenersWssRequiredBindEnableAuthn[keyof typeof ListenersWssRequiredBindEnableAuthn]
+ (typeof ListenersWssRequiredBindEnableAuthn)[keyof typeof ListenersWssRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWssRequiredBindEnableAuthn = {
@@ -181,7 +184,7 @@ export const ListenersWssRequiredBindEnableAuthn = {
export type ListenersWssRequiredBindMaxConnections = number | 'infinity'
export type ListenersWssRequiredBindType =
- typeof ListenersWssRequiredBindType[keyof typeof ListenersWssRequiredBindType]
+ (typeof ListenersWssRequiredBindType)[keyof typeof ListenersWssRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWssRequiredBindType = {
@@ -219,7 +222,7 @@ export type PostListenersId200 =
| ListenersQuicRequiredBind
export type ListenersWssNotRequiredBindEnableAuthn =
- typeof ListenersWssNotRequiredBindEnableAuthn[keyof typeof ListenersWssNotRequiredBindEnableAuthn]
+ (typeof ListenersWssNotRequiredBindEnableAuthn)[keyof typeof ListenersWssNotRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWssNotRequiredBindEnableAuthn = {
@@ -231,7 +234,7 @@ export const ListenersWssNotRequiredBindEnableAuthn = {
export type ListenersWssNotRequiredBindMaxConnections = number | 'infinity'
export type ListenersWssNotRequiredBindType =
- typeof ListenersWssNotRequiredBindType[keyof typeof ListenersWssNotRequiredBindType]
+ (typeof ListenersWssNotRequiredBindType)[keyof typeof ListenersWssNotRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWssNotRequiredBindType = {
@@ -269,7 +272,7 @@ export type PutListenersIdBody =
| ListenersQuicNotRequiredBind
export type ListenersWsRequiredBindEnableAuthn =
- typeof ListenersWsRequiredBindEnableAuthn[keyof typeof ListenersWsRequiredBindEnableAuthn]
+ (typeof ListenersWsRequiredBindEnableAuthn)[keyof typeof ListenersWsRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWsRequiredBindEnableAuthn = {
@@ -281,7 +284,7 @@ export const ListenersWsRequiredBindEnableAuthn = {
export type ListenersWsRequiredBindMaxConnections = number | 'infinity'
export type ListenersWsRequiredBindType =
- typeof ListenersWsRequiredBindType[keyof typeof ListenersWsRequiredBindType]
+ (typeof ListenersWsRequiredBindType)[keyof typeof ListenersWsRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWsRequiredBindType = {
@@ -311,7 +314,7 @@ export interface ListenersWsRequiredBind {
}
export type ListenersWsNotRequiredBindEnableAuthn =
- typeof ListenersWsNotRequiredBindEnableAuthn[keyof typeof ListenersWsNotRequiredBindEnableAuthn]
+ (typeof ListenersWsNotRequiredBindEnableAuthn)[keyof typeof ListenersWsNotRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWsNotRequiredBindEnableAuthn = {
@@ -323,7 +326,7 @@ export const ListenersWsNotRequiredBindEnableAuthn = {
export type ListenersWsNotRequiredBindMaxConnections = number | 'infinity'
export type ListenersWsNotRequiredBindType =
- typeof ListenersWsNotRequiredBindType[keyof typeof ListenersWsNotRequiredBindType]
+ (typeof ListenersWsNotRequiredBindType)[keyof typeof ListenersWsNotRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWsNotRequiredBindType = {
@@ -353,7 +356,7 @@ export interface ListenersWsNotRequiredBind {
}
export type ListenersWithNameWssRequiredBindEnableAuthn =
- typeof ListenersWithNameWssRequiredBindEnableAuthn[keyof typeof ListenersWithNameWssRequiredBindEnableAuthn]
+ (typeof ListenersWithNameWssRequiredBindEnableAuthn)[keyof typeof ListenersWithNameWssRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameWssRequiredBindEnableAuthn = {
@@ -365,7 +368,7 @@ export const ListenersWithNameWssRequiredBindEnableAuthn = {
export type ListenersWithNameWssRequiredBindMaxConnections = number | 'infinity'
export type ListenersWithNameWssRequiredBindType =
- typeof ListenersWithNameWssRequiredBindType[keyof typeof ListenersWithNameWssRequiredBindType]
+ (typeof ListenersWithNameWssRequiredBindType)[keyof typeof ListenersWithNameWssRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameWssRequiredBindType = {
@@ -396,7 +399,7 @@ export interface ListenersWithNameWssRequiredBind {
}
export type ListenersWithNameWsRequiredBindEnableAuthn =
- typeof ListenersWithNameWsRequiredBindEnableAuthn[keyof typeof ListenersWithNameWsRequiredBindEnableAuthn]
+ (typeof ListenersWithNameWsRequiredBindEnableAuthn)[keyof typeof ListenersWithNameWsRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameWsRequiredBindEnableAuthn = {
@@ -408,7 +411,7 @@ export const ListenersWithNameWsRequiredBindEnableAuthn = {
export type ListenersWithNameWsRequiredBindMaxConnections = number | 'infinity'
export type ListenersWithNameWsRequiredBindType =
- typeof ListenersWithNameWsRequiredBindType[keyof typeof ListenersWithNameWsRequiredBindType]
+ (typeof ListenersWithNameWsRequiredBindType)[keyof typeof ListenersWithNameWsRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameWsRequiredBindType = {
@@ -438,7 +441,7 @@ export interface ListenersWithNameWsRequiredBind {
}
export type ListenersWithNameTcpRequiredBindEnableAuthn =
- typeof ListenersWithNameTcpRequiredBindEnableAuthn[keyof typeof ListenersWithNameTcpRequiredBindEnableAuthn]
+ (typeof ListenersWithNameTcpRequiredBindEnableAuthn)[keyof typeof ListenersWithNameTcpRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameTcpRequiredBindEnableAuthn = {
@@ -450,7 +453,7 @@ export const ListenersWithNameTcpRequiredBindEnableAuthn = {
export type ListenersWithNameTcpRequiredBindMaxConnections = number | 'infinity'
export type ListenersWithNameTcpRequiredBindType =
- typeof ListenersWithNameTcpRequiredBindType[keyof typeof ListenersWithNameTcpRequiredBindType]
+ (typeof ListenersWithNameTcpRequiredBindType)[keyof typeof ListenersWithNameTcpRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameTcpRequiredBindType = {
@@ -458,7 +461,7 @@ export const ListenersWithNameTcpRequiredBindType = {
} as const
export type ListenersWithNameSslRequiredBindEnableAuthn =
- typeof ListenersWithNameSslRequiredBindEnableAuthn[keyof typeof ListenersWithNameSslRequiredBindEnableAuthn]
+ (typeof ListenersWithNameSslRequiredBindEnableAuthn)[keyof typeof ListenersWithNameSslRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameSslRequiredBindEnableAuthn = {
@@ -470,7 +473,7 @@ export const ListenersWithNameSslRequiredBindEnableAuthn = {
export type ListenersWithNameSslRequiredBindMaxConnections = number | 'infinity'
export type ListenersWithNameSslRequiredBindType =
- typeof ListenersWithNameSslRequiredBindType[keyof typeof ListenersWithNameSslRequiredBindType]
+ (typeof ListenersWithNameSslRequiredBindType)[keyof typeof ListenersWithNameSslRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameSslRequiredBindType = {
@@ -478,7 +481,7 @@ export const ListenersWithNameSslRequiredBindType = {
} as const
export type ListenersWithNameQuicRequiredBindEnableAuthn =
- typeof ListenersWithNameQuicRequiredBindEnableAuthn[keyof typeof ListenersWithNameQuicRequiredBindEnableAuthn]
+ (typeof ListenersWithNameQuicRequiredBindEnableAuthn)[keyof typeof ListenersWithNameQuicRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameQuicRequiredBindEnableAuthn = {
@@ -490,7 +493,7 @@ export const ListenersWithNameQuicRequiredBindEnableAuthn = {
export type ListenersWithNameQuicRequiredBindMaxConnections = number | 'infinity'
export type ListenersWithNameQuicRequiredBindType =
- typeof ListenersWithNameQuicRequiredBindType[keyof typeof ListenersWithNameQuicRequiredBindType]
+ (typeof ListenersWithNameQuicRequiredBindType)[keyof typeof ListenersWithNameQuicRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersWithNameQuicRequiredBindType = {
@@ -517,7 +520,7 @@ export interface ListenersWithNameQuicRequiredBind {
}
export type ListenersTcpRequiredBindEnableAuthn =
- typeof ListenersTcpRequiredBindEnableAuthn[keyof typeof ListenersTcpRequiredBindEnableAuthn]
+ (typeof ListenersTcpRequiredBindEnableAuthn)[keyof typeof ListenersTcpRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersTcpRequiredBindEnableAuthn = {
@@ -529,7 +532,7 @@ export const ListenersTcpRequiredBindEnableAuthn = {
export type ListenersTcpRequiredBindMaxConnections = number | 'infinity'
export type ListenersTcpRequiredBindType =
- typeof ListenersTcpRequiredBindType[keyof typeof ListenersTcpRequiredBindType]
+ (typeof ListenersTcpRequiredBindType)[keyof typeof ListenersTcpRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersTcpRequiredBindType = {
@@ -558,7 +561,7 @@ export interface ListenersTcpRequiredBind {
}
export type ListenersTcpNotRequiredBindEnableAuthn =
- typeof ListenersTcpNotRequiredBindEnableAuthn[keyof typeof ListenersTcpNotRequiredBindEnableAuthn]
+ (typeof ListenersTcpNotRequiredBindEnableAuthn)[keyof typeof ListenersTcpNotRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersTcpNotRequiredBindEnableAuthn = {
@@ -570,7 +573,7 @@ export const ListenersTcpNotRequiredBindEnableAuthn = {
export type ListenersTcpNotRequiredBindMaxConnections = number | 'infinity'
export type ListenersTcpNotRequiredBindType =
- typeof ListenersTcpNotRequiredBindType[keyof typeof ListenersTcpNotRequiredBindType]
+ (typeof ListenersTcpNotRequiredBindType)[keyof typeof ListenersTcpNotRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersTcpNotRequiredBindType = {
@@ -609,7 +612,7 @@ export interface ListenersStatus {
}
export type ListenersSslRequiredBindEnableAuthn =
- typeof ListenersSslRequiredBindEnableAuthn[keyof typeof ListenersSslRequiredBindEnableAuthn]
+ (typeof ListenersSslRequiredBindEnableAuthn)[keyof typeof ListenersSslRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersSslRequiredBindEnableAuthn = {
@@ -621,7 +624,7 @@ export const ListenersSslRequiredBindEnableAuthn = {
export type ListenersSslRequiredBindMaxConnections = number | 'infinity'
export type ListenersSslRequiredBindType =
- typeof ListenersSslRequiredBindType[keyof typeof ListenersSslRequiredBindType]
+ (typeof ListenersSslRequiredBindType)[keyof typeof ListenersSslRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersSslRequiredBindType = {
@@ -651,7 +654,7 @@ export interface ListenersSslRequiredBind {
}
export type ListenersSslNotRequiredBindEnableAuthn =
- typeof ListenersSslNotRequiredBindEnableAuthn[keyof typeof ListenersSslNotRequiredBindEnableAuthn]
+ (typeof ListenersSslNotRequiredBindEnableAuthn)[keyof typeof ListenersSslNotRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersSslNotRequiredBindEnableAuthn = {
@@ -663,7 +666,7 @@ export const ListenersSslNotRequiredBindEnableAuthn = {
export type ListenersSslNotRequiredBindMaxConnections = number | 'infinity'
export type ListenersSslNotRequiredBindType =
- typeof ListenersSslNotRequiredBindType[keyof typeof ListenersSslNotRequiredBindType]
+ (typeof ListenersSslNotRequiredBindType)[keyof typeof ListenersSslNotRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersSslNotRequiredBindType = {
@@ -693,7 +696,7 @@ export interface ListenersSslNotRequiredBind {
}
export type ListenersQuicRequiredBindEnableAuthn =
- typeof ListenersQuicRequiredBindEnableAuthn[keyof typeof ListenersQuicRequiredBindEnableAuthn]
+ (typeof ListenersQuicRequiredBindEnableAuthn)[keyof typeof ListenersQuicRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersQuicRequiredBindEnableAuthn = {
@@ -705,7 +708,7 @@ export const ListenersQuicRequiredBindEnableAuthn = {
export type ListenersQuicRequiredBindMaxConnections = number | 'infinity'
export type ListenersQuicRequiredBindType =
- typeof ListenersQuicRequiredBindType[keyof typeof ListenersQuicRequiredBindType]
+ (typeof ListenersQuicRequiredBindType)[keyof typeof ListenersQuicRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersQuicRequiredBindType = {
@@ -732,7 +735,7 @@ export interface ListenersQuicRequiredBind {
}
export type ListenersQuicNotRequiredBindEnableAuthn =
- typeof ListenersQuicNotRequiredBindEnableAuthn[keyof typeof ListenersQuicNotRequiredBindEnableAuthn]
+ (typeof ListenersQuicNotRequiredBindEnableAuthn)[keyof typeof ListenersQuicNotRequiredBindEnableAuthn]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersQuicNotRequiredBindEnableAuthn = {
@@ -744,7 +747,7 @@ export const ListenersQuicNotRequiredBindEnableAuthn = {
export type ListenersQuicNotRequiredBindMaxConnections = number | 'infinity'
export type ListenersQuicNotRequiredBindType =
- typeof ListenersQuicNotRequiredBindType[keyof typeof ListenersQuicNotRequiredBindType]
+ (typeof ListenersQuicNotRequiredBindType)[keyof typeof ListenersQuicNotRequiredBindType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersQuicNotRequiredBindType = {
@@ -776,7 +779,7 @@ export interface ListenersNodeStatus {
}
export type ListenersListenerTypeStatusType =
- typeof ListenersListenerTypeStatusType[keyof typeof ListenersListenerTypeStatusType]
+ (typeof ListenersListenerTypeStatusType)[keyof typeof ListenersListenerTypeStatusType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersListenerTypeStatusType = {
@@ -796,7 +799,7 @@ export interface ListenersListenerTypeStatus {
}
export type ListenersListenerIdStatusType =
- typeof ListenersListenerIdStatusType[keyof typeof ListenersListenerIdStatusType]
+ (typeof ListenersListenerIdStatusType)[keyof typeof ListenersListenerIdStatusType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ListenersListenerIdStatusType = {
@@ -822,7 +825,7 @@ export interface ListenersListenerIdStatus {
export type EmqxWsOptsMaxFrameSize = number | 'infinity'
export type EmqxWsOptsMqttPiggyback =
- typeof EmqxWsOptsMqttPiggyback[keyof typeof EmqxWsOptsMqttPiggyback]
+ (typeof EmqxWsOptsMqttPiggyback)[keyof typeof EmqxWsOptsMqttPiggyback]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxWsOptsMqttPiggyback = {
@@ -857,6 +860,7 @@ export interface EmqxTcpOpts {
buffer?: string
high_watermark?: string
nodelay?: boolean
+ nolinger?: boolean
reuseaddr?: boolean
keepalive?: string
}
@@ -891,7 +895,7 @@ export interface EmqxOcsp {
}
export type EmqxListenerWssOptsLogLevel =
- typeof EmqxListenerWssOptsLogLevel[keyof typeof EmqxListenerWssOptsLogLevel]
+ (typeof EmqxListenerWssOptsLogLevel)[keyof typeof EmqxListenerWssOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerWssOptsLogLevel = {
@@ -908,7 +912,7 @@ export const EmqxListenerWssOptsLogLevel = {
} as const
export type EmqxListenerWssOptsVerify =
- typeof EmqxListenerWssOptsVerify[keyof typeof EmqxListenerWssOptsVerify]
+ (typeof EmqxListenerWssOptsVerify)[keyof typeof EmqxListenerWssOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerWssOptsVerify = {
@@ -939,7 +943,7 @@ export interface EmqxListenerWssOpts {
}
export type EmqxListenerSslOptsLogLevel =
- typeof EmqxListenerSslOptsLogLevel[keyof typeof EmqxListenerSslOptsLogLevel]
+ (typeof EmqxListenerSslOptsLogLevel)[keyof typeof EmqxListenerSslOptsLogLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerSslOptsLogLevel = {
@@ -956,7 +960,7 @@ export const EmqxListenerSslOptsLogLevel = {
} as const
export type EmqxListenerSslOptsVerify =
- typeof EmqxListenerSslOptsVerify[keyof typeof EmqxListenerSslOptsVerify]
+ (typeof EmqxListenerSslOptsVerify)[keyof typeof EmqxListenerSslOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerSslOptsVerify = {
@@ -1012,7 +1016,7 @@ export interface ListenersWithNameSslRequiredBind {
}
export type EmqxListenerQuicSslOptsVerify =
- typeof EmqxListenerQuicSslOptsVerify[keyof typeof EmqxListenerQuicSslOptsVerify]
+ (typeof EmqxListenerQuicSslOptsVerify)[keyof typeof EmqxListenerQuicSslOptsVerify]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxListenerQuicSslOptsVerify = {
@@ -1030,7 +1034,7 @@ export interface EmqxListenerQuicSslOpts {
}
export type EmqxDeflateOptsClientContextTakeover =
- typeof EmqxDeflateOptsClientContextTakeover[keyof typeof EmqxDeflateOptsClientContextTakeover]
+ (typeof EmqxDeflateOptsClientContextTakeover)[keyof typeof EmqxDeflateOptsClientContextTakeover]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxDeflateOptsClientContextTakeover = {
@@ -1039,7 +1043,7 @@ export const EmqxDeflateOptsClientContextTakeover = {
} as const
export type EmqxDeflateOptsServerContextTakeover =
- typeof EmqxDeflateOptsServerContextTakeover[keyof typeof EmqxDeflateOptsServerContextTakeover]
+ (typeof EmqxDeflateOptsServerContextTakeover)[keyof typeof EmqxDeflateOptsServerContextTakeover]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxDeflateOptsServerContextTakeover = {
@@ -1048,7 +1052,7 @@ export const EmqxDeflateOptsServerContextTakeover = {
} as const
export type EmqxDeflateOptsStrategy =
- typeof EmqxDeflateOptsStrategy[keyof typeof EmqxDeflateOptsStrategy]
+ (typeof EmqxDeflateOptsStrategy)[keyof typeof EmqxDeflateOptsStrategy]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxDeflateOptsStrategy = {
@@ -1058,7 +1062,7 @@ export const EmqxDeflateOptsStrategy = {
rle: 'rle',
} as const
-export type EmqxDeflateOptsLevel = typeof EmqxDeflateOptsLevel[keyof typeof EmqxDeflateOptsLevel]
+export type EmqxDeflateOptsLevel = (typeof EmqxDeflateOptsLevel)[keyof typeof EmqxDeflateOptsLevel]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxDeflateOptsLevel = {
diff --git a/src/types/schemas/metrics.schemas.ts b/src/types/schemas/metrics.schemas.ts
index 403289b7f..692f4acf2 100644
--- a/src/types/schemas/metrics.schemas.ts
+++ b/src/types/schemas/metrics.schemas.ts
@@ -313,42 +313,42 @@ export interface EmqxMgmtApiMetricsAggregatedMetrics {
}
export interface EmqxDashboardMonitorApiSamplerCurrentNode {
+ connections?: number
+ disconnected_durable_sessions?: number
dropped_msg_rate?: number
- sent_msg_rate?: number
+ live_connections?: number
+ node_uptime?: number
persisted_rate?: number
received_msg_rate?: number
+ retained_msg_count?: number
+ sent_msg_rate?: number
+ shared_subscriptions?: number
+ subscriptions?: number
+ subscriptions_durable?: number
+ topics?: number
transformation_failed_rate?: number
transformation_succeeded_rate?: number
validation_failed_rate?: number
validation_succeeded_rate?: number
- disconnected_durable_sessions?: number
- subscriptions_durable?: number
- subscriptions?: number
- topics?: number
- connections?: number
- live_connections?: number
- node_uptime?: number
- retained_msg_count?: number
- shared_subscriptions?: number
}
export interface EmqxDashboardMonitorApiSamplerCurrent {
+ connections?: number
+ disconnected_durable_sessions?: number
dropped_msg_rate?: number
- sent_msg_rate?: number
+ live_connections?: number
persisted_rate?: number
received_msg_rate?: number
+ retained_msg_count?: number
+ sent_msg_rate?: number
+ shared_subscriptions?: number
+ subscriptions?: number
+ subscriptions_durable?: number
+ topics?: number
transformation_failed_rate?: number
transformation_succeeded_rate?: number
validation_failed_rate?: number
validation_succeeded_rate?: number
- disconnected_durable_sessions?: number
- subscriptions_durable?: number
- subscriptions?: number
- topics?: number
- connections?: number
- live_connections?: number
- retained_msg_count?: number
- shared_subscriptions?: number
}
export interface EmqxDashboardMonitorApiSampler {
diff --git a/src/types/schemas/monitor.schemas.ts b/src/types/schemas/monitor.schemas.ts
index 8b705ad4c..30dd95b69 100644
--- a/src/types/schemas/monitor.schemas.ts
+++ b/src/types/schemas/monitor.schemas.ts
@@ -1,24 +1,13 @@
-export type PutOpentelemetry400Code =
- typeof PutOpentelemetry400Code[keyof typeof PutOpentelemetry400Code]
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const PutOpentelemetry400Code = {
- BAD_REQUEST: 'BAD_REQUEST',
-} as const
-
-export type PutOpentelemetry400 = {
- code?: PutOpentelemetry400Code
- message?: string
-}
-
export type GetPrometheusAuth200Two = { [key: string]: any }
export type GetPrometheusStats200Two = { [key: string]: any }
export type GetPrometheusDataIntegration200Two = { [key: string]: any }
+export type PutPrometheusBody = PrometheusLegacyDeprecatedSetting | PrometheusRecommendSetting
+
export type EmqxPrometheusApiModeParameter =
- typeof EmqxPrometheusApiModeParameter[keyof typeof EmqxPrometheusApiModeParameter]
+ (typeof EmqxPrometheusApiModeParameter)[keyof typeof EmqxPrometheusApiModeParameter]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const EmqxPrometheusApiModeParameter = {
@@ -55,10 +44,8 @@ export interface PrometheusRecommendSetting {
collectors?: PrometheusCollectors
}
-export type PutPrometheusBody = PrometheusLegacyDeprecatedSetting | PrometheusRecommendSetting
-
export type PrometheusLegacyDeprecatedSettingVmMsaccCollector =
- typeof PrometheusLegacyDeprecatedSettingVmMsaccCollector[keyof typeof PrometheusLegacyDeprecatedSettingVmMsaccCollector]
+ (typeof PrometheusLegacyDeprecatedSettingVmMsaccCollector)[keyof typeof PrometheusLegacyDeprecatedSettingVmMsaccCollector]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusLegacyDeprecatedSettingVmMsaccCollector = {
@@ -67,7 +54,7 @@ export const PrometheusLegacyDeprecatedSettingVmMsaccCollector = {
} as const
export type PrometheusLegacyDeprecatedSettingVmMemoryCollector =
- typeof PrometheusLegacyDeprecatedSettingVmMemoryCollector[keyof typeof PrometheusLegacyDeprecatedSettingVmMemoryCollector]
+ (typeof PrometheusLegacyDeprecatedSettingVmMemoryCollector)[keyof typeof PrometheusLegacyDeprecatedSettingVmMemoryCollector]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusLegacyDeprecatedSettingVmMemoryCollector = {
@@ -76,7 +63,7 @@ export const PrometheusLegacyDeprecatedSettingVmMemoryCollector = {
} as const
export type PrometheusLegacyDeprecatedSettingVmSystemInfoCollector =
- typeof PrometheusLegacyDeprecatedSettingVmSystemInfoCollector[keyof typeof PrometheusLegacyDeprecatedSettingVmSystemInfoCollector]
+ (typeof PrometheusLegacyDeprecatedSettingVmSystemInfoCollector)[keyof typeof PrometheusLegacyDeprecatedSettingVmSystemInfoCollector]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusLegacyDeprecatedSettingVmSystemInfoCollector = {
@@ -85,7 +72,7 @@ export const PrometheusLegacyDeprecatedSettingVmSystemInfoCollector = {
} as const
export type PrometheusLegacyDeprecatedSettingVmStatisticsCollector =
- typeof PrometheusLegacyDeprecatedSettingVmStatisticsCollector[keyof typeof PrometheusLegacyDeprecatedSettingVmStatisticsCollector]
+ (typeof PrometheusLegacyDeprecatedSettingVmStatisticsCollector)[keyof typeof PrometheusLegacyDeprecatedSettingVmStatisticsCollector]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusLegacyDeprecatedSettingVmStatisticsCollector = {
@@ -94,7 +81,7 @@ export const PrometheusLegacyDeprecatedSettingVmStatisticsCollector = {
} as const
export type PrometheusLegacyDeprecatedSettingMnesiaCollector =
- typeof PrometheusLegacyDeprecatedSettingMnesiaCollector[keyof typeof PrometheusLegacyDeprecatedSettingMnesiaCollector]
+ (typeof PrometheusLegacyDeprecatedSettingMnesiaCollector)[keyof typeof PrometheusLegacyDeprecatedSettingMnesiaCollector]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusLegacyDeprecatedSettingMnesiaCollector = {
@@ -103,7 +90,7 @@ export const PrometheusLegacyDeprecatedSettingMnesiaCollector = {
} as const
export type PrometheusLegacyDeprecatedSettingVmDistCollector =
- typeof PrometheusLegacyDeprecatedSettingVmDistCollector[keyof typeof PrometheusLegacyDeprecatedSettingVmDistCollector]
+ (typeof PrometheusLegacyDeprecatedSettingVmDistCollector)[keyof typeof PrometheusLegacyDeprecatedSettingVmDistCollector]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusLegacyDeprecatedSettingVmDistCollector = {
@@ -128,7 +115,7 @@ export interface PrometheusLegacyDeprecatedSetting {
}
export type PrometheusCollectorsVmMsacc =
- typeof PrometheusCollectorsVmMsacc[keyof typeof PrometheusCollectorsVmMsacc]
+ (typeof PrometheusCollectorsVmMsacc)[keyof typeof PrometheusCollectorsVmMsacc]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusCollectorsVmMsacc = {
@@ -137,7 +124,7 @@ export const PrometheusCollectorsVmMsacc = {
} as const
export type PrometheusCollectorsVmMemory =
- typeof PrometheusCollectorsVmMemory[keyof typeof PrometheusCollectorsVmMemory]
+ (typeof PrometheusCollectorsVmMemory)[keyof typeof PrometheusCollectorsVmMemory]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusCollectorsVmMemory = {
@@ -146,7 +133,7 @@ export const PrometheusCollectorsVmMemory = {
} as const
export type PrometheusCollectorsVmSystemInfo =
- typeof PrometheusCollectorsVmSystemInfo[keyof typeof PrometheusCollectorsVmSystemInfo]
+ (typeof PrometheusCollectorsVmSystemInfo)[keyof typeof PrometheusCollectorsVmSystemInfo]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusCollectorsVmSystemInfo = {
@@ -155,7 +142,7 @@ export const PrometheusCollectorsVmSystemInfo = {
} as const
export type PrometheusCollectorsVmStatistics =
- typeof PrometheusCollectorsVmStatistics[keyof typeof PrometheusCollectorsVmStatistics]
+ (typeof PrometheusCollectorsVmStatistics)[keyof typeof PrometheusCollectorsVmStatistics]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusCollectorsVmStatistics = {
@@ -164,7 +151,7 @@ export const PrometheusCollectorsVmStatistics = {
} as const
export type PrometheusCollectorsMnesia =
- typeof PrometheusCollectorsMnesia[keyof typeof PrometheusCollectorsMnesia]
+ (typeof PrometheusCollectorsMnesia)[keyof typeof PrometheusCollectorsMnesia]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusCollectorsMnesia = {
@@ -173,7 +160,7 @@ export const PrometheusCollectorsMnesia = {
} as const
export type PrometheusCollectorsVmDist =
- typeof PrometheusCollectorsVmDist[keyof typeof PrometheusCollectorsVmDist]
+ (typeof PrometheusCollectorsVmDist)[keyof typeof PrometheusCollectorsVmDist]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PrometheusCollectorsVmDist = {
@@ -189,99 +176,3 @@ export interface PrometheusCollectors {
vm_memory: PrometheusCollectorsVmMemory
vm_msacc: PrometheusCollectorsVmMsacc
}
-
-export interface OpentelemetryTraceFilter {
- trace_all?: boolean
-}
-
-export interface OpentelemetryOtelTraces {
- enable?: boolean
- scheduled_delay?: string
- filter?: OpentelemetryTraceFilter
-}
-
-export interface OpentelemetryOtelMetrics {
- enable: boolean
- interval?: string
-}
-
-export type OpentelemetryOtelLogsLevel =
- typeof OpentelemetryOtelLogsLevel[keyof typeof OpentelemetryOtelLogsLevel]
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const OpentelemetryOtelLogsLevel = {
- debug: 'debug',
- info: 'info',
- notice: 'notice',
- warning: 'warning',
- error: 'error',
- critical: 'critical',
- alert: 'alert',
- emergency: 'emergency',
- all: 'all',
-} as const
-
-export interface OpentelemetryOtelLogs {
- level?: OpentelemetryOtelLogsLevel
- enable?: boolean
- scheduled_delay?: string
-}
-
-export interface OpentelemetryOtelExporter {
- endpoint?: string
- ssl_options?: EmqxSslClientOpts
-}
-
-export interface OpentelemetryOpentelemetry {
- metrics?: OpentelemetryOtelMetrics
- logs?: OpentelemetryOtelLogs
- traces?: OpentelemetryOtelTraces
- exporter?: OpentelemetryOtelExporter
-}
-
-export type EmqxSslClientOptsServerNameIndication = string | 'disable'
-
-export type EmqxSslClientOptsLogLevel =
- typeof EmqxSslClientOptsLogLevel[keyof typeof EmqxSslClientOptsLogLevel]
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const EmqxSslClientOptsLogLevel = {
- emergency: 'emergency',
- alert: 'alert',
- critical: 'critical',
- error: 'error',
- warning: 'warning',
- notice: 'notice',
- info: 'info',
- debug: 'debug',
- none: 'none',
- all: 'all',
-} as const
-
-export type EmqxSslClientOptsVerify =
- typeof EmqxSslClientOptsVerify[keyof typeof EmqxSslClientOptsVerify]
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const EmqxSslClientOptsVerify = {
- verify_peer: 'verify_peer',
- verify_none: 'verify_none',
-} as const
-
-export interface EmqxSslClientOpts {
- cacertfile?: string
- /** @deprecated */
- cacerts?: boolean
- certfile?: string
- keyfile?: string
- verify?: EmqxSslClientOptsVerify
- reuse_sessions?: boolean
- depth?: number
- password?: string
- versions?: string[]
- ciphers?: string[]
- secure_renegotiate?: boolean
- log_level?: EmqxSslClientOptsLogLevel
- hibernate_after?: string
- enable?: boolean
- server_name_indication?: EmqxSslClientOptsServerNameIndication
-}
diff --git a/src/types/schemas/plugins.schemas.ts b/src/types/schemas/plugins.schemas.ts
index b7f7eb6d2..d31271fd6 100644
--- a/src/types/schemas/plugins.schemas.ts
+++ b/src/types/schemas/plugins.schemas.ts
@@ -1,24 +1,18 @@
-export type PostPluginsInstall400Code =
- typeof PostPluginsInstall400Code[keyof typeof PostPluginsInstall400Code]
+export type PutPluginsNameAction404Code =
+ (typeof PutPluginsNameAction404Code)[keyof typeof PutPluginsNameAction404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const PostPluginsInstall400Code = {
- UNEXPECTED_ERROR: 'UNEXPECTED_ERROR',
- ALREADY_INSTALLED: 'ALREADY_INSTALLED',
- BAD_PLUGIN_INFO: 'BAD_PLUGIN_INFO',
+export const PutPluginsNameAction404Code = {
+ NOT_FOUND: 'NOT_FOUND',
} as const
-export type PostPluginsInstall400 = {
- code?: PostPluginsInstall400Code
+export type PutPluginsNameAction404 = {
+ code?: PutPluginsNameAction404Code
message?: string
}
-export type PostPluginsInstallBody = {
- plugin?: Blob
-}
-
export type PostPluginsNameMove400Code =
- typeof PostPluginsNameMove400Code[keyof typeof PostPluginsNameMove400Code]
+ (typeof PostPluginsNameMove400Code)[keyof typeof PostPluginsNameMove400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostPluginsNameMove400Code = {
@@ -30,21 +24,47 @@ export type PostPluginsNameMove400 = {
message?: string
}
-export type PutPluginsNameAction404Code =
- typeof PutPluginsNameAction404Code[keyof typeof PutPluginsNameAction404Code]
+export type DeletePluginsName404Code =
+ (typeof DeletePluginsName404Code)[keyof typeof DeletePluginsName404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const PutPluginsNameAction404Code = {
+export const DeletePluginsName404Code = {
NOT_FOUND: 'NOT_FOUND',
} as const
-export type PutPluginsNameAction404 = {
- code?: PutPluginsNameAction404Code
+export type DeletePluginsName404 = {
+ code?: DeletePluginsName404Code
+ message?: string
+}
+
+export type DeletePluginsName400Code =
+ (typeof DeletePluginsName400Code)[keyof typeof DeletePluginsName400Code]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const DeletePluginsName400Code = {
+ PARAM_ERROR: 'PARAM_ERROR',
+} as const
+
+export type DeletePluginsName400 = {
+ code?: DeletePluginsName400Code
+ message?: string
+}
+
+export type GetPluginsName404Code =
+ (typeof GetPluginsName404Code)[keyof typeof GetPluginsName404Code]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const GetPluginsName404Code = {
+ NOT_FOUND: 'NOT_FOUND',
+} as const
+
+export type GetPluginsName404 = {
+ code?: GetPluginsName404Code
message?: string
}
export type PutPluginsNameConfig404Code =
- typeof PutPluginsNameConfig404Code[keyof typeof PutPluginsNameConfig404Code]
+ (typeof PutPluginsNameConfig404Code)[keyof typeof PutPluginsNameConfig404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutPluginsNameConfig404Code = {
@@ -57,7 +77,7 @@ export type PutPluginsNameConfig404 = {
}
export type PutPluginsNameConfig400Code =
- typeof PutPluginsNameConfig400Code[keyof typeof PutPluginsNameConfig400Code]
+ (typeof PutPluginsNameConfig400Code)[keyof typeof PutPluginsNameConfig400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutPluginsNameConfig400Code = {
@@ -70,10 +90,10 @@ export type PutPluginsNameConfig400 = {
message?: string
}
-export type PutPluginsNameConfigBody = { [key: string]: any }
+export type PutPluginsNameConfigBody = { [key: string]: unknown }
export type GetPluginsNameConfig404Code =
- typeof GetPluginsNameConfig404Code[keyof typeof GetPluginsNameConfig404Code]
+ (typeof GetPluginsNameConfig404Code)[keyof typeof GetPluginsNameConfig404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetPluginsNameConfig404Code = {
@@ -86,7 +106,7 @@ export type GetPluginsNameConfig404 = {
}
export type GetPluginsNameConfig400Code =
- typeof GetPluginsNameConfig400Code[keyof typeof GetPluginsNameConfig400Code]
+ (typeof GetPluginsNameConfig400Code)[keyof typeof GetPluginsNameConfig400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetPluginsNameConfig400Code = {
@@ -98,46 +118,54 @@ export type GetPluginsNameConfig400 = {
message?: string
}
-export type DeletePluginsName404Code =
- typeof DeletePluginsName404Code[keyof typeof DeletePluginsName404Code]
+export type PostPluginsClusterSync404Code =
+ (typeof PostPluginsClusterSync404Code)[keyof typeof PostPluginsClusterSync404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const DeletePluginsName404Code = {
+export const PostPluginsClusterSync404Code = {
NOT_FOUND: 'NOT_FOUND',
} as const
-export type DeletePluginsName404 = {
- code?: DeletePluginsName404Code
+export type PostPluginsClusterSync404 = {
+ code?: PostPluginsClusterSync404Code
message?: string
}
-export type DeletePluginsName400Code =
- typeof DeletePluginsName400Code[keyof typeof DeletePluginsName400Code]
+export type PostPluginsClusterSync400Code =
+ (typeof PostPluginsClusterSync400Code)[keyof typeof PostPluginsClusterSync400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const DeletePluginsName400Code = {
- PARAM_ERROR: 'PARAM_ERROR',
+export const PostPluginsClusterSync400Code = {
+ BAD_NODE: 'BAD_NODE',
+ BAD_PLUGIN_INFO: 'BAD_PLUGIN_INFO',
} as const
-export type DeletePluginsName400 = {
- code?: DeletePluginsName400Code
+export type PostPluginsClusterSync400 = {
+ code?: PostPluginsClusterSync400Code
message?: string
}
-export type GetPluginsName404Code = typeof GetPluginsName404Code[keyof typeof GetPluginsName404Code]
+export type PostPluginsInstall400Code =
+ (typeof PostPluginsInstall400Code)[keyof typeof PostPluginsInstall400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const GetPluginsName404Code = {
- NOT_FOUND: 'NOT_FOUND',
+export const PostPluginsInstall400Code = {
+ UNEXPECTED_ERROR: 'UNEXPECTED_ERROR',
+ ALREADY_INSTALLED: 'ALREADY_INSTALLED',
+ BAD_PLUGIN_INFO: 'BAD_PLUGIN_INFO',
} as const
-export type GetPluginsName404 = {
- code?: GetPluginsName404Code
+export type PostPluginsInstall400 = {
+ code?: PostPluginsInstall400Code
message?: string
}
+export type PostPluginsInstallBody = {
+ plugin?: Blob
+}
+
export type GetPluginsNameSchema404Code =
- typeof GetPluginsNameSchema404Code[keyof typeof GetPluginsNameSchema404Code]
+ (typeof GetPluginsNameSchema404Code)[keyof typeof GetPluginsNameSchema404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetPluginsNameSchema404Code = {
@@ -150,8 +178,13 @@ export type GetPluginsNameSchema404 = {
message?: string
}
+export interface PluginsSyncRequest {
+ name: string
+ node: string
+}
+
export type PluginsRunningStatusStatus =
- typeof PluginsRunningStatusStatus[keyof typeof PluginsRunningStatusStatus]
+ (typeof PluginsRunningStatusStatus)[keyof typeof PluginsRunningStatusStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PluginsRunningStatusStatus = {
@@ -170,7 +203,7 @@ export interface PluginsPosition {
position?: PluginsPositionPosition
}
-export type PluginsPluginCompatibility = { [key: string]: any }
+export type PluginsPluginCompatibility = { [key: string]: unknown }
export interface PluginsBuilder {
contact?: string
@@ -179,19 +212,19 @@ export interface PluginsBuilder {
}
export interface PluginsPlugin {
- name: string
author?: string[]
builder?: PluginsBuilder
built_on_otp_release?: string
compatibility?: PluginsPluginCompatibility
- git_commit_or_build_date?: string
+ description: string
functionality?: string[]
+ git_commit_or_build_date?: string
git_ref?: string
metadata_vsn?: string
- rel_vsn: string
+ name: string
+ readme?: string
rel_apps: string[]
+ rel_vsn: string
repo?: string
- description: string
running_status: PluginsRunningStatus[]
- readme?: string
}
diff --git a/src/types/schemas/retainer.schemas.ts b/src/types/schemas/retainer.schemas.ts
index f36095dfe..625529a74 100644
--- a/src/types/schemas/retainer.schemas.ts
+++ b/src/types/schemas/retainer.schemas.ts
@@ -1,5 +1,5 @@
export type PutMqttRetainer400Code =
- typeof PutMqttRetainer400Code[keyof typeof PutMqttRetainer400Code]
+ (typeof PutMqttRetainer400Code)[keyof typeof PutMqttRetainer400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutMqttRetainer400Code = {
@@ -12,7 +12,7 @@ export type PutMqttRetainer400 = {
}
export type GetMqttRetainer404Code =
- typeof GetMqttRetainer404Code[keyof typeof GetMqttRetainer404Code]
+ (typeof GetMqttRetainer404Code)[keyof typeof GetMqttRetainer404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetMqttRetainer404Code = {
@@ -25,7 +25,7 @@ export type GetMqttRetainer404 = {
}
export type DeleteMqttRetainerMessageTopic404Code =
- typeof DeleteMqttRetainerMessageTopic404Code[keyof typeof DeleteMqttRetainerMessageTopic404Code]
+ (typeof DeleteMqttRetainerMessageTopic404Code)[keyof typeof DeleteMqttRetainerMessageTopic404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteMqttRetainerMessageTopic404Code = {
@@ -38,7 +38,7 @@ export type DeleteMqttRetainerMessageTopic404 = {
}
export type DeleteMqttRetainerMessageTopic400Code =
- typeof DeleteMqttRetainerMessageTopic400Code[keyof typeof DeleteMqttRetainerMessageTopic400Code]
+ (typeof DeleteMqttRetainerMessageTopic400Code)[keyof typeof DeleteMqttRetainerMessageTopic400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteMqttRetainerMessageTopic400Code = {
@@ -51,7 +51,7 @@ export type DeleteMqttRetainerMessageTopic400 = {
}
export type GetMqttRetainerMessageTopic404Code =
- typeof GetMqttRetainerMessageTopic404Code[keyof typeof GetMqttRetainerMessageTopic404Code]
+ (typeof GetMqttRetainerMessageTopic404Code)[keyof typeof GetMqttRetainerMessageTopic404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetMqttRetainerMessageTopic404Code = {
@@ -64,7 +64,7 @@ export type GetMqttRetainerMessageTopic404 = {
}
export type GetMqttRetainerMessageTopic400Code =
- typeof GetMqttRetainerMessageTopic400Code[keyof typeof GetMqttRetainerMessageTopic400Code]
+ (typeof GetMqttRetainerMessageTopic400Code)[keyof typeof GetMqttRetainerMessageTopic400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetMqttRetainerMessageTopic400Code = {
@@ -77,7 +77,7 @@ export type GetMqttRetainerMessageTopic400 = {
}
export type GetMqttRetainerMessages400Code =
- typeof GetMqttRetainerMessages400Code[keyof typeof GetMqttRetainerMessages400Code]
+ (typeof GetMqttRetainerMessages400Code)[keyof typeof GetMqttRetainerMessages400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetMqttRetainerMessages400Code = {
@@ -103,7 +103,7 @@ export type GetMqttRetainerMessagesParams = {
export type RetainerRetainerMsgExpiryIntervalOverride = string | 'disabled'
export type RetainerMnesiaConfigStorageType =
- typeof RetainerMnesiaConfigStorageType[keyof typeof RetainerMnesiaConfigStorageType]
+ (typeof RetainerMnesiaConfigStorageType)[keyof typeof RetainerMnesiaConfigStorageType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RetainerMnesiaConfigStorageType = {
@@ -112,7 +112,7 @@ export const RetainerMnesiaConfigStorageType = {
} as const
export type RetainerMnesiaConfigType =
- typeof RetainerMnesiaConfigType[keyof typeof RetainerMnesiaConfigType]
+ (typeof RetainerMnesiaConfigType)[keyof typeof RetainerMnesiaConfigType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RetainerMnesiaConfigType = {
@@ -136,6 +136,7 @@ export interface RetainerRetainer {
max_payload_size?: string
stop_publish_clear_msg?: boolean
delivery_rate?: string
+ max_publish_rate?: string
backend?: RetainerMnesiaConfig
}
diff --git a/src/types/schemas/rules.schemas.ts b/src/types/schemas/rules.schemas.ts
index 4beaf83b2..5a4af311e 100644
--- a/src/types/schemas/rules.schemas.ts
+++ b/src/types/schemas/rules.schemas.ts
@@ -1,4 +1,4 @@
-export type PutRuleEngine400Code = typeof PutRuleEngine400Code[keyof typeof PutRuleEngine400Code]
+export type PutRuleEngine400Code = (typeof PutRuleEngine400Code)[keyof typeof PutRuleEngine400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutRuleEngine400Code = {
@@ -10,7 +10,7 @@ export type PutRuleEngine400 = {
message?: string
}
-export type DeleteRulesId404Code = typeof DeleteRulesId404Code[keyof typeof DeleteRulesId404Code]
+export type DeleteRulesId404Code = (typeof DeleteRulesId404Code)[keyof typeof DeleteRulesId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteRulesId404Code = {
@@ -22,7 +22,7 @@ export type DeleteRulesId404 = {
message?: string
}
-export type PutRulesId400Code = typeof PutRulesId400Code[keyof typeof PutRulesId400Code]
+export type PutRulesId400Code = (typeof PutRulesId400Code)[keyof typeof PutRulesId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutRulesId400Code = {
@@ -34,7 +34,7 @@ export type PutRulesId400 = {
message?: string
}
-export type GetRulesId404Code = typeof GetRulesId404Code[keyof typeof GetRulesId404Code]
+export type GetRulesId404Code = (typeof GetRulesId404Code)[keyof typeof GetRulesId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetRulesId404Code = {
@@ -47,7 +47,7 @@ export type GetRulesId404 = {
}
export type PutRulesIdMetricsReset404Code =
- typeof PutRulesIdMetricsReset404Code[keyof typeof PutRulesIdMetricsReset404Code]
+ (typeof PutRulesIdMetricsReset404Code)[keyof typeof PutRulesIdMetricsReset404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutRulesIdMetricsReset404Code = {
@@ -60,7 +60,7 @@ export type PutRulesIdMetricsReset404 = {
}
export type GetRulesIdMetrics404Code =
- typeof GetRulesIdMetrics404Code[keyof typeof GetRulesIdMetrics404Code]
+ (typeof GetRulesIdMetrics404Code)[keyof typeof GetRulesIdMetrics404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetRulesIdMetrics404Code = {
@@ -72,7 +72,7 @@ export type GetRulesIdMetrics404 = {
message?: string
}
-export type PostRules400Code = typeof PostRules400Code[keyof typeof PostRules400Code]
+export type PostRules400Code = (typeof PostRules400Code)[keyof typeof PostRules400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostRules400Code = {
@@ -84,7 +84,7 @@ export type PostRules400 = {
message?: string
}
-export type GetRules400Code = typeof GetRules400Code[keyof typeof GetRules400Code]
+export type GetRules400Code = (typeof GetRules400Code)[keyof typeof GetRules400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetRules400Code = {
@@ -115,7 +115,7 @@ export type GetRulesParams = {
}
export type PostRulesIdTest412Code =
- typeof PostRulesIdTest412Code[keyof typeof PostRulesIdTest412Code]
+ (typeof PostRulesIdTest412Code)[keyof typeof PostRulesIdTest412Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostRulesIdTest412Code = {
@@ -128,7 +128,7 @@ export type PostRulesIdTest412 = {
}
export type PostRulesIdTest404Code =
- typeof PostRulesIdTest404Code[keyof typeof PostRulesIdTest404Code]
+ (typeof PostRulesIdTest404Code)[keyof typeof PostRulesIdTest404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostRulesIdTest404Code = {
@@ -141,7 +141,7 @@ export type PostRulesIdTest404 = {
}
export type PostRulesIdTest400Code =
- typeof PostRulesIdTest400Code[keyof typeof PostRulesIdTest400Code]
+ (typeof PostRulesIdTest400Code)[keyof typeof PostRulesIdTest400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostRulesIdTest400Code = {
@@ -153,7 +153,7 @@ export type PostRulesIdTest400 = {
message?: string
}
-export type PostRuleTest412Code = typeof PostRuleTest412Code[keyof typeof PostRuleTest412Code]
+export type PostRuleTest412Code = (typeof PostRuleTest412Code)[keyof typeof PostRuleTest412Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostRuleTest412Code = {
@@ -165,7 +165,7 @@ export type PostRuleTest412 = {
message?: string
}
-export type PostRuleTest400Code = typeof PostRuleTest400Code[keyof typeof PostRuleTest400Code]
+export type PostRuleTest400Code = (typeof PostRuleTest400Code)[keyof typeof PostRuleTest400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostRuleTest400Code = {
@@ -189,21 +189,23 @@ export interface RuleEngineUserProvidedFunction {
}
export type RuleEngineRuleTestContext =
- | RuleEngineCtxMessageTransformationFailed
+ | RuleEngineCtxUnsub
+ | RuleEngineCtxSub
| RuleEngineCtxSchemaValidationFailed
+ | RuleEngineCtxMessageTransformationFailed
+ | RuleEngineCtxPub
+ | RuleEngineCtxDropped
+ | RuleEngineCtxDelivered
+ | RuleEngineCtxAcked
| RuleEngineCtxDeliveryDropped
- | RuleEngineCtxBridgeMqtt
- | RuleEngineCtxCheckAuthnComplete
- | RuleEngineCtxCheckAuthzComplete
- | RuleEngineCtxConnack
| RuleEngineCtxDisconnected
| RuleEngineCtxConnected
- | RuleEngineCtxDropped
- | RuleEngineCtxAcked
- | RuleEngineCtxDelivered
- | RuleEngineCtxUnsub
- | RuleEngineCtxSub
- | RuleEngineCtxPub
+ | RuleEngineCtxConnack
+ | RuleEngineCtxCheckAuthzComplete
+ | RuleEngineCtxCheckAuthnComplete
+ | RuleEngineCtxAlarmDeactivated
+ | RuleEngineCtxAlarmActivated
+ | RuleEngineCtxBridgeMqtt
export interface RuleEngineRuleTest {
context?: RuleEngineRuleTestContext
@@ -241,10 +243,12 @@ export type RuleEngineRuleEventsTestColumns = { [key: string]: any }
export type RuleEngineRuleEventsColumns = { [key: string]: any }
export type RuleEngineRuleEventsEvent =
- typeof RuleEngineRuleEventsEvent[keyof typeof RuleEngineRuleEventsEvent]
+ (typeof RuleEngineRuleEventsEvent)[keyof typeof RuleEngineRuleEventsEvent]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineRuleEventsEvent = {
+ '$events/sys/alarm_activated': '$events/sys/alarm_activated',
+ '$events/sys/alarm_deactivated': '$events/sys/alarm_deactivated',
'$events/client_connected': '$events/client_connected',
'$events/client_disconnected': '$events/client_disconnected',
'$events/client_connack': '$events/client_connack',
@@ -290,6 +294,25 @@ export interface RuleEngineRuleCreation {
metadata?: RuleEngineRuleCreationMetadata
}
+export type RuleEngineRuleApplyTestContext =
+ | RuleEngineCtxUnsub
+ | RuleEngineCtxSub
+ | RuleEngineCtxSchemaValidationFailed
+ | RuleEngineCtxMessageTransformationFailed
+ | RuleEngineCtxPub
+ | RuleEngineCtxDropped
+ | RuleEngineCtxDelivered
+ | RuleEngineCtxAcked
+ | RuleEngineCtxDeliveryDropped
+ | RuleEngineCtxDisconnected
+ | RuleEngineCtxConnected
+ | RuleEngineCtxConnack
+ | RuleEngineCtxCheckAuthzComplete
+ | RuleEngineCtxCheckAuthnComplete
+ | RuleEngineCtxAlarmDeactivated
+ | RuleEngineCtxAlarmActivated
+ | RuleEngineCtxBridgeMqtt
+
export interface RuleEngineRuleApplyTest {
context?: RuleEngineRuleApplyTestContext
stop_action_after_template_rendering?: boolean
@@ -355,7 +378,7 @@ export interface RuleEngineMetrics {
}
export type RuleEngineCtxUnsubEventType =
- typeof RuleEngineCtxUnsubEventType[keyof typeof RuleEngineCtxUnsubEventType]
+ (typeof RuleEngineCtxUnsubEventType)[keyof typeof RuleEngineCtxUnsubEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxUnsubEventType = {
@@ -374,7 +397,7 @@ export interface RuleEngineCtxUnsub {
}
export type RuleEngineCtxSubEventType =
- typeof RuleEngineCtxSubEventType[keyof typeof RuleEngineCtxSubEventType]
+ (typeof RuleEngineCtxSubEventType)[keyof typeof RuleEngineCtxSubEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxSubEventType = {
@@ -393,7 +416,7 @@ export interface RuleEngineCtxSub {
}
export type RuleEngineCtxSchemaValidationFailedEventType =
- typeof RuleEngineCtxSchemaValidationFailedEventType[keyof typeof RuleEngineCtxSchemaValidationFailedEventType]
+ (typeof RuleEngineCtxSchemaValidationFailedEventType)[keyof typeof RuleEngineCtxSchemaValidationFailedEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxSchemaValidationFailedEventType = {
@@ -413,7 +436,7 @@ export interface RuleEngineCtxSchemaValidationFailed {
}
export type RuleEngineCtxPubEventType =
- typeof RuleEngineCtxPubEventType[keyof typeof RuleEngineCtxPubEventType]
+ (typeof RuleEngineCtxPubEventType)[keyof typeof RuleEngineCtxPubEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxPubEventType = {
@@ -433,7 +456,7 @@ export interface RuleEngineCtxPub {
}
export type RuleEngineCtxMessageTransformationFailedEventType =
- typeof RuleEngineCtxMessageTransformationFailedEventType[keyof typeof RuleEngineCtxMessageTransformationFailedEventType]
+ (typeof RuleEngineCtxMessageTransformationFailedEventType)[keyof typeof RuleEngineCtxMessageTransformationFailedEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxMessageTransformationFailedEventType = {
@@ -453,7 +476,7 @@ export interface RuleEngineCtxMessageTransformationFailed {
}
export type RuleEngineCtxDroppedEventType =
- typeof RuleEngineCtxDroppedEventType[keyof typeof RuleEngineCtxDroppedEventType]
+ (typeof RuleEngineCtxDroppedEventType)[keyof typeof RuleEngineCtxDroppedEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxDroppedEventType = {
@@ -473,25 +496,8 @@ export interface RuleEngineCtxDropped {
qos?: number
}
-export type RuleEngineRuleApplyTestContext =
- | RuleEngineCtxMessageTransformationFailed
- | RuleEngineCtxSchemaValidationFailed
- | RuleEngineCtxDeliveryDropped
- | RuleEngineCtxBridgeMqtt
- | RuleEngineCtxCheckAuthnComplete
- | RuleEngineCtxCheckAuthzComplete
- | RuleEngineCtxConnack
- | RuleEngineCtxDisconnected
- | RuleEngineCtxConnected
- | RuleEngineCtxDropped
- | RuleEngineCtxAcked
- | RuleEngineCtxDelivered
- | RuleEngineCtxUnsub
- | RuleEngineCtxSub
- | RuleEngineCtxPub
-
export type RuleEngineCtxDisconnectedEventType =
- typeof RuleEngineCtxDisconnectedEventType[keyof typeof RuleEngineCtxDisconnectedEventType]
+ (typeof RuleEngineCtxDisconnectedEventType)[keyof typeof RuleEngineCtxDisconnectedEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxDisconnectedEventType = {
@@ -509,7 +515,7 @@ export interface RuleEngineCtxDisconnected {
}
export type RuleEngineCtxDeliveryDroppedEventType =
- typeof RuleEngineCtxDeliveryDroppedEventType[keyof typeof RuleEngineCtxDeliveryDroppedEventType]
+ (typeof RuleEngineCtxDeliveryDroppedEventType)[keyof typeof RuleEngineCtxDeliveryDroppedEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxDeliveryDroppedEventType = {
@@ -532,7 +538,7 @@ export interface RuleEngineCtxDeliveryDropped {
}
export type RuleEngineCtxDeliveredEventType =
- typeof RuleEngineCtxDeliveredEventType[keyof typeof RuleEngineCtxDeliveredEventType]
+ (typeof RuleEngineCtxDeliveredEventType)[keyof typeof RuleEngineCtxDeliveredEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxDeliveredEventType = {
@@ -554,7 +560,7 @@ export interface RuleEngineCtxDelivered {
}
export type RuleEngineCtxConnectedEventType =
- typeof RuleEngineCtxConnectedEventType[keyof typeof RuleEngineCtxConnectedEventType]
+ (typeof RuleEngineCtxConnectedEventType)[keyof typeof RuleEngineCtxConnectedEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxConnectedEventType = {
@@ -578,7 +584,7 @@ export interface RuleEngineCtxConnected {
}
export type RuleEngineCtxConnackEventType =
- typeof RuleEngineCtxConnackEventType[keyof typeof RuleEngineCtxConnackEventType]
+ (typeof RuleEngineCtxConnackEventType)[keyof typeof RuleEngineCtxConnackEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxConnackEventType = {
@@ -601,7 +607,7 @@ export interface RuleEngineCtxConnack {
}
export type RuleEngineCtxCheckAuthzCompleteEventType =
- typeof RuleEngineCtxCheckAuthzCompleteEventType[keyof typeof RuleEngineCtxCheckAuthzCompleteEventType]
+ (typeof RuleEngineCtxCheckAuthzCompleteEventType)[keyof typeof RuleEngineCtxCheckAuthzCompleteEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxCheckAuthzCompleteEventType = {
@@ -620,7 +626,7 @@ export interface RuleEngineCtxCheckAuthzComplete {
}
export type RuleEngineCtxCheckAuthnCompleteEventType =
- typeof RuleEngineCtxCheckAuthnCompleteEventType[keyof typeof RuleEngineCtxCheckAuthnCompleteEventType]
+ (typeof RuleEngineCtxCheckAuthnCompleteEventType)[keyof typeof RuleEngineCtxCheckAuthnCompleteEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxCheckAuthnCompleteEventType = {
@@ -638,7 +644,7 @@ export interface RuleEngineCtxCheckAuthnComplete {
}
export type RuleEngineCtxBridgeMqttEventType =
- typeof RuleEngineCtxBridgeMqttEventType[keyof typeof RuleEngineCtxBridgeMqttEventType]
+ (typeof RuleEngineCtxBridgeMqttEventType)[keyof typeof RuleEngineCtxBridgeMqttEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxBridgeMqttEventType = {
@@ -657,8 +663,45 @@ export interface RuleEngineCtxBridgeMqtt {
qos?: number
}
+export type RuleEngineCtxAlarmDeactivatedDetails = { [key: string]: any }
+
+export type RuleEngineCtxAlarmDeactivatedEventType =
+ (typeof RuleEngineCtxAlarmDeactivatedEventType)[keyof typeof RuleEngineCtxAlarmDeactivatedEventType]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const RuleEngineCtxAlarmDeactivatedEventType = {
+ alarm_deactivated: 'alarm_deactivated',
+} as const
+
+export interface RuleEngineCtxAlarmDeactivated {
+ event_type: RuleEngineCtxAlarmDeactivatedEventType
+ name?: string
+ message?: string
+ details?: RuleEngineCtxAlarmDeactivatedDetails
+ activated_at?: number
+ deactivated_at?: number
+}
+
+export type RuleEngineCtxAlarmActivatedDetails = { [key: string]: any }
+
+export type RuleEngineCtxAlarmActivatedEventType =
+ (typeof RuleEngineCtxAlarmActivatedEventType)[keyof typeof RuleEngineCtxAlarmActivatedEventType]
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const RuleEngineCtxAlarmActivatedEventType = {
+ alarm_activated: 'alarm_activated',
+} as const
+
+export interface RuleEngineCtxAlarmActivated {
+ event_type: RuleEngineCtxAlarmActivatedEventType
+ name?: string
+ message?: string
+ details?: RuleEngineCtxAlarmActivatedDetails
+ activated_at?: number
+}
+
export type RuleEngineCtxAckedEventType =
- typeof RuleEngineCtxAckedEventType[keyof typeof RuleEngineCtxAckedEventType]
+ (typeof RuleEngineCtxAckedEventType)[keyof typeof RuleEngineCtxAckedEventType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineCtxAckedEventType = {
@@ -680,7 +723,7 @@ export interface RuleEngineCtxAcked {
}
export type RuleEngineBuiltinActionRepublishFunction =
- typeof RuleEngineBuiltinActionRepublishFunction[keyof typeof RuleEngineBuiltinActionRepublishFunction]
+ (typeof RuleEngineBuiltinActionRepublishFunction)[keyof typeof RuleEngineBuiltinActionRepublishFunction]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineBuiltinActionRepublishFunction = {
@@ -693,7 +736,7 @@ export interface RuleEngineBuiltinActionRepublish {
}
export type RuleEngineBuiltinActionConsoleFunction =
- typeof RuleEngineBuiltinActionConsoleFunction[keyof typeof RuleEngineBuiltinActionConsoleFunction]
+ (typeof RuleEngineBuiltinActionConsoleFunction)[keyof typeof RuleEngineBuiltinActionConsoleFunction]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const RuleEngineBuiltinActionConsoleFunction = {
diff --git a/src/types/schemas/sources.schemas.ts b/src/types/schemas/sources.schemas.ts
index 864cad339..87edeb618 100644
--- a/src/types/schemas/sources.schemas.ts
+++ b/src/types/schemas/sources.schemas.ts
@@ -1,5 +1,5 @@
export type PostSourcesIdOperation503Code =
- typeof PostSourcesIdOperation503Code[keyof typeof PostSourcesIdOperation503Code]
+ (typeof PostSourcesIdOperation503Code)[keyof typeof PostSourcesIdOperation503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostSourcesIdOperation503Code = {
@@ -12,7 +12,7 @@ export type PostSourcesIdOperation503 = {
}
export type PostSourcesIdOperation501Code =
- typeof PostSourcesIdOperation501Code[keyof typeof PostSourcesIdOperation501Code]
+ (typeof PostSourcesIdOperation501Code)[keyof typeof PostSourcesIdOperation501Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostSourcesIdOperation501Code = {
@@ -25,7 +25,7 @@ export type PostSourcesIdOperation501 = {
}
export type PostSourcesIdOperation404Code =
- typeof PostSourcesIdOperation404Code[keyof typeof PostSourcesIdOperation404Code]
+ (typeof PostSourcesIdOperation404Code)[keyof typeof PostSourcesIdOperation404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostSourcesIdOperation404Code = {
@@ -38,7 +38,7 @@ export type PostSourcesIdOperation404 = {
}
export type PostSourcesIdOperation400Code =
- typeof PostSourcesIdOperation400Code[keyof typeof PostSourcesIdOperation400Code]
+ (typeof PostSourcesIdOperation400Code)[keyof typeof PostSourcesIdOperation400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostSourcesIdOperation400Code = {
@@ -51,7 +51,7 @@ export type PostSourcesIdOperation400 = {
}
export type GetSourcesIdMetrics404Code =
- typeof GetSourcesIdMetrics404Code[keyof typeof GetSourcesIdMetrics404Code]
+ (typeof GetSourcesIdMetrics404Code)[keyof typeof GetSourcesIdMetrics404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetSourcesIdMetrics404Code = {
@@ -69,7 +69,7 @@ export type GetSourcesIdMetrics200 = {
}
export type PostSourcesProbe400Code =
- typeof PostSourcesProbe400Code[keyof typeof PostSourcesProbe400Code]
+ (typeof PostSourcesProbe400Code)[keyof typeof PostSourcesProbe400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostSourcesProbe400Code = {
@@ -82,7 +82,7 @@ export type PostSourcesProbe400 = {
}
export type PutSourcesIdEnableEnable503Code =
- typeof PutSourcesIdEnableEnable503Code[keyof typeof PutSourcesIdEnableEnable503Code]
+ (typeof PutSourcesIdEnableEnable503Code)[keyof typeof PutSourcesIdEnableEnable503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutSourcesIdEnableEnable503Code = {
@@ -95,7 +95,7 @@ export type PutSourcesIdEnableEnable503 = {
}
export type PutSourcesIdEnableEnable404Code =
- typeof PutSourcesIdEnableEnable404Code[keyof typeof PutSourcesIdEnableEnable404Code]
+ (typeof PutSourcesIdEnableEnable404Code)[keyof typeof PutSourcesIdEnableEnable404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutSourcesIdEnableEnable404Code = {
@@ -108,7 +108,7 @@ export type PutSourcesIdEnableEnable404 = {
}
export type PutSourcesIdMetricsReset404Code =
- typeof PutSourcesIdMetricsReset404Code[keyof typeof PutSourcesIdMetricsReset404Code]
+ (typeof PutSourcesIdMetricsReset404Code)[keyof typeof PutSourcesIdMetricsReset404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutSourcesIdMetricsReset404Code = {
@@ -120,7 +120,8 @@ export type PutSourcesIdMetricsReset404 = {
message?: string
}
-export type GetSourceTypes200Item = typeof GetSourceTypes200Item[keyof typeof GetSourceTypes200Item]
+export type GetSourceTypes200Item =
+ (typeof GetSourceTypes200Item)[keyof typeof GetSourceTypes200Item]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetSourceTypes200Item = {
@@ -128,7 +129,7 @@ export const GetSourceTypes200Item = {
} as const
export type DeleteSourcesId503Code =
- typeof DeleteSourcesId503Code[keyof typeof DeleteSourcesId503Code]
+ (typeof DeleteSourcesId503Code)[keyof typeof DeleteSourcesId503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteSourcesId503Code = {
@@ -141,7 +142,7 @@ export type DeleteSourcesId503 = {
}
export type DeleteSourcesId404Code =
- typeof DeleteSourcesId404Code[keyof typeof DeleteSourcesId404Code]
+ (typeof DeleteSourcesId404Code)[keyof typeof DeleteSourcesId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteSourcesId404Code = {
@@ -154,7 +155,7 @@ export type DeleteSourcesId404 = {
}
export type DeleteSourcesId400Code =
- typeof DeleteSourcesId400Code[keyof typeof DeleteSourcesId400Code]
+ (typeof DeleteSourcesId400Code)[keyof typeof DeleteSourcesId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const DeleteSourcesId400Code = {
@@ -171,7 +172,7 @@ export type DeleteSourcesIdParams = {
also_delete_dep_actions?: boolean
}
-export type PutSourcesId503Code = typeof PutSourcesId503Code[keyof typeof PutSourcesId503Code]
+export type PutSourcesId503Code = (typeof PutSourcesId503Code)[keyof typeof PutSourcesId503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutSourcesId503Code = {
@@ -183,7 +184,7 @@ export type PutSourcesId503 = {
message?: string
}
-export type PutSourcesId404Code = typeof PutSourcesId404Code[keyof typeof PutSourcesId404Code]
+export type PutSourcesId404Code = (typeof PutSourcesId404Code)[keyof typeof PutSourcesId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutSourcesId404Code = {
@@ -195,7 +196,7 @@ export type PutSourcesId404 = {
message?: string
}
-export type PutSourcesId400Code = typeof PutSourcesId400Code[keyof typeof PutSourcesId400Code]
+export type PutSourcesId400Code = (typeof PutSourcesId400Code)[keyof typeof PutSourcesId400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PutSourcesId400Code = {
@@ -207,7 +208,7 @@ export type PutSourcesId400 = {
message?: string
}
-export type GetSourcesId404Code = typeof GetSourcesId404Code[keyof typeof GetSourcesId404Code]
+export type GetSourcesId404Code = (typeof GetSourcesId404Code)[keyof typeof GetSourcesId404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetSourcesId404Code = {
@@ -219,7 +220,7 @@ export type GetSourcesId404 = {
message?: string
}
-export type PostSources400Code = typeof PostSources400Code[keyof typeof PostSources400Code]
+export type PostSources400Code = (typeof PostSources400Code)[keyof typeof PostSources400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostSources400Code = {
@@ -232,7 +233,7 @@ export type PostSources400 = {
}
export type PostNodesNodeSourcesIdOperation503Code =
- typeof PostNodesNodeSourcesIdOperation503Code[keyof typeof PostNodesNodeSourcesIdOperation503Code]
+ (typeof PostNodesNodeSourcesIdOperation503Code)[keyof typeof PostNodesNodeSourcesIdOperation503Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostNodesNodeSourcesIdOperation503Code = {
@@ -245,7 +246,7 @@ export type PostNodesNodeSourcesIdOperation503 = {
}
export type PostNodesNodeSourcesIdOperation501Code =
- typeof PostNodesNodeSourcesIdOperation501Code[keyof typeof PostNodesNodeSourcesIdOperation501Code]
+ (typeof PostNodesNodeSourcesIdOperation501Code)[keyof typeof PostNodesNodeSourcesIdOperation501Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostNodesNodeSourcesIdOperation501Code = {
@@ -258,7 +259,7 @@ export type PostNodesNodeSourcesIdOperation501 = {
}
export type PostNodesNodeSourcesIdOperation404Code =
- typeof PostNodesNodeSourcesIdOperation404Code[keyof typeof PostNodesNodeSourcesIdOperation404Code]
+ (typeof PostNodesNodeSourcesIdOperation404Code)[keyof typeof PostNodesNodeSourcesIdOperation404Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostNodesNodeSourcesIdOperation404Code = {
@@ -271,7 +272,7 @@ export type PostNodesNodeSourcesIdOperation404 = {
}
export type PostNodesNodeSourcesIdOperation400Code =
- typeof PostNodesNodeSourcesIdOperation400Code[keyof typeof PostNodesNodeSourcesIdOperation400Code]
+ (typeof PostNodesNodeSourcesIdOperation400Code)[keyof typeof PostNodesNodeSourcesIdOperation400Code]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const PostNodesNodeSourcesIdOperation400Code = {
@@ -284,7 +285,7 @@ export type PostNodesNodeSourcesIdOperation400 = {
}
export type BridgeNodeStatusStatus =
- typeof BridgeNodeStatusStatus[keyof typeof BridgeNodeStatusStatus]
+ (typeof BridgeNodeStatusStatus)[keyof typeof BridgeNodeStatusStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeNodeStatusStatus = {
@@ -328,7 +329,7 @@ export interface BridgeMqttPublisherSourceResourceOpts {
}
export type BridgeMqttPublisherPostSourceType =
- typeof BridgeMqttPublisherPostSourceType[keyof typeof BridgeMqttPublisherPostSourceType]
+ (typeof BridgeMqttPublisherPostSourceType)[keyof typeof BridgeMqttPublisherPostSourceType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeMqttPublisherPostSourceType = {
@@ -336,6 +337,7 @@ export const BridgeMqttPublisherPostSourceType = {
} as const
export interface BridgeMqttPublisherIngressParameters {
+ no_local?: boolean
topic: string
qos?: number
}
@@ -361,7 +363,7 @@ export interface BridgeMqttPublisherPostSource {
}
export type BridgeMqttPublisherGetSourceStatus =
- typeof BridgeMqttPublisherGetSourceStatus[keyof typeof BridgeMqttPublisherGetSourceStatus]
+ (typeof BridgeMqttPublisherGetSourceStatus)[keyof typeof BridgeMqttPublisherGetSourceStatus]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeMqttPublisherGetSourceStatus = {
@@ -372,7 +374,7 @@ export const BridgeMqttPublisherGetSourceStatus = {
} as const
export type BridgeMqttPublisherGetSourceType =
- typeof BridgeMqttPublisherGetSourceType[keyof typeof BridgeMqttPublisherGetSourceType]
+ (typeof BridgeMqttPublisherGetSourceType)[keyof typeof BridgeMqttPublisherGetSourceType]
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const BridgeMqttPublisherGetSourceType = {
@@ -392,3 +394,22 @@ export interface BridgeMqttPublisherGetSource {
description?: string
resource_opts?: BridgeMqttPublisherSourceResourceOpts
}
+
+export interface ActionsAndSourcesResponseNodeStatus {
+ node?: string
+ status?: string
+ status_reason?: string
+}
+
+export interface ActionsAndSourcesResponseSummary {
+ enable?: boolean
+ name?: string
+ type?: string
+ description?: string
+ created_at?: number
+ last_modified_at?: number
+ node_status?: ActionsAndSourcesResponseNodeStatus[]
+ rules?: string[]
+ status?: string
+ status_reason?: string
+}
diff --git a/src/types/typeAlias.ts b/src/types/typeAlias.ts
new file mode 100644
index 000000000..dfe0e4f3c
--- /dev/null
+++ b/src/types/typeAlias.ts
@@ -0,0 +1,30 @@
+import { GetAuthentication200Item, AuthnBuiltinDb } from './schemas/authentication.schemas'
+import {
+ EmqxAuthzApiMnesiaRuleItemAction,
+ EmqxAuthzApiMnesiaRuleItemPermission,
+} from './schemas/authorization.schemas'
+import { PostGatewaysNameListenersBody } from './schemas/gatewayListeners.schemas'
+import {
+ EmqxGatewayApiUpdateCoap,
+ EmqxGatewayApiUpdateExproto,
+ EmqxGatewayApiUpdateStomp,
+ EmqxGatewayApiUpdateLwm2m,
+ EmqxGatewayApiUpdateMqttsn,
+} from './schemas/gateways.schemas'
+
+/* GATEWAY */
+export type StompGatewayConfig = EmqxGatewayApiUpdateStomp
+export type CoapGatewayConfig = EmqxGatewayApiUpdateCoap
+export type ExprotoGatewayConfig = EmqxGatewayApiUpdateExproto
+export type Lwm2mGatewayConfig = EmqxGatewayApiUpdateLwm2m
+export type MqttsnGatewayConfig = EmqxGatewayApiUpdateMqttsn
+
+export type GatewayListener = PostGatewaysNameListenersBody
+
+/* AUTHENTICATION */
+export type AuthenticationBuiltInDbConfig = AuthnBuiltinDb
+export type AuthenticationConfig = GetAuthentication200Item & { id: string }
+
+/* AUTHORIZATION */
+export const AuthzRulePermission = EmqxAuthzApiMnesiaRuleItemPermission
+export const AuthzRuleAction = EmqxAuthzApiMnesiaRuleItemAction
diff --git a/src/views/Auth/Authn.vue b/src/views/Auth/Authn.vue
index 84efffec6..ed5275642 100644
--- a/src/views/Auth/Authn.vue
+++ b/src/views/Auth/Authn.vue
@@ -2,13 +2,8 @@
- {{ $t('Auth.users') }}
+ {{ $t('Auth.users') }}
+
import { deleteAuthn } from '@/api/auth'
-import useAuthn, { AuthnItemInTable } from '@/hooks/Auth/useAuthn'
-import { useAuthnMechanismType } from '@/hooks/Auth/useAuthnType'
-import useToggleAuthStatus from '@/hooks/Auth/useToggleAuthStatus'
import { AuthnItem } from '@/types/auth'
-import { Plus } from '@element-plus/icons-vue'
import { ElMessageBox as MB } from 'element-plus'
-import { useI18n } from 'vue-i18n'
-import { useRouter } from 'vue-router'
import AuthItemStatus from './components/AuthItemStatus.vue'
import TableDropdown from './components/TableDropdown.vue'
+import NodeCache from './components/NodeCache.vue'
const router = useRouter()
const { t } = useI18n()
@@ -151,5 +141,5 @@ const findIndex = (row: AuthnItem) => {
diff --git a/src/views/Auth/AuthnCreate.vue b/src/views/Auth/AuthnCreate.vue
index 62bb4b6e2..e8c49a8c3 100644
--- a/src/views/Auth/AuthnCreate.vue
+++ b/src/views/Auth/AuthnCreate.vue
@@ -28,7 +28,7 @@
>
@@ -64,10 +64,10 @@
v-if="!isDisabledDatabase(item.value)"
:value="$t('Base.added')"
class="item"
- :hidden="((!addedAuthn.includes(`${mechanism}_${item.value}`) || gateway) as boolean)"
+ :hidden="!!(!addedAuthn.includes(`${mechanism}_${item.value}`) || gateway)"
>
diff --git a/src/views/Auth/Authz.vue b/src/views/Auth/Authz.vue
index 5ddd0be13..f6186b9c0 100644
--- a/src/views/Auth/Authz.vue
+++ b/src/views/Auth/Authz.vue
@@ -2,16 +2,11 @@
-
{{ $t('Auth.permissions') }}
-
+
import { deleteAuthz } from '@/api/auth'
-import useAuth from '@/hooks/Auth/useAuth'
-import useAuthz, { AuthzItemInTable } from '@/hooks/Auth/useAuthz'
-import useToggleAuthStatus from '@/hooks/Auth/useToggleAuthStatus'
import router from '@/router'
import { AuthzSourceItem } from '@/types/auth'
-import { Plus, Setting } from '@element-plus/icons-vue'
+import { Setting } from '@element-plus/icons-vue'
import { ElMessageBox as MB } from 'element-plus'
-import { useI18n } from 'vue-i18n'
import AuthItemStatus from './components/AuthItemStatus.vue'
import TableDropdown from './components/TableDropdown.vue'
import AuthzSettingDrawer from './components/AuthzSettingDrawer.vue'
-import { ref } from 'vue'
+import NodeCache from './components/NodeCache.vue'
const { t } = useI18n()
@@ -146,5 +136,5 @@ const routeToDetail = function ({ type }: AuthzSourceItem, tab: string) {
diff --git a/src/views/Auth/AuthzCreate.vue b/src/views/Auth/AuthzCreate.vue
index cfb04de79..43fd8ce9f 100644
--- a/src/views/Auth/AuthzCreate.vue
+++ b/src/views/Auth/AuthzCreate.vue
@@ -21,7 +21,7 @@
>
-
diff --git a/src/views/Auth/AuthzDetails.vue b/src/views/Auth/AuthzDetails.vue
index 55d0303cb..c99b5ca12 100644
--- a/src/views/Auth/AuthzDetails.vue
+++ b/src/views/Auth/AuthzDetails.vue
@@ -71,7 +71,7 @@
{{ $t('Base.cancel') }}
-
+
{{ $t('Base.update') }}
-
-
-
- {{ getLabelFromValueInOptionList(row.action, actionOpts) }}
-
-
-
-
- {{ getLabelFromValueInOptionList(row.permission, permissionOpts) }}
-
-
-
+
@@ -111,12 +77,12 @@
-
+
{{ $t('Base.edit') }}
-
-
+
+
{{ $t('Base.delete') }}
-
+
@@ -126,44 +92,83 @@
-
-
-
-
-
-
-
-
-
-
- {{ $t('Base.topic') }}
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ {{ $t('Base.topic') }}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- {{ $t('Base.add') }}
-
-
-
-
- {{ $t('Base.up') }}
-
-
- {{ $t('Base.down') }}
-
-
- {{ $t('Base.delete') }}
-
-
-
-
+
+
+
+
+
+ {{ $t('Base.add') }}
+
+
+
+
+ {{ $t('Base.up') }}
+
+
+ {{ $t('Base.down') }}
+
+
+ {{ $t('Base.delete') }}
+
+
+
+
+
@@ -255,8 +240,7 @@
-
diff --git a/src/views/Auth/components/DatabaseConfig.vue b/src/views/Auth/components/DatabaseConfig.vue
index 6aafa1f45..bbad69958 100644
--- a/src/views/Auth/components/DatabaseConfig.vue
+++ b/src/views/Auth/components/DatabaseConfig.vue
@@ -79,12 +79,7 @@
-
@@ -177,7 +172,7 @@
-
+
{{ $t('Auth.filter') }}
+
+
+
+
+
+
+
+
+
+
@@ -290,35 +297,16 @@
diff --git a/src/views/Auth/components/FileConfig.vue b/src/views/Auth/components/FileConfig.vue
index 91a56317e..cfc00a913 100644
--- a/src/views/Auth/components/FileConfig.vue
+++ b/src/views/Auth/components/FileConfig.vue
@@ -32,17 +32,8 @@
diff --git a/src/views/Auth/components/HelpBlock.vue b/src/views/Auth/components/HelpBlock.vue
index e74901627..fb032d299 100644
--- a/src/views/Auth/components/HelpBlock.vue
+++ b/src/views/Auth/components/HelpBlock.vue
@@ -1,7 +1,15 @@
- promDefaultContent: Ref
- rulesWithPg: Record
- rulesDefault: Record
-} => {
- const { tl } = useI18nTl('MonitoringIntegration')
- const promConfigWithPg = reactive({
- promHost: '',
- pushgatewayHost: '',
- nodeExporterHost: '',
- })
- const rulesWithPg = {
- pushgatewayHost: [
- {
- required: true,
- message: tl('pushgatewayRequired'),
- },
- ],
- }
- const rulesDefault = {
- emqxHost: [
- {
- required: true,
- message: tl('emqxRequired'),
- },
- ],
- metricsPath: [
- {
- required: true,
- message: tl('metricsPathRequired'),
- },
- ],
- }
- const promConfigDefault = reactive({
- emqxHost: '127.0.0.1:18083',
- metricsPath: '/api/v5/prometheus/stats',
- nodeExporterHost: '',
- })
- watch(promConfigWithPg, (val) => {
- promPgContent.value = getPromConfigWithPushgateway(val)
- })
- watch(promConfigDefault, (val) => {
- promDefaultContent.value = getPromConfigDefault(val)
- })
- const getPromConfigDefault = (configs: {
- emqxHost: string
- metricsPath: string
- nodeExporterHost: string
- }) => `# prometheus.yaml
-global:
- scrape_interval: 10s # The default scrape interval is every 10 seconds.
- evaluation_interval: 10s # The default evaluation interval is every 10 seconds.
- # On this machine, every time series will be exported by default.
- external_labels:
- monitor: 'emqx-monitor'
-# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
-rule_files:
- # - "first.rules"
- # - "second.rules"
- - "/etc/prometheus/rules/*.rules"
-# Data pull configuration
-scrape_configs:
- # EMQX monitoring
- - job_name: 'emqx'
- metrics_path: ${configs.metricsPath}
- scrape_interval: 5s
- honor_labels: true
- static_configs:
- # EMQX IP address and port
- - targets: [${configs.emqxHost}]
- - job_name: 'node-exporter'
- scrape_interval: 5s
- static_configs:
- # node-exporter IP address and port
- - targets: ['${configs.nodeExporterHost || '127.0.0.1:9100'}']
- labels:
- instance: dashboard-local
-`
- const getPromConfigWithPushgateway = (configs: {
- promHost: string
- pushgatewayHost: string
- nodeExporterHost: string
- }) => `# prometheus.yaml
-global:
- scrape_interval: 10s # The default scrape interval is every 10 seconds.
- evaluation_interval: 10s # The default evaluation interval is every 10 seconds.
- # On this machine, every time series will be exported by default.
- external_labels:
- monitor: 'emqx-monitor'
-# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
-rule_files:
- # - "first.rules"
- # - "second.rules"
- - "/etc/prometheus/rules/*.rules"
-# Data pull configuration
-scrape_configs:
- # Meaning that in this configuration, each time series will automatically add this {job_name: "prometheus"} label.
- - job_name: 'prometheus'
- scrape_interval: 5s
- static_configs:
- # Prometheus IP address and port
- - targets: ['${configs.promHost || '127.0.0.1:9090'}']
- # Server physical machine monitoring
- - job_name: 'node-exporter'
- scrape_interval: 5s
- static_configs:
- # node-exporter IP address and port
- - targets: ['${configs.nodeExporterHost || '127.0.0.1:9100'}']
- labels:
- instance: dashboard-local
- # EMQX Pushgateway monitoring
- - job_name: 'pushgateway'
- scrape_interval: 5s
- honor_labels: true
- static_configs:
- # Pushgateway IP address and port
- - targets: ['${configs.pushgatewayHost}']
-`
- const promPgContent = ref(getPromConfigWithPushgateway(promConfigWithPg))
- const promDefaultContent = ref(getPromConfigDefault(promConfigDefault))
- return {
- promConfigWithPg,
- promPgContent,
- rulesWithPg,
- promConfigDefault,
- promDefaultContent,
- rulesDefault,
- }
-}
-
-export default usePromConfig
diff --git a/src/views/Config/Monitoring/components/HelpDrawer.vue b/src/views/Config/Monitoring/components/HelpDrawer.vue
deleted file mode 100644
index 2f8477c29..000000000
--- a/src/views/Config/Monitoring/components/HelpDrawer.vue
+++ /dev/null
@@ -1,330 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/src/views/Dashboard/Metrics.vue b/src/views/Dashboard/Metrics.vue
index fd1d8896e..e9c5fbc32 100644
--- a/src/views/Dashboard/Metrics.vue
+++ b/src/views/Dashboard/Metrics.vue
@@ -14,9 +14,7 @@
- {{ $t('Base.refresh') }}
-
+
{showSkeleton.value ?
diff --git a/src/components/SchemaFormItem.tsx b/src/components/SchemaFormItem.tsx
index 751327a57..1e244e257 100644
--- a/src/components/SchemaFormItem.tsx
+++ b/src/components/SchemaFormItem.tsx
@@ -2,7 +2,6 @@ import { createRandomString } from '@/common/tools'
import Monaco from '@/components/Monaco.vue'
import CommonTLSConfig from '@/components/TLSConfig/CommonTLSConfig.vue'
import { Properties } from '@/types/schemaForm'
-import { PropType, SetupContext, computed, defineComponent } from 'vue'
import ArrayEditor from './ArrayEditor.vue'
import CustomInputNumber from './CustomInputNumber.vue'
import InputWithPlaceholderSelect from './InputWithPlaceholderSelect.vue'
@@ -10,6 +9,8 @@ import InputWithUnit from './InputWithUnit.vue'
import KeyAndValueEditor from './KeyAndValueEditor.vue'
import OneOf from './Oneof.vue'
import TimeInputWithUnitSelect from './TimeInputWithUnitSelect.vue'
+import CustomInputPassword from './CustomInputPassword.vue'
+import { SetupContext } from 'vue'
type FormItemType =
| 'string'
@@ -153,6 +154,17 @@ export default defineComponent({
disabled={isDisabled}
type={inputType}
clearable
+ oneOf={props.property?.oneOf}
+ {...customProps}
+ />
+ )
+ } else if (props.format === 'password') {
+ return (
+ ${getSizeStr(value)}` + return `${dayjs(Number(axisValue)).format('HH:mm:ss')}
${getSizeStr(value)}` }, }, color: [TYPE_COLOR_MAP[MetricType.Blue]], diff --git a/src/hooks/useOperationConfirm.ts b/src/hooks/useOperationConfirm.ts index 509b2caf2..0c985f43a 100644 --- a/src/hooks/useOperationConfirm.ts +++ b/src/hooks/useOperationConfirm.ts @@ -1,7 +1,4 @@ import type { MessageBoxData } from 'element-plus' -import { ElMessage, ElMessageBox } from 'element-plus' -import { isFunction } from 'lodash' -import useI18nTl from './useI18nTl' export default (): { operationWarning: (confirmText: string, opts?: Record
支持在路径末尾添加 `/[...]` 表示任意子路径。例如，当设置为 `/mqtt/[...]` 时，可以接受 `/mqtt/org1`、`/mqtt/org1/app1` 等连接。
注意，如果客户端连接的路径与配置不匹配，则连接将在 HTTP 层被拒绝。", en: "The path in the WebSocket connection URL, which should start with `/` and supports subpaths. By default, the full URL of a WebSocket client connection is `ws://{'{'}ip{'}'}:{'{'}port{'}'}/mqtt`.
It is supported to add `/[...] ` at the end of the path to make EMOX accept any subpath. For example, specifying `/mqtt/[...]` would allow clients to connect at paths like `mqtt/org1` or `mqtt/org1/app1`, etc.
NOTE: An unmatched path will cause the client to be rejected immediately at the HTTP laver.", @@ -75,10 +71,6 @@ export default { zh: '邀请成功', en: 'Invite Successfully', }, - clusterType: { - zh: '集群方式', - en: 'Cluster Type', - }, currentNode: { zh: '当前节点', en: 'Current Node', @@ -118,11 +110,11 @@ export default { }, console: { zh: '控制台日志', - en: 'Console Log', + en: 'Console Logs', }, file: { zh: '文件日志', - en: 'File Log', + en: 'File Logs', }, throttling: { zh: '日志限流', diff --git a/src/i18n/Clients.js b/src/i18n/Clients.ts similarity index 97% rename from src/i18n/Clients.js rename to src/i18n/Clients.ts index b2a1206c1..be668abd6 100644 --- a/src/i18n/Clients.js +++ b/src/i18n/Clients.ts @@ -415,6 +415,26 @@ export default { zh: '来自于用户名', en: 'From Username', }, + name: { + zh: '警报名称', + en: 'Alarm Name', + }, + details: { + zh: '告警消息', + en: 'Alarm Message', + }, + message: { + zh: '警报信息', + en: 'Alarm Message', + }, + activated_at: { + zh: '开始时间', + en: 'Activated At', + }, + deactivated_at: { + zh: '解除时间', + en: 'Deactivated At', + }, reason: { zh: '原因', en: 'Reason', diff --git a/src/i18n/Dashboard.js b/src/i18n/Dashboard.ts similarity index 98% rename from src/i18n/Dashboard.js rename to src/i18n/Dashboard.ts index 41db31ec1..b96fe31ef 100644 --- a/src/i18n/Dashboard.js +++ b/src/i18n/Dashboard.ts @@ -283,14 +283,6 @@ export default { zh: '数据指标集成', en: 'Metrics Integration', }, - integrationDesc: { - zh: '集成指标数据外部的监控与告警管理', - en: 'Integrated monitoring and alerting toolkit', - }, - promDesc: { - zh: '使用 Prometheus 采集指标数据', - en: 'Integrated with Prometheus', - }, role: { zh: '角色', en: 'Role', @@ -331,6 +323,14 @@ export default { zh: '过去 7 天', en: 'Last 7 days', }, + resetMonitorData: { + zh: '重置监控数据', + en: 'Reset monitor data', + }, + confirmResetMonitorData: { + zh: '确定重置监控数据？', + en: 'Confirm to reset monitor data?', + }, /* client */ client_connect: { zh: 'client.connect 钩子触发次数', diff --git a/src/i18n/Exhook.js b/src/i18n/Exhook.ts similarity index 97% rename from src/i18n/Exhook.js rename to src/i18n/Exhook.ts index c3f4a1873..317316553 100644 --- a/src/i18n/Exhook.js +++ b/src/i18n/Exhook.ts @@ -95,10 +95,6 @@ export default { zh: '次/秒', en: 'time/sec', }, - nodeMetricsData: { - zh: '节点指标', - en: 'Node Metrics', - }, nodeStatusDesc: { zh: '每个节点上钩子执行指标数据', en: 'Hook execution metrics data on each node', diff --git a/src/i18n/Extension.js b/src/i18n/Extension.ts similarity index 87% rename from src/i18n/Extension.js rename to src/i18n/Extension.ts index 0774ca83e..35fb8e135 100644 --- a/src/i18n/Extension.js +++ b/src/i18n/Extension.ts @@ -11,10 +11,6 @@ export default { zh: '自动订阅', en: 'Auto Subscribe', }, - postpone: { - zh: '延迟发布', - en: 'Delayed Publish', - }, message: { zh: '事件消息', en: 'Event Message', @@ -23,10 +19,6 @@ export default { zh: '消息存储', en: 'Storage', }, - flowControl: { - en: 'Flow Control', - zh: '流控', - }, msgExpiryInterval: { en: 'Message Expiry Interval', zh: '消息过期间隔', @@ -51,6 +43,14 @@ export default { zh: '派发保留消息的最大速率', en: 'The maximum rate of delivering retained messages', }, + maxPublishRate: { + zh: '最大发布速率', + en: 'Max Publish Rate', + }, + maxPublishRateDesc: { + zh: '发布保留消息的最大速率。超过限制发布的消息会被投递，但不会存储为保留消息。', + en: 'The maximum rate of publishing retained messages. Messages that are published over the limit are delivered but not stored as retained.', + }, storageMethod: { zh: '存储方式', en: 'Storage Method', @@ -71,14 +71,6 @@ export default { zh: '启用', en: 'Enable', }, - enableRetained: { - zh: '启用保留消息', - en: 'Enable Retained Messages', - }, - enableDesc: { - zh: '打开或关闭保留消息功能，停用后不会清除已保留消息', - en: 'Enable retainer feature, disabling will not clear the saved retained messages', - }, createDate: { zh: '发布时间', en: 'Created At', @@ -103,14 +95,6 @@ export default { zh: '发布时间', en: 'Publish Time', }, - eventTitleDesc: { - zh: '将设备生命周期事件通过事件主题以 MQTT 消息的形式发布', - en: 'Publish client life cycle events through events topic', - }, - configMsg: { - zh: '配置需要启用的事件消息', - en: 'Configure event messages that need to be enabled', - }, client_connected: { en: 'Clients have already connected', zh: '客户端连接完成', @@ -151,14 +135,6 @@ export default { zh: '正则表达式', en: 'Regex', }, - dataManage: { - zh: '数据管理', - en: 'Manage Data', - }, - builtInDatabase: { - zh: '内置数据库', - en: 'Built-in Database', - }, noExp: { en: 'Never Expire', zh: '永不过期', @@ -227,10 +203,6 @@ export default { zh: '已保留消息', en: 'Retained Messages', }, - retainerDisabled: { - zh: '保留消息功能已禁用，点击跳转到设置页面中开启。', - en: 'Retained message is disabled, click to enable on settings page.', - }, msgExpiryIntervalDesc: { en: 'Message retention time. 0 means message will never be expired', zh: '消息保留时间。0 代表永久保留', diff --git a/src/i18n/Function.js b/src/i18n/Function.ts similarity index 100% rename from src/i18n/Function.js rename to src/i18n/Function.ts diff --git a/src/i18n/Gateway.js b/src/i18n/Gateway.ts similarity index 77% rename from src/i18n/Gateway.js rename to src/i18n/Gateway.ts index 133faf92a..6bbca5b2a 100644 --- a/src/i18n/Gateway.js +++ b/src/i18n/Gateway.ts @@ -11,6 +11,10 @@ export default { zh: '连接', en: 'Connections', }, + currentConnection: { + zh: '连接数', + en: 'Current Connections', + }, listeners: { zh: '监听器', en: 'Listeners', @@ -111,6 +115,48 @@ export default { zh: '挂载点', en: 'MountPoint', }, + mountPointDesc: { + zh: `为客户端在 \`SUBSCRIBE\` 和 \`UNSUBSCRIBE\` 请求、\`PUBLISH\` 消息以及 Will Message（如果在 \`CONNECT\` 数据包中提供）中使用的主题添加静态或模板前缀（例如 \`n1/\` 或 \`{'$'}{'{'}username{'}'}/\`）。
+从发布到相应订阅的消息的主题中将移除此前缀。 + +支持的占位符包括： +- \`{'$'}{'{'}username{'}'}\` +- \`{'$'}{'{'}clientid{'}'}\` +- \`{'$'}{'{'}zone{'}'}\` +- \`{'$'}{'{'}client_attrs.NAME{'}'}\` + +例如，使用 \`mountpoint="{'$'}{'{'}username{'}'}/"\` 时，用户名 \`u1\` 的客户端将出现以下情况： +- 客户端 SUBSCRIBE \`sensors/#\` -> 在代理中内部转换为 \`u1/sensors/#\`。 +- 代理 PUBLISH \`u1/sensors/data\` -> 发送给客户端时变为 \`sensors/data\`。 + +前缀的挂载/卸载应用于： +- \`CONNECT\` 中的 Will +- \`PUBLISH\` +- \`SUBSCRIBE\` +- \`UNSUBSCRIBE\` + +注意：挂载发生在**授权/ACL检查之后**。`, + en: `Adds a static or templated prefix (e.g., \`n1/\` or \`{'$'}{'{'}username{'}'}/\`) to topics used by clients in \`SUBSCRIBE\` and \`UNSUBSCRIBE\` requests, \`PUBLISH\` messages, and Will Message (if supplied in the \`CONNECT\` packet).
+Removes this prefix from topics of messages published to the respective subscriptions. + +The supported placeholders are: +- \`{'$'}{'{'}username{'}'}\` +- \`{'$'}{'{'}clientid{'}'}\` +- \`{'$'}{'{'}zone{'}'}\` +- \`{'$'}{'{'}client_attrs.NAME{'}'}\` + +For example, with \`mountpoint="{'$'}{'{'}username{'}'}/"\`, a client using \`u1\` as username will have: +- Client SUBSCRIBE \`sensors/#\` -> \`u1/sensors/#\` internally in the broker. +- Broker PUBLISH \`u1/sensors/data\` -> \`sensors/data\` sent to the client. + +The prefix mount/unmount is applied to: +- Will in \`CONNECT\` +- \`PUBLISH\` +- \`SUBSCRIBE\` +- \`UNSUBSCRIBE\` + +Note: mounting occurs **after authorization/ACL checks**.`, + }, lType: { zh: '类型', en: 'Type', @@ -148,8 +194,8 @@ export default { en: 'Connection Required', }, connectionRequireDesc: { - zh: '连接模式是非标准协议的特性。启用连接模式时，需要管理连接资源的创建、认证和保活。选择为 false 则进入无连接模式，在此模式下，添加的认证器不会生效。', - en: `Connection mode is a feature of non-standard protocols. When connection mode is enabled, it's essential to manage the creation, authentication, and aliveness of connection resources. When set to false, it enters connectionless mode, and the added authenticator won't take effect.`, + zh: '连接模式是非标准的特性。启用连接模式时，客户端**必须**管理连接资源的创建、认证和保活。选择为 false 则表示客户端对管理连接资源是可选的，支持不创建连接资源，直接进行消息发布和订阅。', + en: `Connection Required is a non-standard feature. When Connection Required is enabled, the client **must** manage the creation, authentication, and keep-alive of connection resources. Selecting false means that the client is optional for managing connection resources and supports not creating connection resources directly for message publishing and subscription.`, }, heartbeat: { zh: '心跳间隔', @@ -215,14 +261,30 @@ export default { zh: '最大连接速率（监听器）', en: 'Max Connection Rate (Listener)', }, + maxConnBurst: { + zh: '最大连接突发速率（监听器）', + en: 'Max Connection Burst (Listener)', + }, + maxConnBurstDesc: { + zh: '在突发情况下当前监听器可以接受的最大连接数量；为空时表示不限制。\n\n例如：`10000/60m` 表示在 60 分钟内，允许接受最多 10000 个连接。', + en: 'The maximum number of connections that can be accepted in a burst by the current listener; empty means no limit.\n\nFor example: `10000/60m` means allowing up to 10000 connections in 60 minutes.', + }, maxMsgPubRate: { zh: '最大消息发布速率（单客户端）', en: 'Max Message Publishing Rate (Per Client)', }, + maxMsgPubBurst: { + zh: '最大消息发布突发速率（单客户端）', + en: 'Max Message Publishing Burst (Per Client)', + }, maxMsgPubTraffic: { zh: '最大消息发布流量（单客户端）', en: 'Max Message Publishing Traffic (Per Client)', }, + maxMsgPubTrafficBurst: { + zh: '最大消息发布流量突发速率（单客户端）', + en: 'Max Message Publishing Traffic Burst (Per Client)', + }, maxConn: { zh: '最大连接数', en: 'Max Connections', diff --git a/src/i18n/General.js b/src/i18n/General.ts similarity index 68% rename from src/i18n/General.js rename to src/i18n/General.ts index fad7f1912..7f2e16c0f 100644 --- a/src/i18n/General.js +++ b/src/i18n/General.ts @@ -131,10 +131,6 @@ export default { zh: '确认重置?', en: 'Confirm to reset', }, - 'banned-clients': { - zh: '黑名单', - en: 'Banned Clients', - }, determineToDeleteTheBannedClient: { zh: '确认解除该黑名单？', en: 'Confirm to unban this banned client?', @@ -259,4 +255,28 @@ export default { zh: '持久会话中消息保留时长，超期的消息不会发送到订阅者。', en: 'The duration of message retention in a persistent session, messages that expire are not delivered to subscribers.', }, + enableForceShutdown: { + zh: '启用强制关闭', + en: 'Enable Force Shutdown', + }, + enableForceShutdownDesc: { + zh: '启用
force_shutdown（强制关闭）功能，当进程堆内存或邮箱大小超过设定值时强制关闭进程',
+ en: 'Enable force_shutdown feature. Process will be forcibly shutdown when heap memory or mailbox size exceeds the set value',
+ },
+ maxHeapSize: {
+ zh: '最大堆内存',
+ en: 'Max Heap Size',
+ },
+ maxHeapSizeDesc: {
+ zh: '进程的最大堆内存大小。如果启用了强制关闭功能，超过此限制的进程将自动退出或被强制终止。进程消息队列（邮箱）中的消息也是堆的一部分。进程关闭可分为以下两种情况：\n- 进程在运行时主动检查当前堆大小，发现超出限制后主动退出\n- 底层调度系统在为进程执行垃圾回收后检查当前堆大小，发现超出限制后强制终止进程\n\n注意：上述两种情况产生的错误日志会有所不同。前者生成的日志类似于 ...errorContext: connection_shutdown, reason: #{max => 2097152, reason => proc_heap_too_large, value => 2787348}..，后者生成的日志类似于 ...Context: maximum heap size reached...。',
+ en: 'The maximum heap size of the process. If the force_shutdown is enabled, processes that exceed this limit will automatically exit or be forcibly killed. Messages in the process message queue (mailbox) are also part of the heap. The shutdown of a process can be divided into the following two situations:\n- The process actively checks the current heap size during its own operation, and actively exits after finding that it exceeds the limit.\n- The underlying scheduling system checks the current heap size after performing garbage collection for the process, and forcibly kills the process after finding that it exceeds the limit.\n\nNote: The Error logs generated by the above two will be different. The log generated by the former is similar to ...errorContext: connection_shutdown, reason: #{max => 2097152, reason => proc_heap_too_large, value => 2787348}.., and the log generated by the latter is similar to ...Context: maximum heap size reached....',
+ },
+ maxMailboxSize: {
+ zh: '最大邮箱大小',
+ en: 'Max Mailbox Size',
+ },
+ maxMailboxSizeDesc: {
+ zh: 'EMQX 为每个客户端连接创建至少一个轻量级进程。每个进程都有自己的消息队列（邮箱）来保存来自其他进程（如 MQTT 消息）的消息，以便进程可以随时从消息队列（邮箱）中读取消息。如果系统繁忙或进程因繁忙的套接字而挂起，消息队列可能会积累大量消息。为避免过度使用内存，当进程的消息队列长度超过此值时，EMQX 将强制关闭该进程。',
+ en: 'EMQX creates at least one lightweight process for each client connection. Each process has its own message queue (aka mailbox) to hold messages from other processes (e.g. MQTT messages) so that the process can read messages from the message queue (mailbox) at any time. If the system is busy or the process hangs due to a busy socket (see high_watermark), the message queue can accumulate many messages. To avoid excessive memory usage, EMQX will force a process to shut down when the length of its message queue exceeds max_mailbox_size.',
+ },
}
diff --git a/src/i18n/LogTrace.js b/src/i18n/LogTrace.ts
similarity index 100%
rename from src/i18n/LogTrace.js
rename to src/i18n/LogTrace.ts
diff --git a/src/i18n/MQTTRes.js b/src/i18n/MQTTRes.ts
similarity index 100%
rename from src/i18n/MQTTRes.js
rename to src/i18n/MQTTRes.ts
diff --git a/src/i18n/MonitoringIntegration.js b/src/i18n/MonitoringIntegration.js
deleted file mode 100644
index 4f07e355a..000000000
--- a/src/i18n/MonitoringIntegration.js
+++ /dev/null
@@ -1,189 +0,0 @@
-export default {
- monitoringPlatform: {
- zh: '监控平台',
- en: 'Monitoring platform',
- },
- monitoringPlatformFormItemLabel: {
- en: `Select a monitoring platform, for Prometheus, click the "Help button" after configuration to see how to configure the monitoring platform.`,
- zh: '选择一个监控平台，对于 Prometheus，配置后点击 "帮助按钮" 查看如何配置监控平台。',
- },
- enablePushgateway: {
- zh: '启用 Pushgateway',
- en: 'Enable Pushgateway',
- },
- enablePushgatewayDesc: {
- zh: '启用后，EMQX 将会将监控数据推送到 Pushgateway，然后由 Prometheus 从 Pushgateway 中拉取数据。',
- en: 'After enabling, EMQX will push the monitoring metrics data to the Pushgateway, and then Prometheus will pull the data from the Pushgateway.',
- },
- interval: {
- zh: '采集间隔',
- en: 'Interval',
- },
- jobName: {
- zh: 'Job 名称',
- en: 'Job Name',
- },
- jobNameDesc: {
- zh: `推送到 Pushgateway 的 Job 名称。可用变量为：-- \${'{'}name{'}'}: EMQX 节点的名称。
-- \${'{'}host{'}'}: EMQX 节点主机名。
-例如，当 EMQX 节点名为
emqx{'@'}127.0.0.1 则 name 变量的值为 emqx，host 变量的值为 127.0.0.1。-默认值为:
\${'{'}name{'}'}/instance/\${'{'}name{'}'}~\${'{'}host{'}'}`,
- en: `Job Name that is pushed to the Pushgateway. Available variables:-- \${'{'}name{'}'}: Name of EMQX node.
-- \${'{'}host{'}'}: Host name of EMQX node.
-For example, when the EMQX node name is
emqx{'@'}127.0.0.1 then the name variable takes value emqx and the host variable takes value 127.0.0.1.-Default value is:
\${'{'}name{'}'}/instance/\${'{'}name{'}'}~\${'{'}host{'}'}`,
- },
- headersDesc: {
- zh: `推送到 Pushgateway 的 HTTP Headers 列表。-例如，
{'{'} Authorization = "some-authz-tokens"{'}'}`,
- en: `A list of HTTP Headers when pushing to Pushgateway.-For example,
{'{'} Authorization = "some-authz-tokens"{'}'}`,
- },
- dataReportingInterval: {
- zh: '监控数据指标上报到监控服务的时间间隔。',
- en: 'The time interval at which monitoring data metrics are reported to the monitoring service.',
- },
- pushgatewayServer: {
- zh: 'Pushgateway 服务',
- en: 'Pushgateway Server',
- },
- pushgatewayDesc: {
- zh: '通常情况下不需要使用。启用后，将会在每个节点上启动 Pushgateway，用于收集 Prometheus Push 模式的监控数据。',
- en: 'Usually not needed. When enabled, Pushgateway will be started on each node to collect Prometheus Push mode monitoring data.',
- },
- learn: {
- zh: '了解',
- en: 'Learn ',
- },
- usePushgateway: {
- zh: '使用 Pushgateway',
- en: 'Use Pushgateway',
- },
- whenToUsePushgateway: {
- zh: '何时使用 Pushgateway',
- en: 'When to use Pushgateway',
- },
- promSetupHelp: {
- zh: 'Prometheus 与 Grafana 配置帮助',
- en: 'Prometheus and Grafana setup help',
- },
- promSetupHelpDesc: {
- zh: 'EMQX 支持将数据集成到 Prometheus 服务中来监控数据，可以使用 Grafana 来可视化监控数据。通常使用默认方法即可完成配置，也可选择使用 Pushgateway。',
- en: 'EMQX supports integrating data into the Prometheus service to monitor data, and you can use Grafana to visualize monitoring data. Usually the default method can be used to complete the configuration, or you can choose to use Pushgateway.',
- },
- pushgatewayInstall: {
- zh: '安装 Pushgateway 或 Node Exporter 服务',
- en: 'Install the Pushgateway or Node Exporter service',
- },
- promStepOne: {
- zh: '可以使用 Docker 来安装和启动 Pushgateway 服务，例如使用以下命令：',
- en: 'You can use Docker to install and start the Pushgateway service, for example, use the following command:',
- },
- nodeExporterDesc: {
- zh: '对于监控物理机或虚拟机的系统信息可使用 Node Exporter, 点击查看 ',
- en: 'For monitoring system information of physical machines or VM, you can use Node Exporter, click to view ',
- },
- installNodeExporter: {
- zh: '安装和运行 Node Exporter。',
- en: 'Installing and running the Node Exporter.',
- },
- promConfig: {
- zh: '配置 Prometheus',
- en: 'Configure Prometheus',
- },
- promConfigDesc: {
- zh: '生成 Prometheus 配置文件，包括 EMQX 服务地址，以及 EMQX 提供监控数据 API 的 Path。',
- en: 'Generate a Prometheus configuration file, including the EMQX service address, and the Path of the EMQX monitoring metrics data API.',
- },
- promStepTwo: {
- zh: '在 Prometheus 的配置文件中添加 Pushgateway 服务的地址，Node Exporter 和 Prometheus 的地址在有需要的情况下再添加。',
- en: 'Add the address of the Pushgateway service to the Prometheus configuration file, and add the address of Node Exporter and Prometheus if necessary.',
- },
- promRun: {
- zh: '再使用生成的配置文件来启动 Prometheus，例如使用以下命令：',
- en: 'Then use the generated configuration file to start Prometheus, for example, use the following command:',
- },
- grafConfig: {
- zh: '配置 Grafana',
- en: 'Configure Grafana',
- },
- promStepThree: {
- zh: '在 Grafana 中添加 Prometheus 作为数据源，然后添加配置或导入一个 Dashboard 来可视化监控数据，例如可使用以下启动命令：',
- en: 'Add Prometheus as a data source in Grafana, then add a configuration or import a Dashboard to visualize the monitoring data, for example, you can use the following startup command:',
- },
- clickDownloadTemplateDesc: {
- zh: '点击下方按钮下载默认的 Grafana Dashboard 模版。',
- en: 'Click the button below to download the default Grafana Dashboard template.',
- },
- clickDonwnloadTemplate: {
- zh: '下载 Grafana 模版',
- en: 'Download Grafana Template',
- },
- genPromConfig: {
- zh: '生成配置文件',
- en: 'Generate Configuration File',
- },
- pushgatewayRequired: {
- zh: '请配置 Pushgateway 地址',
- en: 'Please configure the Pushgateway address',
- },
- emqxRequired: {
- zh: '请配置 EMQX 地址',
- en: 'Please configure the EMQX address',
- },
- metricsPathRequired: {
- zh: '请配置 metrics API path',
- en: 'Please configure the metrics API path',
- },
- endpoint: {
- zh: '服务地址',
- en: 'Endpoint',
- },
- exportInterval: {
- zh: '导出间隔',
- // Must have a space at the beginning
- en: ' Export Interval',
- },
- enableBasicAuth: {
- zh: '启用基本认证',
- en: 'Enable Basic Auth',
- },
- enableBasicAuthDesc: {
- zh: '启用或禁用 Prometheus 抓取 API 的基本认证，不适用于 Pushgateway',
- en: 'Enable or disable basic authentication for Prometheus scrape API, not for Pushgateway',
- },
- featureSelection: {
- zh: '功能选择',
- en: 'Feature Selection',
- },
- metricsEnable: {
- zh: '指标',
- en: 'Metrics',
- },
- tracesEnable: {
- zh: '追踪',
- en: 'Traces',
- },
- tracesFilterTracesAll: {
- zh: '追踪全部消息',
- en: 'Traces All Messages',
- },
- tracesFilterTracesAllDesc: {
- zh: '当启用时，EMQX 将追踪所有发布的消息，如果无法从消息中提取追踪ID，则会生成一个新的追踪ID。当禁用时，只有在发布时带有追踪上下文（Trace context）的消息才会被追踪。',
- en: 'When enabled, the EMQX will trace all published messages. If a trace ID cannot be extracted from the message, a new trace ID will be generated. When disabled, only messages with trace context at the time of publishing will be traced.',
- },
- logsEnable: {
- zh: '日志',
- en: 'Logs',
- },
- logsLevel: {
- zh: '日志级别',
- en: 'Logs Level',
- },
- thisDoc: {
- zh: '此文档',
- en: 'this doc',
- },
-}
diff --git a/src/i18n/Plugins.js b/src/i18n/Plugins.ts
similarity index 76%
rename from src/i18n/Plugins.js
rename to src/i18n/Plugins.ts
index 5595d41cd..561387604 100644
--- a/src/i18n/Plugins.js
+++ b/src/i18n/Plugins.ts
@@ -59,10 +59,6 @@ export default {
zh: '插件描述',
en: 'Description',
},
- uploadPlugin: {
- zh: '上传插件',
- en: 'Upload plugin',
- },
dragFilePlaceholder: {
zh: '选择或拖拽文件到此处',
en: 'Select or drag files here',
@@ -91,10 +87,6 @@ export default {
zh: '请先上传文件',
en: 'Please upload the file first',
},
- installNow: {
- zh: '立即安装',
- en: 'Install now',
- },
moveToTop: {
zh: '移到顶部',
en: 'Move to top',
@@ -127,4 +119,28 @@ export default {
zh: '此插件不支持在 Dashboard 中进行配置。',
en: 'This plugin does not support configuration via the Dashboard.',
},
+ inConsistent: {
+ zh: '集群中各节点版本不一致',
+ en: 'Inconsistent for nodes in the cluster',
+ },
+ syncToNodes: {
+ zh: '同步至各节点',
+ en: 'Sync to Nodes',
+ },
+ confirmSyncPluginVersion: {
+ zh: '是否确认将版本 {currentVersion} 的插件 {name} 同步至以下节点',
+ en: 'Are you sure to sync version {currentVersion} of the plugin {name} to the following nodes?',
+ },
+ currentVersion: {
+ zh: '当前版本',
+ en: 'Current Version',
+ },
+ syncSuccess: {
+ zh: '同步成功',
+ en: 'Synchronized Successfully',
+ },
+ restartPluginTip: {
+ zh: '为保证同步后插件正常运行，请在同步后重新启动插件',
+ en: 'To ensure the plugin runs normally after synchronization, please restart the plugin after synchronization.',
+ },
}
diff --git a/src/i18n/Rule.js b/src/i18n/Rule.ts
similarity index 100%
rename from src/i18n/Rule.js
rename to src/i18n/Rule.ts
diff --git a/src/i18n/RuleEngine.js b/src/i18n/RuleEngine.ts
similarity index 98%
rename from src/i18n/RuleEngine.js
rename to src/i18n/RuleEngine.ts
index 1449c34aa..6f0a0aed4 100644
--- a/src/i18n/RuleEngine.js
+++ b/src/i18n/RuleEngine.ts
@@ -75,14 +75,6 @@ export default {
zh: 'HTTP 服务',
en: 'HTTP Server',
},
- bridgeDescHTTP: {
- zh: '发送数据到 HTTP 服务',
- en: 'Send data to HTTP Server',
- },
- bridgeDescMQTT: {
- zh: '使用 MQTT 桥接数据',
- en: 'Using MQTT to bridge data',
- },
trigger: {
zh: '触发器',
en: 'Trigger',
@@ -693,6 +685,14 @@ export default {
zh: '当取消终端订阅成功时触发规则',
en: `Triggered when the terminal subscription is cancelled successfully`,
},
+ sysAlarmActivatedDesc: {
+ zh: '当系统告警激活时触发规则',
+ en: `Trigger the rule when the system alarm is activated`,
+ },
+ sysAlarmDeactivatedDesc: {
+ zh: '当系统告警解除时触发规则',
+ en: `Trigger the rule when the system alarm is deactivated`,
+ },
useAction: {
zh: '使用动作',
en: 'Use action',
@@ -1089,6 +1089,10 @@ export default {
zh: '关联规则',
en: 'Associated Rules',
},
+ viewRules: {
+ zh: '查看规则',
+ en: 'View Rules',
+ },
directDispatch: {
zh: '直接派发',
en: 'Direct Dispatch',
diff --git a/src/i18n/RuleEvent.js b/src/i18n/RuleEvent.ts
similarity index 87%
rename from src/i18n/RuleEvent.js
rename to src/i18n/RuleEvent.ts
index 04289353c..59a576f27 100644
--- a/src/i18n/RuleEvent.js
+++ b/src/i18n/RuleEvent.ts
@@ -55,6 +55,14 @@ export default {
en: 'Message Transformation Failed',
zh: '消息转换失败',
},
+ eventsSysAlarmDeactivated: {
+ en: 'System Alarm Deactivated',
+ zh: '系统告警解除',
+ },
+ eventsSysAlarmActivated: {
+ en: 'System Alarm Activated',
+ zh: '系统告警激活',
+ },
bridgesMqtt: {
en: 'Mqtt Bridge Message',
zh: 'MQTT 桥接消息',
diff --git a/src/i18n/RuleSyntax.js b/src/i18n/RuleSyntax.ts
similarity index 96%
rename from src/i18n/RuleSyntax.js
rename to src/i18n/RuleSyntax.ts
index 7d368adab..cf61156bc 100644
--- a/src/i18n/RuleSyntax.js
+++ b/src/i18n/RuleSyntax.ts
@@ -1064,7 +1064,7 @@ export default {
},
hexstr2BinDesc: {
zh: 'Hex 字符串转为二进制数据',
- en: 'Binary to Hex String',
+ en: 'Hex String to Hex String',
},
hexstr2BinParams: {
zh: 'Hex 字符串',
@@ -1164,4 +1164,52 @@ Typical JQ programs describe simple transformations or filters for JSON data, bu
zh: '返回值为执行生成生成的 JSON 对象列表。如果执行超时或者 JQ 程序抛出异常，该函数将抛出异常。',
en: 'list of objects corresponding to the JSON objects generated by the given JQ program (parameter 1) when given the input provided by parameter 2. The function throws an exception if the execution did not finish before the timeout or if the jq program throws an exception.',
},
+ isEmptyDesc: {
+ zh: '判断 Map 或数组是否为空',
+ en: 'Return true if the map or array is empty',
+ },
+ isEmptyParams: {
+ zh: '要检查的值',
+ en: 'Value to check',
+ },
+ isEmptyReturns: {
+ zh: '布尔值，为空时返回 true',
+ en: 'Boolean value, true if empty',
+ },
+ mapSizeDesc: {
+ zh: '获取 Map 的大小',
+ en: 'Return the size of a map',
+ },
+ mapSizeParams: {
+ zh: 'Map 对象',
+ en: 'Map object',
+ },
+ mapSizeReturns: {
+ zh: 'Map 的大小',
+ en: 'The size of the map',
+ },
+ strUtf16LeDesc: {
+ zh: '将 UTF-8 字符串转换为 UTF-16 小端序编码',
+ en: 'Convert a UTF-8 string to UTF-16 little-endian'
+ },
+ strUtf16LeParams: {
+ zh: '要转换的字符串',
+ en: 'String to convert'
+ },
+ strUtf16LeReturns: {
+ zh: 'UTF-16 小端序编码的字符串',
+ en: 'UTF-16 little-endian encoded string'
+ },
+ sqlserverBin2HexstrDesc: {
+ zh: '将字符串或二进制转换为 SQL Server 十六进制格式（带 0x 前缀）',
+ en: 'Convert string or binary to SQL Server hex format with 0x prefix'
+ },
+ sqlserverBin2HexstrParams: {
+ zh: '要转换的数据',
+ en: 'Data to convert'
+ },
+ sqlserverBin2HexstrReturns: {
+ zh: 'SQL Server 格式的十六进制字符串',
+ en: 'Hex string in SQL Server format'
+ }
}
diff --git a/src/i18n/Settings.js b/src/i18n/Settings.ts
similarity index 100%
rename from src/i18n/Settings.js
rename to src/i18n/Settings.ts
diff --git a/src/i18n/Subs.js b/src/i18n/Subs.ts
similarity index 100%
rename from src/i18n/Subs.js
rename to src/i18n/Subs.ts
diff --git a/src/i18n/Tools.js b/src/i18n/Tools.ts
similarity index 92%
rename from src/i18n/Tools.js
rename to src/i18n/Tools.ts
index 328c24fdd..56cf59fdc 100644
--- a/src/i18n/Tools.js
+++ b/src/i18n/Tools.ts
@@ -79,6 +79,14 @@ export default {
zh: '订阅',
en: 'Subscribe',
},
+ invalidPubTopic: {
+ zh: '请输入有效的主题',
+ en: 'Please enter a valid topic',
+ },
+ invalidSubTopic: {
+ zh: '发布主题不能包含通配符',
+ en: 'Publish topic cannot contain wildcards',
+ },
time: {
zh: '时间',
en: 'Time',
diff --git a/src/i18n/Topics.js b/src/i18n/Topics.ts
similarity index 100%
rename from src/i18n/Topics.js
rename to src/i18n/Topics.ts
diff --git a/src/i18n/components.js b/src/i18n/components.ts
similarity index 93%
rename from src/i18n/components.js
rename to src/i18n/components.ts
index 4e1974c5c..7f793eadf 100644
--- a/src/i18n/components.js
+++ b/src/i18n/components.ts
@@ -24,8 +24,8 @@ export default {
en: 'Management',
},
diagnose: {
- zh: '问题分析',
- en: 'Diagnose',
+ zh: '诊断工具',
+ en: 'Diagnostics Tools',
},
acl: {
zh: 'ACL',
@@ -89,7 +89,7 @@ export default {
},
rule: {
zh: '规则',
- en: 'Rule',
+ en: 'Rules',
},
rules: {
zh: '规则',
@@ -108,8 +108,8 @@ export default {
en: 'Create Flow',
},
webhook: {
- zh: 'Webhook',
- en: 'Webhook',
+ zh: 'Webhooks',
+ en: 'Webhooks',
},
'webhook-create': {
zh: '创建 Webhook',
@@ -157,7 +157,7 @@ export default {
},
extension: {
zh: '扩展',
- en: 'Extension',
+ en: 'Extensions',
},
'mqtt-system-topic': {
zh: '系统主题',
@@ -172,12 +172,12 @@ export default {
en: 'Gateways',
},
exhook: {
- zh: 'ExHook',
- en: 'ExHook',
+ zh: 'ExHooks',
+ en: 'ExHooks',
},
'api-key': {
zh: 'API 密钥',
- en: 'API Key',
+ en: 'API Keys',
},
'banned-clients': {
zh: '黑名单',
@@ -257,11 +257,11 @@ export default {
},
'log-trace': {
zh: '日志追踪',
- en: 'Log Trace',
+ en: 'Log Traces',
},
connector: {
zh: '连接器',
- en: 'Connector',
+ en: 'Connectors',
},
extensions: {
zh: '插件扩展',
@@ -269,7 +269,7 @@ export default {
},
'mqtt-session': {
zh: '会话',
- en: 'Session',
+ en: 'Sessions',
},
'mqtt-retainer': {
zh: '保留消息',
@@ -287,6 +287,10 @@ export default {
zh: '会话持久化',
en: 'Durable Sessions',
},
+ 'mqtt-force-shutdown': {
+ zh: '强制关闭',
+ en: 'Force Shutdown',
+ },
/* For Quick Panel Start */
'rule-create': {
zh: '创建规则',
diff --git a/src/main.ts b/src/main.ts
index 23bad0fed..9746e6999 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -11,8 +11,8 @@ import ElementPlus from 'element-plus'
import elementI18nZhCn from 'element-plus/es/locale/lang/zh-cn'
import elementI18nEn from 'element-plus/es/locale/lang/en'
import safeHTML from '@/common/safeHTML'
-
import i18n from './i18n'
+import globalComponents from './components/global-components'
function bindDirective(app: Application) {
app.directive('safe-html', safeHTML)
@@ -27,6 +27,7 @@ const app = createApp(App)
})
.use(i18n)
.use(bindDirective)
+ .use(globalComponents)
.mount('#app')
export default app
diff --git a/src/router/index.ts b/src/router/index.ts
index 3c4656b73..5e6b775ba 100644
--- a/src/router/index.ts
+++ b/src/router/index.ts
@@ -1,6 +1,4 @@
import store from '@/store'
-import { Component } from 'vue'
-import { createRouter, createWebHashHistory, RouteRecordRaw } from 'vue-router'
const Layout = (): Promisecluster.discovery_strategy = dns",
- "label": "Cluster Dns Name"
- },
- "rpc_keyfile": {
- "desc": "Path to the private key file for the rpc.certfile.\nNote: contents of this file are secret, so it's necessary to set permissions to 600.", - "label": "RPC Keyfile" - }, - "cluster_mcast_recbuf": { - "desc": "Size of the kernel-level buffer for incoming datagrams.", - "label": "Cluster Muticast Sendbuf" - }, - "cluster_autoheal": { - "desc": "If
true, the node will try to heal network partitions automatically.",
- "label": "Cluster Auto Heal"
- },
- "log_overload_kill_enable": {
- "desc": "Enable log handler overload kill feature.",
- "label": "Log Handler Overload Kill"
- },
- "node_etc_dir": {
- "desc": "etc dir for the node",
- "label": "Etc Dir"
- },
- "cluster_proto_dist": {
- "desc": "The Erlang distribution protocol for the cluster.\n- inet_tcp: IPv4 TCP
\n- inet_tls: IPv4 TLS, works together with
etc/ssl_dist.conf",
- "label": "Cluster Protocol Distribution"
- },
- "log_burst_limit_enable": {
- "desc": "Enable log burst control feature.",
- "label": "Enable Burst"
- },
- "dist_buffer_size": {
- "desc": "Erlang's distribution buffer busy limit in kilobytes.",
- "label": "Erlang's dist buffer size(KB)"
- },
- "common_handler_max_depth": {
- "desc": "Maximum depth for Erlang term log formatting and Erlang process message queue inspection.",
- "label": "Max Depth"
- },
- "desc_log": {
- "desc": "EMQX logging supports multiple sinks for the log events.\nEach sink is represented by a _log handler_, which can be configured independently.",
- "label": "Log"
- },
- "common_handler_flush_qlen": {
- "desc": "If the number of buffered log events grows larger than this threshold, a flush (delete) operation takes place.\nTo flush events, the handler discards the buffered log messages without logging.",
- "label": "Flush Threshold"
- },
- "common_handler_chars_limit": {
- "desc": "Set the maximum length of a single log message. If this length is exceeded, the log message will be truncated.\nNOTE: Restrict char limiter if formatter is JSON , it will get a truncated incomplete JSON data, which is not recommended.",
- "label": "Single Log Max Length"
- },
- "cluster_k8s_namespace": {
- "desc": "Kubernetes namespace.",
- "label": "K8s Namespace"
- },
- "node_name": {
- "desc": "Unique name of the EMQX node. It must follow %name%{'@'}FQDN or\n%name%{'@'}IPv4 format.",
- "label": "Node Name"
- },
- "rpc_port_discovery": {
- "desc": "manual: discover ports by tcp_server_port.\n
stateless: discover ports in a stateless manner, using the following algorithm.\nIf node name is emqxN{'@'}127.0.0.1, where the N is an integer,\nthen the listening port will be 5370 + N.",
- "label": "RRC Port Discovery"
- },
- "log_overload_kill_restart_after": {
- "desc": "The handler restarts automatically after a delay in the event of termination, unless the value `infinity` is set, which blocks any subsequent restarts.",
- "label": "Handler Restart Timer"
- },
- "log_file_handler_rotation_size": {
- "desc": "This parameter controls log file rotation. The value `infinity` means the log file will grow indefinitely, otherwise the log file will be rotated once it reaches `max_size` in bytes.",
- "label": "Rotation Size"
- },
- "desc_log_file_handler": {
- "desc": "Log handler that prints log events to files.",
- "label": "Files Log Handler"
- },
- "rpc_socket_keepalive_count": {
- "desc": "How many times the keepalive probe message can fail to receive a reply\nuntil the RPC connection is considered lost.",
- "label": "RPC Socket Keepalive Count"
- },
- "cluster_etcd_server": {
- "desc": "List of endpoint URLs of the etcd cluster",
- "label": "Cluster Etcd Server"
- },
- "db_backend": {
- "desc": "Select the backend for the embedded database.\n
rlog is the default backend,\nthat is suitable for very large clusters.\n
mnesia is a backend that offers decent performance in small clusters.",
- "label": "DB Backend"
- },
- "desc_authorization": {
- "desc": "Settings that control client authorization.",
- "label": "Authorization"
- },
- "cluster_etcd_ssl": {
- "desc": "Options for the TLS connection to the etcd cluster.",
- "label": "Cluster Etcd SSL Option"
- },
- "rpc_insecure_fallback": {
- "desc": "Enable compatibility with old RPC authentication.",
- "label": "RPC insecure fallback"
- },
- "cluster_mcast_buffer": {
- "desc": "Size of the user-level buffer.",
- "label": "Cluster Muticast Buffer"
- },
- "rpc_authentication_timeout": {
- "desc": "Timeout for the remote node authentication.",
- "label": "RPC Authentication Timeout"
- },
- "cluster_call_retry_interval": {
- "desc": "Time interval to retry after a failed call.",
- "label": "Cluster Call Retry Interval"
- },
- "cluster_mcast_sndbuf": {
- "desc": "Size of the kernel-level buffer for outgoing datagrams.",
- "label": "Cluster Muticast Sendbuf"
- },
- "rpc_driver": {
- "desc": "Transport protocol used for inter-broker communication",
- "label": "RPC dirver"
- },
- "max_ets_tables": {
- "desc": "Max number of ETS tables",
- "label": "Max number of ETS tables"
- },
- "desc_db": {
- "desc": "Settings for the embedded database.",
- "label": "Database"
- },
- "desc_cluster_etcd": {
- "desc": "Service discovery using 'etcd' service.",
- "label": "Cluster Etcd"
- },
- "cluster_name": {
- "desc": "Human-friendly name of the EMQX cluster.",
- "label": "Cluster Name"
- },
- "log_rotation_enable": {
- "desc": "Enable log rotation feature.",
- "label": "Rotation Enable"
- },
- "cluster_call_cleanup_interval": {
- "desc": "Time interval to clear completed but stale transactions.\nEnsure that the number of completed transactions is less than the max_history.",
- "label": "Clean Up Interval"
- },
- "desc_cluster_static": {
- "desc": "Service discovery via static nodes.\nThe new node joins the cluster by connecting to one of the bootstrap nodes.",
- "label": "Cluster Static"
- },
- "db_default_shard_transport": {
- "desc": "Defines the default transport for pushing transaction logs.\nThis may be overridden on a per-shard basis in
db.shard_transports.\ngen_rpc uses the gen_rpc library,\ndistr uses the Erlang distribution.",
- "label": "Default Shard Transport"
- },
- "cluster_static_seeds": {
- "desc": "List EMQX node names in the static cluster. See node.name.",
- "label": "Cluster Static Seeds"
- },
- "log_overload_kill_qlen": {
- "desc": "Maximum allowed queue length.",
- "label": "Max Queue Length"
- },
- "node_backtrace_depth": {
- "desc": "Maximum depth of the call stack printed in error messages and\nprocess_info.",
- "label": "BackTrace Depth"
- },
- "desc_log_burst_limit": {
- "desc": "Large bursts of log events produced in a short time can potentially cause problems, such as:\n - Log files grow very large\n - Log files are rotated too quickly, and useful information gets overwritten\n - Overall performance impact on the system\n\nLog burst limit feature can temporarily disable logging to avoid these issues.",
- "label": "Log Burst Limit"
- },
- "common_handler_enable": {
- "desc": "Enable this log handler.",
- "label": "Enable Log Handler"
- },
- "common_handler_timestamp_format": {
- "desc": "Pick a timestamp format:-
auto: automatically choose the best format based on log formatter. epoch for JSON and rfc3339 for text.-
epoch: Unix epoch time in microseconds.-
rfc3339: RFC3339 format.",
- "label": "Timestamp Format"
- },
- "cluster_k8s_service_name": {
- "desc": "EMQX broker service name.",
- "label": "K8s Service Name"
- },
- "common_handler_rotation_count": {
- "desc": "Maximum number of log files.",
- "label": "Max Log Files Number"
- },
- "node_cookie": {
- "desc": "Secret cookie is a random string that should be the same on all nodes in\nthe given EMQX cluster, but unique per EMQX cluster. It is used to prevent EMQX nodes that\nbelong to different clusters from accidentally connecting to each other.",
- "label": "Node Cookie"
- },
- "db_role": {
- "desc": "Select a node role.\n
core nodes provide durability of the data, and take care of writes.\nIt is recommended to place core nodes in different racks or different availability zones.\n
replicant nodes are ephemeral worker nodes. Removing them from the cluster\ndoesn't affect database redundancy\nIt is recommended to have more replicant nodes than core nodes.
\nNote: this parameter only takes effect when the
backend is set\nto rlog.",
- "label": "DB Role"
- },
- "rpc_tcp_server_port": {
- "desc": "Listening port used by RPC local service.\nNote that this config only takes effect when rpc.port_discovery is set to manual.", - "label": "RPC TCP Server Port" - }, - "desc_console_handler": { - "desc": "Log handler that prints log events to the EMQX console.", - "label": "Console Handler" - }, - "node_applications": { - "desc": "List of Erlang applications that shall be rebooted when the EMQX broker joins the cluster.", - "label": "Application" - }, - "log_burst_limit_max_count": { - "desc": "Maximum number of log events to handle within a `window_time` interval. After the limit is reached, successive events are dropped until the end of the `window_time`.", - "label": "Events Number" - }, - "rpc_tcp_client_num": { - "desc": "Set the maximum number of RPC communication channels initiated by this node to each remote node.", - "label": "RPC TCP Client Num" - }, - "cluster_k8s_address_type": { - "desc": "Address type used for connecting to the discovered nodes.\nSetting
cluster.k8s.address_type to ip will\nmake EMQX to discover IP addresses of peer nodes from Kubernetes API.",
- "label": "K8s Address Type"
- },
- "rpc_socket_sndbuf": {
- "desc": "TCP tuning parameters. TCP sending buffer size.",
- "label": "RPC Socket Sndbuf"
- },
- "cluster_mcast_ttl": {
- "desc": "Time-to-live (TTL) for the outgoing UDP datagrams.",
- "label": "Cluster Multicast TTL"
- },
- "db_core_nodes": {
- "desc": "List of core nodes that the replicant will connect to.\nNote: this parameter only takes effect when the
backend is set\nto rlog and the role is set to replicant.\nThis value needs to be defined for manual or static cluster discovery mechanisms.
\nIf an automatic cluster discovery mechanism is being used (such as
etcd),\nthere is no need to set this value.",
- "label": "Db Core Node"
- },
- "log_file_handler_path": {
- "desc": "The path and name of the log file.",
- "label": "Log File Name"
- },
- "log_file_handler_to": {
- "desc": "Name the log file.",
- "label": "Log File Name"
- },
- "node_dist_net_ticktime": {
- "desc": "This is the approximate time an EMQX node may be unresponsive until it is considered down and thereby disconnected.",
- "label": "Dist Net TickTime"
- },
- "desc_cluster_k8s": {
- "desc": "Service discovery via Kubernetes API server.",
- "label": "Cluster Kubernetes"
- },
- "desc_cluster_mcast": {
- "desc": "Service discovery via UDP multicast.",
- "label": "Cluster Multicast"
- },
- "rpc_cacertfile": {
- "desc": "Path to certification authority TLS certificate file used to validate rpc.certfile.\nNote: certificates of all nodes in the cluster must be signed by the same CA.", - "label": "RPC Cacertfile" - }, - "desc_node": { - "desc": "Node name, cookie, config & data directories and the Erlang virtual machine (BEAM) boot parameters.", - "label": "Node" - }, - "cluster_k8s_apiserver": { - "desc": "Kubernetes API endpoint URL.", - "label": "Cluster k8s ApiServer" - }, - "common_handler_supervisor_reports": { - "desc": "Type of supervisor reports that are logged. Defaults to
error\n -
error: only log errors in the Erlang processes.\n -
progress: log process startup.",
- "label": "Report Type"
- },
- "node_data_dir": {
- "desc": "Path to the persistent data directory.\nPossible auto-created subdirectories are:
\n- `mnesia/
\nFor example, `mnesia/emqx{'@'}127.0.0.1`.
\nThere should be only one such subdirectory.
\nMeaning, in case the node is to be renamed (to e.g. `emqx{'@'}10.0.1.1`),
\nthe old dir should be deleted first.
\n- `configs`: Generated configs at boot time, and cluster/local override configs.
\n- `patches`: Hot-patch beam files are to be placed here.
\n- `trace`: Trace log files.
\n\n**NOTE**: One data dir cannot be shared by two or more EMQX nodes.", - "label": "Node Data Dir" - }, - "cluster_k8s_suffix": { - "desc": "Node name suffix.
\nNote: this parameter is only relevant when
address_type is dns\nor hostname.",
- "label": "K8s Suffix"
- },
- "db_rpc_module": {
- "desc": "Protocol used for pushing transaction logs to the replicant nodes.",
- "label": "RPC Module"
- },
- "cluster_etcd_prefix": {
- "desc": "Key prefix used for EMQX service discovery.",
- "label": "Cluster Etcd Prefix"
- },
- "cluster_mcast_iface": {
- "desc": "Local IP address the node discovery service needs to bind to.",
- "label": "Cluster Multicast Interface"
- },
- "log_burst_limit_window_time": {
- "desc": "See max_count.",
- "label": "Window Time"
- },
- "cluster_dns_record_type": {
- "desc": "DNS record type.",
- "label": "DNS Record Type"
- },
- "cluster_autoclean": {
- "desc": "Remove disconnected nodes from the cluster after this interval.",
- "label": "Cluster Auto Clean"
- },
- "process_limit": {
- "desc": "Maximum number of simultaneously existing processes for this Erlang system.\nThe actual maximum chosen may be much larger than the Number passed.\nFor more information, see: https://www.erlang.org/doc/man/erl.html",
- "label": "Erlang Process Limit"
- },
- "max_ports": {
- "desc": "Maximum number of simultaneously existing ports for this Erlang system.\nThe actual maximum chosen may be much larger than the Number passed.\nFor more information, see: https://www.erlang.org/doc/man/erl.html",
- "label": "Erlang Port Limit"
- },
- "desc_log_rotation": {
- "desc": "By default, the logs are stored in `./log` directory (for installation from zip file) or in `/var/log/emqx` (for binary installation).\nThis section of the configuration controls the number of files kept for each log handler.", - "label": "Log Rotation" - }, - "desc_log_overload_kill": { - "desc": "Log overload kill features an overload protection that activates when the log handlers use too much memory or have too many buffered log messages.
\nWhen the overload is detected, the log handler is terminated and restarted after a cooldown period.", - "label": "Log Overload Kill" - }, - "authorization": { - "desc": "Authorization a.k.a. ACL.
\nIn EMQX, MQTT client access control is extremely flexible.
\nAn out-of-the-box set of authorization data sources are supported.\nFor example,
\n'file' source is to support concise and yet generic ACL rules in a file;
\n'built_in_database' source can be used to store per-client customizable rule sets,\nnatively in the EMQX node;
\n'http' source to make EMQX call an external HTTP API to make the decision;
\n'PostgreSQL' etc. to look up clients or rules from external databases", - "label": "Authorization" - }, - "rpc_socket_keepalive_idle": { - "desc": "How long the connections between the brokers should remain open after the last message is sent.", - "label": "RPC Socket Keepalive Idle" - }, - "desc_cluster_call": { - "desc": "Options for the 'cluster call' feature that allows to execute a callback on all nodes in the cluster.", - "label": "Cluster Call" - }, - "cluster_mcast_ports": { - "desc": "List of UDP ports used for service discovery.
\nNote: probe messages are broadcast to all the specified ports.", - "label": "Cluster Multicast Ports" - }, - "log_overload_kill_mem_size": { - "desc": "Maximum memory size that the log handler process is allowed to use.", - "label": "Log Handler Max Memory Size" - }, - "rpc_connect_timeout": { - "desc": "Timeout for establishing an RPC connection.", - "label": "RPC Connect Timeout" - }, - "cluster_etcd_node_ttl": { - "desc": "Expiration time of the etcd key associated with the node.\nIt is refreshed automatically, as long as the node is alive.", - "label": "Cluster Etcd Node TTL" - }, - "rpc_call_receive_timeout": { - "desc": "Timeout for the reply to a synchronous RPC.", - "label": "RPC Call Receive Timeout" - }, - "rpc_socket_recbuf": { - "desc": "TCP tuning parameters. TCP receiving buffer size.", - "label": "RPC Socket Recbuf" - }, - "db_tlog_push_mode": { - "desc": "In sync mode the core node waits for an ack from the replicant nodes before sending the next\ntransaction log entry.", - "label": "Tlog Push Mode" - }, - "node_crash_dump_bytes": { - "desc": "This variable sets the maximum size of a crash dump file in bytes.\nThe crash dump will be truncated if this limit is exceeded.\nIf setting it to 0, the runtime system does not even attempt to write a crash dump file.", - "label": "Crash Dump Bytes" - }, - "rpc_certfile": { - "desc": "Path to TLS certificate file used to validate identity of the cluster nodes.\nNote that this config only takes effect when
rpc.driver is set to ssl.",
- "label": "RPC Certfile"
- },
- "node_crash_dump_seconds": {
- "desc": "This variable gives the number of seconds that the emulator is allowed to spend writing a crash dump. When the given number of seconds have elapsed, the emulator is terminated.\n- If setting to 0 seconds, the runtime system does not even attempt to write the crash dump file. It only terminates.
\n- If setting to a positive value S, wait for S seconds to complete the crash dump file and then terminates the runtime system with a SIGALRM signal.
\n- A negative value causes the termination of the runtime system to wait indefinitely until the crash dump file has been completely written.", - "label": "Crash Dump Seconds" - }, - "log_file_handlers": { - "desc": "File-based log handlers.", - "label": "File Handler" - }, - "node_global_gc_interval": { - "desc": "Periodic garbage collection interval. Set to
disabled to have it disabled.",
- "label": "Global GC Interval"
- },
- "common_handler_time_offset": {
- "desc": "The time offset to be used when formatting the timestamp.\nCan be one of:\n - system: the time offset used by the local system\n - utc: the UTC time offset\n - +-[hh]:[mm]: user specified time offset, such as \"-02:00\" or \"+00:00\"\nDefaults to: system.",
- "label": "Time Offset"
- },
- "rpc_mode": {
- "desc": "In sync mode the sending side waits for the ack from the receiving side.",
- "label": "RPC Mode"
- },
- "node_crash_dump_file": {
- "desc": "Location of the crash dump file.",
- "label": "Crash Dump File"
- },
- "cluster_mcast_loop": {
- "desc": "If true, loop UDP datagrams back to the local socket.",
- "label": "Cluster Multicast Loop"
- },
- "rpc_socket_keepalive_interval": {
- "desc": "The interval between keepalive messages.",
- "label": "RPC Socket Keepalive Interval"
- },
- "common_handler_level": {
- "desc": "The log level for the current log handler.\nDefaults to warning.",
- "label": "Log Level"
- },
- "desc_rpc": {
- "desc": "EMQX uses a library called gen_rpc for inter-broker communication.\nMost of the time the default config should work,\nbut in case you need to do performance fine-tuning or experiment a bit,\nthis is where to look.", - "label": "RPC" - }, - "rpc_ssl_server_port": { - "desc": "Listening port used by RPC local service.
\nNote that this config only takes effect when rpc.port_discovery is set to manual\nand
driver is set to ssl.",
- "label": "RPC SSL Server Port"
- },
- "desc_cluster": {
- "desc": "EMQX nodes can form a cluster to scale up the total capacity.\n Here holds the configs to instruct how individual nodes can discover each other.", - "label": "Cluster" - }, - "common_handler_sync_mode_qlen": { - "desc": "As long as the number of buffered log events is lower than this value,\nall log events are handled asynchronously. This means that the client process sending the log event,\nby calling a log function in the Logger API, does not wait for a response from the handler\nbut continues executing immediately after the event is sent.\nIt is not affected by the time it takes the handler to print the event to the log device.\nIf the message queue grows larger than this value,\nthe handler starts handling log events synchronously instead,\nmeaning that the client process sending the event must wait for a response.\nWhen the handler reduces the message queue to a level below the sync_mode_qlen threshold,\nasynchronous operation is resumed.", - "label": "Queue Length before Entering Sync Mode" - }, - "common_handler_formatter": { - "desc": "Choose log formatter.
text for free text, and json for structured logging.",
- "label": "Log Formatter"
- },
- "rpc_async_batch_size": {
- "desc": "The maximum number of batch messages sent in asynchronous mode.\n Note that this configuration does not work in synchronous mode.",
- "label": "Async Batch Size"
- },
- "cluster_call_max_history": {
- "desc": "Retain the maximum number of completed transactions (for queries).",
- "label": "Cluster Call Max History"
- },
- "cluster_discovery_strategy": {
- "desc": "Service discovery method for the cluster nodes. Possible values are:\n- manual: Use emqx ctl cluster command to manage cluster.\n- static: Configure static nodes list by setting
seeds in config file.\n- dns: Use DNS A record to discover peer nodes.
\n- etcd: Use etcd to discover peer nodes.
\n- k8s: Use Kubernetes API to discover peer pods.", - "label": "Cluster Discovery Strategy" - }, - "rpc_send_timeout": { - "desc": "Timeout for sending the RPC request.", - "label": "RPC Send Timeout" - }, - "common_handler_single_line": { - "desc": "Print logs in a single line if set to true. Otherwise, log messages may span multiple lines.", - "label": "Single Line Mode" - }, - "rpc_socket_buffer": { - "desc": "TCP tuning parameters. Socket buffer size in user mode.", - "label": "RPC Socket Buffer" - }, - "db_shard_transports": { - "desc": "Allows to tune the transport method used for transaction log replication, on a per-shard basis.
\n
gen_rpc uses the gen_rpc library,\ndistr uses the Erlang distribution.If not specified,\nthe default is to use the value set in
db.default_shard_transport.",
- "label": "Shard Transports"
- },
- "common_handler_time_window": {
- "desc": "The time window for log throttling ensures that the same type of event is only logged once within the designated time frame to prevent log overflow. A detailed log encapsulating the activities within that period is generated at the end of the time window. The minimum configurable value for this window is one second.The following events are throttled:
- authorization_permission_denied
- cannot_publish_to_topic_due_to_not_authorized
- cannot_publish_to_topic_due_to_quota_exceeded
- connection_rejected_due_to_license_limit_reached
- dropped_msg_due_to_mqueue_is_full", - "label": "Time Window" - }, - "common_handler_payload_encode": { - "desc": "The encoding method of payload in logs", - "label": "Payload Encode" - } - }, - "emqx_limiter_schema": { - "max_conn_rate": { - "desc": "Maximum connection rate.
\nThis is used to limit the connection rate for this node,\nonce the limit is reached, new connections will be deferred or refused.", - "label": "Maximum Connection Rate" - }, - "messages_rate": { - "desc": "Messages publish rate.
\nThis is used to limit the inbound message numbers for this node,\nonce the limit is reached, the restricted client will slow down and even be hung for a while.", - "label": "Messages Publish Rate" - }, - "bytes_rate": { - "desc": "Data publish rate.
\nThis is used to limit the inbound bytes rate for this node,\nonce the limit is reached, the restricted client will slow down and even be hung for a while.", - "label": "Data Publish Rate" - } - }, - "emqx_schema": { - "fields_mqtt_quic_listener_peer_unidi_stream_count": { - "desc": "Number of unidirectional streams to allow the peer to open.", - "label": "Peer unidi stream count" - }, - "fields_authorization_no_match": { - "desc": "Default access control action if the user or client matches no ACL rules,\nor if no such user or client is found by the configurable authorization\nsources such as built_in_database, an HTTP API, or a query against PostgreSQL.\nFind more details in 'authorization.sources' config.", - "label": "Authorization no match" - }, - "sysmon_top_db_hostname": { - "desc": "Hostname of the PostgreSQL database that collects the data points", - "label": "DB Hostname" - }, - "zones": { - "desc": "A zone is a set of configs grouped by the zone
name.\nFor flexible configuration mapping, the name can be set to a listener's zone config.\nNOTE: A built-in zone named default is auto created and can not be deleted."
- },
- "fields_mqtt_quic_listener_certfile": {
- "desc": "Path to the certificate file. Will be deprecated in 5.1, use .ssl_options.certfile instead.",
- "label": "Certificate file"
- },
- "fields_rate_limit_conn_bytes_in": {
- "desc": "Limit the rate of receiving packets for a MQTT connection.\nThe rate is counted by bytes of packets per second.",
- "label": "Connection bytes in"
- },
- "crl_cache_capacity": {
- "desc": "The maximum number of CRL URLs that can be held in cache. If the cache is at full capacity and a new URL must be fetched, then it'll evict the oldest inserted URL in the cache.",
- "label": "CRL Cache Capacity"
- },
- "alarm_actions": {
- "desc": "The actions triggered when the alarm is activated.Currently, the following actions are supported:
log and publish.\nlog is to write the alarm to log (console or file).\npublish is to publish the alarm as an MQTT message to the system topics:\n$SYS/brokers/emqx{'@'}xx.xx.xx.x/alarms/activate and\n$SYS/brokers/emqx{'@'}xx.xx.xx.x/alarms/deactivate",
- "label": "Alarm Actions"
- },
- "base_listener_max_connections": {
- "desc": "The maximum number of concurrent connections allowed by the listener.",
- "label": "Max connections"
- },
- "mqtt_peer_cert_as_username": {
- "desc": "Use the CN, DN field in the peer certificate or the entire certificate content as Username. Only works for the TLS connection.\nSupported configurations are the following:\n- cn: CN field of the certificate\n- dn: DN field of the certificate\n- crt: Content of the DER or PEM certificate\n- pem: Convert DER certificate content to PEM format and use as Username\n- md5: MD5 value of the DER or PEM certificate",
- "label": "Use Peer Certificate as Username"
- },
- "fields_cache_enable": {
- "desc": "Enable or disable the authorization cache.",
- "label": "Enable or disable the authorization cache"
- },
- "fields_mqtt_quic_listener_disconnect_timeout_ms": {
- "desc": "How long to wait for an ACK before declaring a path dead and disconnecting. Default: 16000",
- "label": "Disconnect timeout ms"
- },
- "mqtt_max_topic_alias": {
- "label": "Max Topic Alias"
- },
- "common_ssl_opts_schema_user_lookup_fun": {
- "desc": "EMQX-internal callback that is used to lookup pre-shared key (PSK) identity.",
- "label": "SSL PSK user lookup fun"
- },
- "fields_listeners_wss": {
- "desc": "HTTPS websocket listeners.",
- "label": "HTTPS websocket listeners"
- },
- "sysmon_top_max_procs": {
- "desc": "Stop collecting data when the number of processes\nin the VM exceeds this value",
- "label": "Max procs"
- },
- "mqtt_use_username_as_clientid": {
- "desc": "Whether to use Username as Client ID.\nThis setting takes effect later than Use Peer Certificate as Username and Use Peer Certificate as Client ID.",
- "label": "Use Username as Client ID"
- },
- "mqtt_max_qos_allowed": {
- "label": "Max QoS Allowed"
- },
- "fields_mqtt_quic_listener_max_binding_stateless_operations": {
- "desc": "The maximum number of stateless operations that may be queued on a binding at any one time. Default: 100",
- "label": "Max binding stateless operations"
- },
- "fields_mqtt_quic_listener_stream_recv_buffer_default": {
- "desc": "Stream initial buffer size. Default: 4096",
- "label": "Stream recv buffer default"
- },
- "fields_mqtt_quic_listener_pacing_enabled": {
- "desc": "Pace sending to avoid overfilling buffers on the path. Default: 1 (Enabled)",
- "label": "Pacing enabled"
- },
- "mqtt_max_subscriptions": {
- "desc": "Maximum number of subscriptions allowed per client.",
- "label": "Max Subscriptions"
- },
- "persistent_session_builtin_messages_table": {
- "desc": "Performance tuning options for built-in messages table.",
- "label": "Persistent messages"
- },
- "sysmon_os_cpu_low_watermark": {
- "desc": "The threshold, as percentage of system CPU load,\n for how much system cpu can be used before the corresponding alarm is cleared.",
- "label": "CPU low watermark"
- },
- "fields_mqtt_quic_listener_tls_server_max_send_buffer": {
- "desc": "How much Server TLS data to buffer. Default: 8192",
- "label": "TLS server max send buffer"
- },
- "base_listener_bind": {
- "desc": "IP address and port for the listening socket.",
- "label": "IP address and port"
- },
- "server_ssl_opts_schema_handshake_timeout": {
- "desc": "Maximum time duration allowed for the handshake to complete",
- "label": "Handshake timeout"
- },
- "fields_deflate_opts_server_context_takeover": {
- "desc": "Takeover means the compression state is retained between server messages.",
- "label": "Server context takeover"
- },
- "mqtt_session_expiry_interval": {
- "desc": "Specifies how long the session will expire after the connection is disconnected, only for non-MQTT 5.0 connections.",
- "label": "Session Expiry Interval"
- },
- "mqtt_message_expiry_interval": {
- "desc": "The MQTT message expiry interval. For MQTT v5.0 clients, it is only effective if the Message-Expiry-Interval property is not specified for the message; for MQTT v3.1 and v3.1.1, it always applies. Note that it is not helpful to set this value to a greater value than the MQTT Session Expiry Interval, because once the session expires, all related messages are purged.",
- "label": "Message Expiry Interval"
- },
- "fields_listener_enabled": {
- "desc": "Enable listener.",
- "label": "Enable listener"
- },
- "mqtt": {
- "desc": "Global MQTT configuration.\nThe configs here work as default values which can be overridden in zone configs"
- },
- "crl_cache_refresh_http_timeout": {
- "desc": "The timeout for the HTTP request when fetching CRLs. This is a global setting for all listeners.",
- "label": "CRL Cache Refresh HTTP Timeout"
- },
- "fields_tcp_opts_backlog": {
- "desc": "TCP backlog defines the maximum length that the queue of\npending connections can grow to.",
- "label": "TCP backlog length"
- },
- "broker_route_batch_clean": {
- "desc": "Enable batch clean for deleted routes."
- },
- "fields_mqtt_quic_listener_initial_window_packets": {
- "desc": "The size (in packets) of the initial congestion window for a connection. Default: 10",
- "label": "Initial window packets"
- },
- "flapping_detect_enable": {
- "desc": "Enable flapping connection detection feature.",
- "label": "Enable flapping detection"
- },
- "sysmon_top_db_password": {
- "desc": "EMQX user password in the PostgreSQL database",
- "label": "DB Password"
- },
- "fields_ws_opts_check_origins": {
- "desc": "List of allowed origins.See
check_origin_enable.",
- "label": "Allowed origins"
- },
- "fields_deflate_opts_client_context_takeover": {
- "desc": "Takeover means the compression state is retained between client messages.",
- "label": "Client context takeover"
- },
- "base_listener_acceptors": {
- "desc": "The size of the listener's receiving pool.",
- "label": "Acceptors Num"
- },
- "common_ssl_opts_schema_cacertfile": {
- "desc": "Trusted PEM format CA certificates bundle file.\nThe certificates in this file are used to verify the TLS peer's certificates.\nAppend new certificates to the file if new CAs are to be trusted.\nThere is no need to restart EMQX to have the updated file loaded, because\nthe system regularly checks if file has been updated (and reload).
\nNOTE: invalidating (deleting) a certificate from the file will not affect\nalready established connections.", - "label": "CACertfile" - }, - "fields_ws_opts_mqtt_path": { - "desc": "WebSocket's MQTT protocol path. So the address of EMQX Broker's WebSocket is:\n
ws://{'{'}ip{'}'}:{'{'}port{'}'}/mqtt",
- "label": "WS MQTT Path"
- },
- "sysmon_os_procmem_high_watermark": {
- "desc": "The threshold, as percentage of system memory,\n for how much system memory can be allocated by one Erlang process before\n the corresponding alarm is raised.",
- "label": "ProcMem high wartermark"
- },
- "fields_listeners_quic": {
- "desc": "QUIC listeners.",
- "label": "QUIC listeners"
- },
- "fields_listeners_ws": {
- "desc": "HTTP websocket listeners.",
- "label": "HTTP websocket listeners"
- },
- "mqtt_retry_interval": {
- "desc": "Retry interval for QoS 1/2 message delivering.",
- "label": "Message Retry Interval"
- },
- "stats_enable": {
- "desc": "Enable/disable statistic data collection.",
- "label": "Enable/disable statistic data collection"
- },
- "fields_authorization_deny_action": {
- "desc": "The action when the authorization check rejects an operation.",
- "label": "Authorization deny action"
- },
- "fields_deflate_opts_server_max_window_bits": {
- "desc": "Specifies the size of the compression context for the server.",
- "label": "Server compression max window size"
- },
- "client_ssl_opts_schema_server_name_indication": {
- "desc": "Specify the host name to be used in TLS Server Name Indication extension.\nFor instance, when connecting to \"server.example.net\", the genuine server\nwhich accepts the connection and performs TLS handshake may differ from the\nhost the TLS client initially connects to, e.g. when connecting to an IP address\nor when the host has multiple resolvable DNS records
\nIf not specified, it will default to the host name string which is used\nto establish the connection, unless it is IP addressed used.
\nThe host name is then also used in the host name verification of the peer\ncertificate.
The special value 'disable' prevents the Server Name\nIndication extension from being sent and disables the hostname\nverification check.", - "label": "Server Name Indication" - }, - "fields_mqtt_quic_listener_retry_memory_limit": { - "desc": "The percentage of available memory usable for handshake connections before stateless retry is used. Calculated as `N/65535`. Default: 65", - "label": "Retry memory limit" - }, - "force_shutdown_max_message_queue_len": { - "desc": "Maximum message queue length.", - "label": "Maximum mailbox queue length of process" - }, - "sys_heartbeat_interval": { - "desc": "Time interval for publishing following heartbeat messages:\n - `$SYS/brokers/
\nSet to `\"\"` to disable the feature.
\n\nVariables in mountpoint string:\n -
${'{'}clientid{'}'}: clientid\n - ${'{'}username{'}'}: username",
- "label": "mountpoint"
- },
- "mqtt_max_awaiting_rel": {
- "desc": "Specifies the maximum number of pending QoS 2 messages in each session until either PUBREL is received or timed out. When this limit is reached, new QoS 2 PUBLISH requests will be rejected with error code 147(0x93).",
- "label": "Max Awaiting PUBREL"
- },
- "ciphers_schema_quic": {
- "desc": "This config holds TLS cipher suite names separated by comma,\nor as an array of strings. e.g.\n\"TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256\" or\n[\"TLS_AES_256_GCM_SHA384\",\"TLS_AES_128_GCM_SHA256\"].\n\nCiphers (and their ordering) define the way in which the\nclient and server encrypts information over the network connection.\nSelecting a good cipher suite is critical for the\napplication's data security, confidentiality and performance.\n\nThe names should be in OpenSSL string format (not RFC format).\nAll default values and examples provided by EMQX config\ndocumentation are all in OpenSSL format.
\n\nNOTE: Certain cipher suites are only compatible with\nspecific TLS
versions ('tlsv1.1', 'tlsv1.2' or 'tlsv1.3')\nincompatible cipher suites will be silently dropped.\nFor instance, if only 'tlsv1.3' is given in the versions,\nconfiguring cipher suites for other versions will have no effect.\n\n\nNOTE: PSK ciphers are suppressed by 'tlsv1.3' version config
\nIf PSK cipher suites are intended, 'tlsv1.3' should be disabled from
versions.\nPSK cipher suites:
\"RSA-PSK-AES256-GCM-SHA384,RSA-PSK-AES256-CBC-SHA384,\nRSA-PSK-AES128-GCM-SHA256,RSA-PSK-AES128-CBC-SHA256,\nRSA-PSK-AES256-CBC-SHA,RSA-PSK-AES128-CBC-SHA,\nRSA-PSK-DES-CBC3-SHA,RSA-PSK-RC4-SHA\"\n\nNOTE: QUIC listener supports only 'tlsv1.3' ciphers", - "label": "" - }, - "fields_mqtt_quic_listener_max_bytes_per_key": { - "desc": "Maximum number of bytes to encrypt with a single 1-RTT encryption key before initiating key update. Default: 274877906944", - "label": "Max bytes per key" - }, - "fields_mqtt_quic_listener_mtu_discovery_search_complete_timeout_us": { - "desc": "The time in microseconds to wait before reattempting MTU probing if max was not reached. Default: 600000000", - "label": "MTU discovery search complete timeout us" - }, - "fields_ws_opts_check_origin_enable": { - "desc": "If
true, origin HTTP header will be\n validated against the list of allowed origins configured in check_origins\n parameter.",
- "label": "Check origin"
- },
- "sysmon_vm_busy_dist_port": {
- "desc": "When the RPC connection used to communicate with other nodes in the cluster is overloaded,\nthere will be a busy_dist_port warning log,\nand an MQTT message is published to system topic $SYS/sysmon/busy_dist_port.",
- "label": "Enable Busy Distribution Port monitoring"
- },
- "mqtt_max_mqueue_len": {
- "desc": "Maximum allowed queue length when persistent client are disconnected or inflight window is full.",
- "label": "Max Message Queue Length"
- },
- "mqtt_max_inflight": {
- "desc": "Maximum number of QoS 1 and QoS 2 messages that are allowed to be delivered simultaneously before completing the acknowledgment.",
- "label": "Max Inflight"
- },
- "persistent_session_store_enabled": {
- "desc": "Use the database to store information about persistent sessions.\nThis makes it possible to migrate a client connection to another\ncluster node if a node is stopped.",
- "label": "Enable persistent session store"
- },
- "fields_deflate_opts_level": {
- "desc": "Compression level.",
- "label": "Compression level"
- },
- "mqtt_server_keepalive": {
- "label": "Server Keep Alive"
- },
- "global_authentication": {
- "desc": "Default authentication configs for all MQTT listeners.\n\nFor per-listener overrides see authentication in listener configs\n\nThis option can be configured with:\n- \n
[]: The default value, it allows *ALL* logins \n - one: For example
{'{'}enable:true,backend:\"built_in_database\",mechanism=\"password_based\"{'}'}\n - chain: An array of structs. \n
The alarm is cleared only when there's no pending data in
the queue, and at least
min_alarm_sustain_durationmilliseconds passed since the last time we considered the connection 'congested'.This is to avoid clearing and raising the alarm again too often.", - "label": "Sustain duration" - }, - "fields_mqtt_quic_listener_keep_alive_interval_ms": { - "desc": "How often to send PING frames to keep a connection alive.", - "label": "Keep alive interval ms" - }, - "fields_mqtt_quic_listener_handshake_idle_timeout_ms": { - "desc": "How long a handshake can idle before it is discarded", - "label": "Handshake idle timeout ms" - }, - "broker_session_locking_strategy": { - "desc": "Session locking strategy in a cluster.\n - `local`: only lock the session on the current node\n - `one`: select only one remote node to lock the session\n - `quorum`: select some nodes to lock the session\n - `all`: lock the session on all the nodes in the cluster" - }, - "persistent_store_ram_cache": { - "desc": "Maintain a copy of the data in RAM for faster access.", - "label": "RAM cache" - }, - "fields_mqtt_quic_listener_stream_recv_window_default": { - "desc": "Initial stream receive window size. Default: 32678", - "label": "Stream recv window default" - }, - "mqtt_mqueue_priorities": { - "desc": "Topic priorities. Priority number [1-255]. There's no priority table by default, hence all messages are treated equal.
NOTE: Comma and equal signs are not allowed for priority topic names.
NOTE: Messages for topics not in the priority table are treated as either highest or lowest priority depending on the configured value for mqtt.mqueue_default_priority.
Examples:
To configure \"topic/1\" > \"topic/2\":
mqueue_priorities: {'{'}\"topic/1\": 10, \"topic/2\": 8{'}'}", - "label": "Topic Priorities" - }, - "fields_rate_limit_conn_messages_in": { - "desc": "Message limit for the external MQTT connections.", - "label": "connecting messages in" - }, - "fields_rate_limit_max_conn_rate": { - "desc": "Maximum connections per second.", - "label": "Max connection rate" - }, - "alarm_size_limit": { - "desc": "The maximum total number of deactivated alarms to keep as history.
When this limit is exceeded, the oldest deactivated alarms are deleted to cap the total number.", - "label": "Alarm size limit" - }, - "fields_cache_max_size": { - "desc": "Maximum number of cached items.", - "label": "Maximum number of cached items" - }, - "fields_listeners_tcp": { - "desc": "TCP listeners.", - "label": "TCP listeners" - }, - "conn_congestion_enable_alarm": { - "desc": "Enable or disable connection congestion alarm.", - "label": "Enable/disable congestion alarm" - }, - "fields_ws_opts_proxy_port_header": { - "desc": "HTTP header used to pass information about the client port. Relevant when the EMQX cluster is deployed behind a load-balancer.", - "label": "Proxy port header" - }, - "overload_protection_enable": { - "desc": "React on system overload or not.", - "label": "React on system overload or not" - }, - "fields_mqtt_quic_listener_minimum_mtu": { - "desc": "The minimum MTU supported by a connection. This will be used as the starting MTU. Default: 1248", - "label": "Minimum MTU" - }, - "sys_msg_interval": { - "desc": "Time interval of publishing `$SYS` messages." - }, - "mqtt_await_rel_timeout": { - "desc": "Specifies the amount of time to wait for a publish of a QoS 2 message with no PUBREL received. When this limit is reached, EMQX will release the packet ID and also output a warning level log. \nNote: EMQX’s forwarding of the received QoS 2 message is independent from the receiving of PUBREL", - "label": "Max Awaiting PUBREL Timeout" - }, - "common_ssl_opts_schema_verify": { - "desc": "Enable or disable peer verification.", - "label": "Verify peer" - }, - "fields_listeners_ssl": { - "desc": "SSL listeners.", - "label": "SSL listeners" - }, - "fields_deflate_opts_client_max_window_bits": { - "desc": "Specifies the size of the compression context for the client.", - "label": "Client compression max window size" - }, - "common_ssl_opts_schema_keyfile": { - "desc": "PEM format private key file.", - "label": "Keyfile" - }, - "sysmon_os_cpu_high_watermark": { - "desc": "The threshold, as percentage of system CPU load,\n for how much system cpu can be used before the corresponding alarm is raised.", - "label": "CPU high watermark" - }, - "flapping_detect_window_time": { - "desc": "The time window for flapping detection.", - "label": "Window time" - }, - "mqtt_mqueue_default_priority": { - "desc": "Default topic priority, which will be used by topics not in
Topic Priorities (mqueue_priorities).",
- "label": "Default Topic Priorities"
- },
- "client_ssl_opts_schema_enable": {
- "desc": "Enable TLS.",
- "label": "Enable TLS"
- },
- "fields_mqtt_quic_listener_mtu_discovery_missing_probe_count": {
- "desc": "The maximum number of stateless operations that may be queued on a binding at any one time. Default: 3",
- "label": "MTU discovery missing probe count"
- },
- "fields_tcp_opts_recbuf": {
- "desc": "The TCP receive buffer (OS kernel) for the connections.",
- "label": "TCP receive buffer"
- },
- "sysmon_vm_process_check_interval": {
- "desc": "The time interval for the periodic process limit check.",
- "label": "Process limit check interval"
- },
- "fields_mqtt_quic_listener_server_resumption_level": {
- "desc": "Controls resumption tickets and/or 0-RTT server support. Default: 0 (No resumption)",
- "label": "Server resumption level"
- },
- "fields_ws_opts_proxy_address_header": {
- "desc": "HTTP header used to pass information about the client IP address.\nRelevant when the EMQX cluster is deployed behind a load-balancer.",
- "label": "Proxy address header"
- },
- "sysmon_os_sysmem_high_watermark": {
- "desc": "The threshold, as percentage of system memory,\n for how much system memory can be allocated before the corresponding alarm is raised.",
- "label": "SysMem high wartermark"
- },
- "fields_tcp_opts_high_watermark": {
- "desc": "The socket is set to a busy state when the amount of data queued internally\nby the VM socket implementation reaches this limit.",
- "label": "TCP 高水位线"
- },
- "fields_mqtt_quic_listener_stateless_operation_expiration_ms": {
- "desc": "The time limit between operations for the same endpoint, in milliseconds. Default: 100",
- "label": "Stateless operation expiration ms"
- },
- "server_ssl_opts_schema_dhfile": {
- "desc": "Path to a file containing PEM-encoded Diffie-Hellman parameters\nto be used by the server if a cipher suite using Diffie-Hellman\nkey exchange is negotiated. If not specified, default parameters\nare used.\nNOTE: The
dhfile option is not supported by TLS 1.3.",
- "label": "SSL dhfile"
- },
- "flapping_detect_max_count": {
- "desc": "The maximum number of disconnects allowed for a MQTT Client in `window_time`",
- "label": "Max count"
- },
- "mqtt_max_topic_levels": {
- "label": "Max Topic Levels"
- },
- "force_shutdown_max_heap_size": {
- "desc": "Total heap size",
- "label": "Total heap size"
- },
- "persistent_store_on_disc": {
- "desc": "Save information about the persistent sessions on disc.\nIf this option is enabled, persistent sessions will survive full restart of the cluster.\nOtherwise, all the data will be stored in RAM, and it will be lost when all the nodes in the cluster are stopped.",
- "label": "Persist on disc"
- },
- "mqtt_ignore_loop_deliver": {
- "desc": "Whether the messages sent by the MQTT v3.1.1/v3.1.0 client will be forwarded to the client itself, similar to `No Local` in MQTT 5.0.",
- "label": "Ignore Loop Deliver"
- },
- "common_ssl_opts_schema_certfile": {
- "desc": "PEM format certificates chain file.\nThe certificates in this file should be in reversed order of the certificate\nissue chain. That is, the host's certificate should be placed in the beginning\nof the file, followed by the immediate issuer certificate and so on.\nAlthough the root CA certificate is optional, it should be placed at the end of\nthe file if it is to be added.", - "label": "Certfile" - }, - "mqtt_exclusive_subscription": { - "label": "Allowed Exclusive Subscription" - }, - "mqtt_retain_available": { - "desc": "Whether to enable support for MQTT retained message. When this option is disabled, clients will not be able to publish retained messages.", - "label": "Allowed Retain" - }, - "fields_tcp_opts_reuseaddr": { - "desc": "The SO_REUSEADDR flag for the connections.", - "label": "SO_REUSEADDR" - }, - "sysmon_vm_long_schedule": { - "desc": "When the Erlang VM detect a task scheduled for too long, a warning level 'long_schedule' log is emitted,\nand an MQTT message is published to the system topic
$SYS/sysmon/long_schedule.",
- "label": "Enable Long Schedule monitoring"
- },
- "mqtt_keepalive_multiplier": {
- "desc": "`Keep-Alive Timeout = Keep-Alive Interval × Keep-Alive Multiplier`. Default value is 1.5 as per MQTT 5.0.\n\nFor example, a Keep-Alive interval of 10 seconds yields a timeout of 15 seconds with a multiplier of 1.5. Increasing the multiplier value to 2 extends the timeout to 20 seconds.",
- "label": "Keep Alive Multiplier"
- },
- "force_gc_bytes": {
- "desc": "GC the process after specified number of bytes have passed through.",
- "label": "Process GC bytes"
- },
- "server_ssl_opts_schema_fail_if_no_peer_cert": {
- "desc": "Used together with {'{'}verify, verify_peer{'}'} by an TLS/DTLS server.\nIf set to true, the server fails if the client does not have a\ncertificate to send, that is, sends an empty certificate.\nIf set to false, it fails only if the client sends an invalid\ncertificate (an empty certificate is considered valid).",
- "label": "Force Verify Peer Certificate"
- },
- "fields_ws_opts_compress": {
- "desc": "If true, compress WebSocket messages using zlib.\nThe configuration items under
deflate_opts belong to the compression-related parameter configuration.",
- "label": "Ws compress"
- },
- "fields_mqtt_quic_listener_keep_alive_interval": {
- "desc": "How often to send PING frames to keep a connection alive. 0 means disabled.",
- "label": "Keep Alive Interval"
- },
- "fields_cache_ttl": {
- "desc": "Time to live for the cached data.",
- "label": "Time to live for the cached data"
- },
- "sys_topics": {
- "desc": "System topics configuration."
- },
- "sys_event_client_subscribed": {
- "desc": "Enable to publish event message that client subscribed a topic successfully."
- },
- "sysmon_top_db_port": {
- "desc": "Port of the PostgreSQL database that collects the data points.",
- "label": "DB Port"
- },
- "fields_mqtt_quic_listener_max_operations_per_drain": {
- "desc": "The maximum number of operations to drain per connection quantum. Default: 16",
- "label": "Max operations per drain"
- },
- "fields_mqtt_quic_listener_datagram_receive_enabled": {
- "desc": "Advertise support for QUIC datagram extension. Reserve for the future. Default 0 (FALSE)",
- "label": "Datagram receive enabled"
- },
- "fields_mqtt_quic_listener_initial_rtt_ms": {
- "desc": "Initial RTT estimate.",
- "label": "Initial RTT ms"
- },
- "overload_protection_backoff_gc": {
- "desc": "When at high load, skip forceful GC.",
- "label": "Skip GC"
- },
- "broker_perf_route_lock_type": {
- "desc": "Performance tuning for subscribing/unsubscribing a wildcard topic.\nChange this parameter only when there are many wildcard topics.\n\nNOTE: when changing from/to `global` lock, it requires all nodes in the cluster to be stopped before the change.\n - `key`: mnesia transactional updates with per-key locks. Recommended for a single-node setup.\n - `tab`: mnesia transactional updates with table lock. Recommended for a cluster setup.\n - `global`: updates are protected with a global lock. Recommended for large clusters."
- },
- "fields_tcp_opts_nodelay": {
- "desc": "The TCP_NODELAY flag for the connections.",
- "label": "TCP_NODELAY"
- },
- "sysmon_top_db_username": {
- "desc": "Username of the PostgreSQL database",
- "label": "DB Username"
- },
- "broker": {
- "desc": "Message broker options."
- },
- "force_gc_count": {
- "desc": "GC the process after this many received messages.",
- "label": "Process GC messages num"
- },
- "mqtt_max_clientid_len": {
- "label": "Max Client ID Length"
- },
- "fields_ws_opts_supported_subprotocols": {
- "desc": "Comma-separated list of supported subprotocols.",
- "label": "Supported subprotocols"
- },
- "broker_shared_subscription_strategy": {
- "desc": "Dispatch strategy for shared subscription.\n - `random`: dispatch the message to a random selected subscriber\n - `round_robin`: select the subscribers in a round-robin manner\n - `round_robin_per_group`: select the subscribers in round-robin fashion within each shared subscriber group\n - `local`: select random local subscriber otherwise select random cluster-wide\n - `sticky`: always use the last selected subscriber to dispatch, until the subscriber disconnects.\n - `hash_clientid`: select the subscribers by hashing the `clientIds` of senders.\n - `hash_topic`: select the subscribers by hashing the source topic"
- },
- "fields_deflate_opts_mem_level": {
- "desc": "Specifies the size of the compression state.\nLower values decrease memory usage per connection.", - "label": "Size of the compression state" - }, - "fields_mqtt_quic_listener_send_idle_timeout_ms": { - "desc": "Reset congestion control after being idle for amount of time. Default: 1000", - "label": "Send idle timeout ms" - }, - "base_listener_limiter": { - "desc": "Type of the rate limit.", - "label": "Type of the rate limit" - }, - "persistent_session_store_backend": { - "desc": "Database management system used to store information about persistent sessions and messages.\n- `builtin`: Use the embedded database (mria)", - "label": "Backend" - }, - "alarm_validity_period": { - "desc": "Retention time of deactivated alarms. Alarms are not deleted immediately\nwhen deactivated, but after the retention time.", - "label": "Alarm validity period" - }, - "server_ssl_opts_schema_ocsp_issuer_pem": { - "desc": "PEM-encoded certificate of the OCSP issuer for the server certificate.", - "label": "OCSP Issuer Certificate" - }, - "fields_tcp_opts_active_n": { - "desc": "Specify the {'{'}active, N{'}'} option for this Socket.
\nSee: https://erlang.org/doc/man/inet.html#setopts-2", - "label": "active_n" - }, - "listener_authentication": { - "desc": "Per-listener authentication override.\nAuthentication can be one single authenticator instance or a chain of authenticators as an array.\nWhen authenticating a login (username, client ID, etc.) the authenticators are checked in the configured order.", - "label": "Per-listener authentication override" - }, - "fields_trace_payload_encode": { - "desc": "Determine the format of the payload format in the trace log file.
\n`text`: Text-based protocol or plain text protocol.\n It is recommended when payload is JSON encoded.
\n`hex`: Binary hexadecimal encode. It is recommended when payload is a custom binary protocol.
\n`hidden`: payload is obfuscated as `******`", - "label": "Payload encode" - }, - "mqtt_response_information": { - "desc": "Response Information
UTF-8 string, for creating the response topic, for example, if set to `reqrsp/`, the publisher/subscriber will communite under the topic `reqrsp/`.To disable this feature, input `\"\"` in the text box below.", - "label": "Response Information" - }, - "persistent_session_store_max_retain_undelivered": { - "desc": "The time messages that was not delivered to a persistent session\nis stored before being garbage collected if the node the previous\nsession was handled on restarts of is stopped.", - "label": "Max retain undelivered" - }, - "fields_mqtt_quic_listener_migration_enabled": { - "desc": "Enable clients to migrate IP addresses and tuples. Requires a cooperative load-balancer, or no load-balancer. Default: 1 (Enabled)", - "label": "Migration enabled" - }, - "common_ssl_opts_schema_password": { - "desc": "String containing the user's password. Only used if the private key file is password-protected.", - "label": "Keyfile passphrase" - }, - "common_ssl_opts_schema_hibernate_after": { - "desc": "Hibernate the SSL process after idling for amount of time reducing its memory footprint.", - "label": "hibernate after" - }, - "fields_mqtt_quic_listener_send_buffering_enabled": { - "desc": "Buffer send data instead of holding application buffers until sent data is acknowledged. Default: 1 (Enabled)", - "label": "Send buffering enabled" - }, - "sys_event_client_unsubscribed": { - "desc": "Enable to publish event message that client unsubscribed a topic successfully." - }, - "overload_protection_backoff_new_conn": { - "desc": "When at high load, close new incoming connections.", - "label": "Close new connections" - }, - "server_ssl_opts_schema_ocsp_responder_url": { - "desc": "URL for the OCSP responder to check the server certificate against.", - "label": "OCSP Responder URL" - }, - "mqtt_idle_timeout": { - "desc": "Configure the duration of time that a connection can remain idle (i.e., without any data transfer) before being: \n\n- Automatically disconnected if no CONNECT package is received from the client yet. \n- Put into hibernation mode to save resources if some CONNECT packages are already received.\n\nNote: Please set the parameter with caution as long idle time will lead to resource waste.", - "label": "Idle Timeout" - }, - "fields_mqtt_quic_listener_conn_flow_control_window": { - "desc": "Connection-wide flow control window. Default: 16777216", - "label": "Conn flow control window" - }, - "fields_mqtt_quic_listener_maximum_mtu": { - "desc": "The maximum MTU supported by a connection. This will be the maximum probed value. Default: 1500", - "label": "Maximum MTU" - }, - "sysmon_top_db_name": { - "desc": "PostgreSQL database name", - "label": "DB Name" - }, - "mqtt_strict_mode": { - "desc": "Whether to parse MQTT messages in strict mode.\nIn strict mode, invalid utf8 strings in for example client ID, topic name, etc. will cause the client to be disconnected.", - "label": "Strict Mode" - }, - "shared_subscription_group_strategy": { - "desc": "Per group dispatch strategy for shared subscription.\nThis config is a map from shared subscription group name to the strategy\nname. The group name should be of format `[A-Za-z0-9]`. i.e. no\nspecial characters are allowed." - }, - "fields_deflate_opts_strategy": { - "desc": "Specifies the compression strategy.", - "label": "compression strategy" - }, - "shared_subscription_strategy_enum": { - "desc": "Dispatch strategy for shared subscription.\n- `random`: dispatch the message to a random selected subscriber\n- `round_robin`: select the subscribers in a round-robin manner\n- `round_robin_per_group`: select the subscribers in round-robin fashion within each shared subscriber group\n- `sticky`: always use the last selected subscriber to dispatch,\nuntil the subscriber disconnects.\n- `hash`: select the subscribers by the hash of `clientIds`\n- `local`: send to a random local subscriber. If local\nsubscriber was not found, send to a random subscriber cluster-wide" - }, - "persistent_session_builtin_sess_msg_table": { - "desc": "Performance tuning options for built-in session messages table.", - "label": "Persistent session messages" - }, - "mqtt_mqueue_store_qos0": { - "desc": "Specifies whether to store QoS 0 messages in the message queue while the connection is down but the session remains.", - "label": "Store QoS 0 Message" - }, - "server_ssl_opts_schema_client_renegotiation": { - "desc": "In protocols that support client-initiated renegotiation,\nthe cost of resources of such an operation is higher for the server than the client.\nThis can act as a vector for denial of service attacks.\nThe SSL application already takes measures to counter-act such attempts,\nbut client-initiated renegotiation can be strictly disabled by setting this option to false.\nThe default value is true. Note that disabling renegotiation can result in\nlong-lived connections becoming unusable due to limits on\nthe number of messages the underlying cipher suite can encipher.", - "label": "SSL client renegotiation" - }, - "server_ssl_opts_schema_enable_crl_check": { - "desc": "Whether to enable CRL verification for this listener.", - "label": "Enable CRL Check" - }, - "fields_mqtt_quic_listener_peer_bidi_stream_count": { - "desc": "Number of bidirectional streams to allow the peer to open.", - "label": "Peer bidi stream count" - }, - "fields_mqtt_quic_listener_max_stateless_operations": { - "desc": "The maximum number of stateless operations that may be queued on a worker at any one time. Default: 16", - "label": "Max stateless operations" - }, - "fields_ws_opts_idle_timeout": { - "desc": "Close transport-layer connections from the clients that have not sent MQTT CONNECT message within this interval.", - "label": "WS idle timeout" - }, - "fields_mqtt_quic_listener_max_ack_delay_ms": { - "desc": "How long to wait after receiving data before sending an ACK. Default: 25", - "label": "Max ack delay ms" - }, - "base_listener_zone": { - "desc": "The configuration zone to which the listener belongs.", - "label": "Zone" - }, - "fields_mqtt_quic_listener_handshake_idle_timeout": { - "desc": "How long a handshake can idle before it is discarded.", - "label": "Handshake Idle Timeout" - }, - "force_gc_enable": { - "desc": "Enable forced garbage collection.", - "label": "Enable forced garbage collection" - }, - "fields_ws_opts_allow_origin_absence": { - "desc": "If
false and check_origin_enable is\n true, the server will reject requests that don't have origin\n HTTP header.",
- "label": "Allow origin absence"
- },
- "common_ssl_opts_schema_versions": {
- "desc": "All TLS/DTLS versions to be supported.\nNOTE: PSK ciphers are suppressed by 'tlsv1.3' version config.
\nIn case PSK cipher suites are intended, make sure to configure\n
['tlsv1.2', 'tlsv1.1'] here.",
- "label": "SSL versions"
- },
- "mqtt_listener_proxy_protocol_timeout": {
- "desc": "Timeout for proxy protocol. EMQX will close the TCP connection if proxy protocol packet is not received within the timeout.",
- "label": "Proxy protocol timeout"
- },
- "fields_mqtt_quic_listener_idle_timeout": {
- "desc": "How long a connection can go idle before it is gracefully shut down. 0 to disable",
- "label": "Idle Timeout"
- },
- "common_ssl_opts_schema_secure_renegotiate": {
- "desc": "SSL parameter renegotiation is a feature that allows a client and a server\nto renegotiate the parameters of the SSL connection on the fly.\nRFC 5746 defines a more secure way of doing this. By enabling secure renegotiation,\nyou drop support for the insecure renegotiation, prone to MitM attacks.",
- "label": "SSL renegotiate"
- },
- "sysmon_vm_busy_port": {
- "desc": "When a port (e.g. TCP socket) is overloaded, there will be a busy_port warning log,\nand an MQTT message is published to the system topic $SYS/sysmon/busy_port.",
- "label": "Enable Busy Port monitoring"
- },
- "sys_event_client_connected": {
- "desc": "Enable to publish client connected event messages"
- },
- "sysmon_vm_process_low_watermark": {
- "desc": "The threshold, as percentage of processes, for how many\n processes can simultaneously exist at the local node before the corresponding\n alarm is cleared.",
- "label": "Process low watermark"
- },
- "mqtt_max_packet_size": {
- "desc": "If the size is out of the preset value, EMQX will disconnect the current connection",
- "label": "Max Packet Size"
- },
- "common_ssl_opts_schema_reuse_sessions": {
- "desc": "Enable TLS session reuse.",
- "label": "TLS session reuse"
- },
- "common_ssl_opts_schema_depth": {
- "desc": "Maximum number of non-self-issued intermediate certificates that can follow the peer certificate in a valid certification path.\nSo, if depth is 0 the PEER must be signed by the trusted ROOT-CA directly;\nif 1 the path can be PEER, Intermediate-CA, ROOT-CA;
\nif 2 the path can be PEER, Intermediate-CA1, Intermediate-CA2, ROOT-CA.", - "label": "CACert Depth" - }, - "sysmon_vm_long_gc": { - "desc": "When an Erlang process spends long time to perform garbage collection, a warning level
long_gc log is emitted,\nand an MQTT message is published to the system topic $SYS/sysmon/long_gc.",
- "label": "Enable Long GC monitoring"
- },
- "fields_mqtt_quic_listener_keyfile": {
- "desc": "Path to the secret key file. Will be deprecated in 5.1, use .ssl_options.keyfile instead.",
- "label": "Key file"
- },
- "mqtt_peer_cert_as_clientid": {
- "desc": "Use the CN, DN field in the peer certificate or the entire certificate content as Client ID. Only works for the TLS connection.\nSupported configurations are the following:\n- cn: CN field of the certificate\n- dn: DN field of the certificate\n- crt: DER or PEM certificate\n- pem: Convert DER certificate content to PEM format and use as Client ID\n- md5: MD5 value of the DER or PEM certificate",
- "label": "Use Peer Certificate as Client ID"
- },
- "persistent_session_store_message_gc_interval": {
- "desc": "The starting interval for garbage collection of undelivered messages to\na persistent session. This affects how often the \"max_retain_undelivered\"\nis checked for removal.",
- "label": "Message GC interval"
- },
- "broker_shared_dispatch_ack_enabled": {
- "desc": "Deprecated, will be removed in 5.1.\nEnable/disable shared dispatch acknowledgement for QoS 1 and QoS 2 messages.\nThis should allow messages to be dispatched to a different subscriber in the group in case the picked (based on `shared_subscription_strategy`) subscriber is offline."
- },
- "base_listener_enable_authn": {
- "desc": "Set true (default) to enable client authentication on this listener, the authentication\nprocess goes through the configured authentication chain.\nWhen set to false to allow any clients with or without authentication information such as username or password to log in.\nWhen set to quick_deny_anonymous, it behaves like when set to true, but clients will be\ndenied immediately without going through any authenticators if username is not provided. This is useful to fence off\nanonymous clients early.",
- "label": "Enable authentication"
- },
- "force_shutdown_enable": {
- "desc": "Enable `force_shutdown` feature.",
- "label": "Enable `force_shutdown` feature"
- },
- "broker_enable_session_registry": {
- "desc": "Enable session registry"
- },
- "overload_protection_backoff_delay": {
- "desc": "The maximum duration of delay for background task execution during high load conditions.",
- "label": "Delay Time"
- },
- "ciphers_schema_common": {
- "desc": "This config holds TLS cipher suite names separated by comma,\nor as an array of strings. e.g.\n\"TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256\" or\n[\"TLS_AES_256_GCM_SHA384\",\"TLS_AES_128_GCM_SHA256\"].\n\nCiphers (and their ordering) define the way in which the\nclient and server encrypts information over the network connection.\nSelecting a good cipher suite is critical for the\napplication's data security, confidentiality and performance.\n\nThe names should be in OpenSSL string format (not RFC format).\nAll default values and examples provided by EMQX config\ndocumentation are all in OpenSSL format.
\n\nNOTE: Certain cipher suites are only compatible with\nspecific TLS
versions ('tlsv1.1', 'tlsv1.2' or 'tlsv1.3')\nincompatible cipher suites will be silently dropped.\nFor instance, if only 'tlsv1.3' is given in the versions,\nconfiguring cipher suites for other versions will have no effect.\n\n\nNOTE: PSK ciphers are suppressed by 'tlsv1.3' version config
\nIf PSK cipher suites are intended, 'tlsv1.3' should be disabled from
versions.\nPSK cipher suites:
\"RSA-PSK-AES256-GCM-SHA384,RSA-PSK-AES256-CBC-SHA384,\nRSA-PSK-AES128-GCM-SHA256,RSA-PSK-AES128-CBC-SHA256,\nRSA-PSK-AES256-CBC-SHA,RSA-PSK-AES128-CBC-SHA,\nRSA-PSK-DES-CBC3-SHA,RSA-PSK-RC4-SHA\"",
- "label": ""
- },
- "sys_event_client_disconnected": {
- "desc": "Enable to publish client disconnected event messages."
- },
- "crl_cache_refresh_interval": {
- "desc": "The period to refresh the CRLs from the servers. This is a global setting for all URLs and listeners.",
- "label": "CRL Cache Refresh Interval"
- },
- "mqtt_listener_proxy_protocol": {
- "desc": "Enable the Proxy Protocol V1/2 if the EMQX cluster is deployed behind HAProxy or Nginx.\nSee: https://www.haproxy.com/blog/haproxy/proxy-protocol/", - "label": "Proxy protocol" - }, - "mqtt_listener_access_rules": { - "desc": "The access control rules for this listener.
See: https://github.com/emqtt/esockd#allowdeny", - "label": "Access rules" - }, - "server_ssl_opts_schema_enable_ocsp_stapling": { - "desc": "Whether to enable Online Certificate Status Protocol (OCSP) stapling for the listener. If set to true, requires defining the OCSP responder URL and issuer PEM path.", - "label": "Enable OCSP Stapling" - }, - "fields_tcp_opts_send_timeout_close": { - "desc": "Close the connection if send timeout.", - "label": "TCP send timeout close" - }, - "sysmon_os_cpu_check_interval": { - "desc": "The time interval for the periodic CPU check.", - "label": "The time interval for the periodic CPU check" - }, - "sysmon_top_sample_interval": { - "desc": "Specifies how often process top should be collected", - "label": "Top sample interval" - }, - "fields_mqtt_quic_listener_idle_timeout_ms": { - "desc": "How long a connection can go idle before it is gracefully shut down. 0 to disable timeout", - "label": "Idle timeout ms" - }, - "fields_ws_opts_fail_if_no_subprotocol": { - "desc": "If
true, the server will return an error when\n the client does not carry the Sec-WebSocket-Protocol field.\n Note: WeChat applet needs to disable this verification.", - "label": "Fail if no subprotocol" - }, - "mqtt_wildcard_subscription": { - "label": "Allowed Wildcard Subscription" - }, - "server_ssl_opts_schema_ocsp_refresh_interval": { - "desc": "The period to refresh the OCSP response for the server.", - "label": "OCSP Refresh Interval" - }, - "overload_protection_backoff_hibernation": { - "desc": "When at high load, skip process hibernation.", - "label": "Skip hibernation" - }, - "fields_ws_opts_max_frame_size": { - "desc": "The maximum length of a single MQTT packet.", - "label": "Max frame size" - }, - "sys_event_messages": { - "desc": "Client events messages." - }, - "broker_perf_trie_compaction": { - "desc": "Enable trie path compaction.\nEnabling it significantly improves wildcard topic subscribe rate, if wildcard topics have unique prefixes like: 'sensor/{'{'}{'{'}id{'}'}{'}'}/+/', where ID is unique per subscriber.\nTopic match performance (when publishing) may degrade if messages are mostly published to topics with large number of levels.\n\nNOTE: This is a cluster-wide configuration. It requires all nodes to be stopped before changing it." - }, - "sysmon_vm_large_heap": { - "desc": "When an Erlang process consumed a large amount of memory for its heap space,\nthe system will write a warning level
large_heap log, and an MQTT message is published to\nthe system topic $SYS/sysmon/large_heap.",
- "label": "Enable Large Heap monitoring"
- },
- "mqtt_shared_subscription_strategy": {
- "label": "Shared Subscription Strategy",
- "desc": "Dispatch strategy for shared subscription.- `random`: dispatch the message to a random selected subscriber
- `round_robin`: select the subscribers in a round-robin manner
- `round_robin_per_group`: select the subscribers in round-robin fashion within each shared subscriber group
- `sticky`: always use the last selected subscriber to dispatch, until the subscriber disconnects.
- `local`: select random local subscriber otherwise select random cluster-wide
- `hash_topic`: select the subscribers by hashing the source topic
- `hash_clientid`: select the subscribers by hashing the `clientIds` of senders" - }, - "mqtt_client_attrs_init": { - "label": "Client Attributes", - "desc": "Set custom attributes on client connection and use them in authentication, authorization, and other functions." - }, - "client_attrs_init_set_as_attr": { - "label": "Attribute" - }, - "client_attrs_init_expression": { - "label": "Attribute Expression", - "desc": "A single-line expression that dynamically extracts attribute values from existing client information can use the following fields:
- `clientid`: client ID
- `username`: user name
- `cn`: CN field of TLS certificate
- `dn`: DN field of TLS certificate
- `user_property.*`: extracts the property value from the `User-Property` of the MQTT CONNECT packet, e.g. `user_property.foo`
You can use predefined string functions to dynamically process the information. For example, to extract the prefix of a dot-separated client ID: `nth(1, tokens(clientid, '.'))`; to extract a partial username: `substr(username, 0, 5)`. You can read more about variform expressions in EMQX docs.
" - }, - "mqtt_keepalive_check_interval": { - "label": "Keep Alive Check Interval", - "desc": "The frequency of checking for incoming MQTT packets determines how often the server will check for new MQTT packets.
If a certain amount of time passes without any packets being sent from the client, this time will be added up.
Once the accumulated time exceeds `keepalive-interval * keepalive-multiplier`, the connection will be terminated.
The default is set to 30 seconds, with a minimum value of 1 second and a maximum value of `keepalive-interval / 2`.
" - }, - "mqtt_shared_subscription_initial_sticky_pick": { - "label": "Shared Subscription Initial Sticky Pick", - "desc": "The strategy to use for the initial subscriber pick when `Shared Subscription Strategy` is `sticky`.
- `random`: Randomly select the subscriber;
- `local`: Randomly select a subscriber on the current node, if there are no subscribers on the current node, then randomly select within the cluster;
- `hash_clientid`: Hash the publisher's client ID to select a subscriber;
- `hash_topic`: Hash the publishing topic to select a subscriber." - } - } -} \ No newline at end of file diff --git a/src/schemaText/schema-text-en.ts b/src/schemaText/schema-text-en.ts new file mode 100644 index 000000000..6bc440c38 --- /dev/null +++ b/src/schemaText/schema-text-en.ts @@ -0,0 +1,269 @@ +export default { + /* MQTT START */ + exclusive_subscription: { + label: 'Allowed Exclusive Subscription', + }, + max_topic_alias: { + label: 'Max Topic Alias', + }, + use_username_as_clientid: { + desc: 'Whether to use Username as Client ID.\nThis setting takes effect later than
Use Peer Certificate as Username and Use Peer Certificate as Client ID.',
+ label: 'Use Username as Client ID',
+ },
+ idle_timeout: {
+ desc: 'Configure the duration of time that a connection can remain idle (i.e., without any data transfer) before being: \n\n- Automatically disconnected if no CONNECT package is received from the client yet. \n- Put into hibernation mode to save resources if some CONNECT packages are already received.\n\nNote: Please set the parameter with caution as long idle time will lead to resource waste.',
+ label: 'Idle Timeout',
+ },
+ strict_mode: {
+ desc: 'Whether to parse MQTT messages in strict mode.\nIn strict mode, invalid utf8 strings in for example client ID, topic name, etc. will cause the client to be disconnected.',
+ label: 'Strict Mode',
+ },
+ shared_subscription: {
+ label: 'Allowed Shared Subscription',
+ },
+ server_keepalive: {
+ label: 'Server Keep Alive',
+ },
+ wildcard_subscription: {
+ label: 'Allowed Wildcard Subscription',
+ },
+ max_clientid_len: {
+ label: 'Max Client ID Length',
+ },
+ response_information: {
+ desc: 'Response Information UTF-8 string, for creating the response topic, for example, if set to `reqrsp/`, the publisher/subscriber will communite under the topic `reqrsp/`.To disable this feature, input `""` in the text box below.', + label: 'Response Information', + }, + shared_subscription_initial_sticky_pick: { + label: 'Shared Subscription Initial Sticky Pick', + desc: "The strategy to use for the initial subscriber pick when `Shared Subscription Strategy` is `sticky`.
- `random`: Randomly select the subscriber;
- `local`: Randomly select a subscriber on the current node, if there are no subscribers on the current node, then randomly select within the cluster;
- `hash_clientid`: Hash the publisher's client ID to select a subscriber;
- `hash_topic`: Hash the publishing topic to select a subscriber.", + }, + peer_cert_as_username: { + desc: 'Use the CN, DN field in the peer certificate or the entire certificate content as Username. Only works for the TLS connection.\nSupported configurations are the following:\n-
cn: CN field of the certificate\n- dn: DN field of the certificate\n- crt: Content of the DER or PEM certificate\n- pem: Convert DER certificate content to PEM format and use as Username\n- md5: MD5 value of the DER or PEM certificate',
+ label: 'Use Peer Certificate as Username',
+ },
+ client_attrs_init: {
+ label: 'Client Attributes',
+ desc: "Specify how to initialize client attributes.Each client attribute can be initialized as `client_attrs.{'{'}NAME{'}'}`,
where `{'{'}NAME{'}'}` is the name of the attribute specified in the config field `set_as_attr`.
The initialized client attribute will be stored in the `client_attrs` property with the specified name,
and can be used as a variable to render a template for mountpoint, authentication and authorization requests.
For example, use `${'{'}client_attrs.tns{'}'}` to render an HTTP POST body when `set_as_attr = tns`,
or render listener config `moutpoint = ${'{'}client_attrs.tns{'}'}/` for topic namespacing.", + }, + client_attrs_init_set_as_attr: { + label: 'Attribute', + }, + client_attrs_init_expression: { + label: 'Attribute Expression', + desc: "A one line expression to evaluate a set of predefined string functions (like in the rule engine SQL statements).
The expression can be a function call with nested calls as its arguments, or direct variable reference.
So far, it does not provide user-defined variable binding (like `var a=1`) or user-defined functions.
As an example, to extract the prefix of client ID delimited by a dot: `nth(1, tokens(clientid, '.'))`.
The variables pre-bound variables are:
- `clientid`: MQTT Client ID.
- `username`: MQTT Client's username.
- `user_property.{'{'}NAME{'}'}`: User properties in the CONNECT packet.
For TLS clients, connected directly or via proxy-protocol (v2) enabled load balancer,
some extra variables can be used:
- `cn`: Client's TLS certificate common name.
- `dn`: Client's TLS certificate distinguished name (the subject).
- `peersni`: TLS server name indication sent by the client.
You can read more about variform expressions in EMQX docs.", + }, + clientid_override: { + label: 'Client ID Override Expression', + desc: "A one line expression to evaluate a set of predefined string functions (like in the rule engine SQL statements).
The expression can be a function call with nested calls as its arguments, or direct variable reference.
So far, it does not provide user-defined variable binding (like `var a=1`) or user-defined functions.
As an example, to extract the prefix of client ID delimited by a dot: `nth(1, tokens(username, '.'))`.
The variables pre-bound variables are:
- `clientid`: The original MQTT Client ID.
- `username`: MQTT Client's username.
- `client_attrs.{'{'}NAME{'}'}`: Client attributes initialized by per config `client_attrs_init`.
For TLS clients, connected directly or via proxy-protocol (v2) enabled load balancer,
some extra variables can be used:
- `cn`: Client's TLS certificate common name.
- `dn`: Client's TLS certificate distinguished name (the subject).
- `peersni`: TLS server name indication sent by the client.
You can read more about variform expressions in EMQX docs.", + }, + retain_available: { + desc: 'Whether to enable support for MQTT retained message. When this option is disabled, clients will not be able to publish retained messages.', + label: 'Allowed Retain', + }, + message_expiry_interval: { + desc: 'The MQTT message expiry interval. For MQTT v5.0 clients, it is only effective if the Message-Expiry-Interval property is not specified for the message; for MQTT v3.1 and v3.1.1, it always applies. Note that it is not helpful to set this value to a greater value than the MQTT Session Expiry Interval, because once the session expires, all related messages are purged.', + label: 'Message Expiry Interval', + }, + ignore_loop_deliver: { + desc: 'Whether the messages sent by the MQTT v3.1.1/v3.1.0 client will be forwarded to the client itself, similar to `No Local` in MQTT 5.0.', + label: 'Ignore Loop Deliver', + }, + max_qos_allowed: { + label: 'Max QoS Allowed', + }, + max_topic_levels: { + label: 'Max Topic Levels', + }, + peer_cert_as_clientid: { + desc: 'Use the CN, DN field in the peer certificate or the entire certificate content as Client ID. Only works for the TLS connection.\nSupported configurations are the following:\n-
cn: CN field of the certificate\n- dn: DN field of the certificate\n- crt: DER or PEM certificate\n- pem: Convert DER certificate content to PEM format and use as Client ID\n- md5: MD5 value of the DER or PEM certificate',
+ label: 'Use Peer Certificate as Client ID',
+ },
+ keepalive_multiplier: {
+ desc: '`Keep-Alive Timeout = Keep-Alive Interval × Keep-Alive Multiplier`. Default value is 1.5 as per MQTT 5.0.\n\nFor example, a Keep-Alive interval of 10 seconds yields a timeout of 15 seconds with a multiplier of 1.5. Increasing the multiplier value to 2 extends the timeout to 20 seconds.',
+ label: 'Keep Alive Multiplier',
+ },
+ shared_subscription_strategy: {
+ label: 'Shared Subscription Strategy',
+ desc: 'Dispatch strategy for shared subscription.- `random`: dispatch the message to a random selected subscriber
- `round_robin`: select the subscribers in a round-robin manner
- `round_robin_per_group`: select the subscribers in round-robin fashion within each shared subscriber group
- `sticky`: always use the last selected subscriber to dispatch, until the subscriber disconnects.
- `local`: select random local subscriber otherwise select random cluster-wide
- `hash_topic`: select the subscribers by hashing the source topic
- `hash_clientid`: select the subscribers by hashing the `clientIds` of senders', + }, + keepalive_check_interval: { + label: 'Keep Alive Check Interval', + desc: 'The frequency of checking for incoming MQTT packets determines how often the server will check for new MQTT packets.
If a certain amount of time passes without any packets being sent from the client, this time will be added up.
Once the accumulated time exceeds `keepalive-interval * keepalive-multiplier`, the connection will be terminated.
The default is set to 30 seconds, with a minimum value of 1 second and a maximum value of `keepalive-interval / 2`.
', + }, + max_packet_size: { + desc: 'If the size is out of the preset value, EMQX will disconnect the current connection', + label: 'Max Packet Size', + }, + max_conn_rate: { + desc: 'Used to limit the rate at which EMQX accepts connections. Once the limit is reached, EMQX will pause fetching connections from the accept queue, delaying or rejecting new connections. If empty, it means no limit.\n\nFor example:\n\n- `1000/s` means accepting up to 1000 connections per second.\n- `1000/10s` means accepting up to 1000 connections every 10 seconds.', + label: 'Maximum Connection Rate', + }, + max_conn_burst: { + desc: 'The maximum number of connections that can be accepted in a burst. If empty, it means no limit.\n\nFor example: `10000/60m` means allowing up to 10000 connections in 60 minutes.', + label: 'Maximum Connection Burst', + }, + messages_rate: { + desc: 'Used to limit the number of messages a single client can send to EMQX per second, Once the limit is reached, EMQX will pause reading data from the receive-buffer, thus slowing down or even temporarily hanging the sender.\n\nFor example:\n\n- `500/s` means only 500 messages will be received per second, and the remaining messages will be delayed.\n- `500/10s`: Only 500 messages will be received every 10 seconds and the remaining messages will be delayed.', + label: 'Messages Publish Rate', + }, + messages_burst: { + desc: 'Number of messages that can be sent in a burst. If empty, it means no limit.\n\nFor example: `10000/60m` means allowing up to 10000 messages to be sent in 60 minutes.', + label: 'Messages Publish Burst', + }, + bytes_rate: { + desc: 'Used to limit the number of bytes a single client can send to EMQX per second, Once the limit is reached, EMQX will pause reading data from the receive-buffer, thus slowing down or even temporarily hanging the sender.\n\nThe unit of the bytes could be: B, KB, MB, GB.\n\nFor example:\n\n- `500KB/s` means only 500 kilobytes per second will be received, and the remaining bytes will be delayed.\n- `500MB/10s` means only 500 megabytes will be received every 10 seconds, and the remaining bytes will be delayed.', + label: 'Data Publish Rate', + }, + bytes_burst: { + desc: 'Number of bytes that can be sent in a burst. If empty, it means no limit.\n\nFor example: `100MB/60m` means allowing up to 100 megabytes of data to be sent in 60 minutes.', + label: 'Data Publish Burst', + }, + /* MQTT END */ + /* SESSION START */ + max_subscriptions: { + desc: 'Maximum number of subscriptions allowed per client.', + label: 'Max Subscriptions', + }, + upgrade_qos: { + desc: 'Force upgrade of QoS level according to subscription.', + label: 'Upgrade QoS', + }, + max_inflight: { + desc: 'Maximum number of QoS 1 and QoS 2 messages that are allowed to be delivered simultaneously before completing the acknowledgment.', + label: 'Max Inflight', + }, + retry_interval: { + desc: 'Retry interval for QoS 1/2 message delivering.', + label: 'Message Retry Interval', + }, + max_awaiting_rel: { + desc: 'Specifies the maximum number of pending QoS 2 messages in each session until either PUBREL is received or timed out. When this limit is reached, new QoS 2 PUBLISH requests will be rejected with error code 147(0x93).', + label: 'Max Awaiting PUBREL', + }, + await_rel_timeout: { + desc: 'Specifies the amount of time to wait for a publish of a QoS 2 message with no PUBREL received. When this limit is reached, EMQX will release the packet ID and also output a warning level log. \nNote: EMQX’s forwarding of the received QoS 2 message is independent from the receiving of PUBREL', + label: 'Max Awaiting PUBREL Timeout', + }, + session_expiry_interval: { + desc: 'Specifies how long the session will expire after the connection is disconnected, only for non-MQTT 5.0 connections.', + label: 'Session Expiry Interval', + }, + max_mqueue_len: { + desc: 'Maximum allowed queue length when persistent client are disconnected or inflight window is full.', + label: 'Max Message Queue Length', + }, + mqueue_priorities: { + desc: 'Topic priorities. Priority number [1-255]. There\'s no priority table by default, hence all messages are treated equal.
NOTE: Comma and equal signs are not allowed for priority topic names.
NOTE: Messages for topics not in the priority table are treated as either highest or lowest priority depending on the configured value for mqtt.mqueue_default_priority.
Examples:
To configure "topic/1" > "topic/2":
mqueue_priorities: {\'{\'}"topic/1": 10, "topic/2": 8{\'}\'}', + label: 'Topic Priorities', + }, + mqueue_default_priority: { + desc: 'Default topic priority, which will be used by topics not in
Topic Priorities (mqueue_priorities).',
+ label: 'Default Topic Priorities',
+ },
+ mqueue_store_qos0: {
+ desc: 'Specifies whether to store QoS 0 messages in the message queue while the connection is down but the session remains.',
+ label: 'Store QoS 0 Message',
+ },
+ /* SESSION END */
+ /* LOG START */
+ enable: {
+ desc: 'Enable this log handler.',
+ label: 'Enable Log Handler',
+ },
+ level: {
+ desc: 'The log level for the current log handler.\nDefaults to warning.',
+ label: 'Log Level',
+ },
+ log_file_default_path: {
+ desc: 'The path and name of the log file.',
+ label: 'Log File Name',
+ },
+ payload_encode: {
+ desc: 'The encoding method of payload in logs',
+ label: 'Payload Encode',
+ },
+ rotation_count: {
+ desc: 'Maximum number of log files.',
+ label: 'Max Log Files Number',
+ },
+ rotation_size: {
+ desc: 'This parameter controls log file rotation. The value `infinity` means the log file will grow indefinitely, otherwise the log file will be rotated once it reaches `max_size` in bytes.',
+ label: 'Rotation Size',
+ },
+ time_offset: {
+ desc: 'The time offset to be used when formatting the timestamp.\nCan be one of:\n - system: the time offset used by the local system\n - utc: the UTC time offset\n - +-[hh]:[mm]: user specified time offset, such as "-02:00" or "+00:00"\nDefaults to: system.',
+ label: 'Time Offset',
+ },
+ timestamp_format: {
+ desc: 'Pick a timestamp format:-
auto: automatically choose the best format based on log formatter. epoch for JSON and rfc3339 for text.-
epoch: Unix epoch time in microseconds.-
rfc3339: RFC3339 format.',
+ label: 'Timestamp Format',
+ },
+ formatter: {
+ desc: 'Choose log formatter. text for free text, and json for structured logging.',
+ label: 'Log Formatter',
+ },
+ time_window: {
+ desc: 'The time window for log throttling ensures that the same type of event is only logged once within the designated time frame to prevent log overflow. A detailed log encapsulating the activities within that period is generated at the end of the time window. The minimum configurable value for this window is one second.The following events are throttled:
- authorization_permission_denied
- cannot_publish_to_topic_due_to_not_authorized
- cannot_publish_to_topic_due_to_quota_exceeded
- connection_rejected_due_to_license_limit_reached
- dropped_msg_due_to_mqueue_is_full', + label: 'Time Window', + }, + /* LOG END */ + /* ALARM START */ + cpu_check_interval: { + desc: 'The time interval for the periodic CPU check.', + label: 'The time interval for the periodic CPU check', + }, + cpu_high_watermark: { + desc: 'The threshold, as percentage of system CPU load,\n for how much system cpu can be used before the corresponding alarm is raised.', + label: 'CPU high watermark', + }, + cpu_low_watermark: { + desc: 'The threshold, as percentage of system CPU load,\n for how much system cpu can be used before the corresponding alarm is cleared.', + label: 'CPU low watermark', + }, + mem_check_interval: { + desc: 'The time interval for the periodic memory check.', + label: 'Mem check interval', + }, + procmem_high_watermark: { + desc: 'The threshold, as percentage of system memory,\n for how much system memory can be allocated by one Erlang process before\n the corresponding alarm is raised.', + label: 'ProcMem high wartermark', + }, + sysmem_high_watermark: { + desc: 'The threshold, as percentage of system memory,\n for how much system memory can be allocated before the corresponding alarm is raised.', + label: 'SysMem high wartermark', + }, + busy_dist_port: { + desc: 'When the RPC connection used to communicate with other nodes in the cluster is overloaded,\nthere will be a
busy_dist_port warning log,\nand an MQTT message is published to system topic $SYS/sysmon/busy_dist_port.',
+ label: 'Enable Busy Distribution Port monitoring',
+ },
+ busy_port: {
+ desc: 'When a port (e.g. TCP socket) is overloaded, there will be a busy_port warning log,\nand an MQTT message is published to the system topic $SYS/sysmon/busy_port.',
+ label: 'Enable Busy Port monitoring',
+ },
+ large_heap: {
+ desc: 'When the heap memory occupied by a process exceeds the size specified by large_heap, the system will write a warning level large_heap log, and an MQTT message is published to\nthe system topic $SYS/sysmon/large_heap.',
+ label: 'Enable Large Heap monitoring',
+ },
+ long_gc: {
+ desc: 'When an Erlang process spends long time to perform garbage collection, a warning level long_gc log is emitted,\nand an MQTT message is published to the system topic $SYS/sysmon/long_gc.',
+ label: 'Enable Long GC monitoring',
+ },
+ long_schedule: {
+ desc: "When the Erlang VM detect a task scheduled for too long, a warning level 'long_schedule' log is emitted,\nand an MQTT message is published to the system topic $SYS/sysmon/long_schedule.",
+ label: 'Enable Long Schedule monitoring',
+ },
+ process_check_interval: {
+ desc: 'The time interval for the periodic process limit check.',
+ label: 'Process limit check interval',
+ },
+ process_high_watermark: {
+ desc: 'The threshold, as percentage of processes, for how many\n processes can simultaneously exist at the local node before the corresponding\n alarm is raised.',
+ label: 'Process high watermark',
+ },
+ process_low_watermark: {
+ desc: 'The threshold, as percentage of processes, for how many\n processes can simultaneously exist at the local node before the corresponding\n alarm is cleared.',
+ label: 'Process low watermark',
+ },
+ /* ALARM END */
+}
diff --git a/src/schemaText/schema-text-zh.json b/src/schemaText/schema-text-zh.json
deleted file mode 100644
index 92d25f96a..000000000
--- a/src/schemaText/schema-text-zh.json
+++ /dev/null
@@ -1,1374 +0,0 @@
-{
- "emqx_conf_schema": {
- "common_handler_drop_mode_qlen": {
- "desc": "当缓冲的日志事件数大于此值时，新的日志事件将被丢弃。起到过载保护的功能。\n为了使过载保护算法正常工作必须要： sync_mode_qlen =< drop_mode_qlen =< flush_qlen 且 drop_mode_qlen > 1\n要禁用某些模式，请执行以下操作。\n- 如果sync_mode_qlen被设置为0，所有的日志事件都被同步处理。也就是说，异步日志被禁用。\n- 如果sync_mode_qlen被设置为与drop_mode_qlen相同的值，同步模式被禁用。也就是说，处理程序总是以异步模式运行，除非调用drop或flushing。\n- 如果drop_mode_qlen被设置为与flush_qlen相同的值，则drop模式被禁用，永远不会发生。",
- "label": "进入丢弃模式的队列长度"
- },
- "cluster_mcast_addr": {
- "desc": "指定多播 IPv4 地址。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。",
- "label": "多播地址"
- },
- "desc_cluster_dns": {
- "desc": "DNS SRV 记录服务发现。",
- "label": "DNS SRV 记录服务发现"
- },
- "cluster_dns_name": {
- "desc": "指定 DNS A 记录的名字。emqx 会通过访问这个 DNS A 记录来获取 IP 地址列表。\n当cluster.discovery_strategy 为 dns 时有效。",
- "label": "DNS名称"
- },
- "rpc_keyfile": {
- "desc": "rpc.certfile 的私钥文件的路径。\n注意：此文件内容是私钥，所以需要设置权限为 600。", - "label": "RPC 私钥文件" - }, - "cluster_mcast_recbuf": { - "desc": "接收数据报的内核级缓冲区的大小。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。", - "label": "多播接收数据缓冲区" - }, - "cluster_autoheal": { - "desc": "集群脑裂自动恢复机制开关。", - "label": "节点脑裂自动修复机制" - }, - "log_overload_kill_enable": { - "desc": "日志处理进程过载时为保护自己节点其它的业务能正常，强制杀死日志处理进程。", - "label": "日志处理进程过载保护" - }, - "node_etc_dir": { - "desc": "
etc 存放目录",
- "label": "Etc 目录"
- },
- "cluster_proto_dist": {
- "desc": "分布式 Erlang 集群协议类型。可选值为:\n- inet_tcp: 使用 IPv4
\n- inet_tls: 使用 TLS，需要配合
etc/ssl_dist.conf 一起使用。",
- "label": "集群内部通信协议"
- },
- "log_burst_limit_enable": {
- "desc": "启用日志限流保护机制。",
- "label": "日志限流保护"
- },
- "dist_buffer_size": {
- "desc": "Erlang分布式缓冲区的繁忙阈值，单位是KB。",
- "label": "Erlang分布式缓冲区的繁忙阈值(KB)"
- },
- "common_handler_max_depth": {
- "desc": "Erlang 内部格式日志格式化和 Erlang 进程消息队列检查的最大深度。",
- "label": "最大深度"
- },
- "desc_log": {
- "desc": "EMQX 日志记录支持日志事件的多个接收器。 每个接收器由一个_log handler_表示，可以独立配置。",
- "label": "日志"
- },
- "common_handler_flush_qlen": {
- "desc": "如果缓冲日志事件的数量增长大于此阈值，则会发生冲刷（删除）操作。 日志处理进程会丢弃缓冲的日志消息。\n来缓解自身不会由于内存瀑涨而影响其它业务进程。日志内容会提醒有多少事件被删除。",
- "label": "冲刷阈值"
- },
- "common_handler_chars_limit": {
- "desc": "设置单个日志消息的最大长度。 如果超过此长度，则日志消息将被截断。最小可设置的长度为100。\n注意：如果日志格式为 JSON，限制字符长度可能会导致截断不完整的 JSON 数据。",
- "label": "单条日志长度限制"
- },
- "cluster_k8s_namespace": {
- "desc": "当使用 k8s 方式并且 cluster.k8s.address_type 指定为 dns 类型时，\n可设置 emqx 节点名的命名空间。与 cluster.k8s.suffix 一起使用用以拼接得到节点名列表。",
- "label": "K8s 命名空间"
- },
- "node_name": {
- "desc": "节点名。格式为 \\manual: 通过 tcp_server_port 来发现端口。\nstateless: 使用无状态的方式来发现端口，使用如下算法。如果节点名称是 \nemqxN{'@'}127.0.0.1, N 是一个数字，那么监听端口就是 5370 + N。",
- "label": "RPC 端口发现策略"
- },
- "log_overload_kill_restart_after": {
- "desc": "如果处理进程终止，它会在以指定的时间后后自动重新启动。 `infinity` 不自动重启。",
- "label": "处理进程重启机制"
- },
- "log_file_handler_rotation_size": {
- "desc": "此参数控制日志文件轮换。 `infinity` 意味着日志文件将无限增长，否则日志文件将在达到 `max_size`（以字节为单位）时进行轮换。\n与 rotation count配合使用。如果 counter 为 10，则是10个文件轮换。",
- "label": "日志文件轮换大小"
- },
- "desc_log_file_handler": {
- "desc": "日志处理进程将日志事件打印到文件。",
- "label": "文件日志处理进程"
- },
- "rpc_socket_keepalive_count": {
- "desc": "keepalive 探测消息发送失败的次数，直到 RPC 连接被认为已经断开。",
- "label": "RPC Socket Keepalive 次数"
- },
- "cluster_etcd_server": {
- "desc": "指定 etcd 服务的地址。如有多个服务使用逗号 , 分隔。\n当 cluster.discovery_strategy 为 etcd 时，此配置项才有效。",
- "label": "Etcd 服务器地址"
- },
- "db_backend": {
- "desc": "配置后端数据库驱动，默认值为 rlog 它适用于大规模的集群。\nmnesia 是备选数据库，适合中小集群。",
- "label": "内置数据库"
- },
- "desc_authorization": {
- "desc": "授权相关",
- "label": "授权"
- },
- "cluster_etcd_ssl": {
- "desc": "当使用 TLS 连接 etcd 时的配置选项。\n当 cluster.discovery_strategy 为 etcd 时，此配置项才有效。",
- "label": "Etcd SSL 选项"
- },
- "rpc_insecure_fallback": {
- "desc": "兼容旧的无鉴权模式",
- "label": "向后兼容旧的无鉴权模式"
- },
- "cluster_mcast_buffer": {
- "desc": "用户级缓冲区的大小。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。",
- "label": "多播用户级缓冲区"
- },
- "rpc_authentication_timeout": {
- "desc": "远程节点认证的超时时间。",
- "label": "RPC 认证超时时间"
- },
- "cluster_call_retry_interval": {
- "desc": "当集群间调用出错时，多长时间重试一次。",
- "label": "重试时间间隔"
- },
- "cluster_mcast_sndbuf": {
- "desc": "外发数据报的内核级缓冲区的大小。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。",
- "label": "多播发送缓存区"
- },
- "rpc_driver": {
- "desc": "集群间通信使用的传输协议。",
- "label": "RPC 驱动"
- },
- "max_ets_tables": {
- "desc": "Erlang ETS 表的最大数量",
- "label": "Erlang 表的最大数量"
- },
- "desc_db": {
- "desc": "内置数据库的配置。",
- "label": "数据库"
- },
- "desc_cluster_etcd": {
- "desc": "使用 'etcd' 服务的服务发现。",
- "label": "'etcd' 服务的服务发现"
- },
- "cluster_name": {
- "desc": "EMQX集群名称。每个集群都有一个唯一的名称。服务发现时会用于做路径的一部分。",
- "label": "集群名称"
- },
- "log_rotation_enable": {
- "desc": "启用日志轮换功能。启动后生成日志文件后缀会加上对应的索引数字，比如：log/emqx.log.1。\n系统会默认生成*.siz/*.idx用于记录日志位置，请不要手动修改这两个文件。",
- "label": "日志轮换"
- },
- "cluster_call_cleanup_interval": {
- "desc": "清理过期事务的时间间隔",
- "label": "清理间隔"
- },
- "desc_cluster_static": {
- "desc": "静态节点服务发现。新节点通过连接一个节点来加入集群。",
- "label": "静态节点服务发现"
- },
- "db_default_shard_transport": {
- "desc": "定义用于推送事务日志的默认传输。\n这可以在
db.shard_transports 中基于每个分片被覆盖。\ngen_rpc 使用 gen_rpc 库，\ndistr 使用 Erlang 发行版。",
- "label": "事务日志传输默认协议"
- },
- "cluster_static_seeds": {
- "desc": "集群中的EMQX节点名称列表，\n指定固定的节点列表，多个节点间使用逗号 , 分隔。\n当 cluster.discovery_strategy 为 static 时，此配置项才有效。\n适合于节点数量较少且固定的集群。",
- "label": "集群静态节点"
- },
- "log_overload_kill_qlen": {
- "desc": "允许的最大队列长度。",
- "label": "最大队列长度"
- },
- "node_backtrace_depth": {
- "desc": "错误信息中打印的最大堆栈层数",
- "label": "最大堆栈导数"
- },
- "desc_log_burst_limit": {
- "desc": "短时间内产生的大量日志事件可能会导致问题，例如：\n - 日志文件变得非常大\n - 日志文件轮换过快，有用信息被覆盖\n - 对系统的整体性能影响\n\n日志突发限制功能可以暂时禁用日志记录以避免这些问题。",
- "label": "日志突发限制"
- },
- "common_handler_enable": {
- "desc": "启用此日志处理进程。",
- "label": "启用日志处理进程"
- },
- "common_handler_timestamp_format": {
- "desc": "选择时间戳格式：-
auto：根据日志的格式自动选择最合适的时间戳格式。对于 JSON 使用 epoch，对于文本则使用 rfc3339。-
epoch：表示为自 Unix 纪元起的微秒数。-
rfc3339：遵循 RFC3339 标准的时间格式。",
- "label": "时间戳格式"
- },
- "cluster_k8s_service_name": {
- "desc": "指定 Kubernetes 中 EMQX 的服务名。\n当 cluster.discovery_strategy 为 k8s 时，此配置项才有效。",
- "label": "K8s 服务别名"
- },
- "common_handler_rotation_count": {
- "desc": "轮换的最大日志文件数。",
- "label": "最大日志文件数"
- },
- "node_cookie": {
- "desc": "分布式 Erlang 集群使用的 cookie 值。集群间保持一致",
- "label": "节点 Cookie"
- },
- "db_role": {
- "desc": "选择节点的角色。\n
core 节点提供数据的持久性，并负责写入。建议将核心节点放置在不同的机架或不同的可用区。\n
repliant 节点是临时工作节点。 从集群中删除它们，不影响数据库冗余\n建议复制节点多于核心节点。
\n注意：该参数仅在设置
backend时生效到 rlog。",
- "label": "数据库角色"
- },
- "rpc_tcp_server_port": {
- "desc": "RPC 本地服务使用的 TCP 端口。\n只有当 rpc.port_discovery 设置为 manual 时，此配置才会生效。", - "label": "RPC TCP 服务监听端口" - }, - "desc_console_handler": { - "desc": "日志处理进程将日志事件打印到 EMQX 控制台。", - "label": "Console Handler" - }, - "node_applications": { - "desc": "当新EMQX 加入集群时，应重启的Erlang应用程序的列表。", - "label": "应用" - }, - "log_burst_limit_max_count": { - "desc": "在 `window_time` 间隔内处理的最大日志事件数。 达到限制后，将丢弃连续事件，直到 `window_time` 结束。", - "label": "日志事件数" - }, - "rpc_tcp_client_num": { - "desc": "设置本节点与远程节点之间的 RPC 通信通道的最大数量。", - "label": "RPC TCP 客户端数量" - }, - "cluster_k8s_address_type": { - "desc": "当使用 k8s 方式集群时，address_type 用来从 Kubernetes 接口的应答里获取什么形式的 Host 列表。\n指定
cluster.k8s.address_type 为 ip，则将从 Kubernetes 接口中获取集群中其他节点\n的IP地址。",
- "label": "K8s 地址类型"
- },
- "rpc_socket_sndbuf": {
- "desc": "TCP 调节参数。TCP 发送缓冲区大小。",
- "label": "RPC 套接字发送缓冲区大小"
- },
- "cluster_mcast_ttl": {
- "desc": "指定多播的 Time-To-Live 值。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。",
- "label": "多播TTL"
- },
- "db_core_nodes": {
- "desc": "当前节点连接的核心节点列表。\n注意：该参数仅在设置
backend时生效到 rlog\n并且设置role为replicant时生效。\n该值需要在手动或静态集群发现机制下设置。
\n如果使用了自动集群发现机制（如
etcd），则不需要设置该值。",
- "label": "数据库核心节点"
- },
- "log_file_handler_path": {
- "desc": "日志文件路径及名字。",
- "label": "日志文件名字"
- },
- "node_dist_net_ticktime": {
- "desc": "系统调优参数，此配置将覆盖 vm.args 文件里的 -kernel net_ticktime 参数。当一个节点持续无响应多久之后，认为其已经宕机并断开连接。",
- "label": "节点间心跳间隔"
- },
- "desc_cluster_k8s": {
- "desc": "Kubernetes 服务发现。",
- "label": "Kubernetes 服务发现"
- },
- "desc_cluster_mcast": {
- "desc": "UDP 组播服务发现。",
- "label": "UDP 组播服务发现"
- },
- "rpc_cacertfile": {
- "desc": "验证 rpc.certfile 的 CA 证书文件的路径。\n注意：集群中所有节点的证书必须使用同一个 CA 签发。", - "label": "RPC CA 证书文件" - }, - "desc_node": { - "desc": "节点名称、Cookie、配置文件、数据目录和 Erlang 虚拟机（BEAM）启动参数。", - "label": "节点" - }, - "cluster_k8s_apiserver": { - "desc": "指定 Kubernetes API Server。如有多个 Server 使用逗号 , 分隔。\n当 cluster.discovery_strategy 为 k8s 时，此配置项才有效。", - "label": "K8s 服务地址" - }, - "common_handler_supervisor_reports": { - "desc": "Supervisor 报告的类型。默认为 error 类型。
\n -
error：仅记录 Erlang 进程中的错误。\n - progress：除了 error 信息外，还需要记录进程启动的详细信息。",
- "label": "报告类型"
- },
- "node_data_dir": {
- "desc": "节点数据存放目录，可能会自动创建的子目录如下：\n- `mnesia/
\n如果节点要被重新命名（例如，`emqx{'@'}10.0.1.1`）。旧目录应该首先被删除。
\n- `configs`。在启动时生成的配置，以及集群/本地覆盖的配置。
\n- `patches`: 热补丁文件将被放在这里。
\n- `trace`: 日志跟踪文件。
\n\n**注意**: 一个数据dir不能被两个或更多的EMQX节点同时使用。", - "label": "节点数据目录" - }, - "cluster_k8s_suffix": { - "desc": "当使用 k8s 方式并且 cluster.k8s.address_type 指定为 dns 类型时，可设置 emqx 节点名的后缀。\n与 cluster.k8s.namespace 一起使用用以拼接得到节点名列表。", - "label": "K8s 前缀" - }, - "db_rpc_module": { - "desc": "集群间推送事务日志到复制节点使用的协议。", - "label": "RPC协议" - }, - "cluster_etcd_prefix": { - "desc": "指定 etcd 路径的前缀。每个节点在 etcd 中都会创建一个路径:\nv2/keys/
\n当 cluster.discovery_strategy 为 etcd 时，此配置项才有效。", - "label": "Etcd 路径前缀" - }, - "cluster_mcast_iface": { - "desc": "指定节点发现服务需要绑定到本地 IP 地址。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。", - "label": "多播绑定地址" - }, - "log_burst_limit_window_time": { - "desc": "参考
max_count。",
- "label": "Window Time"
- },
- "cluster_dns_record_type": {
- "desc": "DNS 记录类型。",
- "label": "DNS记录类型"
- },
- "cluster_autoclean": {
- "desc": "指定多久之后从集群中删除离线节点。",
- "label": "自动删除离线节点时间"
- },
- "process_limit": {
- "desc": "Erlang系统同时存在的最大进程数。\n实际选择的最大值可能比设置的数字大得多。\n参考: https://www.erlang.org/doc/man/erl.html",
- "label": "Erlang 最大进程数"
- },
- "max_ports": {
- "desc": "Erlang系统同时存在的最大端口数。\n实际选择的最大值可能比设置的数字大得多。\n参考: https://www.erlang.org/doc/man/erl.html",
- "label": "Erlang 最大端口数"
- },
- "desc_log_rotation": {
- "desc": "默认情况下，日志存储在 `./log` 目录（用于从 zip 文件安装）或 `/var/log/emqx`（用于二进制安装）。\n这部分配置，控制每个日志处理进程保留的文件数量。", - "label": "日志轮换" - }, - "desc_log_overload_kill": { - "desc": "日志过载终止，具有过载保护功能。当日志处理进程使用过多内存，或者缓存的日志消息过多时该功能被激活。
\n检测到过载时，日志处理进程将终止，并在冷却期后重新启动。", - "label": "日志过载保护" - }, - "authorization": { - "desc": "授权（ACL）。EMQX 支持完整的客户端访问控制（ACL）。", - "label": "授权" - }, - "rpc_socket_keepalive_idle": { - "desc": "broker 之间的连接在最后一条消息发送后保持打开的时间。", - "label": "RPC Socket Keepalive Idle" - }, - "desc_cluster_call": { - "desc": "集群调用功能的选项。", - "label": "集群调用" - }, - "cluster_mcast_ports": { - "desc": "指定多播端口。如有多个端口使用逗号 , 分隔。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。", - "label": "多播端口" - }, - "log_overload_kill_mem_size": { - "desc": "日志处理进程允许使用的最大内存。", - "label": "日志处理进程允许使用的最大内存" - }, - "rpc_connect_timeout": { - "desc": "建立 RPC 连接的超时时间。", - "label": "RPC 连接超时时间" - }, - "cluster_etcd_node_ttl": { - "desc": "指定 etcd 中节点信息的过期时间。\n当 cluster.discovery_strategy 为 etcd 时，此配置项才有效。", - "label": "Etcd 节点过期时间" - }, - "rpc_call_receive_timeout": { - "desc": "同步 RPC 的回复超时时间。", - "label": "RPC 调用接收超时时间" - }, - "rpc_socket_recbuf": { - "desc": "TCP 调节参数。TCP 接收缓冲区大小。", - "label": "RPC 套接字接收缓冲区大小" - }, - "db_tlog_push_mode": { - "desc": "同步模式下，核心节点等待复制节点的确认信息，然后再发送下一条事务日志。", - "label": "Tlog推送模式" - }, - "node_crash_dump_bytes": { - "desc": "限制崩溃文件的大小，当崩溃时节点内存太大，\n如果为了保存现场，需要全部存到崩溃文件中，此处限制最多能保存多大的文件。\n如果超过此限制，崩溃转储将被截断。如果设置为0，系统不会尝试写入崩溃转储文件。", - "label": "崩溃文件最大容量" - }, - "rpc_certfile": { - "desc": "TLS 证书文件的路径，用于验证集群节点的身份。\n只有当
rpc.driver 设置为 ssl 时，此配置才会生效。",
- "label": "RPC 证书文件"
- },
- "node_crash_dump_seconds": {
- "desc": "该配置给出了运行时系统允许花费的写入崩溃转储的秒数。当给定的秒数已经过去，运行时系统将被终止。\n- 如果设置为0秒，运行时会立即终止，不会尝试写入崩溃转储文件。
\n- 如果设置为一个正数 S，节点会等待 S 秒来完成崩溃转储文件，然后用SIGALRM信号终止运行时系统。
\n- 如果设置为一个负值导致运行时系统的终止等待无限期地直到崩溃转储文件已经完全写入。", - "label": "保存崩溃文件最长时间" - }, - "log_file_handlers": { - "desc": "输出到文件的日志处理进程列表", - "label": "File Handler" - }, - "node_global_gc_interval": { - "desc": "系统调优参数，设置节点运行多久强制进行一次全局垃圾回收。禁用设置为
disabled。",
- "label": "全局垃圾回收"
- },
- "common_handler_time_offset": {
- "desc": "日志中的时间戳使用的时间偏移量。\n可选值为：\n - system: 本地系统使用的时区偏移量\n - utc: 0 时区的偏移量\n - +-[hh]:[mm]: 自定义偏移量，比如 \"-02:00\" 或者 \"+00:00\"\n默认值为本地系统的时区偏移量：system。",
- "label": "时间偏移量"
- },
- "rpc_mode": {
- "desc": "在 sync 模式下，发送端等待接收端的 ack信号。",
- "label": "RPC 模式"
- },
- "node_crash_dump_file": {
- "desc": "设置 Erlang crash_dump 文件的存储路径和文件名。",
- "label": "节点崩溃时的Dump文件"
- },
- "cluster_mcast_loop": {
- "desc": "设置多播的报文是否投递到本地回环地址。\n当 cluster.discovery_strategy 为 mcast 时，此配置项才有效。",
- "label": "多播回环开关"
- },
- "rpc_socket_keepalive_interval": {
- "desc": "keepalive 消息的间隔。",
- "label": "RPC Socket Keepalive 间隔"
- },
- "common_handler_level": {
- "desc": "当前日志处理进程的日志级别。\n默认为 warning 级别。",
- "label": "日志级别"
- },
- "desc_rpc": {
- "desc": "EMQX 使用 gen_rpc 库来实现跨节点通信。\n大多数情况下，默认的配置应该可以工作，但如果你需要做一些性能优化或者实验，可以尝试调整这些参数。", - "label": "RPC" - }, - "rpc_ssl_server_port": { - "desc": "RPC 本地服务使用的监听SSL端口。
\n只有当 rpc.port_discovery 设置为 manual 且
dirver 设置为 ssl，\n此配置才会生效。",
- "label": "RPC SSL 服务监听端口"
- },
- "desc_cluster": {
- "desc": "EMQX 节点可以组成一个集群，以提高总容量。这里指定了节点之间如何连接。", - "label": "集群" - }, - "common_handler_sync_mode_qlen": { - "desc": "只要缓冲的日志事件的数量低于这个值，所有的日志事件都会被异步处理。\n这意味着，日志落地速度不会影响正常的业务进程，因为它们不需要等待日志处理进程的响应。\n如果消息队列的增长超过了这个值，处理程序开始同步处理日志事件。也就是说，发送事件的客户进程必须等待响应。\n当处理程序将消息队列减少到低于sync_mode_qlen阈值的水平时，异步操作就会恢复。\n默认为100条信息，当等待的日志事件大于100条时，就开始同步处理日志。", - "label": "进入同步模式的队列长度" - }, - "common_handler_formatter": { - "desc": "选择日志格式类型。
text 用于纯文本，json 用于结构化日志记录。",
- "label": "日志格式类型"
- },
- "rpc_async_batch_size": {
- "desc": "异步模式下，发送的批量消息的最大数量。",
- "label": "异步模式下的批量消息数量"
- },
- "cluster_call_max_history": {
- "desc": "集群间调用最多保留的历史记录数。只用于排错时查看。",
- "label": "最大历史记录"
- },
- "cluster_discovery_strategy": {
- "desc": "集群节点发现方式。可选值为:\n- manual: 使用 emqx ctl cluster 命令管理集群。\n- static: 配置静态节点。配置几个固定的节点，新节点通过连接固定节点中的某一个来加入集群。
\n- dns: 使用 DNS A 记录的方式发现节点。
\n- etcd: 使用 etcd 发现节点。
\n- k8s: 使用 Kubernetes API 发现节点。", - "label": "集群服务发现策略" - }, - "rpc_send_timeout": { - "desc": "发送 RPC 请求的超时时间。", - "label": "RPC 发送超时时间" - }, - "common_handler_single_line": { - "desc": "如果设置为 true，则单行打印日志。 否则，日志消息可能跨越多行。", - "label": "单行模式" - }, - "rpc_socket_buffer": { - "desc": "TCP 调节参数。用户模式套接字缓冲区大小。", - "label": "RPC 套接字缓冲区大小" - }, - "db_shard_transports": { - "desc": "允许为每个 shard 下的事务日志复制操作的传输方法进行调优。
\n
gen_rpc 使用 gen_rpc 库，\ndistr 使用 Erlang 自带的 rpc 库。如果未指定，\n默认是使用
db.default_shard_transport 中设置的值。",
- "label": "事务日志传输协议"
- },
- "common_handler_time_window": {
- "desc": "日志节流的时间窗口，在设定的时间窗口内同一事件类型的日志只被记录一次以防止日志泛滥。时间窗口结束时将生成反映该时间段内的日志活动的详细日志。该窗口的最小可设置值为1秒。支持的事件如下：
- authorization_permission_denied
- cannot_publish_to_topic_due_to_not_authorized
- cannot_publish_to_topic_due_to_quota_exceeded
- connection_rejected_due_to_license_limit_reached
- dropped_msg_due_to_mqueue_is_full", - "label": "时间窗口" - }, - "common_handler_payload_encode": { - "desc": "日志中 Payload 的编码方式。", - "label": "Payload 编码" - } - }, - "emqx_limiter_schema": { - "max_conn_rate": { - "desc": "最大连接速率。
\n这用于限制此节点的连接速率，\n一旦达到限制，新连接将被推迟或拒绝。", - "label": "最大连接速率" - }, - "messages_rate": { - "desc": "消息发布速率。
\n这用于限制该节点的入站消息数量，\n一旦达到限制，受限客户端的消息发布将会减慢甚至暂停一段时间。", - "label": "消息发布速率" - }, - "bytes_rate": { - "desc": "数据发布速率。
\n这用于限制该节点的入站字节速率，\n一旦达到限制，受限客户端的数据发布将会减慢甚至暂停一段时间。", - "label": "数据发布速率" - } - }, - "emqx_schema": { - "fields_mqtt_quic_listener_peer_unidi_stream_count": { - "desc": "允许对端打开的单向流的数量", - "label": "对端单向流的数量" - }, - "fields_authorization_no_match": { - "desc": "如果用户或客户端不匹配ACL规则，或者从可配置授权源(比如内置数据库、HTTP API 或 PostgreSQL 等。)内未找\n到此类用户或客户端时，模式的认访问控制操作。\n在“授权”中查找更多详细信息。", - "label": "未匹时的默认授权动作" - }, - "sysmon_top_db_hostname": { - "desc": "收集数据点的 PostgreSQL 数据库的主机名。", - "label": "数据库主机名" - }, - "zones": { - "desc": "
zone 是按name 分组的一组配置。\n对于灵活的配置映射，可以将 name 设置为侦听器的 zone 配置。\n注：名为 default 的内置区域是自动创建的，无法删除。"
- },
- "fields_mqtt_quic_listener_certfile": {
- "desc": "证书文件。在 5.1 中会被废弃，使用 .ssl_options.certfile 代替。",
- "label": "证书文件"
- },
- "fields_rate_limit_conn_bytes_in": {
- "desc": "限制 MQTT 连接接收数据包的速率。 速率以每秒的数据包字节数计算。",
- "label": "数据包速率"
- },
- "crl_cache_capacity": {
- "desc": "缓存中可容纳的 CRL URL 的最大数量。 如果缓存的容量已满，并且必须获取一个新的 URL，那么它将驱逐缓存中插入的最老的 URL。",
- "label": "CRL 缓存容量"
- },
- "alarm_actions": {
- "desc": "警报激活时触发的动作。目前，支持以下操作：
log 和 publish.\nlog 将告警写入日志 (控制台或者文件).\npublish 将告警作为 MQTT 消息发布到系统主题:\n$SYS/brokers/emqx{'@'}xx.xx.xx.x/alarms/activate and\n$SYS/brokers/emqx{'@'}xx.xx.xx.x/alarms/deactivate",
- "label": "告警动作"
- },
- "base_listener_max_connections": {
- "desc": "监听器允许的最大并发连接数。",
- "label": "最大并发连接数"
- },
- "mqtt_peer_cert_as_username": {
- "desc": "使用对端证书中的 CN、DN 字段或整个证书内容来作为用户名；仅适用于 TLS 连接。\n目前支持：\n- cn: 取证书的 CN 字段\n- dn: 取证书的 DN 字段\n- crt: 取 DER 或 PEM 的证书内容\n- pem: 将 DER 证书转换为 PEM 格式作为用户名\n- md5: 取 DER 或 PEM 证书内容的 MD5 值",
- "label": "使用对端证书作为用户名"
- },
- "fields_cache_enable": {
- "desc": "启用或禁用授权缓存。",
- "label": "启用或禁用授权缓存"
- },
- "fields_mqtt_quic_listener_disconnect_timeout_ms": {
- "desc": "在判定路径无效和断开连接之前，要等待多长时间的ACK。默认：16000",
- "label": "断开连接超时 毫秒"
- },
- "mqtt_max_topic_alias": {
- "label": "最大主题别名数"
- },
- "common_ssl_opts_schema_user_lookup_fun": {
- "desc": "用于查找预共享密钥（PSK）标识的 EMQX 内部回调。",
- "label": "SSL PSK 用户回调"
- },
- "fields_listeners_wss": {
- "desc": "HTTPS websocket 监听器。",
- "label": "HTTPS websocket 监听器"
- },
- "sysmon_top_max_procs": {
- "desc": "当 VM 中的进程数超过此值时，停止收集数据。",
- "label": "最大进程数"
- },
- "mqtt_use_username_as_clientid": {
- "desc": "是否使用用户名作为客户端 ID。 作用时间晚于 对端证书作为用户名 和 对端证书作为客户端 ID。",
- "label": "使用用户名作为客户端 ID"
- },
- "mqtt_max_qos_allowed": {
- "label": "最大 QoS"
- },
- "fields_mqtt_quic_listener_max_binding_stateless_operations": {
- "desc": "在任何时候可以在一个绑定上排队的无状态操作的最大数量。默认值：100",
- "label": "最大绑定无状态操作"
- },
- "fields_mqtt_quic_listener_stream_recv_buffer_default": {
- "desc": "流的初始缓冲区大小。默认：4096",
- "label": "流媒体接收缓冲区默认值"
- },
- "fields_mqtt_quic_listener_pacing_enabled": {
- "desc": "有节奏的发送，以避免路径上的缓冲区过度填充。默认值：1（已启用）",
- "label": "启用节奏发送"
- },
- "mqtt_max_subscriptions": {
- "desc": "允许每个客户端建立的最大订阅数量。",
- "label": "最大订阅数量"
- },
- "persistent_session_builtin_messages_table": {
- "desc": "用于内建消息表的性能调优参数。",
- "label": "持久化消息"
- },
- "sysmon_os_cpu_low_watermark": {
- "desc": "在解除相应警报之前可以使用多少系统 CPU 的阈值，以系统CPU负载的百分比表示。",
- "label": "CPU 低水位线"
- },
- "fields_mqtt_quic_listener_tls_server_max_send_buffer": {
- "desc": "缓冲多少TLS数据。 默认值：8192",
- "label": "TLS 服务器最大发送缓冲区"
- },
- "base_listener_bind": {
- "desc": "监听套接字的 IP 地址和端口。",
- "label": "IP 地址和端口"
- },
- "server_ssl_opts_schema_handshake_timeout": {
- "desc": "握手完成所允许的最长时间",
- "label": "握手超时时间"
- },
- "fields_deflate_opts_server_context_takeover": {
- "desc": "接管意味着在服务器消息之间保留压缩状态。",
- "label": "服务上下文接管"
- },
- "mqtt_session_expiry_interval": {
- "desc": "指定会话将在连接断开后多久过期，仅适用于非 MQTT 5.0 的连接。",
- "label": "会话过期间隔"
- },
- "mqtt_message_expiry_interval": {
- "desc": "MQTT 消息的过期时间间隔。对于 MQTT 5.0 版本的客户端，此设置仅在消息未指定 Message-Expiry-Interval 属性时才会生效。对于 MQTT 3.1 和 3.1.1 版本，此设置始终适用。值得注意的是，将此值设定为大于会话过期间隔是无效的，因为一旦会话过期，所有相关消息都将被清除。",
- "label": "消息过期间隔"
- },
- "fields_listener_enabled": {
- "desc": "启停监听器。",
- "label": "启停监听器"
- },
- "mqtt": {
- "desc": "全局的 MQTT 配置项。\nmqtt 下所有的配置作为全局的默认值存在，它可以被 zone 中的配置覆盖。"
- },
- "crl_cache_refresh_http_timeout": {
- "desc": "获取 CRLs 时 HTTP 请求的超时。 该配置对所有启用 CRL 检查的监听器监听器有效。",
- "label": "CRL 缓存刷新 HTTP 超时"
- },
- "fields_tcp_opts_backlog": {
- "desc": "TCP backlog 定义了挂起连接队列可以增长到的最大长度。",
- "label": "TCP 连接队列长度"
- },
- "broker_route_batch_clean": {
- "desc": "是否开启批量清除路由。"
- },
- "fields_mqtt_quic_listener_initial_window_packets": {
- "desc": "一个连接的初始拥堵窗口的大小（以包为单位）。默认值：10",
- "label": "初始窗口数据包"
- },
- "flapping_detect_enable": {
- "desc": "启用抖动检测功能。",
- "label": "启用抖动检测"
- },
- "sysmon_top_db_password": {
- "desc": "PostgreSQL 数据库的密码",
- "label": "数据库密码"
- },
- "fields_ws_opts_check_origins": {
- "desc": "允许的 origins 列表",
- "label": "允许的 origins"
- },
- "fields_deflate_opts_client_context_takeover": {
- "desc": "接管意味着在客户端消息之间保留压缩状态。",
- "label": "客户端上下文接管"
- },
- "base_listener_acceptors": {
- "desc": "监听器接收池的大小。",
- "label": "接收器数量"
- },
- "common_ssl_opts_schema_cacertfile": {
- "desc": "受信任的PEM格式 CA 证书捆绑文件\n此文件中的证书用于验证TLS对等方的证书。\n如果要信任新 CA，请将新证书附加到文件中。\n无需重启EMQX即可加载更新的文件，因为系统会定期检查文件是否已更新（并重新加载）
\n注意：从文件中失效（删除）证书不会影响已建立的连接。", - "label": "CA 证书文件" - }, - "fields_ws_opts_mqtt_path": { - "desc": "WebSocket 的 MQTT 协议路径。因此，EMQX Broker的WebSocket地址为：\n
ws://{'{'}ip{'}'}:{'{'}port{'}'}/mqtt",
- "label": "WS MQTT 路径"
- },
- "sysmon_os_procmem_high_watermark": {
- "desc": "在发出相应警报之前，一个Erlang进程可以分配多少系统内存的阈值，以系统内存的百分比表示。",
- "label": "进程内存高水位线"
- },
- "fields_listeners_quic": {
- "desc": "QUIC 监听器。",
- "label": "QUIC 监听器"
- },
- "fields_listeners_ws": {
- "desc": "HTTP websocket 监听器。",
- "label": "HTTP websocket 监听器"
- },
- "mqtt_retry_interval": {
- "desc": "QoS 1/2 消息的重新投递间隔。",
- "label": "消息重试间隔"
- },
- "stats_enable": {
- "desc": "启用/禁用统计数据收集功能。",
- "label": "启用/禁用统计数据收集功能"
- },
- "fields_authorization_deny_action": {
- "desc": "授权检查拒绝操作时的操作。",
- "label": "授权检查拒绝操作时的操作"
- },
- "fields_deflate_opts_server_max_window_bits": {
- "desc": "指定服务器压缩上下文的大小。",
- "label": "服务器压缩窗口大小"
- },
- "client_ssl_opts_schema_server_name_indication": {
- "desc": "指定要在 TLS 服务器名称指示扩展中使用的主机名。\n例如，当连接到 \"server.example.net\" 时，接受连接并执行 TLS 握手的真正服务器可能与 TLS 客户端最初连接到的主机不同，\n例如，当连接到 IP 地址时，或者当主机具有多个可解析的 DNS 记录时
\n如果未指定，它将默认为使用的主机名字符串\n建立连接，除非使用 IP 地址
\n然后，主机名也用于对等机的主机名验证证书
\n特殊值
disable 阻止发送服务器名称指示扩展，并禁用主机名验证检查。",
- "label": "服务器名称指示"
- },
- "fields_mqtt_quic_listener_retry_memory_limit": {
- "desc": "在使用无状态重试之前，可用于握手连接的可用内存的百分比。计算为`N/65535`。默认值：65",
- "label": "重试内存限制"
- },
- "force_shutdown_max_message_queue_len": {
- "desc": "消息队列的最大长度。",
- "label": "进程邮箱消息队列的最大长度"
- },
- "sys_heartbeat_interval": {
- "desc": "发送心跳系统消息的间隔时间，它包括：\n - `$SYS/brokers/listeners.tcp.\\.mountpoint 设置为'some_tenant'，那么客户端实际上订阅了主题'some_tenant/t'。\n类似地，如果另一个客户端B（与客户端A连接到同一个侦听器）向主题 't' 发送消息，该消息将路由到所有订阅了'some_租户/t'的客户端，因此客户端 A 将接收主题名为't'的消息
\n\n设置为
\"\" 以禁用该功能\n\nmountpoint 字符串中的变量：\n-
${'{'}clientid{'}'}: clientid\n- ${'{'}username{'}'}: username",
- "label": "mountpoint"
- },
- "mqtt_max_awaiting_rel": {
- "desc": "为每个会话指定未收到 PUBREL 且未超时的最大 QoS 2 消息数量。超过限制后，新的 QoS 2 消息发布会被拒绝，并返回 147(0x93) 错误。",
- "label": "最大待发 PUBREL 数量"
- },
- "ciphers_schema_quic": {
- "desc": "此配置保存由逗号分隔的 TLS 密码套件名称，或作为字符串数组。例如\n\"TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256\"或\n[\"TLS_AES_256_GCM_SHA384\",\"TLS_AES_128_GCM_SHA256\"]。\n\n密码（及其顺序）定义了客户端和服务器通过网络连接加密信息的方式。\n选择一个好的密码套件对于应用程序的数据安全性、机密性和性能至关重要。\n\n名称应为 OpenSSL 字符串格式（而不是 RFC 格式）。\nEMQX 配置文档提供的所有默认值和示例都是 OpenSSL 格式
\n注意：某些密码套件仅与特定的 TLS
版本兼容（'tlsv1.1'、'tlsv1.2'或'tlsv1.3'）。\n不兼容的密码套件将被自动删除。\n\n例如，如果只有 versions 仅配置为 tlsv1.3。为其他版本配置密码套件将无效。\n\n\n注：PSK 的 Ciphers 不支持 tlsv1.3
\n如果打算使用PSK密码套件，
tlsv1.3。应在ssl.versions中禁用。\n\n\nPSK 密码套件：\n
\"RSA-PSK-AES256-GCM-SHA384,RSA-PSK-AES256-CBC-SHA384,\nRSA-PSK-AES128-GCM-SHA256,RSA-PSK-AES128-CBC-SHA256,\nRSA-PSK-AES256-CBC-SHA,RSA-PSK-AES128-CBC-SHA,\nRSA-PSK-DES-CBC3-SHA,RSA-PSK-RC4-SHA\"\n\n注：QUIC 监听器不支持 tlsv1.3 的 ciphers", - "label": "" - }, - "fields_mqtt_quic_listener_max_bytes_per_key": { - "desc": "在启动密钥更新之前，用单个 1-RTT 加密密钥加密的最大字节数。默认值：274877906944", - "label": "每个密钥的最大字节数" - }, - "fields_mqtt_quic_listener_mtu_discovery_search_complete_timeout_us": { - "desc": "如果没有达到 max ，在重新尝试 MTU 探测之前要等待的时间，单位是微秒。默认值：600000000", - "label": "" - }, - "fields_ws_opts_check_origin_enable": { - "desc": "如果
true，originHTTP 头将根据check_origins参数中配置的允许来源列表进行验证。",
- "label": "检查 origin"
- },
- "sysmon_vm_busy_dist_port": {
- "desc": "启用后，当用于集群接点之间 RPC 的连接过忙时，会触发一条带有 busy_dist_port 关键字的 warning 级别日志。\n同时还会发布一条主题为 $SYS/sysmon/busy_dist_port 的 MQTT 系统消息。",
- "label": "启用分布式端口过忙监控"
- },
- "mqtt_max_mqueue_len": {
- "desc": "最大消息队列长度。持久客户端断开连接或飞行窗口已满时，允许排队的的最大消息数量。",
- "label": "最大消息队列长度"
- },
- "mqtt_max_inflight": {
- "desc": "完成应答前，最多允许同时投递的 QoS 1 和 QoS 2 消息数量。",
- "label": "最大飞行窗口"
- },
- "persistent_session_store_enabled": {
- "desc": "使用数据库存储有关持久会话的信息。\n这使得在节点停止时，可以将客户端连接迁移到另一个群集节点。",
- "label": "启用持久会话保存"
- },
- "fields_deflate_opts_level": {
- "desc": "压缩级别",
- "label": "压缩级别"
- },
- "mqtt_server_keepalive": {
- "label": "服务端 Keep Alive"
- },
- "global_authentication": {
- "desc": "全局 MQTT 监听器的默认认证配置。 为每个监听器配置认证参考监听器器配置中的authentication 配置。\n\n该配置可以被配置为：\n- \n
[]: 默认值，允许所有的登录请求\n- 配置为单认证器，例如
{'{'}enable:true,backend:\"built_in_database\",mechanism=\"password_based\"{'}'}\n - 配置为认证器数组 \n
allow 或 deny的结果。\n\n如果在所有的认证器都执行完后，还是没有结果，登录将被拒绝。"
- },
- "fields_mqtt_quic_listener_load_balancing_mode": {
- "desc": "0: 禁用, 1: SERVER_ID_IP, 2: SERVER_ID_FIXED. 默认: 0",
- "label": "负载平衡模式"
- },
- "persistent_session_store_session_message_gc_interval": {
- "desc": "持久会话消息的临时数据垃圾收集的开始间隔。\n这不会影响持久会话消息的生命周期长度。",
- "label": "会话消息清理间隔"
- },
- "server_ssl_opts_schema_ocsp_refresh_http_timeout": {
- "desc": "检查 OCSP 响应时，HTTP 请求的超时。",
- "label": "OCSP 刷新 HTTP 超时"
- },
- "fields_tcp_opts_send_timeout": {
- "desc": "连接的 TCP 发送超时。",
- "label": "TCP 发送超时"
- },
- "sysmon_vm_process_high_watermark": {
- "desc": "在发出相应警报之前，本地节点上可以同时存在多少进程的阈值（以进程百分比表示）。",
- "label": "进程数高水位线"
- },
- "fields_tcp_opts_buffer": {
- "desc": "驱动程序使用的用户空间缓冲区的大小。",
- "label": "TCP 用户态缓冲区"
- },
- "server_ssl_opts_schema_honor_cipher_order": {
- "desc": "一个重要的安全设置，它强制根据服务器指定的顺序而不是客户机指定的顺序设置密码，从而强制服务器管理员执行（通常配置得更正确）安全顺序。",
- "label": "SSL honor cipher order"
- },
- "conn_congestion_min_alarm_sustain_duration": {
- "desc": "清除警报前的最短时间。只有当队列中没有挂起的数据，并且连接至少被堵塞了
min_alarm_sustain_duration 毫秒时，报警才会被清除。这是为了避免太频繁地清除和再次发出警报。", - "label": "告警维持时间" - }, - "fields_mqtt_quic_listener_keep_alive_interval_ms": { - "desc": "多长时间发送一次PING帧以保活连接。", - "label": "保持活着的时间间隔 毫秒" - }, - "fields_mqtt_quic_listener_handshake_idle_timeout_ms": { - "desc": "一个握手在被丢弃之前可以空闲多长时间", - "label": "握手空闲超时 毫秒" - }, - "broker_session_locking_strategy": { - "desc": "Session 在集群中的锁策略。\n - `loca`：仅锁本节点的 Session；\n - `one`：任选一个其它节点加锁；\n - `quorum`：选择集群中半数以上的节点加锁；\n - `all`：选择所有节点加锁。" - }, - "persistent_store_ram_cache": { - "desc": "在内存中保持一份数据的副本，以便更快地访问。", - "label": "内存缓存" - }, - "fields_mqtt_quic_listener_stream_recv_window_default": { - "desc": "初始流接收窗口大小。 默认值：32678", - "label": "流接收窗口默认" - }, - "mqtt_mqueue_priorities": { - "desc": "主题优先级。优先级数字[1-255]。默认情况下没有优先级表，因此所有消息都被平等对待。
注意：优先级主题名称中不允许使用逗号和等号。
注意：不在优先级表中的主题的消息将根据 mqtt.mqueue_default_priority 的配置值被视为最高优先级或最低优先级。
示例：
要配置 'topic/1' > 'topic/2'：
mqueue_priorities: {'{'}\"topic/1\": 10, \"topic/2\": 8{'}'}", - "label": "主题优先级" - }, - "fields_rate_limit_conn_messages_in": { - "desc": "外部 MQTT 连接的消息限制。", - "label": "外部 MQTT 连接的消息限制" - }, - "fields_rate_limit_max_conn_rate": { - "desc": "每秒最大连接数。", - "label": "每秒最大连接数" - }, - "alarm_size_limit": { - "desc": "要保留为历史记录的已停用报警的最大总数。当超过此限制时，将删除最旧的停用报警，以限制总数。", - "label": "告警总数限制" - }, - "fields_cache_max_size": { - "desc": "缓存项的最大数量。", - "label": "缓存项的最大数量" - }, - "fields_listeners_tcp": { - "desc": "TCP 监听器。", - "label": "TCP 监听器" - }, - "conn_congestion_enable_alarm": { - "desc": "启用或者禁用连接阻塞告警功能。", - "label": "启用/禁用阻塞告警" - }, - "fields_ws_opts_proxy_port_header": { - "desc": "HTTP 头，用于传递有关客户端端口的信息。当 EMQX 集群部署在负载平衡器后面时，这一点非常重要。", - "label": "客户端端口头" - }, - "overload_protection_enable": { - "desc": "是否对系统过载做出反应。", - "label": "是否对系统过载做出反应" - }, - "fields_mqtt_quic_listener_minimum_mtu": { - "desc": "一个连接所支持的最小MTU。这将被作为起始MTU使用。默认值：1248", - "label": "最小 MTU" - }, - "sys_msg_interval": { - "desc": "发送 `$SYS` 主题的间隔时间。" - }, - "mqtt_await_rel_timeout": { - "desc": "对于未收到 PUBREL 的 QoS 2 消息，将按照指定时间等待重传；超时后 EMQX 将释放 packet ID 并产生一条告警日志。\n注意：EMQX 对消息的转发操作不依赖于 PUBREL收到与否。", - "label": "最大 PUBREL 等待时长" - }, - "common_ssl_opts_schema_verify": { - "desc": "启用或禁用对等验证。", - "label": "对等验证" - }, - "fields_listeners_ssl": { - "desc": "SSL 监听器。", - "label": "SSL 监听器" - }, - "fields_deflate_opts_client_max_window_bits": { - "desc": "指定客户端压缩上下文的大小。", - "label": "压缩窗口大小" - }, - "common_ssl_opts_schema_keyfile": { - "desc": "PEM格式的私钥文件。", - "label": "私钥文件" - }, - "sysmon_os_cpu_high_watermark": { - "desc": "在发出相应警报之前可以使用多少系统 CPU 的阈值，以系统CPU负载的百分比表示。", - "label": "CPU 高水位线" - }, - "flapping_detect_window_time": { - "desc": "抖动检测的时间窗口。", - "label": "时间窗口" - }, - "mqtt_mqueue_default_priority": { - "desc": "默认的主题优先级，不在
主题优先级（mqueue_priorities） 中的主题将会使用该优先级。",
- "label": "默认主题优先级"
- },
- "client_ssl_opts_schema_enable": {
- "desc": "启用 TLS。",
- "label": "启用 TLS"
- },
- "fields_mqtt_quic_listener_mtu_discovery_missing_probe_count": {
- "desc": "在任何时候都可以在一个绑定上排队的无状态操作的最大数量。默认值：3",
- "label": "MTU发现丢失的探针数量"
- },
- "fields_tcp_opts_recbuf": {
- "desc": "连接的 TCP 接收缓冲区（OS 内核）。",
- "label": "TCP 接收缓冲区"
- },
- "sysmon_vm_process_check_interval": {
- "desc": "定期进程限制检查的时间间隔。",
- "label": "进程限制检查时间"
- },
- "fields_mqtt_quic_listener_server_resumption_level": {
- "desc": "连接恢复 和/或 0-RTT 服务器支持。默认值：0（无恢复功能）",
- "label": "服务端连接恢复支持"
- },
- "fields_ws_opts_proxy_address_header": {
- "desc": "HTTP 头，用于传递有关客户端 IP 地址的信息。\n当 EMQX 集群部署在负载平衡器后面时，这一点非常重要。",
- "label": "客户端地址头"
- },
- "sysmon_os_sysmem_high_watermark": {
- "desc": "在发出相应报警之前可以分配多少系统内存的阈值，以系统内存的百分比表示。",
- "label": "系统内存高水位线"
- },
- "fields_tcp_opts_high_watermark": {
- "desc": "当 VM 套接字实现内部排队的数据量达到此限制时，套接字将设置为忙碌状态。",
- "label": ""
- },
- "fields_mqtt_quic_listener_stateless_operation_expiration_ms": {
- "desc": "同一个对端的操作之间的时间限制，单位是毫秒。 默认：100",
- "label": "无状态操作过期 毫秒"
- },
- "server_ssl_opts_schema_dhfile": {
- "desc": "如果协商使用Diffie-Hellman密钥交换的密码套件，则服务器将使用包含PEM编码的Diffie-Hellman参数的文件的路径。如果未指定，则使用默认参数。\n注意：TLS 1.3不支持
dhfile选项。",
- "label": "SSL dhfile"
- },
- "flapping_detect_max_count": {
- "desc": "MQTT 客户端在“窗口”时间内允许的最大断开次数。",
- "label": "最大断开次数"
- },
- "mqtt_max_topic_levels": {
- "label": "最大主题层级"
- },
- "force_shutdown_max_heap_size": {
- "desc": "Heap 的总大小。",
- "label": "Heap 的总大小"
- },
- "persistent_store_on_disc": {
- "desc": "将持久会话数据保存在磁盘上。如果为 false 则存储在内存中。\n如开启， 持久会话数据可在集群重启后恢复。\n如关闭， 数据仅存储在内存中， 则在整个集群停止后丢失。",
- "label": "持久化在磁盘上"
- },
- "mqtt_ignore_loop_deliver": {
- "desc": "设置由 MQTT v3.1.1/v3.1.0 客户端发布的消息是否将转发给其本身；类似 MQTT 5.0 协议中的 `No Local` 选项。",
- "label": "忽略循环投递"
- },
- "common_ssl_opts_schema_certfile": {
- "desc": "PEM格式证书链文件\n此文件中的证书应与证书颁发链的顺序相反。也就是说，主机的证书应该放在文件的开头，\n然后是直接颁发者 CA 证书，依此类推，一直到根 CA 证书。\n根 CA 证书是可选的，如果想要添加，应加到文件到最末端。", - "label": "证书文件" - }, - "mqtt_exclusive_subscription": { - "label": "允许排它订阅" - }, - "mqtt_retain_available": { - "desc": "是否启用对 MQTT 保留消息的支持。禁用此选项时，客户端将无法发布保留消息。", - "label": "启用保留消息" - }, - "fields_tcp_opts_reuseaddr": { - "desc": "连接的 SO_REUSEADDR 标识。", - "label": "SO_REUSEADDR" - }, - "sysmon_vm_long_schedule": { - "desc": "启用后，如果 Erlang VM 调度器出现某个任务占用时间过长时，会触发一条带有 'long_schedule' 关键字的日志。\n同时还会发布一条主题为
$SYS/sysmon/long_schedule 的 MQTT 系统消息。",
- "label": "启用长调度监控"
- },
- "mqtt_keepalive_multiplier": {
- "desc": "`Keep-Alive Timeout = Keep-Alive Interval × Keep-Alive Multiplier`，根据 MQTT 5.0，默认值为1.5。\n\n例如，如果 Keep-Alive interval 为 10 秒，那么乘以 1.5 的倍数，将产生 15 秒的超时。将倍数值增加到 2，超时将延长到 20 秒。",
- "label": "Keep Alive 倍数"
- },
- "force_gc_bytes": {
- "desc": "在进程处理过多少个字节之后，对此进程执行垃圾回收。",
- "label": "垃圾回收字节数"
- },
- "server_ssl_opts_schema_fail_if_no_peer_cert": {
- "desc": "TLS/DTLS 服务器与 {'{'}verify，verify_peer{'}'} 一起使用。\n如果设置为true，则如果客户端没有要发送的证书，即发送空证书，服务器将失败。\n如果设置为false，则仅当客户端发送无效证书（空证书被视为有效证书）时才会失败。",
- "label": "强制验证对端证书"
- },
- "fields_ws_opts_compress": {
- "desc": "如果 true，则使用zlib 压缩 WebSocket 消息\n
deflate_opts 下的配置项属于压缩相关参数配置。",
- "label": "Ws 压缩"
- },
- "fields_mqtt_quic_listener_keep_alive_interval": {
- "desc": "发送 PING 帧的频率，以保活连接. 设为 0 表示禁用。",
- "label": "PING 保活频率"
- },
- "fields_cache_ttl": {
- "desc": "缓存数据的生存时间。",
- "label": "缓存数据的生存时间"
- },
- "sys_topics": {
- "desc": "系统主题配置。"
- },
- "sys_event_client_subscribed": {
- "desc": "是否开启客户端已成功订阅主题事件消息。"
- },
- "sysmon_top_db_port": {
- "desc": "收集数据点的 PostgreSQL 数据库的端口。",
- "label": "数据库端口"
- },
- "fields_mqtt_quic_listener_max_operations_per_drain": {
- "desc": "每个连接操作的最大耗费操作数。默认：16",
- "label": "每次操作最大操作数"
- },
- "fields_mqtt_quic_listener_datagram_receive_enabled": {
- "desc": "宣传对QUIC Datagram 扩展的支持。为将来保留。默认为0（FALSE）",
- "label": "启用 Datagram 接收"
- },
- "fields_mqtt_quic_listener_initial_rtt_ms": {
- "desc": "初始RTT估计",
- "label": "Initial RTT 毫秒"
- },
- "overload_protection_backoff_gc": {
- "desc": "高负载时，跳过强制 GC。",
- "label": "跳过GC"
- },
- "broker_perf_route_lock_type": {
- "desc": "通配主题订阅/取消订阅性能调优。\n建议仅当通配符主题较多时才更改此参数。\n\n注：当从/更改为 `global` 锁时，它要求集群中的所有节点在更改之前停止。\n - `key`：为 Mnesia 事务涉及到的每个 key 上锁，建议单节点时使用。\n - `tab`：为 Mnesia 事务涉及到的表上锁，建议在集群中使用。\n - `global`：所以更新操作都被全局的锁保护，仅建议在超大规模集群中使用。"
- },
- "fields_tcp_opts_nodelay": {
- "desc": "连接的 TCP_NODELAY 标识",
- "label": "TCP_NODELAY"
- },
- "sysmon_top_db_username": {
- "desc": "PostgreSQL 数据库的用户名",
- "label": "数据库用户名"
- },
- "broker": {
- "desc": "Broker 相关配置项。"
- },
- "force_gc_count": {
- "desc": "在进程收到多少消息之后，对此进程执行垃圾回收。",
- "label": "垃圾回收消息数"
- },
- "mqtt_max_clientid_len": {
- "label": "最大客户端 ID 长度"
- },
- "fields_ws_opts_supported_subprotocols": {
- "desc": "逗号分隔的 subprotocols 支持列表。",
- "label": "Subprotocols 支持列表"
- },
- "broker_shared_subscription_strategy": {
- "desc": "共享订阅消息派发策略。\n - `random`：随机挑选一个共享订阅者派发；\n - `round_robin`：使用 round-robin 策略派发；\n - `round_robin_per_group`：在共享组内循环选择下一个成员；\n - `local`：选择随机的本地成员，否则选择随机的集群范围内成员;\n - `sticky`：总是使用上次选中的订阅者派发，直到它断开连接；\n - `hash_clientid`：通过对发送者的客户端 ID 进行 Hash 处理来选择订阅者;\n - `hash_topic`：通过对源主题进行 Hash 处理来选择订阅者。"
- },
- "fields_deflate_opts_mem_level": {
- "desc": "指定压缩状态的大小\n较低的值会减少每个连接的内存使用。", - "label": "压缩状态大小" - }, - "fields_mqtt_quic_listener_send_idle_timeout_ms": { - "desc": "在闲置一定时间后重置拥堵控制。默认值：1000", - "label": "发送空闲超时毫秒" - }, - "base_listener_limiter": { - "desc": "速率限制类型", - "label": "速率限制类型" - }, - "persistent_session_store_backend": { - "desc": "用于存储持久性会话和信息的数据库管理后端\n- `builtin`: 使用内置的数据库（mria）", - "label": "后端类型" - }, - "alarm_validity_period": { - "desc": "停用报警的保留时间。报警在停用时不会立即删除，而是在保留时间之后删除。", - "label": "告警保留时间" - }, - "server_ssl_opts_schema_ocsp_issuer_pem": { - "desc": "服务器证书的 OCSP 签发者的 PEM 编码证书。", - "label": "OCSP 签发者证书" - }, - "fields_tcp_opts_active_n": { - "desc": "为此套接字指定{'{'}active，N{'}'}选项
\nSee: https://erlang.org/doc/man/inet.html#setopts-2", - "label": "active_n" - }, - "listener_authentication": { - "desc": "监听器认证重载。\n认证配置可以是单个认证器实例，也可以是一个认证器数组组成的认证链。\n执行登录验证时（用户名、客户端 ID 等），将按配置的顺序执行。", - "label": "每个监听器的认证覆盖" - }, - "fields_trace_payload_encode": { - "desc": "确定跟踪日志文件中 Payload 格式。
\n`text`：基于文本的协议或纯文本协议。\n建议在 Payload 为 JSON 编码时使用
\n`hex`：二进制十六进制编码。当 Payload 是自定义二进制协议时，建议使用此选项
\n`hidden`：Payload 被模糊化为 `******`", - "label": "Payload 编码" - }, - "mqtt_response_information": { - "desc": "UTF-8 字符串，用于指定返回给客户端的响应主题，如 `reqrsp/`，此时请求和应答客户端都需要使用 `reqrsp/` 前缀的主题来完成通讯。如希望禁用此功能，请在下方的文字框中输入`\"\"`；仅适用于 MQTT 5.0 客户端。", - "label": "响应信息" - }, - "persistent_session_store_max_retain_undelivered": { - "desc": "如果重新启动时处理上一个会话的节点已停止，则未传递到持久会话的消息在垃圾收集之前会被存储。", - "label": "未投递的消息保留条数" - }, - "fields_mqtt_quic_listener_migration_enabled": { - "desc": "开启客户端地址迁移功能。需要一个支持的负载平衡器，或者没有负载平衡器。默认值：1（已启用）", - "label": "启用地址迁移" - }, - "common_ssl_opts_schema_password": { - "desc": "包含用户密码的字符串。仅在私钥文件受密码保护时使用。", - "label": "密钥文件密码" - }, - "common_ssl_opts_schema_hibernate_after": { - "desc": "在闲置一定时间后休眠 SSL 进程，减少其内存占用。", - "label": "闲置多久后休眠" - }, - "fields_mqtt_quic_listener_send_buffering_enabled": { - "desc": "缓冲发送数据，而不是保留应用缓冲区，直到发送数据被确认。默认值：1（启用）", - "label": "启用发送缓冲功能" - }, - "sys_event_client_unsubscribed": { - "desc": "是否开启客户端已成功取消订阅主题事件消息。" - }, - "overload_protection_backoff_new_conn": { - "desc": "高负载时，拒绝新进来的客户端连接。", - "label": "关闭新连接" - }, - "server_ssl_opts_schema_ocsp_responder_url": { - "desc": "用于检查服务器证书的 OCSP Responder 的 URL。", - "label": "OCSP Responder 的 URL" - }, - "mqtt_idle_timeout": { - "desc": "设置连接被断开或进入休眠状态前的等待时间，空闲超时后\n\n- 如暂未收到客户端的 CONNECT 报文，连接将断开；\n- 如已收到客户端的 CONNECT 报文，连接将进入休眠模式以节省系统资源。\n\n注意：请合理设置该参数值，如等待时间设置过长，可能造成系统资源的浪费。", - "label": "空闲超时" - }, - "fields_mqtt_quic_listener_conn_flow_control_window": { - "desc": "连接的流控窗口。默认：16777216", - "label": "流控窗口" - }, - "fields_mqtt_quic_listener_maximum_mtu": { - "desc": "一个连接所支持的最大MTU。这将是最大的探测值。默认值：1500", - "label": "最大 MTU" - }, - "sysmon_top_db_name": { - "desc": "PostgreSQL 数据库的数据库名", - "label": "数据库名" - }, - "mqtt_strict_mode": { - "desc": "是否以严格模式解析 MQTT 消息。严格模式下，如客户端 ID、主题名称等中包含无效 utf8 字符串，连接将被断开。", - "label": "严格模式" - }, - "shared_subscription_group_strategy": { - "desc": "设置共享订阅组为单位的分发策略。该配置是一个从组名到\n策略名的一个map，组名不得包含 `[A-Za-z0-9]` 之外的特殊字符。" - }, - "fields_deflate_opts_strategy": { - "desc": "指定压缩策略。", - "label": "指定压缩策略" - }, - "shared_subscription_strategy_enum": { - "desc": "共享订阅的分发策略名称。\n- `random`：随机选择一个组内成员；\n- `round_robin`：循环选择下一个成员；\n- `round_robin_per_group`：在共享组内循环选择下一个成员；\n- `sticky`：使用上一次选中的成员；\n- `hash`：根据 ClientID 哈希映射到一个成员；\n- `local`：随机分发到节点本地成成员，如果本地成员不存在，则随机分发到任意一个成员。" - }, - "persistent_session_builtin_sess_msg_table": { - "desc": "优化内置的会话消息表的配置。", - "label": "用于内建会话管理表的性能调优参数" - }, - "mqtt_mqueue_store_qos0": { - "desc": "在连接断开但会话保持期间，是否需要在消息队列中存储 QoS 0 消息。", - "label": "存储 QoS 0 消息" - }, - "server_ssl_opts_schema_client_renegotiation": { - "desc": "在支持客户机发起的重新协商的协议中，这种操作的资源成本对于服务器来说高于客户机。\n这可能会成为拒绝服务攻击的载体。\nSSL 应用程序已经采取措施来反击此类尝试，但通过将此选项设置为 false，可以严格禁用客户端发起的重新协商。\n默认值为 true。请注意，由于基础密码套件可以加密的消息数量有限，禁用重新协商可能会导致长期连接变得不可用。", - "label": "SSL 客户端冲协商" - }, - "server_ssl_opts_schema_enable_crl_check": { - "desc": "是否为该监听器启用 CRL 检查。", - "label": "启用 CRL 检查" - }, - "fields_mqtt_quic_listener_peer_bidi_stream_count": { - "desc": "允许对端打开的双向流的数量", - "label": "对端双向流的数量" - }, - "fields_mqtt_quic_listener_max_stateless_operations": { - "desc": "无状态操作的最大数量，在任何时候都可以在一个工作者上排队。默认值：16", - "label": "最大无状态操作数" - }, - "fields_ws_opts_idle_timeout": { - "desc": "关闭在此间隔内未发送 MQTT CONNECT 消息的客户端的传输层连接。", - "label": "WS 空闲时间" - }, - "fields_mqtt_quic_listener_max_ack_delay_ms": { - "desc": "在收到数据后要等待多长时间才能发送一个ACK。默认值：25", - "label": "最大应答延迟 毫秒" - }, - "base_listener_zone": { - "desc": "监听器所属的配置组。", - "label": "配置组" - }, - "fields_mqtt_quic_listener_handshake_idle_timeout": { - "desc": "一个握手在被丢弃之前可以空闲多长时间。", - "label": "握手空闲超时时间" - }, - "force_gc_enable": { - "desc": "启用强制垃圾回收。", - "label": "启用强制垃圾回收" - }, - "fields_ws_opts_allow_origin_absence": { - "desc": "If
false and check_origin_enable is true, the server will reject requests that don't have origin HTTP header.",
- "label": "允许 origin 缺失"
- },
- "common_ssl_opts_schema_versions": {
- "desc": "支持所有TLS/DTLS版本\n注：PSK 的 Ciphers 无法在
tlsv1.3 中使用，如果打算使用 PSK 密码套件，请确保这里配置为 [\"tlsv1.2\",\"tlsv1.1\"]。",
- "label": "SSL 版本"
- },
- "mqtt_listener_proxy_protocol_timeout": {
- "desc": "代理协议超时。如果在超时时间内未收到代理协议数据包，EMQX将关闭TCP连接。",
- "label": "Proxy protocol 超时时间"
- },
- "fields_mqtt_quic_listener_idle_timeout": {
- "desc": "一个连接在被关闭之前可以空闲多长时间。0表示禁用。",
- "label": "空闲超时时间"
- },
- "common_ssl_opts_schema_secure_renegotiate": {
- "desc": "SSL 参数重新协商是一种允许客户端和服务器动态重新协商 SSL 连接参数的功能。\nRFC 5746 定义了一种更安全的方法。通过启用安全的重新协商，您就失去了对不安全的重新协商的支持，从而容易受到 MitM 攻击。",
- "label": "SSL 重新协商"
- },
- "sysmon_vm_busy_port": {
- "desc": "当一个系统接口（例如 TCP socket）过忙，会触发一条带有 busy_port 关键字的 warning 级别的日志。\n同时还会发布一条主题为 $SYS/sysmon/busy_port 的 MQTT 系统消息。",
- "label": "启用端口过忙监控"
- },
- "sys_event_client_connected": {
- "desc": "是否开启客户端已连接事件消息。"
- },
- "sysmon_vm_process_low_watermark": {
- "desc": "在清除相应警报之前，本地节点上可以同时存在多少进程的阈值（以进程百分比表示）。",
- "label": "进程数低水位线"
- },
- "mqtt_max_packet_size": {
- "desc": "允许的最大 MQTT 报文大小，超出此大小后将断开当前客户端连接。",
- "label": "最大报文大小"
- },
- "common_ssl_opts_schema_reuse_sessions": {
- "desc": "启用 TLS 会话重用。",
- "label": "TLS 会话重用"
- },
- "common_ssl_opts_schema_depth": {
- "desc": "在有效的证书路径中，可以跟随对等证书的非自颁发中间证书的最大数量。\n因此，如果深度为0，则对等方必须由受信任的根 CA 直接签名；\n如果是1，路径可以是 PEER、中间 CA、ROOT-CA；
\n如果是2，则路径可以是PEER、中间 CA1、中间 CA2、ROOT-CA。", - "label": "CA 证书深度" - }, - "sysmon_vm_long_gc": { - "desc": "当系统检测到某个 Erlang 进程垃圾回收占用过长时间，会触发一条带有
long_gc 关键字的日志。\n同时还会发布一条主题为 $SYS/sysmon/long_gc 的 MQTT 系统消息。",
- "label": "启用长垃圾回收监控"
- },
- "fields_mqtt_quic_listener_keyfile": {
- "desc": "私钥文件。在 5.1 中会被废弃，使用 .ssl_options.keyfile 代替。",
- "label": "私钥文件"
- },
- "mqtt_peer_cert_as_clientid": {
- "desc": "使用对端证书中的 CN、DN 字段或整个证书内容来作为客户端 ID。仅适用于 TLS 连接；\n目前支持：\n- cn: 取证书的 CN 字段\n- dn: 取证书的 DN 字段\n- crt: 取 DER 或 PEM 证书的内容\n- pem: 将 DER 证书内容转换为 PEM 格式作为客户端 ID\n- md5: 取 DER 或 PEM 证书内容的 MD5 值",
- "label": "使用对端证书作为客户端 ID"
- },
- "persistent_session_store_message_gc_interval": {
- "desc": "将未送达的消息垃圾收集到持久会话的开始间隔。\n这会影响检查 \"max_retain_undelivered\"（最大保留未送达）的删除频率。",
- "label": "消息清理间隔"
- },
- "broker_shared_dispatch_ack_enabled": {
- "desc": "该配置项已废弃，会在 5.1 中移除。\n启用/禁用 QoS 1 和 QoS 2 消息的共享派发确认。\n开启后，允许将消息从未及时回复 ACK 的订阅者 （例如，客户端离线） 重新派发给另外一个订阅者。"
- },
- "base_listener_enable_authn": {
- "desc": "配置 true （默认值）启用客户端进行身份认证，通过检查认配置的认认证器链来决定是否允许接入。\n配置 false 时，将不对客户端做任何认证，任何客户端，不论是不是携带用户名等认证信息，都可以接入。\n配置 quick_deny_anonymous 时，行为跟 true 类似，但是会对匿名\n客户直接拒绝，不做使用任何认证器对客户端进行身份检查。",
- "label": "启用身份认证"
- },
- "force_shutdown_enable": {
- "desc": "启用 `force_shutdown` 功能。",
- "label": "启用 `force_shutdown` 功能"
- },
- "broker_enable_session_registry": {
- "desc": "是否启用 Session Registry"
- },
- "overload_protection_backoff_delay": {
- "desc": "高负载时，一些不重要的任务可能会延迟执行，在这里设置允许延迟的时间。",
- "label": "延迟时间"
- },
- "ciphers_schema_common": {
- "desc": "此配置保存由逗号分隔的 TLS 密码套件名称，或作为字符串数组。例如\n\"TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256\"或\n[\"TLS_AES_256_GCM_SHA384\",\"TLS_AES_128_GCM_SHA256\"]。\n\n密码（及其顺序）定义了客户端和服务器通过网络连接加密信息的方式。\n选择一个好的密码套件对于应用程序的数据安全性、机密性和性能至关重要。\n\n名称应为 OpenSSL 字符串格式（而不是 RFC 格式）。\nEMQX 配置文档提供的所有默认值和示例都是 OpenSSL 格式
\n注意：某些密码套件仅与特定的 TLS
版本兼容（'tlsv1.1'、'tlsv1.2'或'tlsv1.3'）。\n不兼容的密码套件将被自动删除。\n\n例如，如果只有 versions 仅配置为 tlsv1.3。为其他版本配置密码套件将无效。\n\n\n注：PSK 的 Ciphers 不支持 tlsv1.3
\n如果打算使用PSK密码套件
tlsv1.3。应在ssl.versions中禁用。\n\n\nPSK 密码套件：\n
\"RSA-PSK-AES256-GCM-SHA384,RSA-PSK-AES256-CBC-SHA384,\nRSA-PSK-AES128-GCM-SHA256,RSA-PSK-AES128-CBC-SHA256,\nRSA-PSK-AES256-CBC-SHA,RSA-PSK-AES128-CBC-SHA,\nRSA-PSK-DES-CBC3-SHA,RSA-PSK-RC4-SHA\"",
- "label": ""
- },
- "sys_event_client_disconnected": {
- "desc": "是否开启客户端已断开连接事件消息。"
- },
- "crl_cache_refresh_interval": {
- "desc": "从服务器刷新CRL的周期。 该配置对所有 URL 和监听器有效。",
- "label": "CRL 缓存刷新间隔"
- },
- "mqtt_listener_proxy_protocol": {
- "desc": "如果EMQX集群部署在 HAProxy 或 Nginx 之后，请启用代理协议 V1/2 \n详情见: https://www.haproxy.com/blog/haproxy/proxy-protocol/", - "label": "Proxy protocol" - }, - "mqtt_listener_access_rules": { - "desc": "此监听器的访问控制规则。", - "label": "访问控制规则" - }, - "server_ssl_opts_schema_enable_ocsp_stapling": { - "desc": "是否为监听器启用 OCSP Stapling 功能。 如果设置为 true，需要定义 OCSP Responder 的 URL 和证书签发者的 PEM 文件路径。", - "label": "启用 OCSP Stapling" - }, - "fields_tcp_opts_send_timeout_close": { - "desc": "如果发送超时，则关闭连接。", - "label": "TCP 发送超时关闭连接" - }, - "sysmon_os_cpu_check_interval": { - "desc": "定期 CPU 检查的时间间隔。", - "label": "定期 CPU 检查的时间间隔" - }, - "sysmon_top_sample_interval": { - "desc": "指定应收集进程顶部的频率。", - "label": "取样时间" - }, - "fields_mqtt_quic_listener_idle_timeout_ms": { - "desc": "一个连接在被优雅地关闭之前可以空闲多长时间。0 表示禁用超时", - "label": "空闲超时 毫秒" - }, - "fields_ws_opts_fail_if_no_subprotocol": { - "desc": "如果
true，当客户端未携带Sec WebSocket Protocol字段时，服务器将返回一个错误。\n注意：微信小程序需要禁用此验证。", - "label": "无 subprotocol 则失败" - }, - "mqtt_wildcard_subscription": { - "label": "允许通配符订阅" - }, - "server_ssl_opts_schema_ocsp_refresh_interval": { - "desc": "为服务器刷新OCSP响应的周期。", - "label": "OCSP 刷新间隔" - }, - "overload_protection_backoff_hibernation": { - "desc": "高负载时，跳过进程休眠。", - "label": "跳过休眠" - }, - "fields_ws_opts_max_frame_size": { - "desc": "单个 MQTT 数据包的最大长度。", - "label": "最大数据包长度" - }, - "sys_event_messages": { - "desc": "客户端事件消息。" - }, - "broker_perf_trie_compaction": { - "desc": "是否开启主题表压缩存储。\n启用它会显着提高通配符主题订阅率，如果通配符主题具有唯一前缀，例如：'sensor/{'{'}{'{'}id{'}'}{'}'}/+/'，其中每个订阅者的 ID 是唯一的。\n如果消息主要发布到具有大量级别的主题，则主题匹配性能（发布时）可能会降低。\n\n注意：这是一个集群范围的配置。 它要求在更改之前停止所有节点。" - }, - "sysmon_vm_large_heap": { - "desc": "启用后，当一个 Erlang 进程申请了大量内存，系统会触发一条带有
large_heap 关键字的\nwarning 级别日志。同时还会发布一条主题为 $SYS/sysmon/busy_dist_port 的 MQTT 系统消息。",
- "label": "启用大 heap 监控"
- },
- "mqtt_shared_subscription_strategy": {
- "label": "共享订阅策略",
- "desc": "共享订阅的调度策略。- `random`：将消息分配给随机选择的订阅者。
- `round_robin`：以循环方式选择订阅者。
- `round_robin_per_group`：在每个共享订阅组内以循环方式选择订阅者。
- `sticky`：始终使用最后选择的订阅者进行调度，直到订阅者断开连接。
- `local`：如果本地订阅者不存在，则选择随机本地订阅者，否则选择随机集群广域订阅者。
- `hash_topic`：通过主题源的哈希值选择订阅者。
- `hash_clientid`：通过对发送者的客户端 ID 进行 Hash 处理来选择订阅者。" - }, - "mqtt_client_attrs_init": { - "label": "客户端属性", - "desc": "在客户端连接时设置自定义属性并将其用于认证、授权等功能中。" - }, - "client_attrs_init_set_as_attr": { - "label": "属性" - }, - "client_attrs_init_expression": { - "label": "属性表达式", - "desc": "一个行表达式，用于从客户端现有信息中动态提取属性值，可以使用以下字段：
- `clientid`：客户端 ID
- `username`：用户名
- `cn`：TLS 证书的 CN 字段
- `dn`：TLS 证书的 DN 字段
- `user_property.*`：从 MQTT CONNECT 数据包的 `User-Property` 中提取属性值，例如 `user_property.foo`
支持使用预定义的字符串函数对信息进行动态处理。例如，要提取由点分隔的客户端 ID 的前缀：`nth(1, tokens(clientid, '.'))`；要截取用户名部分信息：`substr(username, 0, 5)`。您可以在 EMQX 文档中了解有关 variform 表达式的更多信息。
" - }, - "mqtt_keepalive_check_interval": { - "label": "保活检查间隔", - "desc": "检查传入 MQTT 数据包的频率决定了服务器检查新 MQTT 数据包的频率。
如果客户端在一定时间内没有发送任何数据包，这段时间将会累积。
一旦累积时间超过 `keepalive-interval * keepalive-multiplier`，连接将会被终止。
默认值设置为 30 秒，最小值为 1 秒，最大值为 `keepalive-interval / 2`。" - }, - "mqtt_shared_subscription_initial_sticky_pick": { - "label": "共享订阅初始 Sticky 选择策略", - "desc": "当`共享订阅策略`设置为 `sticky` 时，用于初始订阅者选择的策略：
- `random`：随机选择订阅者；
- `local`：随机选择当前节点上的订阅者，如果当前节点上没有订阅者，则在集群内随机选择；
- `hash_clientid`：通过对发布者的客户端ID进行哈希来选择订阅者；
- `hash_topic`：通过对发布主题进行哈希来选择订阅者。" - } - } -} \ No newline at end of file diff --git a/src/schemaText/schema-text-zh.ts b/src/schemaText/schema-text-zh.ts new file mode 100644 index 000000000..ad294f39e --- /dev/null +++ b/src/schemaText/schema-text-zh.ts @@ -0,0 +1,268 @@ +export default { + /* MQTT START */ + exclusive_subscription: { + label: '允许排它订阅', + }, + max_topic_alias: { + label: '最大主题别名数', + }, + use_username_as_clientid: { + desc: '是否使用用户名作为客户端 ID。 作用时间晚于
对端证书作为用户名 和 对端证书作为客户端 ID。',
+ label: '使用用户名作为客户端 ID',
+ },
+ idle_timeout: {
+ desc: '设置连接被断开或进入休眠状态前的等待时间，空闲超时后\n\n- 如暂未收到客户端的 CONNECT 报文，连接将断开；\n- 如已收到客户端的 CONNECT 报文，连接将进入休眠模式以节省系统资源。\n\n注意：请合理设置该参数值，如等待时间设置过长，可能造成系统资源的浪费。',
+ label: '空闲超时',
+ },
+ strict_mode: {
+ desc: '是否以严格模式解析 MQTT 消息。严格模式下，如客户端 ID、主题名称等中包含无效 utf8 字符串，连接将被断开。',
+ label: '严格模式',
+ },
+ shared_subscription: {
+ label: '允许共享订阅',
+ },
+ server_keepalive: {
+ label: '服务端 Keep Alive',
+ },
+ wildcard_subscription: {
+ label: '允许通配符订阅',
+ },
+ max_clientid_len: {
+ label: '最大客户端 ID 长度',
+ },
+ response_information: {
+ desc: 'UTF-8 字符串，用于指定返回给客户端的响应主题，如 `reqrsp/`，此时请求和应答客户端都需要使用 `reqrsp/` 前缀的主题来完成通讯。如希望禁用此功能，请在下方的文字框中输入`""`；仅适用于 MQTT 5.0 客户端。',
+ label: '响应信息',
+ },
+ shared_subscription_initial_sticky_pick: {
+ label: '共享订阅初始 Sticky 选择策略',
+ desc: '当`共享订阅策略`设置为 `sticky` 时，用于初始订阅者选择的策略：- `random`：随机选择订阅者；
- `local`：随机选择当前节点上的订阅者，如果当前节点上没有订阅者，则在集群内随机选择；
- `hash_clientid`：通过对发布者的客户端ID进行哈希来选择订阅者；
- `hash_topic`：通过对发布主题进行哈希来选择订阅者。', + }, + peer_cert_as_username: { + desc: '使用对端证书中的 CN、DN 字段或整个证书内容来作为用户名；仅适用于 TLS 连接。\n目前支持：\n-
cn: 取证书的 CN 字段\n- dn: 取证书的 DN 字段\n- crt: 取 DER 或 PEM 的证书内容\n- pem: 将 DER 证书转换为 PEM 格式作为用户名\n- md5: 取 DER 或 PEM 证书内容的 MD5 值',
+ label: '使用对端证书作为用户名',
+ },
+ client_attrs_init: {
+ label: '客户端属性',
+ desc: "指定如何初始化客户端属性。每个客户端属性可以初始化为 `client_attrs.{'{'}NAME{'}'}`，
其中 `{'{'}NAME{'}'}` 是配置字段 `set_as_attr` 中指定的属性名称。
初始化的客户端属性将存储在带有指定名称的 `client_attrs` 属性中，
并可用作渲染挂载点、身份验证和授权请求的模板变量。
例如，当 `set_as_attr = tns` 时，使用 `${'{'}client_attrs.tns{'}'}` 渲染 HTTP POST 正文，
或渲染监听器配置 `moutpoint = ${'{'}client_attrs.tns{'}'}/` 用于主题命名空间。", + }, + client_attrs_init_set_as_attr: { + label: '属性', + }, + client_attrs_init_expression: { + label: '属性表达式', + desc: "使用行表达式计算一组预定义的字符串函数（类似于规则引擎 SQL 语句）。
表达式可以是带有嵌套调用参数的函数调用，或直接引用变量。
目前不提供用户自定义变量绑定（如 `var a=1`）或用户自定义函数。
例如，要提取以点分隔的客户端 ID 前缀：`nth(1, tokens(clientid, '.'))`。
预绑定的变量有：
- `clientid`：MQTT 客户端 ID。
- `username`：MQTT 客户端的用户名。
- `user_property.{'{'}NAME{'}'}`：CONNECT 数据包中的用户属性。
对于 TLS 客户端，直接连接或通过支持代理协议（v2）的负载均衡器连接，
可以使用一些额外的变量：
- `cn`：客户端 TLS 证书的通用名称。
- `dn`：客户端 TLS 证书的可分辨名称（主题）。
- `peersni`：客户端发送的 TLS 服务器名称指示。
您可以在 EMQX 文档中阅读更多关于 variform 表达式的信息。", + }, + clientid_override: { + label: '客户端 ID 重写表达式', + desc: "使用行表达式计算一组预定义的字符串函数（类似于规则引擎 SQL 语句）。
表达式可以是带有嵌套调用参数的函数调用，或直接引用变量。
目前不提供用户自定义变量绑定（如 `var a=1`）或用户自定义函数。
例如，要提取以点分隔的客户端 ID 前缀：`nth(1, tokens(username, '.'))`。
预绑定的变量有：
- `clientid`：原始 MQTT 客户端 ID。
- `username`：MQTT 客户端的用户名。
- `client_attrs.{'{'}NAME{'}'}`：通过每个配置的 `client_attrs_init` 初始化的客户端属性。
对于 TLS 客户端，直接连接或通过支持代理协议（v2）的负载均衡器连接，
可以使用一些额外的变量：
- `cn`：客户端 TLS 证书的通用名称。
- `dn`：客户端 TLS 证书的可分辨名称（主题）。
- `peersni`：客户端发送的 TLS 服务器名称指示。
您可以在 EMQX 文档中阅读更多关于 variform 表达式的信息。", + }, + retain_available: { + desc: '是否启用对 MQTT 保留消息的支持。禁用此选项时，客户端将无法发布保留消息。', + label: '启用保留消息', + }, + message_expiry_interval: { + desc: 'MQTT 消息的过期时间间隔。对于 MQTT 5.0 版本的客户端，此设置仅在消息未指定 Message-Expiry-Interval 属性时才会生效。对于 MQTT 3.1 和 3.1.1 版本，此设置始终适用。值得注意的是，将此值设定为大于会话过期间隔是无效的，因为一旦会话过期，所有相关消息都将被清除。', + label: '消息过期间隔', + }, + ignore_loop_deliver: { + desc: '设置由 MQTT v3.1.1/v3.1.0 客户端发布的消息是否将转发给其本身；类似 MQTT 5.0 协议中的 `No Local` 选项。', + label: '忽略循环投递', + }, + max_qos_allowed: { + label: '最大 QoS', + }, + max_topic_levels: { + label: '最大主题层级', + }, + peer_cert_as_clientid: { + desc: '使用对端证书中的 CN、DN 字段或整个证书内容来作为客户端 ID。仅适用于 TLS 连接；\n目前支持：\n-
cn: 取证书的 CN 字段\n- dn: 取证书的 DN 字段\n- crt: 取 DER 或 PEM 证书的内容\n- pem: 将 DER 证书内容转换为 PEM 格式作为客户端 ID\n- md5: 取 DER 或 PEM 证书内容的 MD5 值',
+ label: '使用对端证书作为客户端 ID',
+ },
+ keepalive_multiplier: {
+ desc: '`Keep-Alive Timeout = Keep-Alive Interval × Keep-Alive Multiplier`，根据 MQTT 5.0，默认值为1.5。\n\n例如，如果 Keep-Alive interval 为 10 秒，那么乘以 1.5 的倍数，将产生 15 秒的超时。将倍数值增加到 2，超时将延长到 20 秒。',
+ label: 'Keep Alive 倍数',
+ },
+ shared_subscription_strategy: {
+ label: '共享订阅策略',
+ desc: '共享订阅的调度策略。- `random`：将消息分配给随机选择的订阅者。
- `round_robin`：以循环方式选择订阅者。
- `round_robin_per_group`：在每个共享订阅组内以循环方式选择订阅者。
- `sticky`：始终使用最后选择的订阅者进行调度，直到订阅者断开连接。
- `local`：如果本地订阅者不存在，则选择随机本地订阅者，否则选择随机集群广域订阅者。
- `hash_topic`：通过主题源的哈希值选择订阅者。
- `hash_clientid`：通过对发送者的客户端 ID 进行 Hash 处理来选择订阅者。', + }, + keepalive_check_interval: { + label: '保活检查间隔', + desc: '检查传入 MQTT 数据包的频率决定了服务器检查新 MQTT 数据包的频率。
如果客户端在一定时间内没有发送任何数据包，这段时间将会累积。
一旦累积时间超过 `keepalive-interval * keepalive-multiplier`，连接将会被终止。
默认值设置为 30 秒，最小值为 1 秒，最大值为 `keepalive-interval / 2`。', + }, + max_packet_size: { + desc: '允许的最大 MQTT 报文大小，超出此大小后将断开当前客户端连接。', + label: '最大报文大小', + }, + max_conn_rate: { + desc: '用于限制单节点接受连接的速率，达到限制后，EMQX 将暂停从接受队列中获取连接，延迟或拒绝新的连接；为空时表示不限制。\n\n例如：\n\n- `1000/s` 表示每秒最多接受 1000 个连接。\n- `1000/10s` 表示每 10 秒最多接受 1000 个连接。', + label: '最大连接速率', + }, + max_conn_burst: { + desc: '在突发情况下单节点可以接受的最大连接数量；为空时表示不限制。\n\n例如：`10000/60m` 表示在 60 分钟内，允许接受最多 10000 个连接。', + label: '最大连接突发速率', + }, + messages_rate: { + desc: '用于限制单个客户端每秒可以发送给 EMQX 的消息数量，达到限制后，EMQX 将暂停从接收缓冲区读取数据，降低发送者的速度或暂时挂起发送者；为空时表示不限制。\n\n例如：\n\n- `500/s`：每秒最多接收 500 条消息，其余消息将被延迟。\n- `500/10s`：每 10 秒最多接收 500 条消息，其余消息将被延迟。', + label: '消息发布速率', + }, + messages_burst: { + desc: '在突发情况下单个客户端可以发送的最大消息数量；为空时表示不限制。\n\n例如：`10000/60m` 表示在 60 分钟内，允许发送最多 10000 条消息。', + label: '消息发布突发速率', + }, + bytes_rate: { + desc: '用于限制单个客户端每秒可发送给 EMQX 的字节数，达到限制后，EMQX 将暂停从接收缓冲区读取数据，降低发送者的速度或暂时挂起发送者；为空时表示不限制。\n\n字节的单位可以是：B、KB、MB、GB。\n\n例如：\n\n- `500KB/s`：每秒最多接收 500 千字节，其余字节将被延迟。\n- `500MB/10s`：每 10 秒最多接收 500 兆字节，其余字节将被延迟。', + label: '数据发布速率', + }, + bytes_burst: { + desc: '在突发情况下单个客户端允许发送的最大字节数；为空时表示不限制。\n\n例如：`100MB/60m` 表示在 60 分钟内，允许发送最多 100 兆字节的数据。', + label: '数据发布突发速率', + }, + /* MQTT END */ + /* SESSION START */ + max_subscriptions: { + desc: '允许每个客户端建立的最大订阅数量。', + label: '最大订阅数量', + }, + upgrade_qos: { + desc: '投递消息时，是否根据订阅主题时的 QoS 等级来强制提升派发消息的 QoS 等级。', + label: '升级 QoS', + }, + max_inflight: { + desc: '完成应答前，最多允许同时投递的 QoS 1 和 QoS 2 消息数量。', + label: '最大飞行窗口', + }, + retry_interval: { + desc: 'QoS 1/2 消息的重新投递间隔。', + label: '消息重试间隔', + }, + max_awaiting_rel: { + desc: '为每个会话指定未收到 PUBREL 且未超时的最大 QoS 2 消息数量。超过限制后，新的 QoS 2 消息发布会被拒绝，并返回 147(0x93) 错误。', + label: '最大待发 PUBREL 数量', + }, + await_rel_timeout: { + desc: '对于未收到 PUBREL 的 QoS 2 消息，将按照指定时间等待重传；超时后 EMQX 将释放 packet ID 并产生一条告警日志。\n注意：EMQX 对消息的转发操作不依赖于 PUBREL收到与否。', + label: '最大 PUBREL 等待时长', + }, + session_expiry_interval: { + desc: '指定会话将在连接断开后多久过期，仅适用于非 MQTT 5.0 的连接。', + label: '会话过期间隔', + }, + max_mqueue_len: { + desc: '最大消息队列长度。持久客户端断开连接或飞行窗口已满时，允许排队的的最大消息数量。', + label: '最大消息队列长度', + }, + mqueue_priorities: { + desc: "主题优先级。优先级数字[1-255]。默认情况下没有优先级表，因此所有消息都被平等对待。
注意：优先级主题名称中不允许使用逗号和等号。
注意：不在优先级表中的主题的消息将根据 mqtt.mqueue_default_priority 的配置值被视为最高优先级或最低优先级。
示例：
要配置 'topic/1' > 'topic/2'：
mqueue_priorities: {'{'}\"topic/1\": 10, \"topic/2\": 8{'}'}", + label: '主题优先级', + }, + mqueue_default_priority: { + desc: '默认的主题优先级，不在
主题优先级（mqueue_priorities） 中的主题将会使用该优先级。',
+ label: '默认主题优先级',
+ },
+ mqueue_store_qos0: {
+ desc: '在连接断开但会话保持期间，是否需要在消息队列中存储 QoS 0 消息。',
+ label: '存储 QoS 0 消息',
+ },
+ /* SESSION END */
+ /* LOG START */
+ enable: {
+ desc: '启用此日志处理进程。',
+ label: '启用日志处理进程',
+ },
+ level: {
+ desc: '当前日志处理进程的日志级别。\n默认为 warning 级别。',
+ label: '日志级别',
+ },
+ log_file_default_path: {
+ desc: '日志文件路径及名字。',
+ label: '日志文件名字',
+ },
+ payload_encode: {
+ desc: '日志中 Payload 的编码方式。',
+ label: 'Payload 编码',
+ },
+ rotation_count: {
+ desc: '轮换的最大日志文件数。',
+ label: '最大日志文件数',
+ },
+ rotation_size: {
+ desc: '此参数控制日志文件轮换。 `infinity` 意味着日志文件将无限增长，否则日志文件将在达到 `max_size`（以字节为单位）时进行轮换。\n与 rotation count配合使用。如果 counter 为 10，则是10个文件轮换。',
+ label: '日志文件轮换大小',
+ },
+ time_offset: {
+ desc: '日志中的时间戳使用的时间偏移量。\n可选值为：\n - system: 本地系统使用的时区偏移量\n - utc: 0 时区的偏移量\n - +-[hh]:[mm]: 自定义偏移量，比如 "-02:00" 或者 "+00:00"\n默认值为本地系统的时区偏移量：system。',
+ label: '时间偏移量',
+ },
+ timestamp_format: {
+ desc: '选择时间戳格式：-
auto：根据日志的格式自动选择最合适的时间戳格式。对于 JSON 使用 epoch，对于文本则使用 rfc3339。-
epoch：表示为自 Unix 纪元起的微秒数。-
rfc3339：遵循 RFC3339 标准的时间格式。',
+ label: '时间戳格式',
+ },
+ formatter: {
+ desc: '选择日志格式类型。 text 用于纯文本，json 用于结构化日志记录。',
+ label: '日志格式类型',
+ },
+ time_window: {
+ desc: '日志节流的时间窗口，在设定的时间窗口内同一事件类型的日志只被记录一次以防止日志泛滥。时间窗口结束时将生成反映该时间段内的日志活动的详细日志。该窗口的最小可设置值为1秒。支持的事件如下：
- authorization_permission_denied
- cannot_publish_to_topic_due_to_not_authorized
- cannot_publish_to_topic_due_to_quota_exceeded
- connection_rejected_due_to_license_limit_reached
- dropped_msg_due_to_mqueue_is_full', + label: '时间窗口', + }, + /* LOG END */ + /* ALARM START */ + cpu_check_interval: { + desc: '定期 CPU 检查的时间间隔。', + label: '定期 CPU 检查的时间间隔', + }, + cpu_high_watermark: { + desc: '在发出相应警报之前可以使用多少系统 CPU 的阈值，以系统CPU负载的百分比表示。', + label: 'CPU 高水位线', + }, + cpu_low_watermark: { + desc: '在解除相应警报之前可以使用多少系统 CPU 的阈值，以系统CPU负载的百分比表示。', + label: 'CPU 低水位线', + }, + mem_check_interval: { + desc: '定期内存检查的时间间隔。', + label: '内存检查间隔', + }, + procmem_high_watermark: { + desc: '在发出相应警报之前，一个Erlang进程可以分配多少系统内存的阈值，以系统内存的百分比表示。', + label: '进程内存高水位线', + }, + sysmem_high_watermark: { + desc: '在发出相应报警之前可以分配多少系统内存的阈值，以系统内存的百分比表示。', + label: '系统内存高水位线', + }, + busy_dist_port: { + desc: '启用后，当用于集群接点之间 RPC 的连接过忙时，会触发一条带有
busy_dist_port 关键字的 warning 级别日志。\n同时还会发布一条主题为 $SYS/sysmon/busy_dist_port 的 MQTT 系统消息。',
+ label: '启用分布式端口过忙监控',
+ },
+ busy_port: {
+ desc: '当一个系统接口（例如 TCP socket）过忙，会触发一条带有 busy_port 关键字的 warning 级别的日志。\n同时还会发布一条主题为 $SYS/sysmon/busy_port 的 MQTT 系统消息。',
+ label: '启用端口过忙监控',
+ },
+ large_heap: {
+ desc: '当进程占用的堆内存超过 large_heap 指定的大小时，系统会触发一条带有 large_heap 关键字的 warning 级别日志。同时还会发布一条主题为 $SYS/sysmon/large_heap 的 MQTT 系统消息。',
+ label: '启用大 heap 监控',
+ },
+ long_gc: {
+ desc: '当系统检测到某个 Erlang 进程垃圾回收占用过长时间，会触发一条带有 long_gc 关键字的日志。\n同时还会发布一条主题为 $SYS/sysmon/long_gc 的 MQTT 系统消息。',
+ label: '启用长垃圾回收监控',
+ },
+ long_schedule: {
+ desc: "启用后，如果 Erlang VM 调度器出现某个任务占用时间过长时，会触发一条带有 'long_schedule' 关键字的日志。\n同时还会发布一条主题为 $SYS/sysmon/long_schedule 的 MQTT 系统消息。",
+ label: '启用长调度监控',
+ },
+ process_check_interval: {
+ desc: '定期进程限制检查的时间间隔。',
+ label: '进程限制检查时间',
+ },
+ process_high_watermark: {
+ desc: '在发出相应警报之前，本地节点上可以同时存在多少进程的阈值（以进程百分比表示）。',
+ label: '进程数高水位线',
+ },
+ process_low_watermark: {
+ desc: '在清除相应警报之前，本地节点上可以同时存在多少进程的阈值（以进程百分比表示）。',
+ label: '进程数低水位线',
+ },
+}
diff --git a/src/shims-vue.d.ts b/src/shims-vue.d.ts
index 4fe5ca9f4..e662f80a6 100644
--- a/src/shims-vue.d.ts
+++ b/src/shims-vue.d.ts
@@ -8,9 +8,17 @@ declare module '*.vue' {
export default component
}
+declare module 'vuex' {
+ export * from 'vuex/types/index.d.ts'
+ export * from 'vuex/types/helpers.d.ts'
+ export * from 'vuex/types/logger.d.ts'
+ export * from 'vuex/types/vue.d.ts'
+}
+
declare module '@/common/highlight/sql'
+declare module '@/common/highlight/bash'
declare module 'js-sql-parser'
-declare module 'highlight.js/lib/core'
-declare module 'highlight.js/lib/languages/sql'
+declare module 'highlight.js/*'
+declare module 'monaco-editor/esm/vs/basic-languages/sql/sql'
declare module 'hocon-parser'
declare module 'github-markdown-css/*.css'
diff --git a/src/store/index.ts b/src/store/index.ts
index d57c57aca..366c80a56 100644
--- a/src/store/index.ts
+++ b/src/store/index.ts
@@ -1,6 +1,4 @@
-import { createStore } from 'vuex'
import { getUser, setUser, removeUser } from '@/common/auth'
-import { DEFAULT_CLIENT_TABLE_COLUMNS } from '@/common/constants'
import { UserInfo } from '@/types/common'
import { TestRuleTarget } from '@/types/enum'
import { RuleEvent } from '@/types/rule'
@@ -176,7 +174,7 @@ export default createStore({
},
isDev() {
return false
- // return process.env.NODE_ENV === 'development'
+ // return import.meta.env.DEV
},
getSchema(state) {
return (key: string) => {
diff --git a/src/style/common.scss b/src/style/common.scss
index d7f0f5234..0d8484bd5 100644
--- a/src/style/common.scss
+++ b/src/style/common.scss
@@ -2,7 +2,8 @@
@use './themes/dark.scss';
@use 'normalize.scss';
@use '@/style/schemaForm.scss';
-@use "sass:math";
+@use './variables.scss';
+@use 'sass:math';
@font-face {
font-family: 'Roboto';
@@ -41,15 +42,12 @@
src: url(../assets/fonts/Roboto-BlackItalic.ttf) format('truetype');
}
-$font: Roboto, -apple-system, BlinkMacSystemFont, PingFang SC, Hiragino Sans GB, Helvetica Neue,
- Helvetica, Arial, sans-serif;
-
body {
padding: 0;
margin: 0;
color: var(--el-text-color-primary);
font-size: 14px;
- font-family: $font;
+ font-family: variables.$font;
background-color: var(--color-bg);
}
@@ -69,7 +67,7 @@ a {
textarea,
code {
- font-family: $font;
+ font-family: variables.$font;
}
img {
@@ -120,6 +118,9 @@ p.description {
&.with-padding-top {
padding-top: 32px;
}
+ &.with-padding-bottom {
+ padding-bottom: 32px;
+ }
}
.app-wrapper-compact {
@@ -173,6 +174,11 @@ p.description {
.el-date-editor {
width: 100%;
}
+ .col-oper {
+ display: flex !important;
+ align-items: center;
+ justify-content: flex-end;
+ }
}
.emq-table-footer {
@@ -228,22 +234,22 @@ p.description {
}
.g-coap::before {
- background-image: url('~@/assets/gateway/coap.png');
+ background-image: url('@/assets/gateway/coap.png');
}
.g-lwm2m::before {
- background-image: url('~@/assets/gateway/lwm2m.png');
+ background-image: url('@/assets/gateway/lwm2m.png');
}
.g-mqttsn::before {
- background-image: url('~@/assets/gateway/mqttsn.png');
+ background-image: url('@/assets/gateway/mqttsn.png');
}
.g-stomp::before {
- background-image: url('~@/assets/gateway/stomp.png');
+ background-image: url('@/assets/gateway/stomp.png');
}
.g-tcp::before {
- background-image: url('~@/assets/gateway/tcp.png');
+ background-image: url('@/assets/gateway/tcp.png');
}
.g-exproto::before {
- background-image: url('~@/assets/gateway/exproto.png');
+ background-image: url('@/assets/gateway/exproto.png');
}
.section-header {
@@ -750,10 +756,15 @@ code {
padding: 0.25rem 0.5rem;
margin: 0;
color: var(--color-text-mdcode);
- font-size: .85em;
+ font-size: 0.85em;
border-radius: 3px;
background-color: var(--color-bg-mdcode);
- font-family: Menlo, Monaco, Consolas, Courier New, monospace;
+ font-family:
+ Menlo,
+ Monaco,
+ Consolas,
+ Courier New,
+ monospace;
}
[data-theme='dark'] {
@@ -885,14 +896,26 @@ code {
}
.vue-flow__handle-left {
- left: math.div(-$handle-size, 2)
+ left: math.div(-$handle-size, 2);
}
.vue-flow__handle-right {
- right: math.div(-$handle-size, 2)
+ right: math.div(-$handle-size, 2);
}
.vue-flow__handle {
--vf-handle: #babcbe;
}
}
+
+label.custom-required::after {
+ content: '*';
+ color: var(--el-color-danger);
+ margin-left: 4px;
+}
+
+.el-table__cell.overflow-visible {
+ .cell {
+ overflow: visible;
+ }
+}
diff --git a/src/style/management.scss b/src/style/management.scss
index 4cf23ca32..7b5cf76d8 100644
--- a/src/style/management.scss
+++ b/src/style/management.scss
@@ -5,12 +5,6 @@
.section-header {
margin-top: 0;
}
-
- .col-oper {
- display: flex !important;
- align-items: center;
- justify-content: flex-end;
- }
.show-more {
font-size: 18px;
cursor: pointer;
diff --git a/src/style/normalize.scss b/src/style/normalize.scss
index d0a6f0f26..0b346b6d4 100644
--- a/src/style/normalize.scss
+++ b/src/style/normalize.scss
@@ -1,6 +1,7 @@
-@use "sass:math";
+@use 'sass:math';
+@use 'sass:color';
/* Components Reset Colors */
-@forward "element-plus/theme-chalk/src/common/var.scss" with (
+@forward 'element-plus/theme-chalk/src/common/var.scss' with (
$main: (
'padding': 0px,
),
@@ -42,10 +43,10 @@
),
$drawer: (
'bg-color': var(--color-bg-content),
- ),
+ )
);
-@use "element-plus/theme-chalk/src/index";
+@use 'element-plus/theme-chalk/src/index';
/* Root Colors */
:root {
@@ -56,13 +57,16 @@
--el-text-color-secondary: var(--color-text-secondary);
--el-disabled-text-color: var(--color-text-primary);
--el-border-color-light: var(--color-border-normal);
- --el-color-success: #00B173;
- --el-color-danger: #EB4E3D;
- --el-color-warning: #F19710;
- --el-color-info: #7A7B80;
+ --el-color-success: #00b173;
+ --el-color-danger: #eb4e3d;
+ --el-color-warning: #f19710;
+ --el-color-info: #7a7b80;
--el-box-shadow-light: var(--color-shadow-primary) 0px 4px 12px;
--el-border: 1px solid var(--color-border-primary);
--el-fill-color-light: var(--color-bg-split);
+ --el-fill-color-blank: var(--color-bg-content);
+ --el-border-color: var(--color-border-primary);
+ --el-menu-hover-bg-color: var(--color-bg-split);
}
/* Menu */
@@ -89,7 +93,7 @@
border-left: 4px solid transparent;
color: #ffffffd9;
&:hover {
- background-color: #1F303C;
+ background-color: #1f303c;
border-radius: 8px;
}
}
@@ -115,11 +119,11 @@
min-width: initial;
&.is-active {
color: #fff;
- background-color: #1F303C;
+ background-color: #1f303c;
border-radius: 8px;
}
&:hover {
- background-color: #1F303C;
+ background-color: #1f303c;
border-radius: 8px;
}
}
@@ -141,17 +145,19 @@
color: #ffffffd9;
&.is-active {
color: #fff;
- background-color: #1F303C;
+ background-color: #1f303c;
}
&:hover {
color: #fff;
- background-color: #1F303C;
+ background-color: #1f303c;
}
}
}
&.el-menu--horizontal {
+ height: auto;
background-color: transparent;
border-bottom: 1px solid var(--color-border-card);
+ margin-bottom: 32px;
& > .el-menu-item {
height: 36px;
padding: 0px 12px;
@@ -161,11 +167,10 @@
color: var(--color-primary);
}
}
- margin-bottom: 32px;
}
&.el-menu--collapse {
- >.el-sub-menu.is-active .el-sub-menu__title {
- background-color: #1F303C;
+ > .el-sub-menu.is-active .el-sub-menu__title {
+ background-color: #1f303c;
color: #fff;
}
}
@@ -177,7 +182,7 @@
&:before,
.el-table__inner-wrapper:after,
.el-table__inner-wrapper:before {
- content: "" !important;
+ content: '' !important;
position: absolute;
background-color: transparent;
pointer-events: none;
@@ -239,7 +244,8 @@
}
}
.el-table__row:last-child {
- th.el-table__cell.is-leaf, td.el-table__cell {
+ th.el-table__cell.is-leaf,
+ td.el-table__cell {
border-bottom: none;
}
}
@@ -251,6 +257,7 @@
& + .el-dropdown {
margin-left: 0;
margin-right: 12px;
+ vertical-align: middle;
}
}
}
@@ -301,7 +308,7 @@
color: var(--color-text-primary) !important;
}
.el-progress-bar__inner {
- background: linear-gradient(135deg, #0AD18E 0%, #03A4A5 100%);
+ background: linear-gradient(135deg, #0ad18e 0%, #03a4a5 100%);
}
.el-progress-bar {
&__outer {
@@ -349,7 +356,7 @@
/* Tabs Card */
.el-tabs--card {
- &>.el-tabs__header {
+ & > .el-tabs__header {
border-bottom: 1px solid var(--color-border-card);
margin-bottom: 0px;
.el-tabs__nav {
@@ -363,7 +370,10 @@
outline: none;
border-left: none;
border-top: 2px solid transparent;
- transition: border-top 0.3s, color 0.3s, padding 0.3s;
+ transition:
+ border-top 0.3s,
+ color 0.3s,
+ padding 0.3s;
&.is-active,
.is-focus {
outline: none;
@@ -376,33 +386,38 @@
}
@mixin border-gradient($from, $to, $weight: 0) {
- $mix-main: mix($from, $to);
- $mix-sub-from: mix($mix-main, $from);
- $mix-sub-to: mix($mix-main, $to);
-
- box-shadow: 0 1px 0 $weight rgba($mix-sub-to, .25),
- 0 -1px 0 $weight rgba($mix-sub-from, .25),
- 1px 0 0 $weight rgba($mix-sub-to, .25),
- -1px 0 0 $weight rgba($mix-sub-from, .25),
- 1px -1px 0 $weight rgba($mix-main, .5),
- -1px 1px 0 $weight rgba($mix-main, .5),
- 1px 1px 0 $weight rgba($to, .75),
- -1px -1px 0 $weight rgba($from, .75);
+ $mix-main: color.mix($from, $to);
+ $mix-sub-from: color.mix($mix-main, $from);
+ $mix-sub-to: color.mix($mix-main, $to);
+
+ box-shadow:
+ 0 1px 0 $weight rgba($mix-sub-to, 0.25),
+ 0 -1px 0 $weight rgba($mix-sub-from, 0.25),
+ 1px 0 0 $weight rgba($mix-sub-to, 0.25),
+ -1px 0 0 $weight rgba($mix-sub-from, 0.25),
+ 1px -1px 0 $weight rgba($mix-main, 0.5),
+ -1px 1px 0 $weight rgba($mix-main, 0.5),
+ 1px 1px 0 $weight rgba($to, 0.75),
+ -1px -1px 0 $weight rgba($from, 0.75);
}
/* Button */
.el-button {
&.el-button--primary:not(.is-link) {
- background: linear-gradient(135deg, #0AD18E 0%, #03A4A5 100%);
+ background: linear-gradient(135deg, #0ad18e 0%, #03a4a5 100%);
border: none;
color: #fff;
&.is-plain {
background: var(--color-bg-content);
color: var(--color-primary);
@include border-gradient(#7ad8b3, #6dbebe);
+ &:not(.el-button--small, .el-button--large) {
+ // the border is shadow, so we need to set the height to 30px (32 - 2)
+ height: 30px;
+ }
}
&:hover {
- background: linear-gradient(135deg, #53DEB0 0%, #4EBFC0 100%);
+ background: linear-gradient(135deg, #53deb0 0%, #4ebfc0 100%);
color: #fff;
}
&.is-disabled {
@@ -410,8 +425,8 @@
&:hover,
&:focus,
&:active {
- background: linear-gradient(135deg, #CDF5E8 0%, #CCEDED 100%);
- color: #86DBC1;
+ background: linear-gradient(135deg, #cdf5e8 0%, #cceded 100%);
+ color: #86dbc1;
}
}
}
@@ -419,7 +434,7 @@
min-height: 22px;
padding: 4px 9px;
}
- &+.el-dropdown {
+ & + .el-dropdown {
margin-left: 10px;
}
}
@@ -438,12 +453,15 @@
.el-button.is-link.is-disabled:active {
--el-color-primary-light-5: #86dbc1;
}
+.el-button:focus-visible {
+ outline: none;
+}
/* Dropdown */
.el-dropdown-menu {
background: var(--color-bg-content);
}
-.el-dropdown__popper.el-popper[role=tooltip] {
+.el-dropdown__popper.el-popper[role='tooltip'] {
background: var(--color-bg-content);
}
.el-dropdown-menu__item:not(.is-disabled):hover {
@@ -490,11 +508,11 @@
}
/* Select */
-.el-select__popper.el-popper[role=tooltip] .el-popper__arrow::before {
+.el-select__popper.el-popper[role='tooltip'] .el-popper__arrow::before {
border: 1px solid var(--color-border-normal);
background: var(--color-bg-content);
}
-.el-select__popper.el-popper[role=tooltip] {
+.el-select__popper.el-popper[role='tooltip'] {
background: var(--color-bg-content);
}
.el-select .el-select__tags .el-tag--info {
@@ -507,7 +525,7 @@
}
.el-input.is-disabled {
&.el-input-group--append .el-input-group__append .el-select .el-input .el-input__wrapper,
- &.el-input-group--append .el-input-group__append {
+ &.el-input-group--append .el-input-group__append {
box-shadow: 0 0 0 1px var(--el-disabled-border-color) inset;
}
@@ -525,7 +543,6 @@
}
}
-
/* Date Edtior */
.el-date-editor {
--el-date-editor-width: 100%;
@@ -541,14 +558,14 @@
}
.el-date-table td.in-range .el-date-table-cell:hover,
.el-date-table td.in-range .el-date-table-cell {
- background-color: var(--color-bg-split);
+ background-color: var(--color-bg-split);
}
.el-picker-panel .el-time-panel {
background-color: var(--color-bg-content);
}
-.el-picker-panel *[slot=sidebar],
+.el-picker-panel *[slot='sidebar'],
.el-picker-panel__sidebar {
background-color: var(--color-bg-content);
}
@@ -572,15 +589,15 @@
.el-step__icon {
background-color: var(--color-primary);
border: none;
- &::before {
- position: absolute;
- content: '';
- border-radius: 50%;
- left: -4px;
- width: 32px;
- height: 32px;
- background-color: #00b17333;
- }
+ &::before {
+ position: absolute;
+ content: '';
+ border-radius: 50%;
+ left: -4px;
+ width: 32px;
+ height: 32px;
+ background-color: #00b17333;
+ }
}
}
}
@@ -597,7 +614,9 @@
.el-popper {
font-size: 13px;
line-height: 1.6;
- &:not(.el-select__popper):not(.el-picker__popper):not(.is-wider):not(.el-cascader__dropdown):not(.el-autocomplete__popper) {
+ &:not(.el-select__popper):not(.el-picker__popper):not(.is-wider):not(.el-cascader__dropdown):not(
+ .el-autocomplete__popper
+ ) {
max-width: 330px;
}
&.is-wider {
@@ -635,8 +654,8 @@
font-weight: normal;
border-radius: 8px;
&.el-tag--danger {
- background-color: #FCECEC;
- border: 1px solid #E44242;
+ background-color: #fcecec;
+ border: 1px solid #e44242;
}
&.el-tag--info {
border: 1px solid var(--color-border-primary);
@@ -658,6 +677,7 @@
/* Message */
.el-message {
+ align-items: flex-start;
padding: 16px;
border-radius: 8px;
box-shadow: var(--el-notification-shadow);
@@ -671,26 +691,26 @@
word-break: break-all;
}
.el-message__closeBtn {
- transform: none;
- top: 16px + math.div(14px * 0.5, 2);
+ transform: translateY(3px);
color: #343741;
font-size: 14px;
}
&--success {
- border: 1px solid #00A890;
- background-color: #E2FFF5;
+ border: 1px solid #00a890;
+ background-color: #e2fff5;
}
&--error {
- border: 1px solid #EB4E3D;
- background-color: #FFE9E7;
+ border: 1px solid #eb4e3d;
+ background-color: #ffe9e7;
}
&--warning {
- border: 1px solid #F19710;
- background-color: #FFF0DA;
+ border: 1px solid #f19710;
+ background-color: #fff0da;
}
- &--message, &--info {
- border: 1px solid #469CF7;
- background-color: #E6EEFF;
+ &--message,
+ &--info {
+ border: 1px solid #469cf7;
+ background-color: #e6eeff;
}
}
@@ -711,19 +731,19 @@
/* Card */
.el-card {
+ border: 1px solid var(--color-border-card);
+ position: relative;
&.is-always-shadow {
box-shadow: none;
}
- border: 1px solid var(--color-border-card);
&.allow-overflow {
overflow: visible;
}
- position: relative;
&.top-border,
&.top-primary {
&:before {
position: absolute;
- content: "";
+ content: '';
top: 0px;
left: 0px;
width: 100%;
@@ -753,7 +773,7 @@
}
}
}
-.el-form-item__content>.el-row {
+.el-form-item__content > .el-row {
width: 100%;
}
.el-form-item__label {
@@ -783,7 +803,6 @@
}
}
-
/* Description */
.el-descriptions {
.el-descriptions__title {
@@ -833,11 +852,14 @@
}
/* Pagination */
-.el-pagination.is-background .btn-prev:disabled, .el-pagination.is-background .btn-next:disabled {
- color: #D0D4DC;
+.el-pagination.is-background .btn-prev:disabled,
+.el-pagination.is-background .btn-next:disabled {
+ color: #d0d4dc;
background-color: var(--color-bg-content);
}
-.el-pagination.is-background .btn-prev, .el-pagination.is-background .btn-next, .el-pagination.is-background .el-pager li {
+.el-pagination.is-background .btn-prev,
+.el-pagination.is-background .btn-next,
+.el-pagination.is-background .el-pager li {
border-radius: 8px;
border: 1px solid var(--color-border-primary);
background-color: var(--color-bg-content);
@@ -901,7 +923,7 @@
}
}
-/* Skeleton */
+/* Skeleton */
[data-theme='dark'] {
.el-skeleton {
--el-skeleton-color: #323947;
@@ -928,7 +950,6 @@
padding: 16px 24px;
margin-right: 0;
border-bottom: 1px solid var(--color-border-card);
-
}
.el-dialog__body {
diff --git a/src/style/rule.scss b/src/style/rule.scss
index b46832a71..a37ff0af8 100644
--- a/src/style/rule.scss
+++ b/src/style/rule.scss
@@ -40,6 +40,13 @@
.detail-header img {
height: 40px;
}
+ .block-title {
+ max-width: 400px;
+ overflow: hidden;
+ text-overflow: ellipsis;
+ word-wrap: nowrap;
+ margin: 0;
+ }
.info-tags {
.el-tag,
.node-status {
@@ -192,6 +199,9 @@
}
}
}
+ a.io-item {
+ color: unset;
+ }
.btn-add {
margin-top: 24px;
:deep(span) {
@@ -205,6 +215,7 @@
}
.delete-second-confirm {
+ padding: 0px 16px 4px;
.el-dialog__header {
display: none;
}
diff --git a/src/style/themes/dark.scss b/src/style/themes/dark.scss
index 4b8fba4ea..8b1cbd910 100644
--- a/src/style/themes/dark.scss
+++ b/src/style/themes/dark.scss
@@ -1,14 +1,15 @@
[data-theme='dark'] {
/* Background */
- --color-bg: #18191D;
+ --color-bg: #18191d;
--color-bg-content: #212429;
- --color-bg-split: #272B32;
+ --color-bg-split: #272b32;
--color-bg-main: #17181b;
--color-bg-popper: #fff;
--color-bg-trans: #212429e6;
--color-bg-lighter: #323a48;
--color-bg-mdcode: #ffffff14;
- --color-bg-table-hd: #353A41;
+ --color-bg-details: #1b2028ed;
+ --color-bg-table-hd: #353a41;
/* Text */
--color-text-primary: #fff;
--color-text-secondary: #d2d3d5;
diff --git a/src/style/themes/light.scss b/src/style/themes/light.scss
index 12d8bf349..7fb8eec47 100644
--- a/src/style/themes/light.scss
+++ b/src/style/themes/light.scss
@@ -2,25 +2,26 @@
/* Background */
--color-bg: #071927;
--color-bg-content: #fff;
- --color-bg-split: #F8FAFE;
+ --color-bg-split: #f8fafe;
--color-bg-main: #f9fafb;
--color-bg-popper: #282e38;
--color-bg-trans: #ffffffe6;
- --color-bg-lighter: #E6EDFB;
+ --color-bg-lighter: #e6edfb;
--color-bg-mdcode: #f4f4f4;
- --color-bg-table-hd: #EEF0F5;
+ --color-bg-details: #ffffffed;
+ --color-bg-table-hd: #eef0f5;
/* Text */
--color-text-primary: #343741;
--color-text-secondary: #5a5f6f;
- --color-text-placeholder: #BAC1CD;
+ --color-text-placeholder: #bac1cd;
--color-text-popper: #fff;
--color-title-primary: #192144;
--color-text-footer: #8e8e8e;
- --color-text-mdcode: #EB4E3D;
+ --color-text-mdcode: #eb4e3d;
--color-text-progress: #1f3547a8;
/* Border */
- --color-border-primary: #D0D4DC;
- --color-border-card: #E2E6F0;
+ --color-border-primary: #d0d4dc;
+ --color-border-card: #e2e6f0;
--color-border-normal: #eeedf6;
/* Colors */
--color-primary: #00b173;
diff --git a/src/style/variables.scss b/src/style/variables.scss
new file mode 100644
index 000000000..271a111cb
--- /dev/null
+++ b/src/style/variables.scss
@@ -0,0 +1,10 @@
+$font:
+ Roboto,
+ -apple-system,
+ BlinkMacSystemFont,
+ PingFang SC,
+ Hiragino Sans GB,
+ Helvetica Neue,
+ Helvetica,
+ Arial,
+ sans-serif;
diff --git a/src/types/auth.d.ts b/src/types/auth.d.ts
index 94e9a9e71..0de1d7d7d 100644
--- a/src/types/auth.d.ts
+++ b/src/types/auth.d.ts
@@ -1,5 +1,6 @@
import { MetricsDataWithExtraData } from './common'
-import { BannedType, ConnectionStatus } from './enum'
+import { BannedType, ConnectionStatus, QoSLevel } from './enum'
+import { AuthzRuleAction, AuthzRulePermission } from './typeAlias'
export interface AuthzSetting {
deny_action: 'ignore' | 'disconnect'
@@ -49,9 +50,14 @@ export interface AuthnItem {
}
export interface BuiltInDBRule {
- permission: string
- action: string
+ permission: AuthzRulePermission
+ action: AuthzRuleAction
topic: string
+ qos?: Array
-
- {{ $t('Base.create') }}
-
+
+
{{ $t('Base.setting') }}
-
- {{ $t('Base.create') }}
-
+
-
{{ item }}
+ +{{ item }}
+{{ tl('promSetupHelpDesc') }}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- {{ tl('genPromConfig') }}
-
-
-
-
-
-
- {{
- tl('clickDonwnloadTemplate')
- }}
-
-
-
-
- {{ tl('promConfig') }}
- - -{{ tl('promConfigDesc') }}
-
-
- - {{ tl('nodeExporterDesc') }} - - {{ tl('installNodeExporter') }} - -
-
-
- {{ tl('promRun') }}
-{{ tl('grafConfig') }}
- - -{{ tl('promStepThree') }}
-{{ tl('clickDownloadTemplateDesc') }}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- {{ tl('genPromConfig') }}
-
-
-
-
-
-
- {{
- tl('clickDonwnloadTemplate')
- }}
-
-
-
-
- {{ tl('pushgatewayInstall') }}
- - -{{ tl('promStepOne') }}
-- {{ tl('nodeExporterDesc') }} - - {{ tl('installNodeExporter') }} - -
- -{{ tl('promConfig') }}
- - -{{ tl('promStepTwo') }}
-
-
- {{ tl('promRun') }}
-{{ tl('grafConfig') }}
- - -{{ tl('promStepThree') }}
-{{ tl('clickDownloadTemplateDesc') }}
-
-
- {{ tl('create') }}
-
+
-
{{ $t('RuleEngine.reconnect') }}
-
-
+
{{ $t('Base.setting') }}
-
+
+
+
+
+ {{ $index + 1 }}
+
+
+
+
+
+ ![]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ {{ dateFormat(row.created_at, '') }}
+
+
+
+
+ {{ dateFormat(row.last_modified_at, '') }}
+
+
+
+
+
+ {{ $t('RuleEngine.reconnect') }}
+
+
+ {{ $t('Base.setting') }}
+
+
+
+
+
+
+
+
+
+
+ {{ row.name }}
+
+ {{ getGeneralTypeLabel(row.type) }}
+
+
+
+ {{ `${tl('viewRules')} (${row.rules?.length || 0})` }}
+
+
+
+