com.gremlin

Class GremlinCoordinatesProvider

java.lang.Object

com.gremlin.GremlinCoordinatesProvider

Direct Known Subclasses:

ContextAwareGremlinCoordinatesProvider

public abstract class GremlinCoordinatesProvider
extends java.lang.Object

This class is the way to tell Gremlin about the attributes you care about when creating attacks. The initializeApplicationCoordinates(Optional) is invoked at the beginning of your application lifecycle. You can uniquely identify your application to Gremlin, and then use those attributes when scoping your attack. The extendEachTrafficCoordinates(TrafficCoordinates) is invoked each time your application encounters a possible fault-injection point. If you have a cross-cutting concern (like userId/deviceId), you may attach it to all TrafficCoordinates using this.

Constructor Summary

Constructors

Constructor and Description
GremlinCoordinatesProvider()

Method Summary

Modifier and Type	Method and Description
TrafficCoordinates	extendEachTrafficCoordinates(TrafficCoordinates incomingCoordinates) For every set of TrafficCoordinates, extend the set of attributes.
ApplicationCoordinates	initializeApplicationCoordinates(java.util.Optional<ApplicationCoordinates> autoDiscoveredCoordinates) Identify the application to Gremlin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GremlinCoordinatesProvider

public GremlinCoordinatesProvider()

Method Detail

initializeApplicationCoordinates

public ApplicationCoordinates initializeApplicationCoordinates(java.util.Optional<ApplicationCoordinates> autoDiscoveredCoordinates)

Identify the application to Gremlin. Each ApplicationCoordinates must have a type (ApplicationType) and a set of key-values pairs which uniquely identify the application

Parameters:

autoDiscoveredCoordinates - In some cases, Gremlin will look at environment metadata to populate ApplicationCoordinates for you. You may use them as-is or add to them

Returns:

the updated coordinates

extendEachTrafficCoordinates

public TrafficCoordinates extendEachTrafficCoordinates(TrafficCoordinates incomingCoordinates)

For every set of TrafficCoordinates, extend the set of attributes. Each added attribute is then available to match on when creating blast radius. Since this happens for each TrafficCoordinates, this is a convenient way to tell Gremlin about pieces of data that are in every request (Ex: customer, country, device, etc) For example, if you add "CUSTOMER_ID" as a traffic attribute (via `coordinates.put("CUSTOMER_ID", myCustomerId)`), then you can use "CUSTOMER_ID" in the Gremlin UI to target attacks

Parameters:

incomingCoordinates - key-value map describing the traffic

Returns:

the updated coordinates