healchow commented on code in PR #569: URL: https://github.com/apache/inlong-website/pull/569#discussion_r996801919
##########
docs/modules/manager/configure.md:
##########
@@ -0,0 +1,84 @@
+---
+title: Configuration
+sidebar_position: 3
+---
+## Basic Configuration
+
+- application.properties
+
+| Parameter | Value
|
Default | Notes
|
+|--------------------------------------------------------|--------------------------------------------------------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
+| server.host | server address
| 127.0.0.1
|
|
+| server.port | server port
| 8083
|
|
+| default.admin.user | usename
| admin
|
|
+| default.admin.password | password
| inlong
|
|
+| server.servlet.context-path | context path
|
| Form part of the url
|
+| spring.application.name | server name
|
|
|
+| spring.profiles.active | dev/prod/test
| dev
| Used to differentiate between different environments
|
+| spring.mvc.pathmatch.matching-strategy |
ANT_PATH_MATCHER/PATH_PATTERN_PARSER
| ANT_PATH_MATCHER | Path Matching Strategy of MVC
|
+| spring.jackson.serialization.write-dates-as-timestamps | true/false
| true
| Whether to convert date to timestamp
|
+| spring.jackson.date-format | Date Format
| yyyy-MM-dd
HH:mm:ss |
|
+| spring.jackson.time-zone | Default Time Zone
| GMT+8
|
|
+| mybatis.mapper-locations | Path of mapper file
|
classpath:mappers/*.xml |
|
+| mybatis.type-aliases-package | Path of entity
class |
org.apache.inlong.manager.dao.entity |
|
+| mybatis.configuration.map-underscore-to-camel-case | true/false
| true
| Whether to map the underlined table field to the
entity class attribute of hump type |
+| pagehelper.helperDialect | Database Type
| mysql
| Database type used to specify paging
|
+| pagehelper.reasonable | true/false
| false
| Whether paging is reasonable
|
+| pagehelper.params | Supported parameter
configuration |
| Used to support parameter configuration, such as
pagehelper. params=count=countSql |
+| common.http-client.maxTotal | Total connections
| 20
| Maximum number of connections in use at the same time
|
+| common.http-client.defaultMaxPerRoute | The maximum number
of connections being used by the same host: port at the same time | 2
| The default number of connections per route, and the
number of requests that a service can receive in parallel each time |
+| common.http-client.validateAfterInactivity | Check time after
inactive connection |
| When obtaining a connection from the connection
pool, how long after the connection is inactive should it be verified |
+| common.http-client.connectionTimeout | Connection
establishment timeout |
| In Milliseconds
|
+| common.http-client.readTimeout | Data transmission
timeout |
| In Milliseconds
|
+| common.http-client.connectionRequestTimeout | Get connection
timeout |
| In Milliseconds
|
+| inlong.auth.type | Custom
Authentication Configuration |
default |
|
+| inlong.encrypt.version | Encrypted version
| 1
|
|
+| inlong.encrypt.key.value1 |
|
|
|
+| openapi.auth.enabled | true/false
| false
| 是否开启openapi认证
|
+
+## Log Configuration
+
+- application-dev.properties, application-prod.properties,
application-test.properties
+
+| Parameter | Value | Default | Notes |
+|-----------------------------------------------|-----------------|---------|-----|
+| logging.level.{effective_area} | info/warn/error | info |
effective_ Area is the effective area at the log level. Root represents the
entire project. It can also be set to a package name |
+
+## Datasource Configuration
+
+- application-dev.properties, application-prod.properties,
application-test.properties
+
+| Parameter | Value
| Default
| Notes |
+|----------------------------------------------------|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
+| spring.datasource.druid.url | database url
|
jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
| |
+| spring.datasource.druid.username | database username
| root
| |
+| spring.datasource.druid.password | database password
| inlong
| |
+| spring.datasource.druid.driver-class-name | datasource driver class
name | com.mysql.cj.jdbc.Driver
| |
+| spring.datasource.druid.validationQuery | sql statement
| SELECT 'x'
| Verify whether the
database is available through the sql statement when the system starts |
+| spring.datasource.druid.initialSize | Initialization size of
database connection pool | 20
| |
+| spring.datasource.druid.minIdle | Minimum size of
database connection pool | 20
| |
+| spring.datasource.druid.maxActive | Maximum size of
database connection pool | 300
| |
+| spring.datasource.druid.maxWait | Maximum waiting time
when getting a connection | 600000
| In milliseconds
|
+| spring.datasource.druid.minEvictableIdleTimeMillis | The maximum time that
the connection remains idle without being evicted | 3600000
| In milliseconds
|
+| spring.datasource.druid.testWhileIdle | true/false
| true
| Whether to enable
idle connection detection for recycling |
+| spring.datasource.druid.testOnBorrow | true/false
| false
| Whether to detect
connection availability when obtaining connections from the connection pool.
Enabling the connection will have a certain impact on performance |
+| spring.datasource.druid.testOnReturn | true/false
| false
| Whether the
connection availability is detected when the connection is released to the
connection pool. Enabling the connection will have a certain impact on the
performance |
+| spring.datasource.druid.filters | stat,wall,log4j
| stat,wall
| Configure filters
for monitoring statistics interception, stat:monitoring statistics, log4j:log,
wall:defense against SQL injection |
+| spring.datasource.druid.connectionProperties | datasource connection
properties |
druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
| Open the mergeSql function through the connectProperties property,
Slow SQL records |
+
+## Audit Configuration
+
+- application-dev.properties, application-prod.properties,
application-test.properties
+
+| Parameter | Value
| Default | Notes
|
+|----------------------------------|-----------------------------------------------|---------|--------------------------------------------------------------------------------------------------------------------|
+| audit.query.source | MYSQL/ELASTICSEARCH/CLICKHOUSE | MYSQL
| Audit query source that decide what data source to query, currently only
supports MYSQL, ELASTICSEARCH, CLICKHOUSE |
+| es.index.search.hostname | Elasticsearch hostname |
127.0.0.1 | Elasticsearch host split by coma if more than one host, such as
'host1,host2' |
+| es.index.search.port | Elasticsearch port |
9200 | |
+| es.auth.enable | true/false |
false | Elasticsearch support authentication flag |
+| es.auth.user | Elasticsearch user of authentication info |
admin | |
+| es.auth.password | Elasticsearch password of authentication info |
inlong | |
+| audit.ck.jdbcUrl | Clickhouse jdbc url |
jdbc:clickhouse://127.0.0.1:8123/apache_inlong_audit |
|
Review Comment:
`Clickhouse` -> `ClickHouse`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
