0180efd..master · typeable/katip

git.iko.soy/typeable/katip

19 files changed+133−49

unifiedsplit

.gitignore+1

@@ -7,3 +7,4 @@ TAGS

77*.hi

88*.dyn_o

99*.dyn_hi

10+stack.yaml.lock

.travis.yml+8−9

@@ -9,21 +9,19 @@ addons:

99 apt:

1010 packages:

1111 - libgmp-dev

12− - oracle-java8-installer

1312

1413# The different configurations we want to test. You could also do things like

1514# change flags or use --stack-yaml to point to a different file.

1615matrix:

1716 include:

18− - env: ARGS="--resolver=lts-10" ESVERSION=1.5.2 ESURL=https://download.elastic.co/elasticsearch/elasticsearch ESTESTARGS="--es-version 1"

19− - env: ARGS="--resolver=lts-11" ESVERSION=1.5.2 ESURL=https://download.elastic.co/elasticsearch/elasticsearch ESTESTARGS="--es-version 1"

20− - env: ARGS="--resolver=lts-12" ESVERSION=1.5.2 ESURL=https://download.elastic.co/elasticsearch/elasticsearch ESTESTARGS="--es-version 1"

21− - env: ARGS="--resolver=nightly" ESVERSION=5.5.0 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m" JAVA_HOME=/usr/lib/jvm/java-8-oracle

22− - env: ARGS="--resolver=nightly" ESVERSION=6.2.2 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m" JAVA_HOME=/usr/lib/jvm/java-8-oracle

23− # nightlies may fail from time to time

17+ - env: ARGS="--resolver=lts-16" ESVERSION=5.5.0 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m"

18+ - env: ARGS="--resolver=lts-16" ESVERSION=6.2.2 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m"

19+ - env: ARGS="--resolver=nightly" ESVERSION=5.5.0 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m"

20+ - env: ARGS="--resolver=nightly" ESVERSION=6.2.2 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m"

21+ # nightlies may fail usually due to lagging dependencies

2422 allow_failures:

25− - env: ARGS="--resolver=nightly" ESVERSION=5.5.0 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m" JAVA_HOME=/usr/lib/jvm/java-8-oracle

26− - env: ARGS="--resolver=nightly" ESVERSION=6.2.2 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m" JAVA_HOME=/usr/lib/jvm/java-8-oracle

23+ - env: ARGS="--resolver=nightly" ESVERSION=5.5.0 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m"

24+ - env: ARGS="--resolver=nightly" ESVERSION=6.2.2 ESURL=https://artifacts.elastic.co/downloads/elasticsearch ESTESTARGS="--es-version 5" ES_JAVA_OPTS="-Xms500m -Xmx750m"

2725

2826before_install:

2927# Download and unpack the stack executable

@@ -36,6 +34,7 @@ install:

3634 - tar xzf elasticsearch-$ESVERSION.tar.gz

3735 # set up a repo for snapshot testing. Required in ES >= 1.6

3836 - echo "path.repo = [\"/tmp\"]" >> ./elasticsearch-$ESVERSION/elasticsearch.yml

37+ - java -version

3938 - ./elasticsearch-$ESVERSION/bin/elasticsearch &

4039 # Bloodhound seems to take a while to build and can sometimes stall out the build when travis detects no output.

4140

katip-datadog/changelog.md+4

@@ -1,3 +1,7 @@

1+0.2.0.0

2+==========

3+* Remove import of deprecated Network module

150.1.0.0

26==========

37* Initial release

katip-datadog/katip-datadog.cabal+1−1

@@ -1,5 +1,5 @@

11name: katip-datadog

2−version: 0.1.0.0

2+version: 0.2.0.0

33synopsis: Datadog scribe for the Katip logging framework

44description: See README.md for more details.

55license: BSD3

katip-datadog/src/Katip/Scribes/Datadog/TCP.hs+1−1

@@ -33,8 +33,8 @@ import qualified Data.Text.Lazy.Builder as B

3333import Data.Time (NominalDiffTime)

3434import Katip

3535import Katip.Core (LocJs (..))

36−import qualified Network as Net

3736import qualified Network.Connection as C

37+import qualified Network.Socket as Net

3838import qualified System.Posix.Types as POSIX

3939-------------------------------------------------------------------------------

4040

katip-elasticsearch/bench/Main.hs+3−3

@@ -15,11 +15,11 @@ import qualified Data.HashMap.Strict as HM

1515import Data.Proxy (Proxy (..))

1616import System.Random

1717import qualified Data.Text as T

18−import Database.V1.Bloodhound.Types

18+import Database.Bloodhound.Types

1919import Numeric

2020-------------------------------------------------------------------------------

2121import Katip.Scribes.ElasticSearch

22−import Katip.Scribes.ElasticSearch.Internal (ESV1)

22+import Katip.Scribes.ElasticSearch.Internal (ESV5)

2323-------------------------------------------------------------------------------

2424

2525main :: IO ()

@@ -34,7 +34,7 @@ main = do

3434mkDocIdBenchmark :: Benchmark

3535mkDocIdBenchmark = bgroup "mkDocId"

3636 [

37− bench "mkDocId (randomIO)" $ nfIO (mkDocId (Proxy :: Proxy ESV1))

37+ bench "mkDocId (randomIO)" $ nfIO (mkDocId (Proxy :: Proxy ESV5))

3838 , bench "mkDocId' (shared )" $ nfIO mkDocId'

3939 ]

4040

katip-elasticsearch/changelog.md+10

@@ -1,3 +1,13 @@

1+0.7.0.0

2+=======

3+* Make compatible with unreleased bloodhound 0.17

4+* Deprecate use of ES version 1 which has been removed from bloodhound

5+ 0.17. All users should move over to ESV5 which should work for

6+ versions 5 and up.

7+* Default configuration to ESV5

8+* Add deprecation warnings for ESV1. Support for ESV1 will be removed

9+ in the future.

10+

1110.6.0.0

212=======

313* Update to katip-0.8.0.0 `PermitFunc` convention. To update, for

katip-elasticsearch/docker-compose.ymlnew file+10

@@ -0,0 +1,10 @@

1+version: "3.7"

2+services:

3+ # https://hub.docker.com/_/elasticsearch

4+ elasticsearch:

5+ image: elasticsearch:5-alpine

6+ ports:

7+ - target: 9200

8+ published: 9200

9+ protocol: tcp

10+ mode: host

katip-elasticsearch/examples/example.hs+1−1

@@ -6,7 +6,7 @@ module Main

77-------------------------------------------------------------------------------

88import Control.Exception

9−import Database.V5.Bloodhound

9+import Database.Bloodhound

1010import Network.HTTP.Client

1111-------------------------------------------------------------------------------

1212import Katip

katip-elasticsearch/katip-elasticsearch.cabal+1−4

@@ -1,7 +1,7 @@

11name: katip-elasticsearch

22synopsis: ElasticSearch scribe for the Katip logging framework.

33description: See README.md for more details.

4−version: 0.6.0.0

4+version: 0.7.0.0

55license: BSD3

66license-file: LICENSE

77author: Ozgun Ataman, Michael Xavier

@@ -108,7 +108,4 @@ test-suite test

108108 , bytestring

109109 , tagged

110110

111− if flag(lib-Werror)

112− ghc-options: -Wall -Werror

113−

114111 ghc-options: -threaded -rtsopts

katip-elasticsearch/src/Katip/Scribes/ElasticSearch.hs+5

@@ -1,3 +1,4 @@

1+{-# LANGUAGE CPP #-}

12-- | Includes a scribe that can be used to log structured, JSON log

23-- messages to ElasticSearch. These logs can be explored easily using

34-- <https://www.elastic.co/products/kibana kibana> or your tool of

@@ -67,12 +68,16 @@ module Katip.Scribes.ElasticSearch

6768 , essIndexSettings

6869 , essIndexSharding

6970 , defaultEsScribeCfg

71+#if !MIN_VERSION_bloodhound(0,17,0)

7072 , defaultEsScribeCfgV1

73+#endif

7174 , defaultEsScribeCfgV5

7275 -- ** Version-Proxied APIS

7376 -- $versionproxies

7477 , defaultEsScribeCfg'

78+#if !MIN_VERSION_bloodhound(0,17,0)

7579 , ESV1

80+#endif

7681 , ESV5

7782 -- * Utilities

7883 , mkDocId

katip-elasticsearch/src/Katip/Scribes/ElasticSearch/Internal.hs+18−7

@@ -28,7 +28,7 @@ import Control.Retry (RetryPolicy,

2828import Data.Aeson

2929import Data.ByteString.Lazy (ByteString)

3030import Data.List.NonEmpty (NonEmpty (..))

31−import Data.Monoid ((<>))

31+import Data.Monoid as Monoid

3232import Data.Text (Text)

3333import qualified Data.Text as T

3434import qualified Data.Text.Encoding as T

@@ -37,8 +37,12 @@ import Data.Time.Calendar.WeekDate

3737import Data.Typeable as Typeable

3838import Data.UUID

3939import qualified Data.UUID.V4 as UUID4

40+#if MIN_VERSION_bloodhound(0,17,0)

41+import qualified Database.Bloodhound as V5

42+#else

4043import qualified Database.V1.Bloodhound as V1

4144import qualified Database.V5.Bloodhound as V5

45+#endif

4246import Network.HTTP.Client

4347import Network.HTTP.Types.Status

4448import Text.Printf (printf)

@@ -95,7 +99,7 @@ data EsScribeCfg v = EsScribeCfg {

9599-- * DailyIndexSharding

96100defaultEsScribeCfg' :: ESVersion v => proxy v -> EsScribeCfg v

97101defaultEsScribeCfg' prx = EsScribeCfg {

98− essRetryPolicy = exponentialBackoff 25000 <> limitRetries 5

102+ essRetryPolicy = exponentialBackoff 25000 Monoid.<> limitRetries 5

99103 , essQueueSize = EsQueueSize 1000

100104 , essPoolSize = EsPoolSize 2

101105 , essAnnotateTypes = False

@@ -104,19 +108,22 @@ defaultEsScribeCfg' prx = EsScribeCfg {

104108 }

105109

106110

111+

112+

107113-------------------------------------------------------------------------------

108−-- | Alias of 'defaultEsScribeCfgV1' to minimize API

114+-- | Alias of 'defaultEsScribeCfgV5' to minimize API

109115-- breakage. Previous versions of katip-elasticsearch only supported

110−-- ES version 1.

111−defaultEsScribeCfg :: EsScribeCfg ESV1

112−defaultEsScribeCfg = defaultEsScribeCfgV1

116+-- ES version 1 and defaulted to it.

117+defaultEsScribeCfg :: EsScribeCfg ESV5

118+defaultEsScribeCfg = defaultEsScribeCfgV5

113119

114120

115121-------------------------------------------------------------------------------

122+#if !MIN_VERSION_bloodhound(0,17,0)

116123-- | EsScribeCfg that will use ElasticSearch V1

117124defaultEsScribeCfgV1 :: EsScribeCfg ESV1

118125defaultEsScribeCfgV1 = defaultEsScribeCfg' (Typeable.Proxy :: Typeable.Proxy ESV1)

119−

126+#endif

120127

121128-------------------------------------------------------------------------------

122129-- | EsScribeCfg that will use ElasticSearch V5

@@ -484,7 +491,10 @@ class ESVersion v where

484491

485492

486493

494+#if !MIN_VERSION_bloodhound(0,17,0)

487495data ESV1 = ESV1

496+{-# DEPRECATED ESV1 "ESV1 is deprecated and removed in bloodhound >= 0.17.0" #-}

497+

488498

489499instance ESVersion ESV1 where

490500 type BHEnv ESV1 = V1.BHEnv

@@ -524,6 +534,7 @@ instance ESVersion ESV1 where

524534 [ "type" .= String "string"

525535 , "index" .= String "analyzed"

526536 ]

537+#endif

527538

528539

529540data ESV5 = ESV5

katip-elasticsearch/test/Main.hs+23−7

@@ -34,8 +34,12 @@ import Data.Time

3434import Data.Time.Calendar.WeekDate

3535import Data.Typeable as Typeable

3636import qualified Data.Vector as V

37+#if MIN_VERSION_bloodhound(0,17,0)

38+import qualified Database.Bloodhound as V5

39+#else

3740import qualified Database.V1.Bloodhound as V1

3841import qualified Database.V5.Bloodhound as V5

42+#endif

3943import Network.HTTP.Client

4044import Network.HTTP.Types.Status

4145import Test.QuickCheck.Instances ()

@@ -54,8 +58,10 @@ main :: IO ()

5458main = defaultMainWithIngredients ings $ askOption $ \vers -> testGroup "katip-elasticsearch"

5559 [

5660 case vers of

57− TestV1 -> esTests (Typeable.Proxy :: Typeable.Proxy ESV1)

58− TestV5 -> esTests (Typeable.Proxy :: Typeable.Proxy ESV5)

61+#if !MIN_VERSION_bloodhound(0,17,0)

62+ TestV1 -> esTests (Typeable.Proxy :: Typeable.Proxy ESV1)

63+#endif

64+ TestV5 -> esTests (Typeable.Proxy :: Typeable.Proxy ESV5)

5965 , typeAnnotatedTests

6066 , roundToSundayTests

6167 ]

@@ -64,18 +70,26 @@ main = defaultMainWithIngredients ings $ askOption $ \vers -> testGroup "katip-e

6470

6571

6672-------------------------------------------------------------------------------

67−data TestWithESVersion = TestV1

68− | TestV5

69− deriving (Typeable)

73+data TestWithESVersion = TestV5

74+#if !MIN_VERSION_bloodhound(0,17,0)

75+ | TestV1

76+#endif

77+ deriving (Typeable)

7078

7179

7280instance IsOption TestWithESVersion where

73− defaultValue = TestV1

81+ defaultValue = TestV5

82+#if !MIN_VERSION_bloodhound(0,17,0)

7483 parseValue "1" = Just TestV1

84+#endif

7585 parseValue "5" = Just TestV5

7686 parseValue _ = Nothing

7787 optionName = Tagged "es-version"

78− optionHelp = Tagged "Version of ES to test against, either 1 or 5, defaulting to 1."

88+#if MIN_VERSION_bloodhound(0,17,0)

89+ optionHelp = Tagged "Version of ES to test against, either 1 or 5, defaulting to 5."

90+#else

91+ optionHelp = Tagged "Version of ES to test against, only v5 is supported, but should work for higher versions."

92+#endif

7993

8094

8195class ESVersion v => TestESVersion v where

@@ -101,6 +115,7 @@ class ESVersion v => TestESVersion v where

101115 searchByIndex :: proxy v -> IndexName v -> Search v -> BH v IO (Response ByteString)

102116

103117

118+#if !MIN_VERSION_bloodhound(0,17,0)

104119instance TestESVersion ESV1 where

105120 type Server ESV1 = V1.Server

106121 toServer _ = V1.Server

@@ -122,6 +137,7 @@ instance TestESVersion ESV1 where

122137 refreshIndex _ = V1.refreshIndex

123138 withBH _ = V1.withBH

124139 searchByIndex _ = V1.searchByIndex

140+#endif

125141

126142

127143instance TestESVersion ESV5 where

katip/README.md+1−1

@@ -16,7 +16,7 @@ Kâtip (pronounced kah-tip) is the Turkish word for scribe.

1616 add context that will be automatically merged in with existing log

1717 context.

1818

19−* *Easy to Integration:* Katip was designed to be easily integrated

19+* *Easy Integration:* Katip was designed to be easily integrated

2020 into existing monads. By using typeclasses for logging facilities,

2121 individual subsystems and even libraries can easily add their own

2222 namespacing and context without having any knowledge of their

katip/changelog.md+8

@@ -1,3 +1,11 @@

1+0.8.5.0

2+=======

3+* Add MonadResource instances [#121](https://github.com/Soostone/katip/pull/121)

5+0.8.4.0

6+=======

7+* Add support for unliftio-core 0.2 while maintaining backwards-compatible support for 0.1

190.8.3.0

210=======

311

katip/katip.cabal+2−2

@@ -1,5 +1,5 @@

11name: katip

2−version: 0.8.3.0

2+version: 0.8.5.0

33synopsis: A structured logging framework.

44description:

55 Katip is a structured logging framework. See README.md for more details.

@@ -87,7 +87,7 @@ library

8787 if flag(lib-Werror)

8888 ghc-options: -Werror

8989 if os(windows)

90− build-depends: Win32 >=2.3 && <2.6

90+ build-depends: Win32 >=2.3 && <2.9

9191 exposed-modules: Katip.Compat

9292 else

9393 build-depends: unix >= 2.5 && <2.8

katip/src/Katip/Core.hs+12−5

@@ -44,7 +44,8 @@ import Control.Monad.Trans.Either

4444import Control.Monad.Trans.Except

4545import Control.Monad.Trans.Maybe

4646import Control.Monad.Trans.Reader

47−import Control.Monad.Trans.Resource (ResourceT, transResourceT)

47+import Control.Monad.Trans.Resource (MonadResource, ResourceT,

48+ transResourceT)

4849import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)

4950import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)

5051import Control.Monad.Trans.State.Lazy (StateT, mapStateT)

@@ -664,7 +665,7 @@ makeLenses ''LogEnv

664665

665666

666667-------------------------------------------------------------------------------

667−-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' which

668+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUpdate' which

668669-- updates the timer every 1ms. If you need even more timestamp

669670-- precision at the cost of performance, consider setting

670671-- '_logEnvTimer' with 'getCurrentTime'.

@@ -879,7 +880,8 @@ instance (Katip m) => Katip (ResourceT m) where

879880-- opposed to implementing 'Katip' for your monad.

880881newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }

881882 deriving ( Functor, Applicative, Monad, MonadIO

882− , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)

883+ , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans

884+ , MonadBase b)

883885

884886

885887instance MonadIO m => Katip (KatipT m) where

@@ -901,9 +903,14 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where

901903 restoreM = defaultRestoreM

902904

903905instance MonadUnliftIO m => MonadUnliftIO (KatipT m) where

906+#if MIN_VERSION_unliftio_core(0, 2, 0)

907+ withRunInIO inner = KatipT $ ReaderT $ \le -> withRunInIO $ \run ->

908+ inner (run . runKatipT le)

909+#else

904910 askUnliftIO = KatipT $

905− withUnliftIO $ \u ->

906− pure (UnliftIO (unliftIO u . unKatipT))

911+ withUnliftIO $ \u ->

912+ pure (UnliftIO (unliftIO u . unKatipT))

913+#endif

907914

908915#if MIN_VERSION_base(4, 9, 0)

909916instance MF.MonadFail m => MF.MonadFail (KatipT m) where

katip/src/Katip/Monadic.hs+19−5

@@ -58,7 +58,8 @@ import Control.Monad.Trans.Either (EitherT, mapEitherT)

5858import Control.Monad.Trans.Except (ExceptT, mapExceptT)

5959import Control.Monad.Trans.Identity (IdentityT, mapIdentityT)

6060import Control.Monad.Trans.Maybe (MaybeT, mapMaybeT)

61−import Control.Monad.Trans.Resource (ResourceT, transResourceT)

61+import Control.Monad.Trans.Resource (MonadResource,

62+ ResourceT, transResourceT)

6263import Control.Monad.Trans.RWS (RWST, mapRWST)

6364import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)

6465import qualified Control.Monad.Trans.State.Strict as Strict (StateT, mapStateT)

@@ -349,6 +350,7 @@ newtype KatipContextT m a = KatipContextT {

349350 , MonadWriter w

350351 , MonadError e

351352 , MonadPlus

353+ , MonadResource

352354 , Alternative

353355 , MonadFix

354356 , MonadTrans

@@ -395,9 +397,15 @@ instance (MonadIO m) => KatipContext (KatipContextT m) where

395397 localKatipNamespace f (KatipContextT m) = KatipContextT $ local (\s -> s { ltsNamespace = f (ltsNamespace s)}) m

396398

397399instance MonadUnliftIO m => MonadUnliftIO (KatipContextT m) where

400+#if MIN_VERSION_unliftio_core(0, 2, 0)

401+ withRunInIO inner = KatipContextT $ ReaderT $ \lts -> withRunInIO $ \run ->

402+ inner (run . runKatipContextT (ltsLogEnv lts) (ltsContext lts) (ltsNamespace lts))

403+#else

398404 askUnliftIO = KatipContextT $

399− withUnliftIO $ \u ->

400− pure (UnliftIO (unliftIO u . unKatipContextT))

405+ withUnliftIO $ \u ->

406+ pure (UnliftIO (unliftIO u . unKatipContextT))

407+#endif

408+

401409

402410#if MIN_VERSION_base(4, 9, 0)

403411instance MF.MonadFail m => MF.MonadFail (KatipContextT m) where

@@ -482,9 +490,15 @@ instance MonadBaseControl b m => MonadBaseControl b (NoLoggingT m) where

482490 restoreM = NoLoggingT . restoreM

483491

484492instance MonadUnliftIO m => MonadUnliftIO (NoLoggingT m) where

493+#if MIN_VERSION_unliftio_core(0, 2, 0)

494+ withRunInIO inner = NoLoggingT $ withRunInIO $ \run ->

495+ inner (run . runNoLoggingT)

496+#else

485497 askUnliftIO = NoLoggingT $

486− withUnliftIO $ \u ->

487− pure (UnliftIO (unliftIO u . runNoLoggingT))

498+ withUnliftIO $ \u ->

499+ pure (UnliftIO (unliftIO u . runNoLoggingT))

500+#endif

501+

488502

489503instance MonadIO m => Katip (NoLoggingT m) where

490504 getLogEnv = liftIO (initLogEnv "NoLoggingT" "no-logging")

stack.yaml+5−3

@@ -1,12 +1,14 @@

1−resolver: lts-12.26

1+resolver: lts-16.18

22packages:

33 - katip

44 - katip-elasticsearch

55 - katip-datadog

66 - katip-logzio

77extra-deps:

8− - bloodhound-0.16.0.0

9− - unliftio-core-0.1.2.0

8+ # ghc 8.8 support

9+ - github: wireapp/bloodhound

10+ commit: b409f52b518f20a4c20651b5893c31b7b85cb9b1

11+allow-newer: true

1012flags:

1113 katip:

1214 lib-Werror: true