Record Class ResilienceReport

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.resilience.ResilienceReport

Record Components:

specFingerprint - the analysed spec's fingerprint()

specName - the spec's name

portfolio - the analysed portfolio key

portfolioSource - where the portfolio came from (the optimiser's recommendation, or given)

dataAsOf - when the design facts were gathered

graph - the design graph

baseline - the design with nothing failed

singleFailures - every single failure, element failures first, then shared-fate events

pairs - what the N-2 simulation covered and its worst pairs

blastRadius - the single failures ranked worst first

singlePointsOfFailure - single elements whose loss causes an outage

correlatedRisks - redundant elements sharing a failure domain

n1 - the N-1 verdict (single-element failures; shared-fate events are reported, not counted)

n2 - the N-2 verdict over the simulated pairs

remediations - concrete changes, each tied to the scenarios it addresses

availability - estimated availability per workload

availabilityAssumptions - the per-element availabilities used and their source

assumptions - every assumption the analysis made

notes - what the reader should know about the run

timingsMs - where the time went, in ms, by phase

public record ResilienceReport(String specFingerprint, String specName, String portfolio, String portfolioSource, Instant dataAsOf, DesignGraph graph, ScenarioOutcome baseline, List<ScenarioOutcome> singleFailures, ResilienceFindings.PairSummary pairs, List<ResilienceFindings.RankedScenario> blastRadius, List<ResilienceFindings.SinglePointOfFailure> singlePointsOfFailure, List<ResilienceFindings.CorrelatedRisk> correlatedRisks, ResilienceFindings.NVerdict n1, ResilienceFindings.NVerdict n2, List<ResilienceFindings.Remediation> remediations, List<WorkloadAvailability> availability, AvailabilityAssumptions availabilityAssumptions, List<String> assumptions, List<String> notes, Map<String,Long> timingsMs)
extends Record

The resilience analysis of one design: its graph, what every failure scenario leaves working, the blast-radius ranking, single points of failure, correlated risks, N-1 and N-2 verdicts, estimated availability and remediation. Produced by ResilienceAnalyzer; Jackson-serialisable (toJson()) with a readable toMarkdown().

Constructor Summary

Constructors

Constructor

Description

ResilienceReport(String specFingerprint, String specName, String portfolio, String portfolioSource, Instant dataAsOf, DesignGraph graph, ScenarioOutcome baseline, List<ScenarioOutcome> singleFailures, ResilienceFindings.PairSummary pairs, List<ResilienceFindings.RankedScenario> blastRadius, List<ResilienceFindings.SinglePointOfFailure> singlePointsOfFailure, List<ResilienceFindings.CorrelatedRisk> correlatedRisks, ResilienceFindings.NVerdict n1, ResilienceFindings.NVerdict n2, List<ResilienceFindings.Remediation> remediations, List<WorkloadAvailability> availability, AvailabilityAssumptions availabilityAssumptions, List<String> assumptions, List<String> notes, Map<String,Long> timingsMs)

Makes the collections immutable and non-null.

Method Summary

Modifier and Type	Method	Description
List<String>	assumptions()	Returns the value of the assumptions record component.
List<WorkloadAvailability>	availability()	Returns the value of the availability record component.
AvailabilityAssumptions	availabilityAssumptions()	Returns the value of the availabilityAssumptions record component.
ScenarioOutcome	baseline()	Returns the value of the baseline record component.
List<ResilienceFindings.RankedScenario>	blastRadius()	Returns the value of the blastRadius record component.
List<ResilienceFindings.CorrelatedRisk>	correlatedRisks()	Returns the value of the correlatedRisks record component.
Instant	dataAsOf()	Returns the value of the dataAsOf record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
DesignGraph	graph()	Returns the value of the graph record component.
final int	hashCode()	Returns a hash code value for this object.
ResilienceFindings.NVerdict	n1()	Returns the value of the n1 record component.
ResilienceFindings.NVerdict	n2()	Returns the value of the n2 record component.
List<String>	notes()	Returns the value of the notes record component.
ScenarioOutcome	outcome(String scenarioId)
ResilienceFindings.PairSummary	pairs()	Returns the value of the pairs record component.
String	portfolio()	Returns the value of the portfolio record component.
String	portfolioSource()	Returns the value of the portfolioSource record component.
List<ResilienceFindings.Remediation>	remediations()	Returns the value of the remediations record component.
List<ScenarioOutcome>	singleFailures()	Returns the value of the singleFailures record component.
List<ResilienceFindings.SinglePointOfFailure>	singlePointsOfFailure()	Returns the value of the singlePointsOfFailure record component.
String	specFingerprint()	Returns the value of the specFingerprint record component.
String	specName()	Returns the value of the specName record component.
Map<String,Long>	timingsMs()	Returns the value of the timingsMs record component.
String	toJson()
String	toMarkdown()
final String	toString()	Returns a string representation of this record class.
String	toSummary()

Methods inherited from class Object

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

Constructor Details

ResilienceReport

public ResilienceReport(String specFingerprint,
 String specName,
 String portfolio,
 String portfolioSource,
 Instant dataAsOf,
 DesignGraph graph,
 ScenarioOutcome baseline,
 List<ScenarioOutcome> singleFailures,
 ResilienceFindings.PairSummary pairs,
 List<ResilienceFindings.RankedScenario> blastRadius,
 List<ResilienceFindings.SinglePointOfFailure> singlePointsOfFailure,
 List<ResilienceFindings.CorrelatedRisk> correlatedRisks,
 ResilienceFindings.NVerdict n1,
 ResilienceFindings.NVerdict n2,
 List<ResilienceFindings.Remediation> remediations,
 List<WorkloadAvailability> availability,
 AvailabilityAssumptions availabilityAssumptions,
 List<String> assumptions,
 List<String> notes,
 Map<String,Long> timingsMs)

Makes the collections immutable and non-null.

Method Details

outcome

public ScenarioOutcome outcome(String scenarioId)

Parameters:

scenarioId - a scenario id

Returns:

the single-failure outcome with that id, or null

toSummary

public String toSummary()

Returns:

a few sentences: portfolio, N-1, N-2, worst scenario, single points of failure, availability

toMarkdown

public String toMarkdown()

Returns:

a Markdown report: verdicts, scenario table, blast-radius ranking, single points of failure, correlated risks, N-2 summary, availability, remediation, the graph (Mermaid and table), assumptions, notes and timings

toJson

public String toJson()

Returns:

the report as indented JSON (ISO-8601 instants)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

specFingerprint

public String specFingerprint()

Returns the value of the specFingerprint record component.

Returns:

the value of the specFingerprint record component

specName

public String specName()

Returns the value of the specName record component.

Returns:

the value of the specName record component

portfolio

public String portfolio()

Returns the value of the portfolio record component.

Returns:

the value of the portfolio record component

portfolioSource

public String portfolioSource()

Returns the value of the portfolioSource record component.

Returns:

the value of the portfolioSource record component

dataAsOf

public Instant dataAsOf()

Returns the value of the dataAsOf record component.

Returns:

the value of the dataAsOf record component

graph

public DesignGraph graph()

Returns the value of the graph record component.

Returns:

the value of the graph record component

baseline

public ScenarioOutcome baseline()

Returns the value of the baseline record component.

Returns:

the value of the baseline record component

singleFailures

public List<ScenarioOutcome> singleFailures()

Returns the value of the singleFailures record component.

Returns:

the value of the singleFailures record component

pairs

public ResilienceFindings.PairSummary pairs()

Returns the value of the pairs record component.

Returns:

the value of the pairs record component

blastRadius

public List<ResilienceFindings.RankedScenario> blastRadius()

Returns the value of the blastRadius record component.

Returns:

the value of the blastRadius record component

singlePointsOfFailure

public List<ResilienceFindings.SinglePointOfFailure> singlePointsOfFailure()

Returns the value of the singlePointsOfFailure record component.

Returns:

the value of the singlePointsOfFailure record component

correlatedRisks

public List<ResilienceFindings.CorrelatedRisk> correlatedRisks()

Returns the value of the correlatedRisks record component.

Returns:

the value of the correlatedRisks record component

n1

public ResilienceFindings.NVerdict n1()

Returns the value of the n1 record component.

Returns:

the value of the n1 record component

n2

public ResilienceFindings.NVerdict n2()

Returns the value of the n2 record component.

Returns:

the value of the n2 record component

remediations

public List<ResilienceFindings.Remediation> remediations()

Returns the value of the remediations record component.

Returns:

the value of the remediations record component

availability

public List<WorkloadAvailability> availability()

Returns the value of the availability record component.

Returns:

the value of the availability record component

availabilityAssumptions

public AvailabilityAssumptions availabilityAssumptions()

Returns the value of the availabilityAssumptions record component.

Returns:

the value of the availabilityAssumptions record component

assumptions

public List<String> assumptions()

Returns the value of the assumptions record component.

Returns:

the value of the assumptions record component

notes

public List<String> notes()

Returns the value of the notes record component.

Returns:

the value of the notes record component

timingsMs

public Map<String,Long> timingsMs()

Returns the value of the timingsMs record component.

Returns:

the value of the timingsMs record component