org.elasticsearch.cluster.RestoreInProgress Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch - Open Source, Distributed, RESTful Search Engine
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.cluster;
import org.elasticsearch.TransportVersion;
import org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotRequest;
import org.elasticsearch.cluster.ClusterState.Custom;
import org.elasticsearch.common.collect.Iterators;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.common.util.Maps;
import org.elasticsearch.index.shard.ShardId;
import org.elasticsearch.snapshots.Snapshot;
import org.elasticsearch.xcontent.ToXContent;
import java.io.IOException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
* Meta data about restore processes that are currently executing
*/
public class RestoreInProgress extends AbstractNamedDiffable implements Custom, Iterable {
public static final String TYPE = "restore";
public static final RestoreInProgress EMPTY = new RestoreInProgress(Map.of());
private final Map entries;
/**
* Constructs new restore metadata
*
* @param entries map of currently running restore processes keyed by their restore uuid
*/
private RestoreInProgress(Map entries) {
this.entries = entries;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
return entries.equals(((RestoreInProgress) o).entries);
}
@Override
public int hashCode() {
return entries.hashCode();
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder("RestoreInProgress[");
entries.entrySet()
.forEach(entry -> builder.append("{").append(entry.getKey()).append("}{").append(entry.getValue().snapshot).append("},"));
builder.setCharAt(builder.length() - 1, ']');
return builder.toString();
}
public Entry get(String restoreUUID) {
return entries.get(restoreUUID);
}
public boolean isEmpty() {
return entries.isEmpty();
}
@Override
public Iterator iterator() {
return entries.values().iterator();
}
public static final class Builder {
private final Map entries = new HashMap<>();
public Builder() {}
public Builder(RestoreInProgress restoreInProgress) {
entries.putAll(restoreInProgress.entries);
}
public Builder add(Entry entry) {
entries.put(entry.uuid, entry);
return this;
}
public RestoreInProgress build() {
return entries.isEmpty() ? EMPTY : new RestoreInProgress(Collections.unmodifiableMap(entries));
}
}
/**
* Restore metadata
*/
public record Entry(
String uuid,
Snapshot snapshot,
State state,
boolean quiet,
List indices,
Map shards
) {
/**
* Creates new restore metadata
*
* @param uuid uuid of the restore
* @param snapshot snapshot
* @param state current state of the restore process
* @param quiet {@code true} if logging of the start and completion of the snapshot restore should be at {@code DEBUG} log
* level, else it should be at {@code INFO} log level
* @param indices list of indices being restored
* @param shards map of shards being restored to their current restore status
*/
public Entry(
String uuid,
Snapshot snapshot,
State state,
boolean quiet,
List indices,
Map shards
) {
this.snapshot = Objects.requireNonNull(snapshot);
this.state = Objects.requireNonNull(state);
this.quiet = Objects.requireNonNull(quiet);
this.indices = Objects.requireNonNull(indices);
if (shards == null) {
this.shards = Map.of();
} else {
this.shards = shards;
}
this.uuid = Objects.requireNonNull(uuid);
}
}
/**
* Represents status of a restored shard
*/
public static class ShardRestoreStatus implements Writeable {
private State state;
private String nodeId;
private String reason;
private ShardRestoreStatus() {}
/**
* Constructs a new shard restore status in initializing state on the given node
*
* @param nodeId node id
*/
public ShardRestoreStatus(String nodeId) {
this(nodeId, State.INIT);
}
/**
* Constructs a new shard restore status in with specified state on the given node
*
* @param nodeId node id
* @param state restore state
*/
public ShardRestoreStatus(String nodeId, State state) {
this(nodeId, state, null);
}
/**
* Constructs a new shard restore status in with specified state on the given node with specified failure reason
*
* @param nodeId node id
* @param state restore state
* @param reason failure reason
*/
public ShardRestoreStatus(String nodeId, State state, String reason) {
this.nodeId = nodeId;
this.state = state;
this.reason = reason;
}
/**
* Returns current state
*
* @return current state
*/
public State state() {
return state;
}
/**
* Returns node id of the node where shared is getting restored
*
* @return node id
*/
public String nodeId() {
return nodeId;
}
/**
* Returns failure reason
*
* @return failure reason
*/
public String reason() {
return reason;
}
/**
* Reads restore status from stream input
*
* @param in stream input
* @return restore status
*/
public static ShardRestoreStatus readShardRestoreStatus(StreamInput in) throws IOException {
ShardRestoreStatus shardSnapshotStatus = new ShardRestoreStatus();
shardSnapshotStatus.readFrom(in);
return shardSnapshotStatus;
}
/**
* Reads restore status from stream input
*
* @param in stream input
*/
public void readFrom(StreamInput in) throws IOException {
nodeId = in.readOptionalString();
state = State.fromValue(in.readByte());
reason = in.readOptionalString();
}
/**
* Writes restore status to stream output
*
* @param out stream input
*/
@Override
public void writeTo(StreamOutput out) throws IOException {
out.writeOptionalString(nodeId);
out.writeByte(state.value);
out.writeOptionalString(reason);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ShardRestoreStatus status = (ShardRestoreStatus) o;
return state == status.state && Objects.equals(nodeId, status.nodeId) && Objects.equals(reason, status.reason);
}
@Override
public int hashCode() {
return Objects.hash(state, nodeId, reason);
}
}
/**
* Shard restore process state
*/
public enum State {
/**
* Initializing state
*/
INIT((byte) 0),
/**
* Started state
*/
STARTED((byte) 1),
/**
* Restore finished successfully
*/
SUCCESS((byte) 2),
/**
* Restore failed
*/
FAILURE((byte) 3);
private final byte value;
/**
* Constructs new state
*
* @param value state code
*/
State(byte value) {
this.value = value;
}
/**
* Returns state code
*
* @return state code
*/
public byte value() {
return value;
}
/**
* Returns true if restore process completed (either successfully or with failure)
*
* @return true if restore process completed
*/
public boolean completed() {
return this == SUCCESS || this == FAILURE;
}
/**
* Returns state corresponding to state code
*
* @param value stat code
* @return state
*/
public static State fromValue(byte value) {
return switch (value) {
case 0 -> INIT;
case 1 -> STARTED;
case 2 -> SUCCESS;
case 3 -> FAILURE;
default -> throw new IllegalArgumentException("No snapshot state for value [" + value + "]");
};
}
}
/**
* {@inheritDoc}
*/
@Override
public String getWriteableName() {
return TYPE;
}
@Override
public TransportVersion getMinimalSupportedVersion() {
return TransportVersion.MINIMUM_COMPATIBLE;
}
public static NamedDiff readDiffFrom(StreamInput in) throws IOException {
return readDiffFrom(Custom.class, TYPE, in);
}
public RestoreInProgress(StreamInput in) throws IOException {
int count = in.readVInt();
final Map entriesBuilder = Maps.newHashMapWithExpectedSize(count);
for (int i = 0; i < count; i++) {
final String uuid;
uuid = in.readString();
Snapshot snapshot = new Snapshot(in);
State state = State.fromValue(in.readByte());
boolean quiet;
if (in.getTransportVersion().onOrAfter(RestoreSnapshotRequest.VERSION_SUPPORTING_QUIET_PARAMETER)) {
quiet = in.readBoolean();
} else {
// Backwards compatibility: previously there was no logging of the start or completion of a snapshot restore
quiet = true;
}
List indices = in.readImmutableList(StreamInput::readString);
entriesBuilder.put(
uuid,
new Entry(
uuid,
snapshot,
state,
quiet,
indices,
in.readImmutableMap(ShardId::new, ShardRestoreStatus::readShardRestoreStatus)
)
);
}
this.entries = Collections.unmodifiableMap(entriesBuilder);
}
@Override
public void writeTo(StreamOutput out) throws IOException {
out.writeCollection(entries.values(), (o, entry) -> {
o.writeString(entry.uuid);
entry.snapshot().writeTo(o);
o.writeByte(entry.state().value());
if (out.getTransportVersion().onOrAfter(RestoreSnapshotRequest.VERSION_SUPPORTING_QUIET_PARAMETER)) {
o.writeBoolean(entry.quiet());
}
o.writeStringCollection(entry.indices);
o.writeMap(entry.shards);
});
}
@Override
public Iterator toXContentChunked(ToXContent.Params ignored) {
return Iterators.concat(
Iterators.single((builder, params) -> builder.startArray("snapshots")),
entries.values().stream().map(entry -> (builder, params) -> {
builder.startObject();
builder.field("snapshot", entry.snapshot().getSnapshotId().getName());
builder.field("repository", entry.snapshot().getRepository());
builder.field("state", entry.state());
builder.startArray("indices");
{
for (String index : entry.indices()) {
builder.value(index);
}
}
builder.endArray();
builder.startArray("shards");
{
for (Map.Entry shardEntry : entry.shards.entrySet()) {
ShardId shardId = shardEntry.getKey();
ShardRestoreStatus status = shardEntry.getValue();
builder.startObject();
{
builder.field("index", shardId.getIndex());
builder.field("shard", shardId.getId());
builder.field("state", status.state());
}
builder.endObject();
}
}
builder.endArray();
builder.endObject();
return builder;
}).iterator(),
Iterators.single((builder, params) -> builder.endArray())
);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy