1. 概述
本文主要分享 应用实例的覆盖状态属性。
这里要注意下,不是应用实例的状态( status
),而是覆盖状态( overridestatus
) 。代码如下:
public class InstanceInfo {
private volatile InstanceStatus overriddenstatus = InstanceStatus.UNKNOWN;
// ... 省略属性和方法
}
调用 Eureka-Server HTTP Restful 接口 apps/${APP_NAME}/${INSTANCE_ID}/status
对应用实例覆盖状态的变更,从而达到主动的、强制的变更应用实例状态。注意,实际不会真的修改 Eureka-Client 应用实例的状态,而是修改在 Eureka-Server 注册的应用实例的状态。
通过这样的方式,Eureka-Client 在获取到注册信息时,并且配置 eureka.shouldFilterOnlyUpInstances = true
,过滤掉非 InstanceStatus.UP
的应用实例,从而避免调动该实例,以达到应用实例的暂停服务( InstanceStatus.OUT_OF_SERVICE
),而无需关闭应用实例。
因此,大多数情况下,调用该接口的目的,将应用实例状态在 ( InstanceStatus.UP
) 和 ( InstanceStatus.OUT_OF_SERVICE
) 之间切换。引用官方代码上的注释如下:
AbstractInstanceRegistry#statusUpdate
方法注释 Updates the status of an instance. Normally happens to put an instance between {@link InstanceStatus#OUT_OF_SERVICE} and {@link InstanceStatus#UP} to put the instance in and out of traffic.
推荐 Spring Cloud 书籍:
推荐 Spring Cloud 视频:
接口 apps/${APP_NAME}/${INSTANCE_ID}/status
实际是两个:
apps/${APP_NAME}/${INSTANCE_ID}/status
apps/${APP_NAME}/${INSTANCE_ID}/status
下面,我们逐节分享这两接口的代码实现。
应用实例覆盖状态变更接口,映射 InstanceResource#statusUpdate()
方法,实现代码如下:
@PUT
@Path("status")
public Response statusUpdate(
@QueryParam("value") String newStatus,
@HeaderParam(PeerEurekaNode.HEADER_REPLICATION) String isReplication,
@QueryParam("lastDirtyTimestamp") String lastDirtyTimestamp) {
try {
// 应用实例不存在
if (registry.getInstanceByAppAndId(app.getName(), id) == null) {
logger.warn("Instance not found: {}/{}", app.getName(), id);
return Response.status(Status.NOT_FOUND).build();
}
// 覆盖状态更新
boolean isSuccess = registry.statusUpdate(app.getName(), id,
InstanceStatus.valueOf(newStatus), lastDirtyTimestamp,
"true".equals(isReplication));
// 返回结果
if (isSuccess) {
logger.info("Status updated: " + app.getName() + " - " + id
+ " - " + newStatus);
return Response.ok().build();
} else {
logger.warn("Unable to update status: " + app.getName() + " - "
+ id + " - " + newStatus);
return Response.serverError().build();
}
} catch (Throwable e) {
logger.error("Error updating instance {} for status {}", id,
newStatus);
return Response.serverError().build();
}
}
PeerAwareInstanceRegistryImpl#statusUpdate(...)
方法,更新应用实例覆盖状态。实现代码如下:
@Override public boolean statusUpdate(final String appName, final String id, final InstanceStatus newStatus, String lastDirtyTimestamp, final boolean isReplication) { if (super.statusUpdate(appName, id, newStatus, lastDirtyTimestamp, isReplication)) { // Eureka-Server 集群同步 replicateToPeers(Action.StatusUpdate, appName, id, null, newStatus, isReplication); return true; } return false; }AbstractInstanceRegistry#statusUpdate(…)
方法,更新应用实例覆盖状态。调用 AbstractInstanceRegistry#statusUpdate(...)
方法,更新应用实例覆盖状态,实现代码如下:
1: @Override
2: public boolean statusUpdate(String appName, String id,
3: InstanceStatus newStatus, String lastDirtyTimestamp,
4: boolean isReplication) {
5: try {
6: // 获取读锁
7: read.lock();
8: // 添加 覆盖状态变更次数 到 监控
9: STATUS_UPDATE.increment(isReplication);
10: // 获得 租约
11: Map<String, Lease<InstanceInfo>> gMap = registry.get(appName);
12: Lease<InstanceInfo> lease = null;
13: if (gMap != null) {
14: lease = gMap.get(id);
15: }
16: // 租约不存在
17: if (lease == null) {
18: return false;
19: } else {
20: // 设置 租约最后更新时间(续租)
21: lease.renew();
22:
23: // 应用实例信息不存在( 防御型编程 )
24: InstanceInfo info = lease.getHolder();
25: // Lease is always created with its instance info object.
26: // This log statement is provided as a safeguard, in case this invariant is violated.
27: if (info == null) {
28: logger.error("Found Lease without a holder for instance id {}", id);
29: }
30: //
31: if ((info != null) && !(info.getStatus().equals(newStatus))) {
32: // 设置 租约的开始服务的时间戳(只有第一次有效)
33: // Mark service as UP if needed
34: if (InstanceStatus.UP.equals(newStatus)) {
35: lease.serviceUp();
36: }
37: // 添加到 应用实例覆盖状态映射
38: // This is NAC overridden status
39: overriddenInstanceStatusMap.put(id, newStatus);
40: // 设置 应用实例覆盖状态
41: // Set it for transfer of overridden status to replica on
42: // replica start up
43: info.setOverriddenStatus(newStatus);
44: // 设置 应用实例信息 数据不一致时间
45: long replicaDirtyTimestamp = 0;
46: // 设置 应用实例状态
47: info.setStatusWithoutDirty(newStatus);
48: if (lastDirtyTimestamp != null) {
49: replicaDirtyTimestamp = Long.valueOf(lastDirtyTimestamp);
50: }
51: // If the replication's dirty timestamp is more than the existing one, just update
52: // it to the replica's.
53: if (replicaDirtyTimestamp > info.getLastDirtyTimestamp()) {
54: info.setLastDirtyTimestamp(replicaDirtyTimestamp);
55: }
56: // 添加到 最近租约变更记录队列
57: info.setActionType(ActionType.MODIFIED);
58: recentlyChangedQueue.add(new RecentlyChangedItem(lease));
59: // 设置 最后更新时间
60: info.setLastUpdatedTimestamp();
61: // 设置 响应缓存 过期
62: invalidateCache(appName, info.getVIPAddress(), info.getSecureVipAddress());
63: }
64: return true;
65: }
66: } finally {
67: // 释放锁
68: read.unlock();
69: }
70: }
InstanceStatus.UP
,设置租约的开始服务的时间戳(只有第一次有效)。overriddenInstanceStatusMap
)。此处英文 "NAC"
可能是 "Network Access Control"
的缩写,感兴趣的可以看看 《Network Access Control》 。overriddenInstanceStatusMap
属性代码如下:
/** * 应用实例覆盖状态映射 * key:应用实例编号 */ protected final ConcurrentMap<String, InstanceStatus> overriddenInstanceStatusMap = CacheBuilder .newBuilder().initialCapacity(500) .expireAfterAccess(1, TimeUnit.HOURS) .<String, InstanceStatus>build().asMap();lastUpdatedTimestamp
)。lastUpdatedTimestamp
主要用于记录最后更新时间,无实际业务用途。当我们不需要应用实例的覆盖状态时,调度接口接口进行删除。关联官方 issue#89
:Provide an API to remove all overridden status。
应用实例覆盖状态删除接口,映射 InstanceResource#deleteStatusUpdate()
方法,实现代码如下:
@DELETE
@Path("status")
public Response deleteStatusUpdate(
@HeaderParam(PeerEurekaNode.HEADER_REPLICATION) String isReplication,
@QueryParam("value") String newStatusValue,
@QueryParam("lastDirtyTimestamp") String lastDirtyTimestamp) {
try {
// 应用实例不存在
if (registry.getInstanceByAppAndId(app.getName(), id) == null) {
logger.warn("Instance not found: {}/{}", app.getName(), id);
return Response.status(Status.NOT_FOUND).build();
}
// 覆盖状态删除
InstanceStatus newStatus = newStatusValue == null ? InstanceStatus.UNKNOWN : InstanceStatus.valueOf(newStatusValue);
boolean isSuccess = registry.deleteStatusOverride(app.getName(), id,
newStatus, lastDirtyTimestamp, "true".equals(isReplication));
// 返回结果
if (isSuccess) {
logger.info("Status override removed: " + app.getName() + " - " + id);
return Response.ok().build();
} else {
logger.warn("Unable to remove status override: " + app.getName() + " - " + id);
return Response.serverError().build();
}
} catch (Throwable e) {
logger.error("Error removing instance's {} status override", id);
return Response.serverError().build();
}
}
newStatusValue
,设置应用实例的状态。大多数情况下,newStatusValue
要和应用实例实际的状态一致,因为该应用实例的 Eureka-Client 不会从 Eureka-Server 拉取到该应用状态 newStatusValue
。另外一种方式,不传递该参数,相当于 UNKNOWN
状态,这样,Eureka-Client 会主动向 Eureka-Server 再次发起注册,具体原因在 [「4.3 续租场景」] 详细解析,更加推荐的方式。AbstractInstanceRegistry#deleteStatusOverride(...)
方法,删除应用实例覆盖状态。实现代码如下:
@Override public boolean deleteStatusOverride(String appName, String id, InstanceStatus newStatus, String lastDirtyTimestamp, boolean isReplication) { if (super.deleteStatusOverride(appName, id, newStatus, lastDirtyTimestamp, isReplication)) { // Eureka-Server 集群同步 replicateToPeers(Action.DeleteStatusOverride, appName, id, null, null, isReplication); return true; } return false; }AbstractInstanceRegistry#deleteStatusOverride(…)
方法,删除应用实例覆盖状态。调用父类 AbstractInstanceRegistry#deleteStatusOverride(...)
方法,删除应用实例覆盖状态。实现代码如下:
1: @Override
2: public boolean deleteStatusOverride(String appName, String id,
3: InstanceStatus newStatus,
4: String lastDirtyTimestamp,
5: boolean isReplication) {
6: try {
7: // 获取读锁
8: read.lock();
9: // 添加 覆盖状态删除次数 到 监控
10: STATUS_OVERRIDE_DELETE.increment(isReplication);
11: // 获得 租约
12: Map<String, Lease<InstanceInfo>> gMap = registry.get(appName);
13: Lease<InstanceInfo> lease = null;
14: if (gMap != null) {
15: lease = gMap.get(id);
16: }
17: // 租约不存在
18: if (lease == null) {
19: return false;
20: } else {
21: // 设置 租约最后更新时间(续租)
22: lease.renew();
23:
24: // 应用实例信息不存在( 防御型编程 )
25: InstanceInfo info = lease.getHolder();
26: // Lease is always created with its instance info object.
27: // This log statement is provided as a safeguard, in case this invariant is violated.
28: if (info == null) {
29: logger.error("Found Lease without a holder for instance id {}", id);
30: }
31:
32: // 移除 应用实例覆盖状态
33: InstanceStatus currentOverride = overriddenInstanceStatusMap.remove(id);
34: if (currentOverride != null && info != null) {
35: // 设置 应用实例覆盖状态
36: info.setOverriddenStatus(InstanceStatus.UNKNOWN);
37: // 设置 应用实例状态
38: info.setStatusWithoutDirty(newStatus);
39: // 设置 应用实例信息 数据不一致时间
40: long replicaDirtyTimestamp = 0;
41: if (lastDirtyTimestamp != null) {
42: replicaDirtyTimestamp = Long.valueOf(lastDirtyTimestamp);
43: }
44: // If the replication's dirty timestamp is more than the existing one, just update
45: // it to the replica's.
46: if (replicaDirtyTimestamp > info.getLastDirtyTimestamp()) {
47: info.setLastDirtyTimestamp(replicaDirtyTimestamp);
48: }
49: // 添加到 最近租约变更记录队列
50: info.setActionType(ActionType.MODIFIED);
51: recentlyChangedQueue.add(new RecentlyChangedItem(lease));
52: // 设置 最后更新时间
53: info.setLastUpdatedTimestamp();
54: // 设置 响应缓存 过期
55: invalidateCache(appName, info.getVIPAddress(), info.getSecureVipAddress());
56: }
57: return true;
58: }
59: } finally {
60: // 释放锁
61: read.unlock();
62: }
63: }
overriddenInstanceStatusMap
)。newStatus
。设置后,Eureka-Client 拉取注册信息,被更新覆盖状态的应用实例就是设置的状态。lastUpdatedTimestamp
)。lastUpdatedTimestamp
主要用于记录最后更新时间,无实际业务用途。虽然我们在上面代码,使用覆盖状态( overridestatus
)设置到应用实例的状态( status
),实际调用 AbstractInstanceRegistry#getOverriddenInstanceStatus(...)
方法,根据应用实例状态覆盖规则( InstanceStatusOverrideRule )进行计算最终应用实例的状态。实现代码如下:
// AbstractInstanceRegistry.java
protected InstanceInfo.InstanceStatus getOverriddenInstanceStatus(InstanceInfo r,
Lease<InstanceInfo> existingLease,
boolean isReplication) {
InstanceStatusOverrideRule rule = getInstanceInfoOverrideRule();
logger.debug("Processing override status using rule: {}", rule);
return rule.apply(r, existingLease, isReplication).status();
}
protected abstract InstanceStatusOverrideRule getInstanceInfoOverrideRule();
#getInstanceInfoOverrideRule()
方法,获取应用实例状态覆盖规则( InstanceStatusOverrideRule )。在 PeerAwareInstanceRegistryImpl 里该方法实现代码如下:
private final InstanceStatusOverrideRule instanceStatusOverrideRule; public PeerAwareInstanceRegistryImpl( EurekaServerConfig serverConfig, EurekaClientConfig clientConfig, ServerCodecs serverCodecs, EurekaClient eurekaClient ) { // ... 省略其它方法this.instanceStatusOverrideRule = new FirstMatchWinsCompositeRule( new DownOrStartingRule(), new OverrideExistsRule(overriddenInstanceStatusMap), new LeaseExistsRule()); } @Override protected InstanceStatusOverrideRule getInstanceInfoOverrideRule() { return this.instanceStatusOverrideRule; }com.netflix.eureka.registry.rule.InstanceStatusOverrideRule
,应用实例状态覆盖规则接口。接口代码如下:
// InstanceStatusOverrideRule.java
public interface InstanceStatusOverrideRule {
/**
* Match this rule.
*
* @param instanceInfo The instance info whose status we care about. 关注状态的应用实例对象
* @param existingLease Does the instance have an existing lease already? If so let's consider that. 已存在的租约
* @param isReplication When overriding consider if we are under a replication mode from other servers. 是否是 Eureka-Server 发起的请求
* @return A result with whether we matched and what we propose the status to be overriden to.
*/
StatusOverrideResult apply(final InstanceInfo instanceInfo,
final Lease<InstanceInfo> existingLease,
boolean isReplication);
}
// StatusOverrideResult.java
public class StatusOverrideResult {
public static StatusOverrideResult NO_MATCH = new StatusOverrideResult(false, null);
public static StatusOverrideResult matchingStatus(InstanceInfo.InstanceStatus status) {
return new StatusOverrideResult(true, status);
}
// Does the rule match?
private final boolean matches;
// The status computed by the rule.
private final InstanceInfo.InstanceStatus status;
private StatusOverrideResult(boolean matches, InstanceInfo.InstanceStatus status) {
this.matches = matches;
this.status = status;
}
public boolean matches() {
return matches;
}
public InstanceInfo.InstanceStatus status() {
return status;
}
}
#apply(…)
方法参数 instanceInfo
代表的是关注状态的应用实例,和方法参数 existingLease
里的应用实例不一定是同一个,在 「4.1.6 总结」 详细解析。com.netflix.eureka.registry.rule.StatusOverrideResult
,状态覆盖结果。当匹配成功,返回 matches = true
;否则,返回 matches = false
。实现类关系如下:
com.netflix.eureka.registry.rule.FirstMatchWinsCompositeRule
,复合规则,以第一个匹配成功为准。实现代码如下:
// 超过微信限制 50000 字了
rules
属性,复合规则集合。在 PeerAwareInstanceRegistryImpl 里,我们可以看到该属性为 [ DownOrStartingRule , OverrideExistsRule , LeaseExistsRule ] 。defaultRule
属性,默认规则,值为 AlwaysMatchInstanceStatusRule 。#apply()
方法,优先使用复合规则( rules
),顺序匹配,直到匹配成功 。当未匹配成功,使用默认规则( defaultRule
) 。com.netflix.eureka.registry.rule.DownOrStartingRule
,匹配 InstanceInfo.InstanceStatus.DOWN
或者 InstanceInfo.InstanceStatus.STARTING
状态。实现 #apply(...)
代码如下:
// 超过微信限制 50000 字了
instanceInfo
。com.netflix.eureka.registry.rule.OverrideExistsRule
,匹配应用实例覆盖状态映射( statusOverrides
) 。实现 #apply(...)
代码如下:
// 超过微信限制 50000 字了
statusOverrides
属性,应用实例覆盖状态映射。在 PeerAwareInstanceRegistryImpl 里,使用 AbstractInstanceRegistry.overriddenInstanceStatusMap
属性赋值。AbstractInstanceRegistry.overriddenInstanceStatusMap
每次访问刷新有效期,如果调用到 OverrideExistsRule ,则会不断刷新。从 DownOrStartingRule 看到,instanceInfo
处于 InstanceInfo.InstanceStatus.DOWN
或者 InstanceInfo.InstanceStatus.STARTING
才不会继续调用 OverrideExistsRule 匹配,AbstractInstanceRegistry.overriddenInstanceStatusMap
才有可能过期。com.netflix.eureka.registry.rule.LeaseExistsRule
,匹配已存在租约的应用实例的 nstanceStatus.OUT_OF_SERVICE
或者 InstanceInfo.InstanceStatus.UP
状态。实现 #apply(...)
代码如下:
// 超过微信限制 50000 字了
existingLease
,并且非 Eureka-Server 请求。com.netflix.eureka.registry.rule.AlwaysMatchInstanceStatusRule
,总是匹配关注状态的实例对象( instanceInfo
)的状态。实现 #apply(...)
代码如下:
// 超过微信限制 50000 字了
instanceInfo
。我们将 PeerAwareInstanceRegistryImpl 的应用实例覆盖状态规则梳理如下:
instanceInfo
处于 STARTING
或者 DOWN
状态,应用实例可能不适合提供服务( 被请求 ),考虑可信赖,返回 instanceInfo
的状态。statusoverrides
) ,使用该状态,比较好理解。UP
或则 OUT_OF_SERVICE
,保留当前状态。原因,禁止 Eureka-Client 主动在这两个状态之间切换。如果要切换,使用应用实例覆盖状态变更与删除接口。instanceInfo
的状态返回,以保证能匹配到状态。#getOverriddenInstanceStatus()
方法会在注册和续租使用到。结合上图,我们在 「4.2 注册场景」 和 「4.3 续租场景」 也会详细解析。#getOverriddenInstanceStatus()
方法会在注册和续租使用到,方法参数 instanceInfo
情况如下:instanceInfo
,和 existingLease
的应用实例属性不相等( 如果考虑 Eureka-Server 的 LastDirtyTimestamp
更大的情况,则类似 续租时的情况 ) 。existingLease
的应用实例,两者相等。// AbstractInstanceRegistry.java
// 超过微信限制 50000 字了
existingLease
) 。lease
)。overridestatus
),避免注册应用实例后,丢失覆盖状态。registrant
和 existingLease
的应用实例不是同一个对象。// AbstractInstanceRegistry.java
// 超过微信限制 50000 字了
UNKNOWN
,无法续约 。返回 false
后,请求方( Eureka-Client 或者 Eureka-Server 集群其他节点 )会发起注册,在 《Eureka 源码解析 —— 应用实例注册发现(二)之续租》 有详细解析。为什么会是 `UNKNOWN` 呢?在 「3. 应用实例覆盖状态删除接口」 传递应用实例状态为 UNKNOWN
。#renew(…)
和 #statusUpdate(…)
可以无锁,并行执行,如果// AbstractInstanceRegistry.java
// 超过微信限制 50000 字了
同 「4.4 下线场景」 相同。
对应用实例覆盖状态的变更和删除接口调用,点击如下方法查看,非常易懂,本文就不啰嗦了: