Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Elasticsearch logging back-end.
Synopsis
- data ElasticSearchConfig
- esServer :: ElasticSearchConfig -> Text
- esIndex :: ElasticSearchConfig -> Text
- esShardCount :: ElasticSearchConfig -> Int
- esReplicaCount :: ElasticSearchConfig -> Int
- esMapping :: ElasticSearchConfig -> Text
- esLogin :: ElasticSearchConfig -> Maybe (Text, Text)
- esLoginInsecure :: ElasticSearchConfig -> Bool
- checkElasticSearchLogin :: MonadIO m => ElasticSearchConfig -> m ()
- checkElasticSearchConnection :: MonadIO m => ElasticSearchConfig -> m (Either HttpException ())
- defaultElasticSearchConfig :: ElasticSearchConfig
- withElasticSearchLogger :: MonadUnliftIO m => ElasticSearchConfig -> (Logger -> m r) -> m r
Documentation
data ElasticSearchConfig Source #
Configuration for the Elasticsearch Logger
. See
https://www.elastic.co/guide/en/elasticsearch/reference/current/glossary.html
for the explanation of terms.
Instances
esServer :: ElasticSearchConfig -> Text Source #
Elasticsearch server address.
esIndex :: ElasticSearchConfig -> Text Source #
Elasticsearch index name.
esShardCount :: ElasticSearchConfig -> Int Source #
Elasticsearch shard count for the named index.
Since: 0.10.0.0
esReplicaCount :: ElasticSearchConfig -> Int Source #
Elasticsearch replica count for the named index.
Since: 0.10.0.0
esMapping :: ElasticSearchConfig -> Text Source #
Elasticsearch mapping name (unused with ES >= 7.0.0)
esLogin :: ElasticSearchConfig -> Maybe (Text, Text) Source #
Elasticsearch basic authentication username and password.
esLoginInsecure :: ElasticSearchConfig -> Bool Source #
Allow basic authentication over non-TLS connections.
checkElasticSearchLogin :: MonadIO m => ElasticSearchConfig -> m () Source #
Check that login credentials are specified properly.
Since: 0.10.0.0
checkElasticSearchConnection :: MonadIO m => ElasticSearchConfig -> m (Either HttpException ()) Source #
Check that we can connect to the ES server.
Since: 0.10.0.0
defaultElasticSearchConfig :: ElasticSearchConfig Source #
Sensible defaults for ElasticSearchConfig
.
withElasticSearchLogger :: MonadUnliftIO m => ElasticSearchConfig -> (Logger -> m r) -> m r Source #
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.