OpenMetadata
Search…
Configuration
This document describes OpenMetadata Server Configuration
1
swagger:
2
resourcePackage: org.openmetadata.catalog.resources
3
4
5
server:
6
rootPath: '/api/*'
7
applicationConnectors:
8
- type: http
9
port: 8585
10
adminConnectors:
11
- type: http
12
port: 8586
13
14
# Logging settings.
15
# https://logback.qos.ch/manual/layouts.html#conversionWord
16
logging:
17
level: INFO
18
loggers:
19
org.openmetadata.catalog.common: DEBUG
20
io.swagger: ERROR
21
appenders:
22
- type: file
23
threshold: TRACE
24
logFormat: "%level [%d{HH:mm:ss.SSS}] [%t] %logger{5} - %msg %n"
25
currentLogFilename: ./logs/openmetadata.log
26
archivedLogFilenamePattern: ./logs/openmetadata-%d{yyyy-MM-dd}-%i.log.gz
27
archivedFileCount: 7
28
timeZone: UTC
29
maxFileSize: 50MB
30
31
database:
32
# the name of the JDBC driver, mysql in our case
33
driverClass: com.mysql.cj.jdbc.Driver
34
# the username and password
35
user: openmetadata_user
36
password: openmetadata_password
37
# the JDBC URL; the database is called openmetadata_db
38
url: jdbc:mysql://localhost/openmetadata_db?useSSL=false&serverTimezone=UTC
39
40
41
elasticsearch:
42
host: localhost
43
port: 9200
44
45
eventHandlerConfiguration:
46
eventHandlerClassNames:
47
- "org.openmetadata.catalog.events.AuditEventHandler"
48
- "org.openmetadata.catalog.events.ElasticSearchEventHandler"
49
50
health:
51
delayedShutdownHandlerEnabled: true
52
shutdownWaitPeriod: 1s
53
healthCheckUrlPaths: ["/api/v1/health-check"]
54
healthChecks:
55
- name: UserDatabaseCheck
56
critical: true
57
schedule:
58
checkInterval: 2500ms
59
downtimeInterval: 10s
60
failureAttempts: 2
61
successAttempts: 1
Copied!

Server Port

1
server:
2
rootPath: '/api/*'
3
applicationConnectors:
4
- type: http
5
port: 8585
6
adminConnectors:
7
- type: http
8
port: 8586
Copied!
By default, the OpenMetadata server runs on port 8585. It uses Jetty Server. The above config can be changed to make it run on a different port. Once you have updated the port details in config restart the server.

Database

1
database:
2
# the name of the JDBC driver, mysql in our case
3
driverClass: com.mysql.cj.jdbc.Driver
4
# the username and password
5
user: openmetadata_user
6
password: openmetadata_password
7
# the JDBC URL; the database is called openmetadata_db
8
url: jdbc:mysql://localhost/openmetadata_db?useSSL=false&serverTimezone=UTC
Copied!
The above section is database connection details to MySQL database. We recommend you create a MySQL user with a strong password and update this section accordingly.

ElasticSearch

1
elasticsearch:
2
host: localhost
3
port: 9200
Copied!
ElasticSearch is one of the pre-requisites to run OpenMetadata. Default configuration expects a single instance of ElasticSearch running on the local machine. Please make sure you update it with your production elastic search.

EventHandlers

1
eventHandlerConfiguration:
2
eventHandlerClassNames:
3
- "org.openmetadata.catalog.events.AuditEventHandler"
4
- "org.openmetadata.catalog.events.ElasticSearchEventHandler"
Copied!
EventHandler configuration is optional. It will update the AuditLog in MySQL DB and also ElasticSearch indexes whenever any entity is updated either through UI or API interactions. We recommend you leave it there as it enhances the user experience.

Healthcheck

1
health:
2
delayedShutdownHandlerEnabled: true
3
shutdownWaitPeriod: 1s
4
healthCheckUrlPaths: ["/api/v1/health-check"]
5
healthChecks:
6
- name: UserDatabaseCheck
7
critical: true
8
schedule:
9
checkInterval: 2500ms
10
downtimeInterval: 10s
11
failureAttempts: 2
12
successAttempts: 1
Copied!
Healthcheck API provides an API endpoint to check the OpenMetadata server health. We recommend in production settings to use this API to monitor the health of your OpenMetadata instance. Please tune the above configuration according to your production needs.

Security

Please follow our Enable Security Guide guide to configure security for your OpenMetadata installation.
Last modified 1d ago