Package com.yahoo.vespa.model.search
Class SearchNode
java.lang.Object
com.yahoo.config.model.producer.AnyConfigProducer
com.yahoo.config.model.producer.TreeConfigProducer<AnyConfigProducer>
com.yahoo.vespa.model.AbstractService
com.yahoo.vespa.model.search.SearchNode
- All Implemented Interfaces:
com.yahoo.cloud.config.filedistribution.FiledistributorrpcConfig.Producer
,com.yahoo.config.ConfigInstance.Producer
,com.yahoo.metrics.MetricsmanagerConfig.Producer
,com.yahoo.searchlib.TranslogserverConfig.Producer
,com.yahoo.vespa.config.search.core.ProtonConfig.Producer
,ConfigProducer
,NetworkPortRequestor
,SearchInterface
,Service
,Serializable
public class SearchNode
extends AbstractService
implements SearchInterface, com.yahoo.vespa.config.search.core.ProtonConfig.Producer, com.yahoo.cloud.config.filedistribution.FiledistributorrpcConfig.Producer, com.yahoo.metrics.MetricsmanagerConfig.Producer, com.yahoo.searchlib.TranslogserverConfig.Producer
Represents a search node (proton).
Due to the current disconnect between StorageNode and SearchNode, we have to duplicate the set of RestartConfigs classes from StorageNode here, as SearchNode runs in a content/storage node context without this being immediately obvious in the model.
- Author:
- arnej27959, hmusum
- See Also:
-
Nested Class Summary
-
Field Summary
Fields inherited from class com.yahoo.vespa.model.AbstractService
portsMeta
Fields inherited from class com.yahoo.config.model.producer.AnyConfigProducer
log
-
Method Summary
Modifier and TypeMethodDescriptionvoid
allocatePorts
(int start, PortAllocBridge from) allocate the ports you needstatic SearchNode
create
(TreeConfigProducer<?> parent, String name, int distributionKey, NodeSpec nodeSpec, String clusterName, AbstractService serviceLayerService, boolean flushOnShutdown, Optional<Tuning> tuning, Optional<ResourceLimits> resourceLimits, boolean isHostedVespa, double fractionOfMemoryReserved, com.yahoo.config.model.api.ModelContext.FeatureFlags featureFlags) void
getConfig
(com.yahoo.cloud.config.filedistribution.FiledistributorrpcConfig.Builder builder) void
getConfig
(com.yahoo.metrics.MetricsmanagerConfig.Builder builder) void
getConfig
(com.yahoo.searchlib.TranslogserverConfig.Builder builder) void
getConfig
(com.yahoo.vespa.config.search.core.ProtonConfig.Builder builder) Overridden by subclasses.int
int
The service HTTP port for health statusint
Returns the number of ports needed by this service.Services that wish that a command should be run before shutdown should return the command here.int
Returns the RPC port used by this searchnode.Returns the type of service.Must be overridden by services that should be started by config-sentinel.void
toString()
Methods inherited from class com.yahoo.vespa.model.AbstractService
addEnvironmentVariable, addEnvironmentVariable, appendJvmOptions, defaultPreload, distributeCpuSocketAffinity, getAffinity, getEnvStringForTesting, getEnvVars, getHost, getHostName, getHostResource, getId, getIndex, getJvmOptions, getNumPortsAllocated, getPortsMeta, getPreLoad, getRelativePort, getServiceInfo, getServiceName, getServicePropertyString, getServicePropertyString, getWantedPort, initService, isInitialized, prependJvmOptions, remove, requiresWantedPort, setAffinity, setBasePort, setCoreOnOOM, setHostResource, setJvmOptions, setMMapNoCoreLimit, setNoVespaMalloc, setPreLoad, setProp, setProp, setVespaMalloc, setVespaMallocDebug, setVespaMallocDebugStackTrace
Methods inherited from class com.yahoo.config.model.producer.TreeConfigProducer
addChild, addDescendantService, getChildren, getChildrenByTypeRecursive, getConfigClassLoader, getDescendantServices, removeChild, validate
Methods inherited from class com.yahoo.config.model.producer.AnyConfigProducer
addConfigId, addUserConfig, cascadeConfig, currentConfigId, findInheritedClassLoader, getConfigId, getMonitoringService, getParent, getRoot, getSubId, getUserConfigs, hostSystem, mergeUserConfigs, setParent, setUserConfigs, stateIsHosted
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.yahoo.vespa.model.ConfigProducer
addUserConfig, cascadeConfig, dump, getChildren, getConfigId, getDescendantServices, getUserConfigs, hostSystem, validate
Methods inherited from interface com.yahoo.vespa.model.NetworkPortRequestor
getConfigId
Methods inherited from interface com.yahoo.vespa.model.search.SearchInterface
getHostName
Methods inherited from interface com.yahoo.vespa.model.Service
getLogctlSpecs
-
Method Details
-
create
public static SearchNode create(TreeConfigProducer<?> parent, String name, int distributionKey, NodeSpec nodeSpec, String clusterName, AbstractService serviceLayerService, boolean flushOnShutdown, Optional<Tuning> tuning, Optional<ResourceLimits> resourceLimits, boolean isHostedVespa, double fractionOfMemoryReserved, com.yahoo.config.model.api.ModelContext.FeatureFlags featureFlags) -
getClusterName
-
getNodeSpec
- Specified by:
getNodeSpec
in interfaceSearchInterface
-
allocatePorts
Description copied from interface:NetworkPortRequestor
allocate the ports you need- Specified by:
allocatePorts
in interfaceNetworkPortRequestor
-
getPortCount
public int getPortCount()Returns the number of ports needed by this service.- Specified by:
getPortCount
in interfaceNetworkPortRequestor
- Returns:
- The number of ports.
-
getRpcPort
public int getRpcPort()Returns the RPC port used by this searchnode.- Returns:
- The port.
-
getHealthPort
public int getHealthPort()Description copied from class:AbstractService
The service HTTP port for health status- Specified by:
getHealthPort
in interfaceService
- Overrides:
getHealthPort
in classAbstractService
-
getServiceType
Description copied from class:AbstractService
Returns the type of service. This is the class name without the package prefix by default, never null- Specified by:
getServiceType
in interfaceNetworkPortRequestor
- Overrides:
getServiceType
in classAbstractService
-
getDistributionKey
public int getDistributionKey() -
getConfig
public void getConfig(com.yahoo.searchlib.TranslogserverConfig.Builder builder) - Specified by:
getConfig
in interfacecom.yahoo.searchlib.TranslogserverConfig.Producer
-
toString
- Overrides:
toString
in classAbstractService
-
setTls
-
getServiceLayerService
-
getStartupCommand
Description copied from class:AbstractService
Must be overridden by services that should be started by config-sentinel. The returned value will be used in config-sentinel configuration. Returns empty by default.- Specified by:
getStartupCommand
in interfaceService
- Overrides:
getStartupCommand
in classAbstractService
- Returns:
- empty by default.
-
getConfig
public void getConfig(com.yahoo.cloud.config.filedistribution.FiledistributorrpcConfig.Builder builder) - Specified by:
getConfig
in interfacecom.yahoo.cloud.config.filedistribution.FiledistributorrpcConfig.Producer
-
getConfig
public void getConfig(com.yahoo.vespa.config.search.core.ProtonConfig.Builder builder) - Specified by:
getConfig
in interfacecom.yahoo.vespa.config.search.core.ProtonConfig.Producer
-
getDefaultMetricDimensions
Description copied from class:AbstractService
Overridden by subclasses. List of default dimensions to be added to this services metrics- Specified by:
getDefaultMetricDimensions
in interfaceService
- Overrides:
getDefaultMetricDimensions
in classAbstractService
- Returns:
- the default dimensions for this service
-
getConfig
public void getConfig(com.yahoo.metrics.MetricsmanagerConfig.Builder builder) - Specified by:
getConfig
in interfacecom.yahoo.metrics.MetricsmanagerConfig.Producer
-
getPreShutdownCommand
Description copied from interface:Service
Services that wish that a command should be run before shutdown should return the command here. The command will be executed by the config sentinel before sending SIGTERM to the service. The command is executed without a timeout.- Specified by:
getPreShutdownCommand
in interfaceService
- Overrides:
getPreShutdownCommand
in classAbstractService
-