View Source AbsintheFieldTelemetry.Backend.Redis (absinthe_field_telemetry v0.2.0)

Documentation for AbsintheFieldTelemetry.Backend.Redis

This backend uses the Redix library to connect to Redis.

The backend process is started by calling start_link:

AbsintheFieldTelemetry.Backend.Redis.start_link(
  expiry_ms: 60_000 * 10,
  redix_config: [host: "example.com", port: 5050]
)

Options are:

expiry_ms: Expiry time of buckets in milliseconds, used to set TTL on Redis keys. This configuration is mandatory.
redix_config: Keyword list of options to the Redix redis client, also aliased to redis_config
key_prefix: The prefix to use for all the redis keys (defaults to "AbsintheFieldTelemetry:Redis:")
redis_url: String url of redis server to connect to (optional, invokes Redix.start_link/2)

Summary

t()

Returns a specification to start this module under a supervisor.

stop()

@type t() :: %AbsintheFieldTelemetry.Backend.Redis{
  expiry_ms: integer() | nil,
  key_prefix: String.t() | nil,
  redix: pid() | nil
}

Returns a specification to start this module under a supervisor.

@spec start(keyword()) :: :ignore | {:error, any()} | {:ok, pid()}

@spec start_link(keyword()) :: :ignore | {:error, any()} | {:ok, pid()}

@spec stop() :: any()