Fact.EventDataIndexer (Fact v0.2.1)

Indexes events by the values of a specified field within event data.

Summary

id()

The id for a Fact.EventDataIndexer.

option()

Custom option values passed to the Fact.EventIndexer.index_event/3 callback function.

options()

Custom options passed to the Fact.EventIndexer.index_event/3 callback function.

Returns a specification to start this module under a supervisor.

Retrieves the value for the configured :indexer_key from the event's data payload.

indexer_name()

Gets the friendly name for the indexer.

Starts the indexer process.

(since 0.1.0)

@type id() :: {Fact.EventDataIndexer, Fact.EventIndexer.indexer_key()}

The id for a Fact.EventDataIndexer.

(since 0.1.0)

@type option() :: {:indexer_key, String.t()} | Fact.EventIndexer.indexer_option()

Custom option values passed to the Fact.EventIndexer.index_event/3 callback function.

(since 0.1.0)

@type options() :: [option()]

Custom options passed to the Fact.EventIndexer.index_event/3 callback function.

(since 0.1.0)

Returns a specification to start this module under a supervisor.

(since 0.1.0)

@spec index_event(Fact.event_schema(), Fact.event_record(), options()) ::
  String.t() | nil

Retrieves the value for the configured :indexer_key from the event's data payload.

(since 0.1.2)

@spec indexer_name() :: String.t()

Gets the friendly name for the indexer.

This is included in the file path where index files are stored on disk.

(since 0.1.0)

@spec start_link([Fact.EventIndexer.option()]) :: GenServer.on_start()

Starts the indexer process.