/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * Licensed to Elasticsearch under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch 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. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ package org.opensearch.transport; import org.opensearch.action.admin.cluster.node.liveness.TransportLivenessAction; import org.opensearch.common.network.NetworkService; import org.opensearch.common.settings.Setting; import org.opensearch.common.settings.Settings; import org.opensearch.core.common.unit.ByteSizeValue; import org.opensearch.common.unit.TimeValue; import java.util.Arrays; import java.util.List; import java.util.function.Function; import static java.util.Collections.emptyList; import static org.opensearch.common.settings.Setting.affixKeySetting; import static org.opensearch.common.settings.Setting.boolSetting; import static org.opensearch.common.settings.Setting.intSetting; import static org.opensearch.common.settings.Setting.listSetting; import static org.opensearch.common.settings.Setting.timeSetting; /** * Settings for transport config * * @opensearch.internal */ public final class TransportSettings { public static final String DEFAULT_PROFILE = "default"; public static final String FEATURE_PREFIX = "transport.features"; public static final Setting> HOST = listSetting( "transport.host", emptyList(), Function.identity(), Setting.Property.NodeScope ); public static final Setting> PUBLISH_HOST = listSetting( "transport.publish_host", HOST, Function.identity(), Setting.Property.NodeScope ); public static final Setting.AffixSetting> PUBLISH_HOST_PROFILE = affixKeySetting( "transport.profiles.", "publish_host", key -> listSetting(key, PUBLISH_HOST, Function.identity(), Setting.Property.NodeScope) ); public static final Setting> BIND_HOST = listSetting( "transport.bind_host", HOST, Function.identity(), Setting.Property.NodeScope ); public static final Setting.AffixSetting> BIND_HOST_PROFILE = affixKeySetting( "transport.profiles.", "bind_host", key -> listSetting(key, BIND_HOST, Function.identity(), Setting.Property.NodeScope) ); public static final Setting OLD_PORT = new Setting<>( "transport.tcp.port", "9300-9400", Function.identity(), Setting.Property.NodeScope, Setting.Property.Deprecated ); public static final Setting PORT = new Setting<>("transport.port", OLD_PORT, Function.identity(), Setting.Property.NodeScope); public static final Setting.AffixSetting PORT_PROFILE = affixKeySetting( "transport.profiles.", "port", key -> new Setting<>(key, PORT, Function.identity(), Setting.Property.NodeScope) ); public static final Setting PUBLISH_PORT = intSetting("transport.publish_port", -1, -1, Setting.Property.NodeScope); public static final Setting.AffixSetting PUBLISH_PORT_PROFILE = affixKeySetting( "transport.profiles.", "publish_port", key -> intSetting(key, -1, -1, Setting.Property.NodeScope) ); public static final Setting OLD_TRANSPORT_COMPRESS = boolSetting( "transport.tcp.compress", false, Setting.Property.NodeScope, Setting.Property.Deprecated ); public static final Setting TRANSPORT_COMPRESS = boolSetting( "transport.compress", OLD_TRANSPORT_COMPRESS, Setting.Property.NodeScope ); // the scheduled internal ping interval setting, defaults to disabled (-1) public static final Setting PING_SCHEDULE = timeSetting( "transport.ping_schedule", TimeValue.timeValueSeconds(-1), Setting.Property.NodeScope ); public static final Setting TCP_CONNECT_TIMEOUT = timeSetting( "transport.tcp.connect_timeout", NetworkService.TCP_CONNECT_TIMEOUT, Setting.Property.NodeScope, Setting.Property.Deprecated ); public static final Setting CONNECT_TIMEOUT = timeSetting( "transport.connect_timeout", TCP_CONNECT_TIMEOUT, Setting.Property.NodeScope ); public static final Setting DEFAULT_FEATURES_SETTING = Setting.groupSetting(FEATURE_PREFIX + ".", Setting.Property.NodeScope); // Tcp socket settings public static final Setting OLD_TCP_NO_DELAY = boolSetting( "transport.tcp_no_delay", NetworkService.TCP_NO_DELAY, Setting.Property.NodeScope, Setting.Property.Deprecated ); public static final Setting TCP_NO_DELAY = boolSetting("transport.tcp.no_delay", OLD_TCP_NO_DELAY, Setting.Property.NodeScope); public static final Setting.AffixSetting OLD_TCP_NO_DELAY_PROFILE = affixKeySetting( "transport.profiles.", "tcp_no_delay", key -> boolSetting(key, TCP_NO_DELAY, Setting.Property.NodeScope, Setting.Property.Deprecated) ); public static final Setting.AffixSetting TCP_NO_DELAY_PROFILE = affixKeySetting( "transport.profiles.", "tcp.no_delay", key -> boolSetting(key, fallback(key, OLD_TCP_NO_DELAY_PROFILE, "tcp\\.no_delay$", "tcp_no_delay"), Setting.Property.NodeScope) ); public static final Setting TCP_KEEP_ALIVE = boolSetting( "transport.tcp.keep_alive", NetworkService.TCP_KEEP_ALIVE, Setting.Property.NodeScope ); public static final Setting.AffixSetting OLD_TCP_KEEP_ALIVE_PROFILE = affixKeySetting( "transport.profiles.", "tcp_keep_alive", key -> boolSetting(key, TCP_KEEP_ALIVE, Setting.Property.NodeScope, Setting.Property.Deprecated) ); public static final Setting.AffixSetting TCP_KEEP_ALIVE_PROFILE = affixKeySetting( "transport.profiles.", "tcp.keep_alive", key -> boolSetting( key, fallback(key, OLD_TCP_KEEP_ALIVE_PROFILE, "tcp\\.keep_alive$", "tcp_keep_alive"), Setting.Property.NodeScope ) ); public static final Setting TCP_KEEP_IDLE = intSetting( "transport.tcp.keep_idle", NetworkService.TCP_KEEP_IDLE, -1, 300, Setting.Property.NodeScope ); public static final Setting.AffixSetting TCP_KEEP_IDLE_PROFILE = affixKeySetting( "transport.profiles.", "tcp.keep_idle", key -> intSetting(key, TCP_KEEP_IDLE, -1, 300, Setting.Property.NodeScope) ); public static final Setting TCP_KEEP_INTERVAL = intSetting( "transport.tcp.keep_interval", NetworkService.TCP_KEEP_INTERVAL, -1, 300, Setting.Property.NodeScope ); public static final Setting.AffixSetting TCP_KEEP_INTERVAL_PROFILE = affixKeySetting( "transport.profiles.", "tcp.keep_interval", key -> intSetting(key, TCP_KEEP_INTERVAL, -1, 300, Setting.Property.NodeScope) ); public static final Setting TCP_KEEP_COUNT = intSetting( "transport.tcp.keep_count", NetworkService.TCP_KEEP_COUNT, -1, Setting.Property.NodeScope ); public static final Setting.AffixSetting TCP_KEEP_COUNT_PROFILE = affixKeySetting( "transport.profiles.", "tcp.keep_count", key -> intSetting(key, TCP_KEEP_COUNT, -1, Setting.Property.NodeScope) ); public static final Setting TCP_REUSE_ADDRESS = boolSetting( "transport.tcp.reuse_address", NetworkService.TCP_REUSE_ADDRESS, Setting.Property.NodeScope ); public static final Setting.AffixSetting OLD_TCP_REUSE_ADDRESS_PROFILE = affixKeySetting( "transport.profiles.", "reuse_address", key -> boolSetting(key, TCP_REUSE_ADDRESS, Setting.Property.NodeScope, Setting.Property.Deprecated) ); public static final Setting.AffixSetting TCP_REUSE_ADDRESS_PROFILE = affixKeySetting( "transport.profiles.", "tcp.reuse_address", key -> boolSetting( key, fallback(key, OLD_TCP_REUSE_ADDRESS_PROFILE, "tcp\\.reuse_address$", "reuse_address"), Setting.Property.NodeScope ) ); public static final Setting TCP_SEND_BUFFER_SIZE = Setting.byteSizeSetting( "transport.tcp.send_buffer_size", NetworkService.TCP_SEND_BUFFER_SIZE, Setting.Property.NodeScope ); public static final Setting.AffixSetting OLD_TCP_SEND_BUFFER_SIZE_PROFILE = affixKeySetting( "transport.profiles.", "send_buffer_size", key -> Setting.byteSizeSetting(key, TCP_SEND_BUFFER_SIZE, Setting.Property.NodeScope, Setting.Property.Deprecated) ); public static final Setting.AffixSetting TCP_SEND_BUFFER_SIZE_PROFILE = affixKeySetting( "transport.profiles.", "tcp.send_buffer_size", key -> Setting.byteSizeSetting( key, fallback(key, OLD_TCP_SEND_BUFFER_SIZE_PROFILE, "tcp\\.send_buffer_size$", "send_buffer_size"), Setting.Property.NodeScope ) ); public static final Setting TCP_RECEIVE_BUFFER_SIZE = Setting.byteSizeSetting( "transport.tcp.receive_buffer_size", NetworkService.TCP_RECEIVE_BUFFER_SIZE, Setting.Property.NodeScope ); public static final Setting.AffixSetting OLD_TCP_RECEIVE_BUFFER_SIZE_PROFILE = affixKeySetting( "transport.profiles.", "receive_buffer_size", key -> Setting.byteSizeSetting(key, TCP_RECEIVE_BUFFER_SIZE, Setting.Property.NodeScope, Setting.Property.Deprecated) ); public static final Setting.AffixSetting TCP_RECEIVE_BUFFER_SIZE_PROFILE = affixKeySetting( "transport.profiles.", "tcp.receive_buffer_size", key -> Setting.byteSizeSetting( key, fallback(key, OLD_TCP_RECEIVE_BUFFER_SIZE_PROFILE, "tcp\\.receive_buffer_size$", "receive_buffer_size"), Setting.Property.NodeScope ) ); // Connections per node settings public static final Setting CONNECTIONS_PER_NODE_RECOVERY = intSetting( "transport.connections_per_node.recovery", 2, 1, Setting.Property.NodeScope ); public static final Setting CONNECTIONS_PER_NODE_BULK = intSetting( "transport.connections_per_node.bulk", 3, 1, Setting.Property.NodeScope ); public static final Setting CONNECTIONS_PER_NODE_REG = intSetting( "transport.connections_per_node.reg", 6, 1, Setting.Property.NodeScope ); public static final Setting CONNECTIONS_PER_NODE_STATE = intSetting( "transport.connections_per_node.state", 1, 1, Setting.Property.NodeScope ); public static final Setting CONNECTIONS_PER_NODE_PING = intSetting( "transport.connections_per_node.ping", 1, 1, Setting.Property.NodeScope ); // Tracer settings public static final Setting> TRACE_LOG_INCLUDE_SETTING = listSetting( "transport.tracer.include", emptyList(), Function.identity(), Setting.Property.Dynamic, Setting.Property.NodeScope ); public static final Setting> TRACE_LOG_EXCLUDE_SETTING = listSetting( "transport.tracer.exclude", Arrays.asList("internal:coordination/fault_detection/*", TransportLivenessAction.NAME), Function.identity(), Setting.Property.Dynamic, Setting.Property.NodeScope ); // Time that processing an inbound message on a transport thread may take at the most before a warning is logged public static final Setting SLOW_OPERATION_THRESHOLD_SETTING = Setting.positiveTimeSetting( "transport.slow_operation_logging_threshold", TimeValue.timeValueSeconds(5), Setting.Property.Dynamic, Setting.Property.NodeScope ); private TransportSettings() {} private static Setting fallback(String key, Setting.AffixSetting affixSetting, String regex, String replacement) { return "_na_".equals(key) ? affixSetting.getConcreteSettingForNamespace(key) : affixSetting.getConcreteSetting(key.replaceAll(regex, replacement)); } }