org.springframework.boot.actuate.autoconfigure.availability.AvailabilityProbesHealthEndpointGroups Maven / Gradle / Ivy
/*
* Copyright 2012-2022 the original author or authors.
*
* Licensed 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
*
* https://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.springframework.boot.actuate.autoconfigure.availability;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import org.springframework.boot.actuate.endpoint.web.WebServerNamespace;
import org.springframework.boot.actuate.health.AdditionalHealthEndpointPath;
import org.springframework.boot.actuate.health.HealthEndpointGroup;
import org.springframework.boot.actuate.health.HealthEndpointGroups;
import org.springframework.util.Assert;
/**
* {@link HealthEndpointGroups} decorator to support availability probes.
*
* @author Phillip Webb
* @author Brian Clozel
* @author Madhura Bhave
*/
class AvailabilityProbesHealthEndpointGroups implements HealthEndpointGroups {
private final HealthEndpointGroups groups;
private final Map probeGroups;
private final Set names;
private static final String LIVENESS = "liveness";
private static final String READINESS = "readiness";
AvailabilityProbesHealthEndpointGroups(HealthEndpointGroups groups, boolean addAdditionalPaths) {
Assert.notNull(groups, "Groups must not be null");
this.groups = groups;
this.probeGroups = createProbeGroups(addAdditionalPaths);
Set names = new LinkedHashSet<>(groups.getNames());
names.addAll(this.probeGroups.keySet());
this.names = Collections.unmodifiableSet(names);
}
private Map createProbeGroups(boolean addAdditionalPaths) {
Map probeGroups = new LinkedHashMap<>();
probeGroups.put(LIVENESS, getOrCreateProbeGroup(addAdditionalPaths, LIVENESS, "/livez", "livenessState"));
probeGroups.put(READINESS, getOrCreateProbeGroup(addAdditionalPaths, READINESS, "/readyz", "readinessState"));
return Collections.unmodifiableMap(probeGroups);
}
private HealthEndpointGroup getOrCreateProbeGroup(boolean addAdditionalPath, String name, String path,
String members) {
HealthEndpointGroup group = this.groups.get(name);
if (group != null) {
return determineAdditionalPathForExistingGroup(addAdditionalPath, path, group);
}
AdditionalHealthEndpointPath additionalPath = (!addAdditionalPath) ? null
: AdditionalHealthEndpointPath.of(WebServerNamespace.SERVER, path);
return new AvailabilityProbesHealthEndpointGroup(additionalPath, members);
}
private HealthEndpointGroup determineAdditionalPathForExistingGroup(boolean addAdditionalPath, String path,
HealthEndpointGroup group) {
if (addAdditionalPath && group.getAdditionalPath() == null) {
AdditionalHealthEndpointPath additionalPath = AdditionalHealthEndpointPath.of(WebServerNamespace.SERVER,
path);
return new DelegatingAvailabilityProbesHealthEndpointGroup(group, additionalPath);
}
return group;
}
@Override
public HealthEndpointGroup getPrimary() {
return this.groups.getPrimary();
}
@Override
public Set getNames() {
return this.names;
}
@Override
public HealthEndpointGroup get(String name) {
HealthEndpointGroup group = this.groups.get(name);
if (group == null || isProbeGroup(name)) {
group = this.probeGroups.get(name);
}
return group;
}
private boolean isProbeGroup(String name) {
return name.equals(LIVENESS) || name.equals(READINESS);
}
}