org.axonframework.eventsourcing

Class DefaultSnapshotterSpanFactory

java.lang.Object

org.axonframework.eventsourcing.DefaultSnapshotterSpanFactory

All Implemented Interfaces:

SnapshotterSpanFactory

public class DefaultSnapshotterSpanFactory
extends Object
implements SnapshotterSpanFactory

Default implementation of the SnapshotterSpanFactory. Can be configured to include the aggregate type in the span name (true by default) and to create a separate trace for the creation of the snapshot (false by default).

Since:

4.9.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultSnapshotterSpanFactory.Builder Builder class to instantiate a DefaultSnapshotterSpanFactory.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultSnapshotterSpanFactory(DefaultSnapshotterSpanFactory.Builder builder) Creates a new DefaultSnapshotterSpanFactory using the provided builder.

Method Summary

Modifier and Type	Method and Description
static DefaultSnapshotterSpanFactory.Builder	builder() Creates a new DefaultSnapshotterSpanFactory.Builder to build a DefaultSnapshotterSpanFactory with.
Span	createCreateSnapshotSpan(String aggregateType, String aggregateIdentifier) Creates a new Span that represents the actual creation of a snapshot.
Span	createScheduleSnapshotSpan(String aggregateType, String aggregateIdentifier) Creates a new Span that represents the scheduling of snapshot creation to the snapshotter's executor.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSnapshotterSpanFactory

protected DefaultSnapshotterSpanFactory(DefaultSnapshotterSpanFactory.Builder builder)

Creates a new DefaultSnapshotterSpanFactory using the provided builder.

Parameters:

builder - The builder to build the DefaultSnapshotterSpanFactory from.

Method Detail

createScheduleSnapshotSpan

public Span createScheduleSnapshotSpan(String aggregateType,
                                       String aggregateIdentifier)

Description copied from interface: SnapshotterSpanFactory

Creates a new Span that represents the scheduling of snapshot creation to the snapshotter's executor.

Specified by:

createScheduleSnapshotSpan in interface SnapshotterSpanFactory

Parameters:

aggregateType - The aggregate's type.

aggregateIdentifier - The aggregate's identifier.

Returns:

A Span representing the scheduling of snapshot creation.

createCreateSnapshotSpan

public Span createCreateSnapshotSpan(String aggregateType,
                                     String aggregateIdentifier)

Description copied from interface: SnapshotterSpanFactory

Creates a new Span that represents the actual creation of a snapshot. The creation of a snapshot might be done in a separate thread depending on the implementation of the Snapshotter.

Specified by:

createCreateSnapshotSpan in interface SnapshotterSpanFactory

Parameters:

aggregateType - The aggregate's type.

aggregateIdentifier - The aggregate's identifier.

Returns:

A Span representing the creation of a snapshot.

builder

public static DefaultSnapshotterSpanFactory.Builder builder()

Creates a new DefaultSnapshotterSpanFactory.Builder to build a DefaultSnapshotterSpanFactory with. The default values are:

• separateTrace defaults to true
• aggregateTypeInSpanName defaults to true

The spanFactory is a required field and should be provided.

Returns:

The DefaultSnapshotterSpanFactory.Builder to build a DefaultSnapshotterSpanFactory with.