Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.slm

Class SnapshotLifecycleStats

java.lang.Object

org.elasticsearch.xpack.core.slm.SnapshotLifecycleStats

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class SnapshotLifecycleStats
extends Object
implements Writeable, ToXContentObject

SnapshotLifecycleStats contains metrics and stats about snapshot lifecycle policy execution - how many snapshots were taken, deleted, how many failures, etc. It contains both global stats (snapshots taken, retention runs), and per-policy stats.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotLifecycleStats.SnapshotPolicyStats

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	POLICY_STATS
static final ParseField	RETENTION_FAILED
static final ParseField	RETENTION_RUNS
static final ParseField	RETENTION_TIME
static final ParseField	RETENTION_TIME_MILLIS
static final ParseField	RETENTION_TIMED_OUT
static final ParseField	TOTAL_DELETION_FAILURES
static final ParseField	TOTAL_DELETIONS
static final ParseField	TOTAL_FAILED
static final ParseField	TOTAL_TAKEN

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotLifecycleStats()
SnapshotLifecycleStats(long retentionRuns, long retentionFailed, long retentionTimedOut, long retentionTimeMs, Map<String,SnapshotLifecycleStats.SnapshotPolicyStats> policyStats)
SnapshotLifecycleStats(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<String,SnapshotLifecycleStats.SnapshotPolicyStats>	getMetrics()
int	hashCode()
SnapshotLifecycleStats	merge(SnapshotLifecycleStats other)
static SnapshotLifecycleStats	parse(XContentParser parser)
SnapshotLifecycleStats	removePolicy(String policyId)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
SnapshotLifecycleStats	withDeletedIncremented(String slmPolicy)	Return new stats with the per-policy snapshot deleted count for the given policy id incremented
SnapshotLifecycleStats	withDeleteFailureIncremented(String slmPolicy)	Return new stats with the per-policy snapshot deletion failure count for the given policy id incremented
SnapshotLifecycleStats	withDeletionTimeUpdated(TimeValue elapsedTime)	Return new stats with the amount of time taken for deleting snapshots during SLM retention updated
SnapshotLifecycleStats	withFailedIncremented(String slmPolicy)	Return new stats with the per-policy snapshot failure count for the given policy id incremented
SnapshotLifecycleStats	withRetentionFailedIncremented()	Return new stats with number of times SLM retention has failed incremented
SnapshotLifecycleStats	withRetentionRunIncremented()	Return new stats with number of times SLM retention has been run incremented
SnapshotLifecycleStats	withRetentionTimedOutIncremented()	Return new stats the number of times that SLM retention timed out due to the max delete time window being exceeded incremented
SnapshotLifecycleStats	withTakenIncremented(String slmPolicy)	Return new stats with the per-policy snapshot taken count for the given policy id incremented
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

RETENTION_RUNS

public static final ParseField RETENTION_RUNS

RETENTION_FAILED

public static final ParseField RETENTION_FAILED

RETENTION_TIMED_OUT

public static final ParseField RETENTION_TIMED_OUT

RETENTION_TIME

public static final ParseField RETENTION_TIME

RETENTION_TIME_MILLIS

public static final ParseField RETENTION_TIME_MILLIS

POLICY_STATS

public static final ParseField POLICY_STATS

TOTAL_TAKEN

public static final ParseField TOTAL_TAKEN

TOTAL_FAILED

public static final ParseField TOTAL_FAILED

TOTAL_DELETIONS

public static final ParseField TOTAL_DELETIONS

TOTAL_DELETION_FAILURES

public static final ParseField TOTAL_DELETION_FAILURES

Constructor Details

SnapshotLifecycleStats

public SnapshotLifecycleStats()

SnapshotLifecycleStats

public SnapshotLifecycleStats(long retentionRuns,
 long retentionFailed,
 long retentionTimedOut,
 long retentionTimeMs,
 Map<String,SnapshotLifecycleStats.SnapshotPolicyStats> policyStats)

SnapshotLifecycleStats

public SnapshotLifecycleStats(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

parse

public static SnapshotLifecycleStats parse(XContentParser parser)

merge

public SnapshotLifecycleStats merge(SnapshotLifecycleStats other)

removePolicy

public SnapshotLifecycleStats removePolicy(String policyId)

getMetrics

public Map<String,SnapshotLifecycleStats.SnapshotPolicyStats> getMetrics()

Returns:

a map of per-policy stats for each SLM policy

withRetentionRunIncremented

public SnapshotLifecycleStats withRetentionRunIncremented()

Return new stats with number of times SLM retention has been run incremented

withRetentionFailedIncremented

public SnapshotLifecycleStats withRetentionFailedIncremented()

Return new stats with number of times SLM retention has failed incremented

withRetentionTimedOutIncremented

public SnapshotLifecycleStats withRetentionTimedOutIncremented()

Return new stats the number of times that SLM retention timed out due to the max delete time window being exceeded incremented

withDeletionTimeUpdated

public SnapshotLifecycleStats withDeletionTimeUpdated(TimeValue elapsedTime)

Return new stats with the amount of time taken for deleting snapshots during SLM retention updated

withTakenIncremented

public SnapshotLifecycleStats withTakenIncremented(String slmPolicy)

Return new stats with the per-policy snapshot taken count for the given policy id incremented

withFailedIncremented

public SnapshotLifecycleStats withFailedIncremented(String slmPolicy)

Return new stats with the per-policy snapshot failure count for the given policy id incremented

withDeletedIncremented

public SnapshotLifecycleStats withDeletedIncremented(String slmPolicy)

Return new stats with the per-policy snapshot deleted count for the given policy id incremented

withDeleteFailureIncremented

public SnapshotLifecycleStats withDeleteFailureIncremented(String slmPolicy)

Return new stats with the per-policy snapshot deletion failure count for the given policy id incremented

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object