Log.Backend.ElasticSearch.V1

Elasticsearch logging back-end.

Documentation

data ElasticSearchConfig

Configuration for the Elasticsearch Logger. See https://www.elastic.co/guide/en/elasticsearch/reference/current/glossary.html for the explanation of terms.

Instances

Eq ElasticSearchConfig

Defined in Log.Backend.ElasticSearch.V1.Internal

Methods

(==) :: ElasticSearchConfig -> ElasticSearchConfig -> Bool

(/=) :: ElasticSearchConfig -> ElasticSearchConfig -> Bool

Show ElasticSearchConfig

Defined in Log.Backend.ElasticSearch.V1.Internal

Methods

showsPrec :: Int -> ElasticSearchConfig -> ShowS

show :: ElasticSearchConfig -> String

showList :: [ElasticSearchConfig] -> ShowS

Generic ElasticSearchConfig

Defined in Log.Backend.ElasticSearch.V1.Internal

Associated Types

type Rep ElasticSearchConfig :: Type -> Type

Methods

from :: ElasticSearchConfig -> Rep ElasticSearchConfig x

to :: Rep ElasticSearchConfig x -> ElasticSearchConfig

type Rep ElasticSearchConfig

Defined in Log.Backend.ElasticSearch.V1.Internal

type Rep ElasticSearchConfig = D1 (MetaData "ElasticSearchConfig" "Log.Backend.ElasticSearch.V1.Internal" "log-elasticsearch-0.10.2.0-BvaIJ8UQ2BnHdbZBbmFHMM" False) (C1 (MetaCons "ElasticSearchConfig" PrefixI True) ((S1 (MetaSel (Just "esServer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "esIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "esShardCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))) :*: ((S1 (MetaSel (Just "esReplicaCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "esMapping") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "esLogin") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (EsUsername, EsPassword))) :*: S1 (MetaSel (Just "esLoginInsecure") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))

esServer :: ElasticSearchConfig -> Text

Elasticsearch server address.

esIndex :: ElasticSearchConfig -> Text

Elasticsearch index name.

esShardCount :: ElasticSearchConfig -> Int

Elasticsearch shard count for the named index.

Since: 0.10.0.0

esReplicaCount :: ElasticSearchConfig -> Int

Elasticsearch replica count for the named index.

Since: 0.10.0.0

esMapping :: ElasticSearchConfig -> Text

Elasticsearch mapping name.

esLogin :: ElasticSearchConfig -> Maybe (EsUsername, EsPassword)

Elasticsearch basic authentication username and password.

esLoginInsecure :: ElasticSearchConfig -> Bool

Allow basic authentication over non-TLS connections.

checkElasticSearchLogin :: ElasticSearchConfig -> IO (Either IOException ())

Check that login credentials are specified properly.

Since: 0.10.0.0

checkElasticSearchConnection :: ElasticSearchConfig -> IO (Either HttpException ())

Check that we can connect to the ES server.

Since: 0.10.0.0

defaultElasticSearchConfig :: ElasticSearchConfig

Sensible defaults for ElasticSearchConfig.

withElasticSearchLogger :: ElasticSearchConfig -> IO Word32 -> (Logger -> IO r) -> IO r

Create an elasticSearchLogger for the duration of the given action, and shut it down afterwards, making sure that all buffered messages are actually written to the Elasticsearch store.

elasticSearchLogger

Arguments

:: ElasticSearchConfig

Configuration.

-> IO Word32

Generate a random 32-bit word for use in document IDs.

-> IO Logger

Deprecated: Use withElasticSearchLogger instead!

Start an asynchronous logger thread that stores messages using Elasticsearch.

Please use withElasticSearchLogger instead, which is more exception-safe (see the note attached to mkBulkLogger).