diff --git a/fe/fe-core/pom.xml b/fe/fe-core/pom.xml index 2c427ec5651..ff078fb2adf 100644 --- a/fe/fe-core/pom.xml +++ b/fe/fe-core/pom.xml @@ -764,6 +764,12 @@ under the License. test + + + org.apache.groovy + groovy-groovysh + + io.trino trino-parser diff --git a/fe/fe-core/src/main/java/com/starrocks/common/Config.java b/fe/fe-core/src/main/java/com/starrocks/common/Config.java index 91f06de627a..2c28a46a957 100644 --- a/fe/fe-core/src/main/java/com/starrocks/common/Config.java +++ b/fe/fe-core/src/main/java/com/starrocks/common/Config.java @@ -2173,10 +2173,12 @@ public class Config extends ConfigBase { @ConfField(mutable = true) public static long max_per_node_grep_log_limit = 500000; - /** * only use compute node, test for multi-warehouse */ @ConfField(mutable = true) public static boolean only_use_compute_node = false; + + @ConfField + public static boolean enable_execute_script_on_frontend = true; } diff --git a/fe/fe-core/src/main/java/com/starrocks/monitor/jvm/JvmInfo.java b/fe/fe-core/src/main/java/com/starrocks/monitor/jvm/JvmInfo.java index f0da40f7f1b..cc645d8d8b0 100644 --- a/fe/fe-core/src/main/java/com/starrocks/monitor/jvm/JvmInfo.java +++ b/fe/fe-core/src/main/java/com/starrocks/monitor/jvm/JvmInfo.java @@ -24,8 +24,11 @@ import java.lang.management.ManagementFactory; import java.lang.management.ManagementPermission; import java.lang.management.MemoryMXBean; import java.lang.management.MemoryPoolMXBean; +import java.lang.management.MemoryUsage; import java.lang.management.PlatformManagedObject; import java.lang.management.RuntimeMXBean; +import java.lang.management.ThreadInfo; +import java.lang.management.ThreadMXBean; import java.lang.reflect.Method; import java.util.Collections; import java.util.List; @@ -466,4 +469,38 @@ public class JvmInfo { return sb.toString(); } } + + public static String getThreadDump() { + return getThreadDumpWithPattern(null); + } + + public static String getThreadDumpWithPattern(String pattern) { + StringBuilder sb = new StringBuilder(); + ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean(); + ThreadInfo[] threadInfos = threadMXBean.dumpAllThreads(true, true); + for (ThreadInfo threadInfo : threadInfos) { + if (threadInfo != null) { + String dump = threadInfo.toString(); + if (pattern == null || dump.contains(pattern)) { + sb.append(dump); + sb.append('\n'); + } + } + } + return sb.toString(); + } + + public static String getMemoryStats() { + List memoryPools = ManagementFactory.getMemoryPoolMXBeans(); + StringBuilder sb = new StringBuilder(); + for (MemoryPoolMXBean pool : memoryPools) { + sb.append("Pool: " + pool.getName() + "\n"); + MemoryUsage usage = pool.getUsage(); + sb.append(" - Initial: " + usage.getInit() + "\n"); + sb.append(" - Used: " + usage.getUsed() + "\n"); + sb.append(" - Committed: " + usage.getCommitted() + "\n"); + sb.append(" - Maximum: " + usage.getMax() + "\n"); + } + return sb.toString(); + } } diff --git a/fe/fe-core/src/main/java/com/starrocks/qe/ExecuteScriptExecutor.java b/fe/fe-core/src/main/java/com/starrocks/qe/ExecuteScriptExecutor.java index 808f8edcf36..4e580fe02e8 100644 --- a/fe/fe-core/src/main/java/com/starrocks/qe/ExecuteScriptExecutor.java +++ b/fe/fe-core/src/main/java/com/starrocks/qe/ExecuteScriptExecutor.java @@ -14,6 +14,7 @@ package com.starrocks.qe; +import com.starrocks.common.Config; import com.starrocks.common.UserException; import com.starrocks.proto.ExecuteCommandRequestPB; import com.starrocks.proto.ExecuteCommandResultPB; @@ -22,6 +23,8 @@ import com.starrocks.server.GlobalStateMgr; import com.starrocks.sql.ast.ExecuteScriptStmt; import com.starrocks.system.Backend; import com.starrocks.thrift.TNetworkAddress; +import groovy.lang.Binding; +import groovy.lang.GroovyShell; import org.apache.commons.lang.StringUtils; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; @@ -33,6 +36,32 @@ public class ExecuteScriptExecutor { private static final Logger LOG = LogManager.getLogger(ExecuteScriptExecutor.class); public static void execute(ExecuteScriptStmt stmt, ConnectContext ctx) throws UserException { + if (stmt.isFrontendScript()) { + executeFrontendScript(stmt, ctx); + } else { + executeBackendScript(stmt, ctx); + } + } + + private static void executeFrontendScript(ExecuteScriptStmt stmt, ConnectContext ctx) throws UserException { + if (!Config.enable_execute_script_on_frontend) { + throw new UserException("execute script on frontend is disabled"); + } + try { + StringBuilder sb = new StringBuilder(); + Binding binding = new Binding(); + binding.setVariable("LOG", LOG); + binding.setVariable("out", sb); + binding.setVariable("globalState", GlobalStateMgr.getCurrentState()); + GroovyShell shell = new GroovyShell(binding); + shell.evaluate(stmt.getScript()); + ctx.getState().setOk(0, 0, sb.toString()); + } catch (Exception e) { + throw new UserException("execute script failed: " + e.getMessage()); + } + } + + private static void executeBackendScript(ExecuteScriptStmt stmt, ConnectContext ctx) throws UserException { Backend be = GlobalStateMgr.getCurrentSystemInfo().getBackend(stmt.getBeId()); if (be == null) { throw new UserException("node not found: " + stmt.getBeId()); diff --git a/fe/fe-core/src/main/java/com/starrocks/sql/ast/ExecuteScriptStmt.java b/fe/fe-core/src/main/java/com/starrocks/sql/ast/ExecuteScriptStmt.java index 0b4691f935f..ccbe3f10e45 100644 --- a/fe/fe-core/src/main/java/com/starrocks/sql/ast/ExecuteScriptStmt.java +++ b/fe/fe-core/src/main/java/com/starrocks/sql/ast/ExecuteScriptStmt.java @@ -44,6 +44,10 @@ public class ExecuteScriptStmt extends StatementBase { return script; } + public boolean isFrontendScript() { + return beId == -1; + } + public void setTimeoutSec(long timeoutSec) { this.timeoutSec = timeoutSec; } diff --git a/fe/fe-core/src/main/java/com/starrocks/sql/parser/AstBuilder.java b/fe/fe-core/src/main/java/com/starrocks/sql/parser/AstBuilder.java index 939a4bae99d..8405151d12c 100644 --- a/fe/fe-core/src/main/java/com/starrocks/sql/parser/AstBuilder.java +++ b/fe/fe-core/src/main/java/com/starrocks/sql/parser/AstBuilder.java @@ -511,7 +511,7 @@ public class AstBuilder extends StarRocksBaseVisitor { String dbName = getIdentifierName(context.database); - Map properties = new HashMap<>();; + Map properties = new HashMap<>(); if (context.properties() != null) { List propertyList = visit(context.properties().property(), Property.class); for (Property property : propertyList) { @@ -3166,7 +3166,10 @@ public class AstBuilder extends StarRocksBaseVisitor { @Override public ParseNode visitExecuteScriptStatement(StarRocksParser.ExecuteScriptStatementContext context) { - long beId = Long.parseLong(context.INTEGER_VALUE().getText()); + long beId = -1; + if (context.INTEGER_VALUE() != null) { + beId = Long.parseLong(context.INTEGER_VALUE().getText()); + } StringLiteral stringLiteral = (StringLiteral) visit(context.string()); String script = stringLiteral.getStringValue(); return new ExecuteScriptStmt(beId, script, createPos(context)); diff --git a/fe/fe-core/src/main/java/com/starrocks/sql/parser/StarRocks.g4 b/fe/fe-core/src/main/java/com/starrocks/sql/parser/StarRocks.g4 index bd7bd5185a2..cafb5449cd6 100644 --- a/fe/fe-core/src/main/java/com/starrocks/sql/parser/StarRocks.g4 +++ b/fe/fe-core/src/main/java/com/starrocks/sql/parser/StarRocks.g4 @@ -1522,7 +1522,7 @@ setWarehouseStatement ; executeScriptStatement - : ADMIN EXECUTE ON INTEGER_VALUE string + : ADMIN EXECUTE ON (FRONTEND | INTEGER_VALUE) string ; unsupportedStatement diff --git a/fe/pom.xml b/fe/pom.xml index 2e31e3c321e..6a461a3c5da 100644 --- a/fe/pom.xml +++ b/fe/pom.xml @@ -287,7 +287,7 @@ under the License. starrocks-bdb-je 18.3.13 - + de.jflex @@ -704,6 +704,13 @@ under the License. 2.9.0 + + + org.apache.groovy + groovy-groovysh + 4.0.9 + + diff --git a/licenses-binary/LICENSE-apache-groovy.txt b/licenses-binary/LICENSE-apache-groovy.txt new file mode 100644 index 00000000000..a515d411d42 --- /dev/null +++ b/licenses-binary/LICENSE-apache-groovy.txt @@ -0,0 +1,244 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +------------------------------------------------------------------------ + +Asciidoc License + +This product uses the style.css from asciidoctor.org within +documentation. The file is available under the MIT License. +For details, see licenses/asciidoc-style-license.txt. + +------------------------------------------------------------------------ + +JQuery License + +The following file is used within documentation: + + src/spec/assets/css/jquery-2.1.1.min.js + +This file is made available under the following MIT license: +licenses/jquery-js-license.txt + +------------------------------------------------------------------------ + +JSR223 License + +The following classes within this product: + + org.codehaus.groovy.jsr223.GroovyCompiledScript + org.codehaus.groovy.jsr223.GroovyScriptEngineFactory + org.codehaus.groovy.jsr223.GroovyScriptEngineImpl + +were derived from reference implementation files developed by Sun in +collaboration with the Groovy community. The reference implementation +has a BSD-style license. Details can be found in: licenses/jsr223-license.txt + +------------------------------------------------------------------------ + +normalize.css License + +The stylesheet.css file (originally normalize.css) is used by the +groovydoc and docgenerator components for groovy-jdk/gapi documentation. +It is made available under a MIT License: +licenses/normalize-stylesheet-license.txt diff --git a/licenses-binary/NOTICE-apache-groovy.txt b/licenses-binary/NOTICE-apache-groovy.txt new file mode 100644 index 00000000000..52de23b72b2 --- /dev/null +++ b/licenses-binary/NOTICE-apache-groovy.txt @@ -0,0 +1,18 @@ +Apache Groovy +Copyright 2003-2023 The Apache Software Foundation + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). + +The Java source files in src/main/java/org/apache/groovy/util/concurrent/concurrentlinkedhashmap/ +are from https://github.com/ben-manes/concurrentlinkedhashmap and the following notice applies: +Copyright 2010-2012 Google Inc. All Rights Reserved. + +The Java source file src/main/java/org/apache/groovy/util/concurrent/ConcurrentReferenceHashMap +is from https://github.com/hazelcast/hazelcast and the following notice applies: +Copyright (c) 2008-2020, Hazelcast, Inc. All Rights Reserved. + +This product bundles icons from the famfamfam.com silk icons set +http://www.famfamfam.com/lab/icons/silk/ +Licensed under the Creative Commons Attribution Licence v2.5 +http://creativecommons.org/licenses/by/2.5/