opentracing-zipkin-v2 (empty) → 0.1.0.0
raw patch · 6 files changed
+438/−0 lines, 6 filesdep +aesondep +basedep +base64-bytestring
Dependencies added: aeson, base, base64-bytestring, bytestring, exceptions, http-client, http-types, lens, opentracing, opentracing-zipkin-common, text
Files
- CHANGELOG.md +3/−0
- LICENSE +202/−0
- OpenTracing/Zipkin/V2.hs +6/−0
- OpenTracing/Zipkin/V2/HttpReporter.hs +178/−0
- README.md +0/−0
- opentracing-zipkin-v2.cabal +49/−0
+ CHANGELOG.md view
@@ -0,0 +1,3 @@+* 0.1.0.0 (2012-04-20)++After years of friendly reminders, a zero version gets finally released =]
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ OpenTracing/Zipkin/V2.hs view
@@ -0,0 +1,6 @@+module OpenTracing.Zipkin.V2+ ( module OpenTracing.Zipkin.V2.HttpReporter+ )+where++import OpenTracing.Zipkin.V2.HttpReporter
+ OpenTracing/Zipkin/V2/HttpReporter.hs view
@@ -0,0 +1,178 @@+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE NamedFieldPuns #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE StrictData #-}+{-# LANGUAGE TemplateHaskell #-}++module OpenTracing.Zipkin.V2.HttpReporter+ ( ZipkinOptions+ , zipkinOptions+ , zoManager+ , zoLocalEndpoint+ , zoEndpoint+ , zoLogfmt+ , zoErrorLog++ , defaultZipkinEndpoint+ , defaultZipkinAddr++ , Zipkin+ , newZipkin+ , closeZipkin+ , withZipkin++ , zipkinHttpReporter++ , Endpoint(..)++ , newManager+ , defaultManagerSettings+ )+where++import Control.Lens hiding (Context)+import Control.Monad (unless)+import Control.Monad.Catch+import Control.Monad.IO.Class+import Data.Aeson hiding (Error)+import Data.Aeson.Encoding+import qualified Data.ByteString.Base64.Lazy as B64+import Data.ByteString.Builder+import Data.Map.Lens (toMapOf)+import Data.Maybe (catMaybes)+import Data.Monoid+import Data.Text.Lazy.Encoding (decodeUtf8)+import Data.Text.Strict.Lens (packed, utf8)+import Network.HTTP.Client+import Network.HTTP.Types+import OpenTracing.Log+import OpenTracing.Reporting+import OpenTracing.Span+import OpenTracing.Tags+import OpenTracing.Time+import OpenTracing.Types+import OpenTracing.Zipkin.Types++newtype Zipkin = Zipkin { fromZipkin :: BatchEnv }++data ZipkinOptions = ZipkinOptions+ { _zoManager :: Manager+ , _zoLocalEndpoint :: Endpoint+ , _zoEndpoint :: String+ , _zoLogfmt :: forall t. Foldable t => t LogField -> Builder -- == LogFieldsFormatter+ , _zoErrorLog :: Builder -> IO ()+ }++makeLenses ''ZipkinOptions++zipkinOptions :: Manager -> Endpoint -> ZipkinOptions+zipkinOptions mgr loc = ZipkinOptions+ { _zoManager = mgr+ , _zoLocalEndpoint = loc+ , _zoEndpoint = defaultZipkinEndpoint+ , _zoLogfmt = jsonMap+ , _zoErrorLog = defaultErrorLog+ }++defaultZipkinEndpoint :: String+defaultZipkinEndpoint = "http://"+ <> view addrHostName addr+ <> ":"+ <> show (view addrPort addr)+ <> "/api/v2/spans"+ where+ addr = defaultZipkinAddr++newZipkin :: ZipkinOptions -> IO Zipkin+newZipkin opts@ZipkinOptions{_zoEndpoint=endpoint, _zoErrorLog=errlog} = do+ rq <- mkReq+ fmap Zipkin+ . newBatchEnv+ . set boptErrorLog errlog . batchOptions+ $ reporter opts rq+ where+ mkReq = do+ rq <- parseRequest endpoint+ return rq { requestHeaders = [(hContentType, "application/json")] }++closeZipkin :: Zipkin -> IO ()+closeZipkin = closeBatchEnv . fromZipkin++withZipkin+ :: ( MonadIO m+ , MonadMask m+ )+ => ZipkinOptions+ -> (Zipkin -> m a)+ -> m a+withZipkin opts = bracket (liftIO $ newZipkin opts) (liftIO . closeZipkin)+++zipkinHttpReporter :: MonadIO m => Zipkin -> FinishedSpan -> m ()+zipkinHttpReporter = batchReporter . fromZipkin++reporter :: ZipkinOptions -> Request -> [FinishedSpan] -> IO ()+reporter ZipkinOptions{..} rq spans = do+ rs <- responseStatus <$> httpLbs rq { requestBody = body } _zoManager+ unless (statusIsSuccessful rs) $+ _zoErrorLog $ shortByteString "Error from Zipkin server: "+ <> intDec (statusCode rs)+ <> char8 '\n'+ where+ body = RequestBodyLBS+ . encodingToLazyByteString+ . list (spanE _zoLocalEndpoint _zoLogfmt)+ $ spans+++spanE :: Endpoint -> LogFieldsFormatter -> FinishedSpan -> Encoding+spanE loc logfmt s = pairs $+ pair "name" (view (spanOperation . to text) s)+ <> pair "id" (view (spanContext . to ctxSpanID . hexText . to text) s)+ <> pair "traceId" (view (spanContext . to ctxTraceID . hexText . to text) s)+ <> maybe mempty+ (pair "parentId" . text . view hexText)+ (view (spanContext . to ctxParentSpanID) s)+ <> maybe mempty+ (pair "kind" . toEncoding)+ (view (spanTags . to (getTag SpanKindKey)) s)+ <> pair "timestamp" (view (spanStart . to microsE) s)+ <> pair "duration" (view (spanDuration . to microsE) s)+ <> pair "debug" (bool False)+ <> pair "localEndpoint" (toEncoding loc)+ <> maybe mempty+ (pair "remoteEndpoint")+ (view (spanTags . to remoteEndpoint) s)+ <> pair "annotations" (list (logRecE logfmt) $ view spanLogs s)+ -- Zipkin V2 requires tag values to be strings+ <> pair "tags" (toEncoding . toMapOf (spanTags . to fromTags . ifolded . to tagToText) $ s)+ -- nb. references are lost, perhaps we should stick them into annotations?+ where tagToText = \ case+ BoolT b -> view (to show . packed) b+ StringT t -> t+ IntT i -> view (to show . packed) i+ DoubleT d -> view (to show . packed) d+ BinaryT b -> view (to B64.encode . strict . utf8) b++remoteEndpoint :: Tags -> Maybe Encoding+remoteEndpoint ts = case fields of+ [] -> Nothing+ xs -> Just . pairs $ mconcat xs+ where+ fields = catMaybes+ [ pair PeerServiceKey . toEncoding <$> getTag PeerServiceKey ts+ , pair PeerIPv4Key . toEncoding <$> getTag PeerIPv4Key ts+ , pair PeerIPv6Key . toEncoding <$> getTag PeerIPv6Key ts+ , pair PeerPortKey . toEncoding <$> getTag PeerPortKey ts+ ]++logRecE :: LogFieldsFormatter -> LogRecord -> Encoding+logRecE logfmt r = pairs $+ pair "timestamp" (view (logTime . to microsE) r)+ <> pair "value" (lazyText . decodeUtf8 . toLazyByteString . logfmt $ view logFields r)++microsE :: AsMicros a => a -> Encoding+microsE = word64 . micros
+ README.md view
+ opentracing-zipkin-v2.cabal view
@@ -0,0 +1,49 @@+cabal-version: 2.2++name: opentracing-zipkin-v2+version: 0.1.0.0+synopsis: Zipkin V2 backend for OpenTracing+homepage: https://github.com/kim/opentracing+bug-reports: https://github.com/kim/opentracing/issues+author: Kim Altintop+maintainer: Kim Altintop <kim.altintop+opentracing@gmail.com>+copyright: Copyright (c) 2017-2018 Kim Altintop+license: Apache-2.0+license-file: LICENSE+build-type: Simple+extra-source-files:+ CHANGELOG.md+ README.md++source-repository head+ type: git+ location: git@github.com:kim/opentracing.git++library+ exposed-modules:+ OpenTracing.Zipkin.V2+ OpenTracing.Zipkin.V2.HttpReporter+ other-modules:+ Paths_opentracing_zipkin_v2+ autogen-modules:+ Paths_opentracing_zipkin_v2+ ghc-options:+ -Wall+ -funbox-small-strict-fields+ -Wincomplete-uni-patterns+ -Wincomplete-record-updates+ -Wcompat+ -Wnoncanonical-monad-instances+ build-depends:+ aeson >= 1.1+ , base >= 4.9 && < 4.16+ , base64-bytestring >= 1.0+ , bytestring >= 0.10+ , exceptions >= 0.8+ , http-client >= 0.5+ , http-types >= 0.9+ , lens >= 4.19+ , opentracing >= 0.1+ , opentracing-zipkin-common >= 0.1+ , text >= 1.2+ default-language: Haskell2010