-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[feature](ES Catalog)Add FE open API for ES Catalog (#40444)
Add api to get info from Elasticsearch, it's very useful for debugging.
1. get index mapping api
```
GET /rest/v2/api/es_catalog/get_mapping?catalog=xxx&table=xxx
```
2. search index api
```
POST /rest/v2/api/es_catalog/search?catalog=xxx&table=xxx
{
request_body
...
}
```- Loading branch information
Showing
4 changed files
with
261 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
108 changes: 108 additions & 0 deletions
108
fe/fe-core/src/main/java/org/apache/doris/httpv2/restv2/ESCatalogAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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. | ||
|
|
||
| package org.apache.doris.httpv2.restv2; | ||
|
|
||
| import org.apache.doris.catalog.Env; | ||
| import org.apache.doris.common.Config; | ||
| import org.apache.doris.common.util.JsonUtil; | ||
| import org.apache.doris.datasource.CatalogIf; | ||
| import org.apache.doris.datasource.EsExternalCatalog; | ||
| import org.apache.doris.httpv2.entity.ResponseEntityBuilder; | ||
| import org.apache.doris.httpv2.rest.RestBaseController; | ||
|
|
||
| import com.fasterxml.jackson.databind.node.ObjectNode; | ||
| import com.google.common.collect.Maps; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.RequestMethod; | ||
| import org.springframework.web.bind.annotation.RestController; | ||
|
|
||
| import java.io.BufferedReader; | ||
| import java.io.IOException; | ||
| import java.util.Map; | ||
| import java.util.function.BiFunction; | ||
| import java.util.stream.Collectors; | ||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.servlet.http.HttpServletResponse; | ||
|
|
||
| @RestController | ||
| @RequestMapping("/rest/v2/api/es_catalog") | ||
| public class ESCatalogAction extends RestBaseController { | ||
|
|
||
| private static final Logger LOG = LogManager.getLogger(ESCatalogAction.class); | ||
| private static final String CATALOG = "catalog"; | ||
| private static final String TABLE = "table"; | ||
|
|
||
| private Object handleRequest(HttpServletRequest request, HttpServletResponse response, | ||
| BiFunction<EsExternalCatalog, String, String> action) { | ||
| if (Config.enable_all_http_auth) { | ||
| executeCheckPassword(request, response); | ||
| } | ||
|
|
||
| try { | ||
| if (!Env.getCurrentEnv().isMaster()) { | ||
| return redirectToMasterOrException(request, response); | ||
| } | ||
| } catch (Exception e) { | ||
| return ResponseEntityBuilder.okWithCommonError(e.getMessage()); | ||
| } | ||
|
|
||
| Map<String, Object> resultMap = Maps.newHashMap(); | ||
| Env env = Env.getCurrentEnv(); | ||
| String catalogName = request.getParameter(CATALOG); | ||
| String tableName = request.getParameter(TABLE); | ||
| CatalogIf catalog = env.getCatalogMgr().getCatalog(catalogName); | ||
| if (!(catalog instanceof EsExternalCatalog)) { | ||
| return ResponseEntityBuilder.badRequest("unknown ES Catalog: " + catalogName); | ||
| } | ||
| EsExternalCatalog esExternalCatalog = (EsExternalCatalog) catalog; | ||
| esExternalCatalog.makeSureInitialized(); | ||
| String result = action.apply(esExternalCatalog, tableName); | ||
| ObjectNode jsonResult = JsonUtil.parseObject(result); | ||
|
|
||
| resultMap.put("catalog", catalogName); | ||
| resultMap.put("table", tableName); | ||
| resultMap.put("result", jsonResult); | ||
|
|
||
| return ResponseEntityBuilder.ok(resultMap); | ||
| } | ||
|
|
||
| @RequestMapping(path = "/get_mapping", method = RequestMethod.GET) | ||
| public Object getMapping(HttpServletRequest request, HttpServletResponse response) { | ||
| return handleRequest(request, response, (esExternalCatalog, tableName) -> | ||
| esExternalCatalog.getEsRestClient().getMapping(tableName)); | ||
| } | ||
|
|
||
| @RequestMapping(path = "/search", method = RequestMethod.POST) | ||
| public Object search(HttpServletRequest request, HttpServletResponse response) { | ||
| String body; | ||
| try { | ||
| body = getRequestBody(request); | ||
| } catch (IOException e) { | ||
| return ResponseEntityBuilder.okWithCommonError(e.getMessage()); | ||
| } | ||
| return handleRequest(request, response, (esExternalCatalog, tableName) -> | ||
| esExternalCatalog.getEsRestClient().searchIndex(tableName, body)); | ||
| } | ||
|
|
||
| private String getRequestBody(HttpServletRequest request) throws IOException { | ||
| BufferedReader reader = request.getReader(); | ||
| return reader.lines().collect(Collectors.joining(System.lineSeparator())); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
84 changes: 84 additions & 0 deletions
84
regression-test/suites/external_table_p0/es/test_es_catalog_http_open_api.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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. | ||
|
|
||
| suite("test_es_catalog_http_open_api", "p0,external,es,external_docker,external_docker_es") { | ||
| String enabled = context.config.otherConfigs.get("enableEsTest") | ||
| if (enabled != null && enabled.equalsIgnoreCase("true")) { | ||
| String externalEnvIp = context.config.otherConfigs.get("externalEnvIp") | ||
| String es_5_port = context.config.otherConfigs.get("es_5_port") | ||
| String es_6_port = context.config.otherConfigs.get("es_6_port") | ||
| String es_7_port = context.config.otherConfigs.get("es_7_port") | ||
| String es_8_port = context.config.otherConfigs.get("es_8_port") | ||
|
|
||
| // test old create-catalog syntax for compatibility | ||
| sql """ | ||
| create catalog if not exists test_es_query_es5 | ||
| properties ( | ||
| "type"="es", | ||
| "elasticsearch.hosts"="http://${externalEnvIp}:$es_5_port", | ||
| "elasticsearch.nodes_discovery"="false", | ||
| "elasticsearch.keyword_sniff"="true" | ||
| ); | ||
| """ | ||
| sql """ | ||
| create catalog if not exists test_es_query_es6 | ||
| properties ( | ||
| "type"="es", | ||
| "elasticsearch.hosts"="http://${externalEnvIp}:$es_6_port", | ||
| "elasticsearch.nodes_discovery"="false", | ||
| "elasticsearch.keyword_sniff"="true" | ||
| ); | ||
| """ | ||
|
|
||
| // test new create catalog syntax | ||
| sql """create catalog if not exists test_es_query_es7 properties( | ||
| "type"="es", | ||
| "hosts"="http://${externalEnvIp}:$es_7_port", | ||
| "nodes_discovery"="false", | ||
| "enable_keyword_sniff"="true" | ||
| ); | ||
| """ | ||
|
|
||
| sql """create catalog if not exists test_es_query_es8 properties( | ||
| "type"="es", | ||
| "hosts"="http://${externalEnvIp}:$es_8_port", | ||
| "nodes_discovery"="false", | ||
| "enable_keyword_sniff"="true" | ||
| ); | ||
| """ | ||
|
|
||
| List<String> feHosts = getFrontendIpHttpPort() | ||
| // for each catalog 5..8, send a request | ||
| for (int i = 5; i <= 8; i++) { | ||
| String catalog = String.format("test_es_query_es%s", i) | ||
| def (code, out, err) = curl("GET", String.format("http://%s/rest/v2/api/es_catalog/get_mapping?catalog=%s&table=test1", feHosts[0], catalog)) | ||
| logger.info("Get mapping response: code=" + code + ", out=" + out + ", err=" + err) | ||
| assertTrue(code == 0) | ||
| assertTrue(out.toLowerCase().contains("success")) | ||
| assertTrue(out.toLowerCase().contains("mappings")) | ||
| assertTrue(out.toLowerCase().contains(catalog)) | ||
|
|
||
| String body = '{"query":{"match_all":{}},"stored_fields":"_none_","docvalue_fields":["test6"],"sort":["_doc"],"size":4064}'; | ||
| def (code1, out1, err1) = curl("POST", String.format("http://%s/rest/v2/api/es_catalog/search?catalog=%s&table=test1", feHosts[0], catalog), body) | ||
| logger.info("Search index response: code=" + code1 + ", out=" + out1 + ", err=" + err1) | ||
| assertTrue(code1 == 0) | ||
| assertTrue(out1.toLowerCase().contains("success")) | ||
| assertTrue(out1.toLowerCase().contains("hits")) | ||
| assertTrue(out1.toLowerCase().contains(catalog)) | ||
| } | ||
| } | ||
| } |