| <html class="docs-version-1.0.3" lang="en" dir="ltr"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="generator" content="Docusaurus v2.0.0-beta.14"> |
| <link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache Linkis Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache Linkis Blog Atom Feed"> |
| <link rel="search" type="application/opensearchdescription+xml" title="Apache Linkis" href="/opensearch.xml"><title data-react-helmet="true">Configurations | Apache Linkis</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:url" content="https://linkis.incubator.apache.org/docs/1.0.3/tuning_and_troubleshooting/configuration"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="1.0.3"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-1.0.3"><meta data-react-helmet="true" property="og:title" content="Configurations | Apache Linkis"><meta data-react-helmet="true" name="description" content="The configuration of Linkis1.0 is simplified on the basis of Linkis0.x. A public configuration file linkis.properties is provided in the conf directory to avoid the need for common configuration parameters to be configured in multiple microservices at the same time. This document will list the parameters of Linkis1.0 in modules."><meta data-react-helmet="true" property="og:description" content="The configuration of Linkis1.0 is simplified on the basis of Linkis0.x. A public configuration file linkis.properties is provided in the conf directory to avoid the need for common configuration parameters to be configured in multiple microservices at the same time. This document will list the parameters of Linkis1.0 in modules."><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://linkis.incubator.apache.org/docs/1.0.3/tuning_and_troubleshooting/configuration"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/docs/1.0.3/tuning_and_troubleshooting/configuration" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/zh-CN/docs/1.0.3/tuning_and_troubleshooting/configuration" hreflang="zh-CN"><link data-react-helmet="true" rel="alternate" href="https://linkis.incubator.apache.org/docs/1.0.3/tuning_and_troubleshooting/configuration" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://AE29KQB3IA-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.92d87943.css"> |
| <link rel="preload" href="/assets/js/runtime~main.a4c60f50.js" as="script"> |
| <link rel="preload" href="/assets/js/main.42471b13.js" as="script"> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <div><a href="#" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><img src="/img/logo.png" alt="Apache Linkis Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/img/logo.png" alt="Apache Linkis Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"><b class="navbar__title">Apache Linkis(Incubating)</b></a><a class="navbar__item navbar__link" href="/">Home</a><a class="navbar__item navbar__link" href="/faq/main">FAQ</a><a class="navbar__item navbar__link" href="/download/main">Download</a><a class="navbar__item navbar__link" href="/community/how-to-subscribe">Community</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/user">Users</a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link">Doc</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/1.1.3/introduction">Next(1.1.3)</a></li><li><a class="dropdown__link" href="/docs/latest/introduction">1.1.2</a></li><li><a class="dropdown__link" href="/docs/1.1.1/introduction">1.1.1</a></li><li><a class="dropdown__link" href="/docs/1.1.0/introduction">1.1.0</a></li><li><a class="dropdown__link" href="/docs/1.0.3/introduction">1.0.3</a></li><li><a class="dropdown__link" href="/docs/1.0.2/introduction">1.0.2</a></li><li><a class="dropdown__link" href="/docs/0.11.0/introduction">0.11.0</a></li><li><a class="dropdown__link" href="/versions">All Version</a></li></ul></div><a href="https://github.com/apache/incubator-linkis" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub"></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" class="navbar__link"><span><svg t="1631348384596" class="iconLanguage_EbrZ" viewBox="0 0 1024 1024" version="1.1" p-id="557" width="20" height="20"><path d="M547.797333 638.208l-104.405333-103.168 1.237333-1.28a720.170667 720.170667 0 0 0 152.490667-268.373333h120.448V183.082667h-287.744V100.906667H347.605333v82.218666H59.818667V265.386667h459.178666a648.234667 648.234667 0 0 1-130.304 219.946666 643.242667 643.242667 0 0 1-94.976-137.728H211.541333a722.048 722.048 0 0 0 122.453334 187.434667l-209.194667 206.378667 58.368 58.368 205.525333-205.525334 127.872 127.829334 31.232-83.84m231.424-208.426667h-82.218666l-184.96 493.312h82.218666l46.037334-123.306667h195.242666l46.464 123.306667h82.218667l-185.002667-493.312m-107.690666 287.744l66.56-178.005333 66.602666 178.005333z" fill="currentColor" p-id="558"></path></svg><span>English</span></span></a><ul class="dropdown__menu"><li><a href="/docs/1.0.3/tuning_and_troubleshooting/configuration" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" style="text-transform:capitalize">English</a></li><li><a href="/zh-CN/docs/1.0.3/tuning_and_troubleshooting/configuration" target="_self" rel="noopener noreferrer" class="dropdown__link" style="text-transform:capitalize">简体中文</a></li></ul></div><div class="searchBox_Bc3W"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper docs-doc-page"><div class="docPage_lDyR"><button class="clean-btn backToTopButton_i9tI" type="button"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_0YBq"><div class="sidebar_a3j0"><nav class="menu thin-scrollbar menu_cyFh menuWithAnnouncementBar_+O1J"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" href="/docs/1.0.3/introduction">Introduction</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Deployment</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">User Guide</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Engine Usage</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">API Docs</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Architecture</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Development Doc</a></li><li class="theme-doc-sidebar-item-category menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Upgrade Guide</a></li><li class="theme-doc-sidebar-item-category menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">Tuning And Troubleshooting</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.0.3/tuning_and_troubleshooting/overview">Overview</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/1.0.3/tuning_and_troubleshooting/configuration">Configurations</a></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.0.3/tuning_and_troubleshooting/tuning">Tuning</a></li></ul></li><li class="theme-doc-sidebar-item-link menu__list-item"><a class="menu__link" href="/docs/1.0.3/contact">Contact Us</a></li></ul></nav></div></aside><main class="docMainContainer_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for <!-- -->Apache Linkis<!-- --> <b>1.0.3</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/latest/tuning_and_troubleshooting/configuration">latest version</a></b> (<!-- -->1.1.2<!-- -->).</div></div><div class="docItemContainer_oiyr"><article><span class="theme-doc-version-badge badge badge--secondary">Version: <!-- -->1.0.3</span><div class="tocCollapsible_aw-L theme-doc-toc-mobile tocMobile_Tx6Y"><button type="button" class="clean-btn tocCollapsibleButton_zr6a">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Linkis1.0 Configurations</h1></header><blockquote><p>The configuration of Linkis1.0 is simplified on the basis of Linkis0.x. A public configuration file linkis.properties is provided in the conf directory to avoid the need for common configuration parameters to be configured in multiple microservices at the same time. This document will list the parameters of Linkis1.0 in modules.</p></blockquote><p> <!-- --> <!-- --> <!-- --> <!-- --> <!-- --> <!-- --> <!-- --> <!-- -->Please be noticed: This article only lists all the configuration parameters related to Linkis that have an impact on operating performance or environment dependence. Many configuration parameters that do not need users to care about have been omitted. If users are interested, they can browse through the source code.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="1-general-configuration"></a>1 General configuration<a class="hash-link" href="#1-general-configuration" title="Direct link to heading">#</a></h3><p> <!-- --> <!-- --> <!-- --> <!-- --> <!-- --> <!-- --> <!-- --> <!-- -->The general configuration can be set in the global linkis.properties, one setting, each microservice can take effect.</p><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="11-global-configurations"></a>1.1 Global configurations<a class="hash-link" href="#11-global-configurations" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.encoding</td><td>utf-8</td><td>Linkis default encoding format</td></tr><tr><td>wds.linkis.date.pattern</td><td>yyyy-MM-dd'T'HH:mm:ssZ</td><td>Default date format</td></tr><tr><td>wds.linkis.test.mode</td><td>false</td><td>Whether to enable debugging mode, if set to true, all microservices support password-free login, and all EngineConn open remote debugging ports</td></tr><tr><td>wds.linkis.test.user</td><td>None</td><td>When wds.linkis.test.mode=true, the default login user for password-free login</td></tr><tr><td>wds.linkis.home</td><td>/appcom/Install/LinkisInstall</td><td>Linkis installation directory, if it does not exist, it will automatically get the value of LINKIS_HOME</td></tr><tr><td>wds.linkis.httpclient.default.connect.timeOut</td><td>50000</td><td>Linkis HttpClient default connection timeout</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="12-ldap-configurations"></a>1.2 LDAP configurations<a class="hash-link" href="#12-ldap-configurations" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.ldap.proxy.url</td><td>None</td><td>LDAP URL address</td></tr><tr><td>wds.linkis.ldap.proxy.baseDN</td><td>None</td><td>LDAP baseDN address</td></tr><tr><td>wds.linkis.ldap.proxy.userNameFormat</td><td>None</td><td></td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="13-hadoop-configuration-parameters"></a>1.3 Hadoop configuration parameters<a class="hash-link" href="#13-hadoop-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.hadoop.root.user</td><td>hadoop</td><td>HDFS super user</td></tr><tr><td>wds.linkis.filesystem.hdfs.root.path</td><td>None</td><td>User's HDFS default root path</td></tr><tr><td>wds.linkis.keytab.enable</td><td>false</td><td>Whether to enable kerberos</td></tr><tr><td>wds.linkis.keytab.file</td><td>/appcom/keytab</td><td>Kerberos keytab path, effective only when wds.linkis.keytab.enable=true</td></tr><tr><td>wds.linkis.keytab.host.enabled</td><td>false</td><td></td></tr><tr><td>wds.linkis.keytab.host</td><td>127.0.0.1</td><td></td></tr><tr><td>hadoop.config.dir</td><td>None</td><td>If not configured, it will be read from the environment variable HADOOP_CONF_DIR</td></tr><tr><td>wds.linkis.hadoop.external.conf.dir.prefix</td><td>/appcom/config/external-conf/hadoop</td><td>hadoop additional configuration</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="14-linkis-rpc-configuration-parameters"></a>1.4 Linkis RPC configuration parameters<a class="hash-link" href="#14-linkis-rpc-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.rpc.broadcast.thread.num</td><td>10</td><td>Linkis RPC broadcast thread number (<strong>Recommended default value</strong>)</td></tr><tr><td>wds.linkis.ms.rpc.sync.timeout</td><td>60000</td><td>Linkis RPC Receiver's default processing timeout time</td></tr><tr><td>wds.linkis.rpc.eureka.client.refresh.interval</td><td>1s</td><td>Refresh interval of Eureka client's microservice list (<strong>Recommended default value</strong>)</td></tr><tr><td>wds.linkis.rpc.eureka.client.refresh.wait.time.max</td><td>1m</td><td>Refresh maximum waiting time (<strong>recommended default value</strong>)</td></tr><tr><td>wds.linkis.rpc.receiver.asyn.consumer.thread.max</td><td>10</td><td>Maximum number of Receiver Consumer threads (<strong>If there are many online users, it is recommended to increase this parameter appropriately</strong>)</td></tr><tr><td>wds.linkis.rpc.receiver.asyn.consumer.freeTime.max</td><td>2m</td><td>Receiver Consumer maximum idle time</td></tr><tr><td>wds.linkis.rpc.receiver.asyn.queue.size.max</td><td>1000</td><td>The maximum number of buffers in the receiver consumption queue (<strong>If there are many online users, it is recommended to increase this parameter appropriately</strong>)</td></tr><tr><td>wds.linkis.rpc.sender.asyn.consumer.thread.max", 5</td><td>Sender Consumer maximum number of threads</td><td></td></tr><tr><td>wds.linkis.rpc.sender.asyn.consumer.freeTime.max</td><td>2m</td><td>Sender Consumer Maximum Free Time</td></tr><tr><td>wds.linkis.rpc.sender.asyn.queue.size.max</td><td>300</td><td>Sender consumption queue maximum buffer number</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="2-calculate-governance-configuration-parameters"></a>2. Calculate governance configuration parameters<a class="hash-link" href="#2-calculate-governance-configuration-parameters" title="Direct link to heading">#</a></h3><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="21-entrance-configuration-parameters"></a>2.1 Entrance configuration parameters<a class="hash-link" href="#21-entrance-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.spark.engine.version</td><td>2.4.3</td><td>The default Spark version used when the user submits a script without specifying a version</td></tr><tr><td>wds.linkis.hive.engine.version</td><td>1.2.1</td><td>The default Hive version used when the user submits a script without a specified version</td></tr><tr><td>wds.linkis.python.engine.version</td><td>python2</td><td>The default Python version used when the user submits a script without specifying a version</td></tr><tr><td>wds.linkis.jdbc.engine.version</td><td>4</td><td>The default JDBC version used when the user submits the script without specifying the version</td></tr><tr><td>wds.linkis.shell.engine.version</td><td>1</td><td>The default shell version used when the user submits a script without specifying a version</td></tr><tr><td>wds.linkis.appconn.engine.version</td><td>v1</td><td>The default AppConn version used when the user submits a script without a specified version</td></tr><tr><td>wds.linkis.entrance.scheduler.maxParallelismUsers</td><td>1000</td><td>Maximum number of concurrent users supported by Entrance</td></tr><tr><td>wds.linkis.entrance.job.persist.wait.max</td><td>5m</td><td>Maximum time for Entrance to wait for JobHistory to persist a Job</td></tr><tr><td>wds.linkis.entrance.config.log.path</td><td>None</td><td>If not configured, the value of wds.linkis.filesystem.hdfs.root.path is used by default</td></tr><tr><td>wds.linkis.default.requestApplication.name</td><td>IDE</td><td>The default submission system when the submission system is not specified</td></tr><tr><td>wds.linkis.default.runType</td><td>sql</td><td>The default script type when the script type is not specified</td></tr><tr><td>wds.linkis.warn.log.exclude</td><td>org.apache,hive.ql,hive.metastore,com.netflix,com.webank.wedatasphere</td><td>Real-time WARN-level logs that are not output to the client by default</td></tr><tr><td>wds.linkis.log.exclude</td><td>org.apache, hive.ql, hive.metastore, com.netflix, com.webank.wedatasphere, com.webank</td><td>Real-time INFO-level logs that are not output to the client by default</td></tr><tr><td>wds.linkis.instance</td><td>3</td><td>User's default number of concurrent jobs per engine</td></tr><tr><td>wds.linkis.max.ask.executor.time</td><td>5m</td><td>Apply to LinkisManager for the maximum time available for EngineConn</td></tr><tr><td>wds.linkis.hive.special.log.include</td><td>org.apache.hadoop.hive.ql.exec.Task</td><td>When pushing Hive logs to the client, which logs are not filtered by default</td></tr><tr><td>wds.linkis.spark.special.log.include</td><td>org.apache.linkis.engine.spark.utils.JobProgressUtil</td><td>When pushing Spark logs to the client, which logs are not filtered by default</td></tr><tr><td>wds.linkis.entrance.shell.danger.check.enabled</td><td>false</td><td>Whether to check and block dangerous shell syntax</td></tr><tr><td>wds.linkis.shell.danger.usage</td><td>rm,sh,find,kill,python,for,source,hdfs,hadoop,spark-sql,spark-submit,pyspark,spark-shell,hive,yarn</td><td>Shell default Dangerous grammar</td></tr><tr><td>wds.linkis.shell.white.usage</td><td>cd,ls</td><td>Shell whitelist syntax</td></tr><tr><td>wds.linkis.sql.default.limit</td><td>5000</td><td>SQL default maximum return result set rows</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="22-engineconn-configuration-parameters"></a>2.2 EngineConn configuration parameters<a class="hash-link" href="#22-engineconn-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.engineconn.resultSet.default.store.path</td><td>hdfs:///tmp</td><td>Job result set default storage path</td></tr><tr><td>wds.linkis.engine.resultSet.cache.max</td><td>0k</td><td>When the size of the result set is lower than how much, EngineConn will return to Entrance without placing the disk.</td></tr><tr><td>wds.linkis.engine.default.limit</td><td>5000</td><td></td></tr><tr><td>wds.linkis.engine.lock.expire.time</td><td>120000</td><td>The maximum idle time of the engine lock, that is, after Entrance applies for the lock, how long does it take to submit code to EngineConn will be released</td></tr><tr><td>wds.linkis.engineconn.ignore.words</td><td>org.apache.spark.deploy.yarn.Client</td><td>Logs that are ignored by default when the Engine pushes logs to the Entrance side</td></tr><tr><td>wds.linkis.engineconn.pass.words</td><td>org.apache.hadoop.hive.ql.exec.Task</td><td>The log that must be pushed by default when the Engine pushes logs to the Entrance side</td></tr><tr><td>wds.linkis.engineconn.heartbeat.time</td><td>3m</td><td>Default heartbeat interval from EngineConn to LinkisManager</td></tr><tr><td>wds.linkis.engineconn.max.free.time</td><td>1h</td><td>EngineConn's maximum free time</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="23-engineconnmanager-configuration-parameters"></a>2.3 EngineConnManager configuration parameters<a class="hash-link" href="#23-engineconnmanager-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.ecm.memory.max</td><td>80g</td><td>ECM's maximum bootable EngineConn memory</td></tr><tr><td>wds.linkis.ecm.cores.max</td><td>50</td><td>ECM's maximum number of CPUs that can start EngineConn</td></tr><tr><td>wds.linkis.ecm.engineconn.instances.max</td><td>50</td><td>The maximum number of EngineConn that can be started, it is generally recommended to set the same as wds.linkis.ecm.cores.max</td></tr><tr><td>wds.linkis.ecm.protected.memory</td><td>4g</td><td>ECM protected memory, that is, the memory used by ECM to start EngineConn cannot exceed wds.linkis.ecm.memory.max-wds.linkis.ecm.protected.memory</td></tr><tr><td>wds.linkis.ecm.protected.cores.max</td><td>2</td><td>The number of protected CPUs of ECM, the meaning is the same as wds.linkis.ecm.protected.memory</td></tr><tr><td>wds.linkis.ecm.protected.engine.instances</td><td>2</td><td>Number of protected instances of ECM</td></tr><tr><td>wds.linkis.engineconn.wait.callback.pid</td><td>3s</td><td>Waiting time for EngineConn to return pid</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="24-linkismanager-configuration-parameters"></a>2.4 LinkisManager configuration parameters<a class="hash-link" href="#24-linkismanager-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.manager.am.engine.start.max.time"</td><td>10m</td><td>The maximum start time for LinkisManager to start a new EngineConn</td></tr><tr><td>wds.linkis.manager.am.engine.reuse.max.time</td><td>5m</td><td>LinkisManager reuses an existing EngineConn's maximum selection time</td></tr><tr><td>wds.linkis.manager.am.engine.reuse.count.limit</td><td>10</td><td>LinkisManager reuses an existing EngineConn's maximum polling times</td></tr><tr><td>wds.linkis.multi.user.engine.types</td><td>jdbc,es,presto</td><td>When LinkisManager reuses an existing EngineConn, which engine users are not used as reuse rules</td></tr><tr><td>wds.linkis.rm.instance</td><td>10</td><td>The default maximum number of instances per user per engine</td></tr><tr><td>wds.linkis.rm.yarnqueue.cores.max</td><td>150</td><td>Maximum number of cores per user in each engine usage queue</td></tr><tr><td>wds.linkis.rm.yarnqueue.memory.max</td><td>450g</td><td>The maximum amount of memory per user in each engine's use queue</td></tr><tr><td>wds.linkis.rm.yarnqueue.instance.max</td><td>30</td><td>The maximum number of applications launched by each user in the queue of each engine</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="3-each-engine-configuration-parameter"></a>3. Each engine configuration parameter<a class="hash-link" href="#3-each-engine-configuration-parameter" title="Direct link to heading">#</a></h3><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="31-jdbc-engine-configuration-parameters"></a>3.1 JDBC engine configuration parameters<a class="hash-link" href="#31-jdbc-engine-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.jdbc.default.limit</td><td>5000</td><td>The default maximum return result set rows</td></tr><tr><td>wds.linkis.jdbc.support.dbs</td><td>mysql=>com.mysql.jdbc.Driver,postgresql=>org.postgresql.Driver,oracle=>oracle.jdbc.driver.OracleDriver,hive2=>org.apache.hive .jdbc.HiveDriver,presto=>com.facebook.presto.jdbc.PrestoDriver</td><td>Drivers supported by JDBC engine</td></tr><tr><td>wds.linkis.engineconn.jdbc.concurrent.limit</td><td>100</td><td>Maximum number of concurrent SQL executions</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="32-python-engine-configuration-parameters"></a>3.2 Python engine configuration parameters<a class="hash-link" href="#32-python-engine-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>pythonVersion</td><td>/appcom/Install/anaconda3/bin/python</td><td>Python command path</td></tr><tr><td>python.path</td><td>None</td><td>Specify an additional path for Python, which only accepts shared storage paths</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="33-spark-engine-configuration-parameters"></a>3.3 Spark engine configuration parameters<a class="hash-link" href="#33-spark-engine-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.engine.spark.language-repl.init.time</td><td>30s</td><td>Maximum initialization time for Scala and Python command interpreters</td></tr><tr><td>PYSPARK_DRIVER_PYTHON</td><td>python</td><td>Python command path</td></tr><tr><td>wds.linkis.server.spark-submit</td><td>spark-submit</td><td>spark-submit command path</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="4-publicenhancements-configuration-parameters"></a>4. PublicEnhancements configuration parameters<a class="hash-link" href="#4-publicenhancements-configuration-parameters" title="Direct link to heading">#</a></h3><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="41-bml-configuration-parameters"></a>4.1 BML configuration parameters<a class="hash-link" href="#41-bml-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.bml.dws.version</td><td>v1</td><td>Version number requested by Linkis Restful</td></tr><tr><td>wds.linkis.bml.auth.token.key</td><td>Validation-Code</td><td>Password-free token-key for BML request</td></tr><tr><td>wds.linkis.bml.auth.token.value</td><td>BML-AUTH</td><td>Password-free token-value requested by BML</td></tr><tr><td>wds.linkis.bml.hdfs.prefix</td><td>/tmp/linkis</td><td>The prefix file path of the BML file stored on hdfs</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="42-metadata-configuration-parameters"></a>4.2 Metadata configuration parameters<a class="hash-link" href="#42-metadata-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>hadoop.config.dir</td><td>/appcom/config/hadoop-config</td><td>If it does not exist, the value of the environment variable HADOOP_CONF_DIR is used by default</td></tr><tr><td>hive.config.dir</td><td>/appcom/config/hive-config</td><td>If it does not exist, the value of the environment variable HIVE_CONF_DIR is used by default</td></tr><tr><td>hive.meta.url</td><td>None</td><td>The URL of the HiveMetaStore database. If hive.config.dir is not configured, this value must be configured</td></tr><tr><td>hive.meta.user</td><td>None</td><td>User of the HiveMetaStore database</td></tr><tr><td>hive.meta.password</td><td>None</td><td>Password of the HiveMetaStore database</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="43-jobhistory-configuration-parameters"></a>4.3 JobHistory configuration parameters<a class="hash-link" href="#43-jobhistory-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.jobhistory.admin</td><td>None</td><td>The default Admin account is used to specify which users can view the execution history of everyone</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="44-filesystem-configuration-parameters"></a>4.4 FileSystem configuration parameters<a class="hash-link" href="#44-filesystem-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.filesystem.root.path</td><td>file:///tmp/linkis/</td><td>User's Linux local root directory</td></tr><tr><td>wds.linkis.filesystem.hdfs.root.path</td><td>hdfs:///tmp/</td><td>User's HDFS root directory</td></tr><tr><td>wds.linkis.workspace.filesystem.hdfsuserrootpath.suffix</td><td>/linkis/</td><td>The first-level prefix after the user's HDFS root directory. The user's actual root directory is: ${hdfs.root.path}\${user}\${ hdfsuserrootpath.suffix}</td></tr><tr><td>wds.linkis.workspace.resultset.download.is.limit</td><td>true</td><td>When Client downloads the result set, whether to limit the number of downloads</td></tr><tr><td>wds.linkis.workspace.resultset.download.maxsize.csv</td><td>5000</td><td>When the result set is downloaded as a CSV file, the number of downloads is limited</td></tr><tr><td>wds.linkis.workspace.resultset.download.maxsize.excel</td><td>5000</td><td>When the result set is downloaded as an Excel file, the number of downloads is limited</td></tr><tr><td>wds.linkis.workspace.filesystem.get.timeout</td><td>2000L</td><td>The maximum timeout period for requesting the underlying file system. (<strong>If the performance of your HDFS or Linux machine is low, it is recommended to increase the check number appropriately</strong>)</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="45-udf-configuration-parameters"></a>4.5 UDF configuration parameters<a class="hash-link" href="#45-udf-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.udf.share.path</td><td>/mnt/bdap/udf</td><td>The storage path of the shared UDF, it is recommended to set it to the HDFS path</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor anchor__h3 anchorWithStickyNavbar_y2LR" id="5-microservice-configuration-parameters"></a>5. MicroService configuration parameters<a class="hash-link" href="#5-microservice-configuration-parameters" title="Direct link to heading">#</a></h3><h4><a aria-hidden="true" tabindex="-1" class="anchor anchor__h4 anchorWithStickyNavbar_y2LR" id="51-gateway-configuration-parameters"></a>5.1 Gateway configuration parameters<a class="hash-link" href="#51-gateway-configuration-parameters" title="Direct link to heading">#</a></h4><table><thead><tr><th>Parameter name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td>wds.linkis.gateway.conf.enable.proxy.user</td><td>false</td><td>Whether to enable proxy user mode, if enabled, the login user’s request will be proxied to the proxy user for execution</td></tr><tr><td>wds.linkis.gateway.conf.proxy.user.config</td><td>proxy.properties</td><td>Storage file of proxy rules</td></tr><tr><td>wds.linkis.gateway.conf.proxy.user.scan.interval</td><td>600000</td><td>Proxy file refresh interval</td></tr><tr><td>wds.linkis.gateway.conf.enable.token.auth</td><td>false</td><td>Whether to enable the Token login mode, if enabled, allow access to Linkis in the form of tokens</td></tr><tr><td>wds.linkis.gateway.conf.token.auth.config</td><td>token.properties</td><td>Token rule storage file</td></tr><tr><td>wds.linkis.gateway.conf.token.auth.scan.interval</td><td>600000</td><td>Token file refresh interval</td></tr><tr><td>wds.linkis.gateway.conf.url.pass.auth</td><td>/dws/</td><td>Request for default release without login verification</td></tr><tr><td>wds.linkis.gateway.conf.enable.sso</td><td>false</td><td>Whether to enable SSO user login mode</td></tr><tr><td>wds.linkis.gateway.conf.sso.interceptor</td><td>None</td><td>If the SSO login mode is enabled, the user needs to implement SSOInterceptor to jump to the SSO login page</td></tr><tr><td>wds.linkis.admin.user</td><td>hadoop</td><td>Administrator user list</td></tr><tr><td>wds.linkis.login_encrypt.enable</td><td>false</td><td>When the user logs in, does the password enable RSA encryption transmission</td></tr><tr><td>wds.linkis.enable.gateway.auth</td><td>false</td><td>Whether to enable the Gateway IP whitelist mechanism</td></tr><tr><td>wds.linkis.gateway.auth.file</td><td>auth.txt</td><td>IP whitelist storage file</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/incubator-linkis-website/edit/dev/versioned_docs/version-1.0.3/tuning_and_troubleshooting/configuration.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_mt2f"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/1.0.3/tuning_and_troubleshooting/overview"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« <!-- -->Overview</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/1.0.3/tuning_and_troubleshooting/tuning"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Tuning<!-- --> »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#1-general-configuration" class="table-of-contents__link">1 General configuration</a></li><li><a href="#2-calculate-governance-configuration-parameters" class="table-of-contents__link">2. Calculate governance configuration parameters</a></li><li><a href="#3-each-engine-configuration-parameter" class="table-of-contents__link">3. Each engine configuration parameter</a></li><li><a href="#4-publicenhancements-configuration-parameters" class="table-of-contents__link">4. PublicEnhancements configuration parameters</a></li><li><a href="#5-microservice-configuration-parameters" class="table-of-contents__link">5. MicroService configuration parameters</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Linkis</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/latest/introduction">Document</a></li><li class="footer__item"><a class="footer__link-item" href="/faq/main">FAQ</a></li><li class="footer__item"><a href="https://github.com/apache/incubator-linkis/releases" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Releases<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/apache/incubator-linkis" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://github.com/apache/incubator-linkis/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Issue Tracker<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://github.com/apache/incubator-linkis/pulls" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Pull Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">Subscribe Mailing List</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/community/how-to-subscribe">How to Subscribe</a></li><li class="footer__item"><a href="mailto:dev-subscribe@linkis.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Subscribe Mail<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://lists.apache.org/list.html?dev@linkis.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Mail Archive<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><div><img style="height:50px" alt="Apache Software Foundation" src="/img/incubator-logo.svg"><p style="color: #999999; padding: 0 20px 30px;font-weight:400;text-align:left">Apache Linkis is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p><p></p> |
| <p style="padding: 0 20px 30px;color: #999999;font-weight: 400;"> Copyright © 2022 The Apache Software Foundation. Licensed under the Apache License, Version 2.0. Apache Linkis, Apache Incubator, Apache, the Apache feather logo, the Apache Linkis logo and the Apache Incubator project logo are trademarks of The Apache Software Foundation.</p> |
| <div></div></div></div></div></div></footer></div> |
| <script src="/assets/js/runtime~main.a4c60f50.js"></script> |
| <script src="/assets/js/main.42471b13.js"></script> |
