master..e94dfe5 · typeable/katip

.travis.yml+11−8

since splitsnapshots

unifiedsplit

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

9 apt:

10 packages:

11 - libgmp-dev

12+ # - openjdk-8-jdk

12

13

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

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

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

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

15matrix:

16matrix:

16 include:

17 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"

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"

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"

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"

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"

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"

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"

21− # nightlies may fail usually due to lagging dependencies

24+ # nightlies may fail from time to time

22− allow_failures:

25+ # allow_failures:

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"

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

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"

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

25

28

26before_install:

29before_install:

27# Download and unpack the stack executable

30# Download and unpack the stack executable

katip-datadog/changelog.md−4

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

1−0.2.0.0

2−==========

3−* Remove import of deprecated Network module

4−

50.1.0.0

10.1.0.0

6==========

2==========

7* Initial release

3* Initial release

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

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

1name: katip-datadog

2−version: 0.2.0.0

2+version: 0.1.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

36import qualified Network.Connection as C

37import 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.Bloodhound.Types

18+import Database.V1.Bloodhound.Types

19import Numeric

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

21import Katip.Scribes.ElasticSearch

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

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

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

24

25main :: IO ()

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

34mkDocIdBenchmark :: Benchmark

35mkDocIdBenchmark = bgroup "mkDocId"

36 [

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

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

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

39 ]

40

katip-elasticsearch/changelog.md−10

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

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−

110.6.0.0

10.6.0.0

12=======

2=======

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

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

katip-elasticsearch/docker-compose.ymldeleted−10

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

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.Bloodhound

9+import Database.V5.Bloodhound

10import Network.HTTP.Client

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

12import Katip

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

@@ -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.7.0.0

4+version: 0.6.0.0

5license: BSD3

6license-file: LICENSE

7author: Ozgun Ataman, Michael Xavier

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

108 , bytestring

109 , tagged

110

111+ if flag(lib-Werror)

112+ ghc-options: -Wall -Werror

113+

111 ghc-options: -threaded -rtsopts

114 ghc-options: -threaded -rtsopts

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

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

1−{-# LANGUAGE CPP #-}

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

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

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

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

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

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

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

68 , essIndexSettings

67 , essIndexSettings

69 , essIndexSharding

68 , essIndexSharding

70 , defaultEsScribeCfg

69 , defaultEsScribeCfg

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

72 , defaultEsScribeCfgV1

70 , defaultEsScribeCfgV1

73−#endif

74 , defaultEsScribeCfgV5

71 , defaultEsScribeCfgV5

75 -- ** Version-Proxied APIS

72 -- ** Version-Proxied APIS

76 -- $versionproxies

73 -- $versionproxies

77 , defaultEsScribeCfg'

74 , defaultEsScribeCfg'

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

79 , ESV1

75 , ESV1

80−#endif

81 , ESV5

76 , ESV5

82 -- * Utilities

77 -- * Utilities

83 , mkDocId

78 , mkDocId

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

@@ -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 as Monoid

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

32import Data.Text (Text)

33import qualified Data.Text as T

34import qualified Data.Text.Encoding as T

@@ -37,12 +37,8 @@ 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

43import qualified Database.V1.Bloodhound as V1

40import qualified Database.V1.Bloodhound as V1

44import qualified Database.V5.Bloodhound as V5

41import qualified Database.V5.Bloodhound as V5

45−#endif

46import Network.HTTP.Client

42import Network.HTTP.Client

47import Network.HTTP.Types.Status

43import Network.HTTP.Types.Status

48import Text.Printf (printf)

44import Text.Printf (printf)

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

99-- * DailyIndexSharding

95-- * DailyIndexSharding

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

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

101defaultEsScribeCfg' prx = EsScribeCfg {

97defaultEsScribeCfg' prx = EsScribeCfg {

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

98+ essRetryPolicy = exponentialBackoff 25000 <> limitRetries 5

103 , essQueueSize = EsQueueSize 1000

99 , essQueueSize = EsQueueSize 1000

104 , essPoolSize = EsPoolSize 2

100 , essPoolSize = EsPoolSize 2

105 , essAnnotateTypes = False

101 , essAnnotateTypes = False

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

108 }

104 }

109

105

110

106

111−

112−

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

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

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

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

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

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

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

110+-- ES version 1.

117−defaultEsScribeCfg :: EsScribeCfg ESV5

111+defaultEsScribeCfg :: EsScribeCfg ESV1

118−defaultEsScribeCfg = defaultEsScribeCfgV5

112+defaultEsScribeCfg = defaultEsScribeCfgV1

119

113

120

114

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

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

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

123-- | EsScribeCfg that will use ElasticSearch V1

116-- | EsScribeCfg that will use ElasticSearch V1

124defaultEsScribeCfgV1 :: EsScribeCfg ESV1

117defaultEsScribeCfgV1 :: EsScribeCfg ESV1

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

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

126−#endif

119+

127

120

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

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

129-- | EsScribeCfg that will use ElasticSearch V5

122-- | EsScribeCfg that will use ElasticSearch V5

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

491

484

492

485

493

486

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

495data ESV1 = ESV1

487data ESV1 = ESV1

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

497−

498

488

499instance ESVersion ESV1 where

489instance ESVersion ESV1 where

500 type BHEnv ESV1 = V1.BHEnv

490 type BHEnv ESV1 = V1.BHEnv

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

534 [ "type" .= String "string"

524 [ "type" .= String "string"

535 , "index" .= String "analyzed"

525 , "index" .= String "analyzed"

536 ]

526 ]

537−#endif

538

527

539

528

540data ESV5 = ESV5

529data ESV5 = ESV5

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

@@ -34,12 +34,8 @@ 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

40import qualified Database.V1.Bloodhound as V1

37import qualified Database.V1.Bloodhound as V1

41import qualified Database.V5.Bloodhound as V5

38import qualified Database.V5.Bloodhound as V5

42−#endif

43import Network.HTTP.Client

39import Network.HTTP.Client

44import Network.HTTP.Types.Status

40import Network.HTTP.Types.Status

45import Test.QuickCheck.Instances ()

41import Test.QuickCheck.Instances ()

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

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

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

59 [

55 [

60 case vers of

56 case vers of

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

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

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

63−#endif

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

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

65 , typeAnnotatedTests

59 , typeAnnotatedTests

66 , roundToSundayTests

60 , roundToSundayTests

67 ]

61 ]

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

70

64

71

65

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

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

73−data TestWithESVersion = TestV5

67+data TestWithESVersion = TestV1

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

68+ | TestV5

75− | TestV1

76−#endif

77− deriving (Typeable)

69+ deriving (Typeable)

78

70

79

71

80instance IsOption TestWithESVersion where

72instance IsOption TestWithESVersion where

81− defaultValue = TestV5

73+ defaultValue = TestV1

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

83 parseValue "1" = Just TestV1

74 parseValue "1" = Just TestV1

84−#endif

85 parseValue "5" = Just TestV5

75 parseValue "5" = Just TestV5

86 parseValue _ = Nothing

76 parseValue _ = Nothing

87 optionName = Tagged "es-version"

77 optionName = Tagged "es-version"

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

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

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

90−#else

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

92−#endif

93

79

94

80

95class ESVersion v => TestESVersion v where

81class ESVersion v => TestESVersion v where

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

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

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

116

102

117

103

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

119instance TestESVersion ESV1 where

104instance TestESVersion ESV1 where

120 type Server ESV1 = V1.Server

105 type Server ESV1 = V1.Server

121 toServer _ = V1.Server

106 toServer _ = V1.Server

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

137 refreshIndex _ = V1.refreshIndex

122 refreshIndex _ = V1.refreshIndex

138 withBH _ = V1.withBH

123 withBH _ = V1.withBH

139 searchByIndex _ = V1.searchByIndex

124 searchByIndex _ = V1.searchByIndex

140−#endif

141

125

142

126

143instance TestESVersion ESV5 where

127instance 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 Integration:* Katip was designed to be easily integrated

19+* *Easy to 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,11 +1,3 @@

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−

90.8.3.0

10.8.3.0

10=======

2=======

11

3

katip/katip.cabal+1−1

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

1name: katip

2−version: 0.8.5.0

2+version: 0.8.3.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+3−5

@@ -44,8 +44,7 @@ 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 (MonadResource, ResourceT,

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

48− transResourceT)

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

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

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

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

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

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

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

665

664

666

665

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

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

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

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

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

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

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

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

671-- '_logEnvTimer' with 'getCurrentTime'.

670-- '_logEnvTimer' with 'getCurrentTime'.

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

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

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

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

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

882 deriving ( Functor, Applicative, Monad, MonadIO

881 deriving ( Functor, Applicative, Monad, MonadIO

883− , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans

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

884− , MonadBase b)

885

883

886

884

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

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

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

@@ -58,8 +58,7 @@ 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 (MonadResource,

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

62− ResourceT, transResourceT)

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

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

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

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

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

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

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

350 , MonadWriter w

349 , MonadWriter w

351 , MonadError e

350 , MonadError e

352 , MonadPlus

351 , MonadPlus

353− , MonadResource

354 , Alternative

352 , Alternative

355 , MonadFix

353 , MonadFix

356 , MonadTrans

354 , MonadTrans

stack.yaml+4−5

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

1−resolver: lts-16.18

1+resolver: lts-12.26

2packages:

3 - katip

4 - katip-elasticsearch

5 - katip-datadog

6 - katip-logzio

7extra-deps:

8− # ghc 8.8 support

9− - github: wireapp/bloodhound

8+ - bloodhound-0.16.0.0

10− commit: b409f52b518f20a4c20651b5893c31b7b85cb9b1

9+ - unliftio-core-0.2.0.1

11−allow-newer: true

10+ - resourcet-1.2.3

12flags:

11flags:

13 katip:

12 katip:

14 lib-Werror: true

13 lib-Werror: true