Interface EventProcessor

  • All Superinterfaces:

    public interface EventProcessor
    Interface for an object that can send or store analytics events.

    Application code normally does not need to interact with this interface. It is provided to allow a custom implementation or test fixture to be substituted for the SDK's normal analytics event logic.

    • Method Detail

      • recordEvaluationEvent

        void recordEvaluationEvent​(LDContext context,
                                   java.lang.String flagKey,
                                   int flagVersion,
                                   int variation,
                                   LDValue value,
                                   EvaluationReason reason,
                                   LDValue defaultValue,
                                   java.lang.String prerequisiteOfFlagKey,
                                   boolean requireFullEvent,
                                   java.lang.Long debugEventsUntilDate,
                                   boolean excludeFromSummaries,
                                   java.lang.Long samplingRatio)
        Records the action of evaluating a feature flag.

        Depending on the feature flag properties and event properties, this may be transmitted to the events service as an individual event, or may only be added into summary data.

        context - the evaluation context
        flagKey - key of the feature flag that was evaluated
        flagVersion - the version of the flag, or NO_VERSION if the flag was not found
        variation - the result variation index, or EvaluationDetail.NO_VARIATION if evaluation failed
        value - the result value
        reason - the evaluation reason, or null if the reason was not requested
        defaultValue - the default value parameter for the evaluation
        prerequisiteOfFlagKey - the key of the flag that this flag was evaluated as a prerequisite of, or null if this flag was evaluated for itself
        requireFullEvent - true if full-fidelity analytics events should be sent for this flag
        debugEventsUntilDate - if non-null, debug events are to be generated until this millisecond time
        excludeFromSummaries - true if the event evaluation should not be included in summaries
        samplingRatio - ratio used to control event sampling
      • recordIdentifyEvent

        void recordIdentifyEvent​(LDContext context)
        Registers an evaluation context, as when the SDK's identify method is called.
        context - the evaluation context
      • recordCustomEvent

        void recordCustomEvent​(LDContext context,
                               java.lang.String eventKey,
                               LDValue data,
                               java.lang.Double metricValue)
        Creates a custom event, as when the SDK's track method is called.
        context - the evaluation context
        eventKey - the event key
        data - optional custom data provided for the event, may be null or LDValue.ofNull() if not used
        metricValue - optional numeric metric value provided for the event, or null
      • recordMigrationEvent

        void recordMigrationEvent​(MigrationOpTracker tracker)
        Creates a migration event when the SDK's trackMigration method is called.
        tracker - Migration tracker which was used to track details of the migration operation.
      • flush

        void flush()
        Specifies that any buffered events should be sent as soon as possible, rather than waiting for the next flush interval. This method is asynchronous, so events still may not be sent until a later time. However, calling Closeable.close() will synchronously deliver any events that were not yet delivered prior to shutting down.