e94dfe5...master · typeable/katip

.travis.yml+8−11

since splitsnapshots

unifiedsplit

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

9 apt:

10 packages:

11 - libgmp-dev

12− # - openjdk-8-jdk

13

12

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

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

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

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

16matrix:

15matrix:

17 include:

16 include:

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

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"

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=lts-12" 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"

22− # - env: ARGS="--resolver=nightly" ESVERSION=5.5.0 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"

23− # - env: ARGS="--resolver=nightly" ESVERSION=6.2.2 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"

24− # nightlies may fail from time to time

21+ # nightlies may fail usually due to lagging dependencies

25− # allow_failures:

22+ allow_failures:

26− # - 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

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"

27− # - 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

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"

28

25

29before_install:

26before_install:

30# Download and unpack the stack executable

27# Download and unpack the stack executable

katip-datadog/changelog.md+4

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

1+0.2.0.0

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

3+* Remove import of deprecated Network module

4+

10.1.0.0

50.1.0.0

2==========

6==========

3* Initial release

7* Initial release

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

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

1name: katip-datadog

2−version: 0.1.0.0

2+version: 0.2.0.0

3synopsis: Datadog scribe for the Katip logging framework

4description: See README.md for more details.

5license: BSD3

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

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

33import Data.Time (NominalDiffTime)

34import Katip

35import Katip.Core (LocJs (..))

36−import qualified Network as Net

37import qualified Network.Connection as C

36import qualified Network.Connection as C

37+import qualified Network.Socket as Net

38import qualified System.Posix.Types as POSIX

39-------------------------------------------------------------------------------

40

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

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

15import Data.Proxy (Proxy (..))

16import System.Random

17import qualified Data.Text as T

18−import Database.V1.Bloodhound.Types

18+import Database.Bloodhound.Types

19import Numeric

20-------------------------------------------------------------------------------

21import Katip.Scribes.ElasticSearch

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

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

23-------------------------------------------------------------------------------

24

25main :: IO ()

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

34mkDocIdBenchmark :: Benchmark

35mkDocIdBenchmark = bgroup "mkDocId"

36 [

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

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

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

39 ]

40

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+

10.6.0.0

110.6.0.0

2=======

12=======

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

13* 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

6

7-------------------------------------------------------------------------------

8import Control.Exception

9−import Database.V5.Bloodhound

9+import Database.Bloodhound

10import Network.HTTP.Client

11-------------------------------------------------------------------------------

12import Katip

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

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

1name: katip-elasticsearch

2synopsis: ElasticSearch scribe for the Katip logging framework.

3description: See README.md for more details.

4−version: 0.6.0.0

4+version: 0.7.0.0

5license: BSD3

6license-file: LICENSE

7author: Ozgun Ataman, Michael Xavier

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

108 , bytestring

109 , tagged

110

111− if flag(lib-Werror)

112− ghc-options: -Wall -Werror

113−

114 ghc-options: -threaded -rtsopts

111 ghc-options: -threaded -rtsopts

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

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

1+{-# LANGUAGE CPP #-}

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

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

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

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

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

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

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

67 , essIndexSettings

68 , essIndexSettings

68 , essIndexSharding

69 , essIndexSharding

69 , defaultEsScribeCfg

70 , defaultEsScribeCfg

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

70 , defaultEsScribeCfgV1

72 , defaultEsScribeCfgV1

73+#endif

71 , defaultEsScribeCfgV5

74 , defaultEsScribeCfgV5

72 -- ** Version-Proxied APIS

75 -- ** Version-Proxied APIS

73 -- $versionproxies

76 -- $versionproxies

74 , defaultEsScribeCfg'

77 , defaultEsScribeCfg'

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

75 , ESV1

79 , ESV1

80+#endif

76 , ESV5

81 , ESV5

77 -- * Utilities

82 -- * Utilities

78 , mkDocId

83 , mkDocId

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

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

28import Data.Aeson

29import Data.ByteString.Lazy (ByteString)

30import Data.List.NonEmpty (NonEmpty (..))

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

31+import Data.Monoid as Monoid

32import Data.Text (Text)

33import qualified Data.Text as T

34import qualified Data.Text.Encoding as T

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

37import Data.Typeable as Typeable

38import Data.UUID

39import qualified Data.UUID.V4 as UUID4

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

41+import qualified Database.Bloodhound as V5

42+#else

40import qualified Database.V1.Bloodhound as V1

43import qualified Database.V1.Bloodhound as V1

41import qualified Database.V5.Bloodhound as V5

44import qualified Database.V5.Bloodhound as V5

45+#endif

42import Network.HTTP.Client

46import Network.HTTP.Client

43import Network.HTTP.Types.Status

47import Network.HTTP.Types.Status

44import Text.Printf (printf)

48import Text.Printf (printf)

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

95-- * DailyIndexSharding

99-- * DailyIndexSharding

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

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

97defaultEsScribeCfg' prx = EsScribeCfg {

101defaultEsScribeCfg' prx = EsScribeCfg {

98− essRetryPolicy = exponentialBackoff 25000 <> limitRetries 5

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

99 , essQueueSize = EsQueueSize 1000

103 , essQueueSize = EsQueueSize 1000

100 , essPoolSize = EsPoolSize 2

104 , essPoolSize = EsPoolSize 2

101 , essAnnotateTypes = False

105 , essAnnotateTypes = False

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

104 }

108 }

105

109

106

110

111+

112+

107-------------------------------------------------------------------------------

113-------------------------------------------------------------------------------

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

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

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

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

110−-- ES version 1.

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

111−defaultEsScribeCfg :: EsScribeCfg ESV1

117+defaultEsScribeCfg :: EsScribeCfg ESV5

112−defaultEsScribeCfg = defaultEsScribeCfgV1

118+defaultEsScribeCfg = defaultEsScribeCfgV5

113

119

114

120

115-------------------------------------------------------------------------------

121-------------------------------------------------------------------------------

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

116-- | EsScribeCfg that will use ElasticSearch V1

123-- | EsScribeCfg that will use ElasticSearch V1

117defaultEsScribeCfgV1 :: EsScribeCfg ESV1

124defaultEsScribeCfgV1 :: EsScribeCfg ESV1

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

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

119−

126+#endif

120

127

121-------------------------------------------------------------------------------

128-------------------------------------------------------------------------------

122-- | EsScribeCfg that will use ElasticSearch V5

129-- | EsScribeCfg that will use ElasticSearch V5

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

484

491

485

492

486

493

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

487data ESV1 = ESV1

495data ESV1 = ESV1

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

497+

488

498

489instance ESVersion ESV1 where

499instance ESVersion ESV1 where

490 type BHEnv ESV1 = V1.BHEnv

500 type BHEnv ESV1 = V1.BHEnv

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

524 [ "type" .= String "string"

534 [ "type" .= String "string"

525 , "index" .= String "analyzed"

535 , "index" .= String "analyzed"

526 ]

536 ]

537+#endif

527

538

528

539

529data ESV5 = ESV5

540data ESV5 = ESV5

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

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

34import Data.Time.Calendar.WeekDate

35import Data.Typeable as Typeable

36import qualified Data.Vector as V

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

38+import qualified Database.Bloodhound as V5

39+#else

37import qualified Database.V1.Bloodhound as V1

40import qualified Database.V1.Bloodhound as V1

38import qualified Database.V5.Bloodhound as V5

41import qualified Database.V5.Bloodhound as V5

42+#endif

39import Network.HTTP.Client

43import Network.HTTP.Client

40import Network.HTTP.Types.Status

44import Network.HTTP.Types.Status

41import Test.QuickCheck.Instances ()

45import Test.QuickCheck.Instances ()

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

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

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

55 [

59 [

56 case vers of

60 case vers of

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

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

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

63+#endif

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

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

59 , typeAnnotatedTests

65 , typeAnnotatedTests

60 , roundToSundayTests

66 , roundToSundayTests

61 ]

67 ]

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

64

70

65

71

66-------------------------------------------------------------------------------

72-------------------------------------------------------------------------------

67−data TestWithESVersion = TestV1

73+data TestWithESVersion = TestV5

68− | TestV5

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

75+ | TestV1

76+#endif

69− deriving (Typeable)

77+ deriving (Typeable)

70

78

71

79

72instance IsOption TestWithESVersion where

80instance IsOption TestWithESVersion where

73− defaultValue = TestV1

81+ defaultValue = TestV5

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

74 parseValue "1" = Just TestV1

83 parseValue "1" = Just TestV1

84+#endif

75 parseValue "5" = Just TestV5

85 parseValue "5" = Just TestV5

76 parseValue _ = Nothing

86 parseValue _ = Nothing

77 optionName = Tagged "es-version"

87 optionName = Tagged "es-version"

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

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

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

79

93

80

94

81class ESVersion v => TestESVersion v where

95class ESVersion v => TestESVersion v where

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

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

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

102

116

103

117

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

104instance TestESVersion ESV1 where

119instance TestESVersion ESV1 where

105 type Server ESV1 = V1.Server

120 type Server ESV1 = V1.Server

106 toServer _ = V1.Server

121 toServer _ = V1.Server

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

122 refreshIndex _ = V1.refreshIndex

137 refreshIndex _ = V1.refreshIndex

123 withBH _ = V1.withBH

138 withBH _ = V1.withBH

124 searchByIndex _ = V1.searchByIndex

139 searchByIndex _ = V1.searchByIndex

140+#endif

125

141

126

142

127instance TestESVersion ESV5 where

143instance TestESVersion ESV5 where

katip/README.md+1−1

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

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

17 context.

18

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

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

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

21 individual subsystems and even libraries can easily add their own

22 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)

4+

5+0.8.4.0

6+=======

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

8+

10.8.3.0

90.8.3.0

2=======

10=======

3

11

katip/katip.cabal+1−1

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

1name: katip

2−version: 0.8.3.0

2+version: 0.8.5.0

3synopsis: A structured logging framework.

4description:

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

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

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

44import Control.Monad.Trans.Except

45import Control.Monad.Trans.Maybe

46import Control.Monad.Trans.Reader

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

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

48+ transResourceT)

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

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

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

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

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

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

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

664

665

666

666-------------------------------------------------------------------------------

667-------------------------------------------------------------------------------

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

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

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

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

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

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

670-- '_logEnvTimer' with 'getCurrentTime'.

671-- '_logEnvTimer' with 'getCurrentTime'.

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

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

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

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

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

881 deriving ( Functor, Applicative, Monad, MonadIO

882 deriving ( Functor, Applicative, Monad, MonadIO

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

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

884+ , MonadBase b)

883

885

884

886

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

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

katip/src/Katip/Monadic.hs+3−1

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

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

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

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

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

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

62+ ResourceT, transResourceT)

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

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

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

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

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

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

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

349 , MonadWriter w

350 , MonadWriter w

350 , MonadError e

351 , MonadError e

351 , MonadPlus

352 , MonadPlus

353+ , MonadResource

352 , Alternative

354 , Alternative

353 , MonadFix

355 , MonadFix

354 , MonadTrans

356 , MonadTrans

stack.yaml+5−4

@@ -1,13 +1,14 @@

1−resolver: lts-12.26

1+resolver: lts-16.18

2packages:

3 - katip

4 - katip-elasticsearch

5 - katip-datadog

6 - katip-logzio

7extra-deps:

8+ # ghc 8.8 support

8− - bloodhound-0.16.0.0

9+ - github: wireapp/bloodhound

9− - unliftio-core-0.2.0.1

10+ commit: b409f52b518f20a4c20651b5893c31b7b85cb9b1

10− - resourcet-1.2.3

11+allow-newer: true

11flags:

12flags:

12 katip:

13 katip:

13 lib-Werror: true

14 lib-Werror: true