Log.Backend.ElasticSearch.Internal

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.

Constructors

ElasticSearchConfig

Fields

• esServer :: !Text

  Elasticsearch server address.

• esIndex :: !Text

  Elasticsearch index name.

• esShardCount :: !Int

  Elasticsearch shard count for the named index.

  Since: 0.10.0.0

• esReplicaCount :: !Int

  Elasticsearch replica count for the named index.

  Since: 0.10.0.0

• esMapping :: !Text

  Elasticsearch mapping name (unused with ES >= 7.0.0)

• esLogin :: Maybe (Text, Text)

  Elasticsearch basic authentication username and password.

• esLoginInsecure :: !Bool

  Allow basic authentication over non-TLS connections.

Instances

Eq ElasticSearchConfig

Defined in Log.Backend.ElasticSearch.Internal

Methods

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

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

Show ElasticSearchConfig

Defined in Log.Backend.ElasticSearch.Internal

Methods

showsPrec :: Int -> ElasticSearchConfig -> ShowS

show :: ElasticSearchConfig -> String

showList :: [ElasticSearchConfig] -> ShowS

Generic ElasticSearchConfig

Defined in Log.Backend.ElasticSearch.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.Internal

type Rep ElasticSearchConfig = D1 (MetaData "ElasticSearchConfig" "Log.Backend.ElasticSearch.Internal" "log-elasticsearch-0.11.0.0-83gOSAGjoIuJ97hGawziW6" 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 (Text, Text))) :*: S1 (MetaSel (Just "esLoginInsecure") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))

defaultElasticSearchConfig :: ElasticSearchConfig

Sensible defaults for ElasticSearchConfig.

ES version

data EsVersion

Constructors

EsVersion !Int !Int !Int

Instances

Eq EsVersion

Defined in Log.Backend.ElasticSearch.Internal

Methods

(==) :: EsVersion -> EsVersion -> Bool

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

Ord EsVersion

Defined in Log.Backend.ElasticSearch.Internal

Methods

compare :: EsVersion -> EsVersion -> Ordering

(<) :: EsVersion -> EsVersion -> Bool

(<=) :: EsVersion -> EsVersion -> Bool

(>) :: EsVersion -> EsVersion -> Bool

(>=) :: EsVersion -> EsVersion -> Bool

max :: EsVersion -> EsVersion -> EsVersion

min :: EsVersion -> EsVersion -> EsVersion

parseEsVersion :: Value -> Maybe EsVersion

esV5 :: EsVersion

Minimum version with split string type.

esV7 :: EsVersion

Minimum version without mapping types.

ES commands

serverInfo :: EsEnv -> IO (Either HttpException (Response Value))

Check the ElasticSearch server for info. Result can be fed to parseEsVersion to determine version of the server.

indexExists :: EsEnv -> Text -> IO Bool

Check that given index exists.

createIndexWithMapping :: EsVersion -> EsEnv -> ElasticSearchConfig -> Text -> IO (Response Value)

Create an index with given mapping.

bulkIndex :: EsVersion -> EsEnv -> ElasticSearchConfig -> Text -> Vector (HashMap Text Value) -> IO (Response Value)

refreshIndex :: EsEnv -> Text -> IO ()

ES communication details

data EsEnv

Constructors

EsEnv

Fields

• envServer :: !Text
• envManager :: !Manager
• envRequestHook :: !(Request -> Request)

mkEsEnv :: ElasticSearchConfig -> IO EsEnv

dispatch :: EsEnv -> Method -> [Text] -> Maybe ByteString -> IO (Response Value)

decodeReply :: ByteString -> Value

isSuccess :: Response a -> Bool