|
|
@@ -0,0 +1,254 @@
|
|
|
+/*
|
|
|
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
|
+ * or more contributor license agreements. Licensed under the Elastic License;
|
|
|
+ * you may not use this file except in compliance with the Elastic License.
|
|
|
+ */
|
|
|
+package org.elasticsearch.xpack.transform.rest.action;
|
|
|
+
|
|
|
+import org.elasticsearch.client.node.NodeClient;
|
|
|
+import org.elasticsearch.cluster.metadata.MetaData;
|
|
|
+import org.elasticsearch.common.Strings;
|
|
|
+import org.elasticsearch.common.Table;
|
|
|
+import org.elasticsearch.common.unit.TimeValue;
|
|
|
+import org.elasticsearch.xpack.core.action.util.PageParams;
|
|
|
+import org.elasticsearch.xpack.core.common.table.TableColumnAttributeBuilder;
|
|
|
+import org.elasticsearch.rest.RestRequest;
|
|
|
+import org.elasticsearch.rest.RestResponse;
|
|
|
+import org.elasticsearch.rest.action.RestActionListener;
|
|
|
+import org.elasticsearch.rest.action.RestResponseListener;
|
|
|
+import org.elasticsearch.rest.action.cat.AbstractCatAction;
|
|
|
+import org.elasticsearch.rest.action.cat.RestTable;
|
|
|
+import org.elasticsearch.xpack.core.transform.TransformField;
|
|
|
+import org.elasticsearch.xpack.core.transform.action.GetTransformAction;
|
|
|
+import org.elasticsearch.xpack.core.transform.action.GetTransformStatsAction;
|
|
|
+import org.elasticsearch.xpack.core.transform.transforms.TransformCheckpointingInfo;
|
|
|
+import org.elasticsearch.xpack.core.transform.transforms.TransformIndexerStats;
|
|
|
+import org.elasticsearch.xpack.core.transform.transforms.TransformStats;
|
|
|
+
|
|
|
+import java.util.List;
|
|
|
+import java.util.Map;
|
|
|
+import java.util.function.Function;
|
|
|
+import java.util.stream.Collectors;
|
|
|
+
|
|
|
+import static org.elasticsearch.rest.RestRequest.Method.GET;
|
|
|
+import static org.elasticsearch.xpack.core.transform.TransformField.ALLOW_NO_MATCH;
|
|
|
+
|
|
|
+public class RestCatTransformAction extends AbstractCatAction {
|
|
|
+
|
|
|
+ private static final Integer DEFAULT_MAX_PAGE_SEARCH_SIZE = Integer.valueOf(500);
|
|
|
+ private static final TimeValue DEFAULT_TRANSFORM_FREQUENCY = TimeValue.timeValueMillis(60000);
|
|
|
+
|
|
|
+ @Override
|
|
|
+ public List<Route> routes() {
|
|
|
+ return List.of(
|
|
|
+ new Route(GET, "_cat/transform"),
|
|
|
+ new Route(GET, "_cat/transform/{" + TransformField.TRANSFORM_ID + "}"));
|
|
|
+ }
|
|
|
+
|
|
|
+ @Override
|
|
|
+ public String getName() {
|
|
|
+ return "cat_transform_action";
|
|
|
+ }
|
|
|
+
|
|
|
+ @Override
|
|
|
+ protected RestChannelConsumer doCatRequest(RestRequest restRequest, NodeClient client) {
|
|
|
+ String id = restRequest.param(TransformField.TRANSFORM_ID);
|
|
|
+ if (Strings.isNullOrEmpty(id)) {
|
|
|
+ id = MetaData.ALL;
|
|
|
+ }
|
|
|
+
|
|
|
+ GetTransformAction.Request request = new GetTransformAction.Request(id);
|
|
|
+ request.setAllowNoResources(restRequest.paramAsBoolean(ALLOW_NO_MATCH.getPreferredName(), true));
|
|
|
+
|
|
|
+ GetTransformStatsAction.Request statsRequest = new GetTransformStatsAction.Request(id);
|
|
|
+ statsRequest.setAllowNoMatch(restRequest.paramAsBoolean(ALLOW_NO_MATCH.getPreferredName(), true));
|
|
|
+
|
|
|
+ if (restRequest.hasParam(PageParams.FROM.getPreferredName()) || restRequest.hasParam(PageParams.SIZE.getPreferredName())) {
|
|
|
+ PageParams pageParams = new PageParams(restRequest.paramAsInt(PageParams.FROM.getPreferredName(), PageParams.DEFAULT_FROM),
|
|
|
+ restRequest.paramAsInt(PageParams.SIZE.getPreferredName(), PageParams.DEFAULT_SIZE));
|
|
|
+ request.setPageParams(pageParams);
|
|
|
+ statsRequest.setPageParams(pageParams);
|
|
|
+ }
|
|
|
+
|
|
|
+ return channel -> client.execute(GetTransformAction.INSTANCE, request, new RestActionListener<>(channel) {
|
|
|
+ @Override
|
|
|
+ public void processResponse(GetTransformAction.Response response) {
|
|
|
+ client.execute(GetTransformStatsAction.INSTANCE, statsRequest, new RestResponseListener<>(channel) {
|
|
|
+ @Override
|
|
|
+ public RestResponse buildResponse(GetTransformStatsAction.Response statsResponse) throws Exception {
|
|
|
+ return RestTable.buildResponse(buildTable(response, statsResponse), channel);
|
|
|
+ }
|
|
|
+ });
|
|
|
+ }
|
|
|
+ });
|
|
|
+ }
|
|
|
+
|
|
|
+ @Override
|
|
|
+ protected void documentation(StringBuilder sb) {
|
|
|
+ sb.append("/_cat/transform\n");
|
|
|
+ sb.append("/_cat/transform/{" + TransformField.TRANSFORM_ID + "}\n");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Override
|
|
|
+ protected Table getTableWithHeader(RestRequest unused) {
|
|
|
+ return getTableWithHeader();
|
|
|
+ }
|
|
|
+
|
|
|
+ private static Table getTableWithHeader() {
|
|
|
+ return new Table()
|
|
|
+ .startHeaders()
|
|
|
+ // Transform config info
|
|
|
+ .addCell("id", TableColumnAttributeBuilder.builder("the id").build())
|
|
|
+ .addCell("create_time",
|
|
|
+ TableColumnAttributeBuilder.builder("transform creation time")
|
|
|
+ .setAliases("ct", "createTime")
|
|
|
+ .build())
|
|
|
+ .addCell("version",
|
|
|
+ TableColumnAttributeBuilder.builder("the version of Elasticsearch when the transform was created")
|
|
|
+ .setAliases("v")
|
|
|
+ .build())
|
|
|
+ .addCell("source_index",
|
|
|
+ TableColumnAttributeBuilder.builder("source index")
|
|
|
+ .setAliases("si", "sourceIndex")
|
|
|
+ .build())
|
|
|
+ .addCell("dest_index",
|
|
|
+ TableColumnAttributeBuilder.builder("destination index")
|
|
|
+ .setAliases("di", "destIndex")
|
|
|
+ .build())
|
|
|
+ .addCell("pipeline",
|
|
|
+ TableColumnAttributeBuilder.builder("transform pipeline")
|
|
|
+ .setAliases("p")
|
|
|
+ .build())
|
|
|
+ .addCell("description",
|
|
|
+ TableColumnAttributeBuilder.builder("description")
|
|
|
+ .setAliases("d")
|
|
|
+ .build())
|
|
|
+ .addCell("transform_type",
|
|
|
+ TableColumnAttributeBuilder.builder("batch or continuous transform")
|
|
|
+ .setAliases("tt")
|
|
|
+ .build())
|
|
|
+ .addCell("frequency",
|
|
|
+ TableColumnAttributeBuilder.builder("frequency of transform")
|
|
|
+ .setAliases("f")
|
|
|
+ .build())
|
|
|
+ .addCell("max_page_search_size",
|
|
|
+ TableColumnAttributeBuilder.builder("max page search size ")
|
|
|
+ .setAliases("mpsz")
|
|
|
+ .build())
|
|
|
+
|
|
|
+ // Transform stats info
|
|
|
+ .addCell("state",
|
|
|
+ TableColumnAttributeBuilder.builder("transform state")
|
|
|
+ .setAliases("s")
|
|
|
+ .setTextAlignment(TableColumnAttributeBuilder.TextAlign.RIGHT)
|
|
|
+ .build())
|
|
|
+ .addCell("reason",
|
|
|
+ TableColumnAttributeBuilder.builder("reason", false)
|
|
|
+ .setAliases("r", "reason")
|
|
|
+ .build())
|
|
|
+ .addCell("changes_last_detection_time",
|
|
|
+ TableColumnAttributeBuilder.builder("changes last detected time", false)
|
|
|
+ .setAliases("cldt")
|
|
|
+ .build())
|
|
|
+ .addCell("search_total",
|
|
|
+ TableColumnAttributeBuilder.builder("total number of searches", false)
|
|
|
+ .setAliases("st")
|
|
|
+ .build())
|
|
|
+ .addCell("search_failure",
|
|
|
+ TableColumnAttributeBuilder.builder("total number of search failures", false)
|
|
|
+ .setAliases("sf")
|
|
|
+ .build())
|
|
|
+ .addCell("search_time",
|
|
|
+ TableColumnAttributeBuilder.builder("search time", false)
|
|
|
+ .setAliases("stime")
|
|
|
+ .build())
|
|
|
+ .addCell("index_total",
|
|
|
+ TableColumnAttributeBuilder.builder("total number of indices", false)
|
|
|
+ .setAliases("it")
|
|
|
+ .build())
|
|
|
+ .addCell("index_failure",
|
|
|
+ TableColumnAttributeBuilder.builder("total number of index failures", false)
|
|
|
+ .setAliases("if")
|
|
|
+ .build())
|
|
|
+ .addCell("index_time",
|
|
|
+ TableColumnAttributeBuilder.builder("index time", false)
|
|
|
+ .setAliases("itime")
|
|
|
+ .build())
|
|
|
+ .addCell("document_total",
|
|
|
+ TableColumnAttributeBuilder.builder("total number of documents", false)
|
|
|
+ .setAliases("dt")
|
|
|
+ .build())
|
|
|
+ .addCell("invocation_total",
|
|
|
+ TableColumnAttributeBuilder.builder("total number of invocations", false)
|
|
|
+ .setAliases("itotal")
|
|
|
+ .build())
|
|
|
+ .addCell("page_total",
|
|
|
+ TableColumnAttributeBuilder.builder("total number of pages", false)
|
|
|
+ .setAliases("pt")
|
|
|
+ .build())
|
|
|
+ .addCell("checkpoint_duration_time_exp_avg",
|
|
|
+ TableColumnAttributeBuilder.builder("exponential average checkpoint processing time (milliseconds)", false)
|
|
|
+ .setAliases("cdtea", "checkpointTimeExpAvg")
|
|
|
+ .build())
|
|
|
+ .addCell("indexed_documents_exp_avg",
|
|
|
+ TableColumnAttributeBuilder.builder("exponential average number of documents indexed", false)
|
|
|
+ .setAliases("idea")
|
|
|
+ .build())
|
|
|
+ .addCell("processed_documents_exp_avg",
|
|
|
+ TableColumnAttributeBuilder.builder("exponential average number of documents processed", false)
|
|
|
+ .setAliases("pdea")
|
|
|
+ .build())
|
|
|
+ .endHeaders();
|
|
|
+ }
|
|
|
+
|
|
|
+ private Table buildTable(GetTransformAction.Response response, GetTransformStatsAction.Response statsResponse) {
|
|
|
+ Table table = getTableWithHeader();
|
|
|
+ Map<String, TransformStats> statsById = statsResponse.getTransformsStats().stream()
|
|
|
+ .collect(Collectors.toMap(TransformStats::getId, Function.identity()));
|
|
|
+ response.getTransformConfigurations().forEach(config -> {
|
|
|
+ TransformStats stats = statsById.get(config.getId());
|
|
|
+ TransformCheckpointingInfo checkpointingInfo = null;
|
|
|
+ TransformIndexerStats transformIndexerStats = null;
|
|
|
+
|
|
|
+ if(stats != null) {
|
|
|
+ checkpointingInfo = stats.getCheckpointingInfo();
|
|
|
+ transformIndexerStats = stats.getIndexerStats();
|
|
|
+ }
|
|
|
+
|
|
|
+ table
|
|
|
+ .startRow()
|
|
|
+ .addCell(config.getId())
|
|
|
+ .addCell(config.getCreateTime())
|
|
|
+ .addCell(config.getVersion())
|
|
|
+ .addCell(String.join(",", config.getSource().getIndex()))
|
|
|
+ .addCell(config.getDestination().getIndex())
|
|
|
+ .addCell(config.getDestination().getPipeline())
|
|
|
+ .addCell(config.getDescription())
|
|
|
+ .addCell(config.getSyncConfig() == null ? "batch" : "continuous")
|
|
|
+ .addCell(config.getFrequency() == null ? DEFAULT_TRANSFORM_FREQUENCY : config.getFrequency())
|
|
|
+ .addCell(config.getPivotConfig() == null || config.getPivotConfig().getMaxPageSearchSize() == null ?
|
|
|
+ DEFAULT_MAX_PAGE_SEARCH_SIZE : config.getPivotConfig().getMaxPageSearchSize())
|
|
|
+ .addCell(stats == null ? null : stats.getState())
|
|
|
+ .addCell(stats == null ? null : stats.getReason())
|
|
|
+ .addCell(checkpointingInfo == null ? null : checkpointingInfo.getChangesLastDetectedAt())
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getSearchTotal())
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getSearchFailures())
|
|
|
+ .addCell(transformIndexerStats == null ? null : TimeValue.timeValueMillis(transformIndexerStats.getSearchTime()))
|
|
|
+
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getIndexTotal())
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getIndexFailures())
|
|
|
+ .addCell(transformIndexerStats == null ? null : TimeValue.timeValueMillis(transformIndexerStats.getIndexTime()))
|
|
|
+
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getNumDocuments())
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getNumInvocations())
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getNumPages())
|
|
|
+
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getExpAvgCheckpointDurationMs())
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getExpAvgDocumentsIndexed())
|
|
|
+ .addCell(transformIndexerStats == null ? null : transformIndexerStats.getExpAvgDocumentsProcessed())
|
|
|
+ .endRow();
|
|
|
+ });
|
|
|
+
|
|
|
+ return table;
|
|
|
+ }
|
|
|
+}
|
zacharymorn