Browse Source

examples packaged; editor backend

Signed-off-by: Alexander Diemand <codieplusplus@apax.net>
master^2
Alexander Diemand 3 years ago
parent
commit
c8e2d58ce2
No known key found for this signature in database
GPG Key ID: 99283F5327C5D38F
  1. 6
      cabal.project
  2. 2
      hie.yaml
  3. 90
      iohk-monitoring/iohk-monitoring.cabal
  4. 107
      iohk-monitoring/src/Cardano/BM/Backend/Switchboard.lhs
  5. 2
      iohk-monitoring/src/Cardano/BM/Data/Output.lhs
  6. 2
      iohk-monitoring/src/Cardano/BM/Plugin.lhs
  7. 2
      iohk-monitoring/test/Cardano/BM/Test/Structured.lhs
  8. 3
      iohk-monitoring/test/Cardano/BM/Test/Trace.lhs
  9. 5
      lobemo-examples/CHANGELOG.md
  10. 202
      lobemo-examples/LICENSE
  11. 2
      lobemo-examples/Setup.hs
  12. 20
      lobemo-examples/complex/Main.lhs
  13. 75
      lobemo-examples/lobemo-examples.cabal
  14. 0
      lobemo-examples/performance/Main.lhs
  15. 0
      lobemo-examples/performance/README.md
  16. 0
      lobemo-examples/simple/Main.lhs
  17. 202
      plugins/backend-editor/LICENSE
  18. 5
      plugins/backend-editor/NOTICE
  19. 4
      plugins/backend-editor/README.md
  20. 2
      plugins/backend-editor/Setup.hs
  21. 41
      plugins/backend-editor/lobemo-backend-editor.cabal
  22. 14
      plugins/backend-editor/src/Cardano/BM/Backend/Editor.lhs

6
cabal.project

@ -6,6 +6,8 @@ packages:
plugins/backend-ekg
plugins/backend-prometheus
plugins/backend-graylog
plugins/backend-editor
lobemo-examples
package iohk-monitoring
tests: True
@ -13,13 +15,13 @@ package iohk-monitoring
package contra-tracer
-- Currently does not have tests, but set it True in case any are added.
tests: True
documentation: True
documentation: False
haddock-hyperlink-source: True
package tracer-transformers
-- Currently does not have tests, but set it True in case any are added.
tests: True
documentation: True
documentation: False
haddock-hyperlink-source: True
source-repository-package

2
hie.yaml

@ -0,0 +1,2 @@
cradle: {cabal: {component: "lib:iohk-monitoring"}}

90
iohk-monitoring/iohk-monitoring.cabal

@ -1,5 +1,5 @@
name: iohk-monitoring
version: 0.1.10.0
version: 0.1.10.1
synopsis: logging, benchmarking and monitoring framework
-- description:
license: Apache-2.0
@ -102,9 +102,6 @@ library
if !flag(disable-aggregation)
exposed-modules: Cardano.BM.Backend.Aggregation
if !flag(disable-gui)
exposed-modules: Cardano.BM.Backend.Editor
if !flag(disable-observables)
exposed-modules: Cardano.BM.Observer.Monadic
Cardano.BM.Observer.STM
@ -124,7 +121,7 @@ library
other-extensions: OverloadedStrings
build-depends: base >= 4.11,
contra-tracer,
aeson,
aeson >= 1.4.4,
array,
async,
async-timer,
@ -152,8 +149,7 @@ library
unordered-containers,
vector,
yaml, libyaml
if !flag(disable-gui)
build-depends: threepenny-gui
if os(windows)
build-depends: Win32
else
@ -190,6 +186,7 @@ test-suite tests
Cardano.BM.Test.STM
Cardano.BM.Test.Configuration
Cardano.BM.Test.LogItem
Cardano.BM.Test.Mock
Cardano.BM.Test.Rotator
Cardano.BM.Test.Routing
Cardano.BM.Test.Structured
@ -208,7 +205,7 @@ test-suite tests
contra-tracer,
iohk-monitoring,
aeson,
aeson >= 1.4.4,
array,
async,
bytestring,
@ -252,80 +249,3 @@ test-suite tests
if !flag(disable-observables)
cpp-options: -DENABLE_OBSERVABLES
executable example-simple
hs-source-dirs: examples/simple
main-is: Main.lhs
default-language: Haskell2010
default-extensions: OverloadedStrings
ghc-options: -threaded -Wall -O2 "-with-rtsopts=-T"
other-modules:
build-depends: base,
aeson,
iohk-monitoring,
async,
bytestring,
mtl
if os(windows)
build-depends: Win32
else
build-depends: unix
if flag(disable-examples)
buildable: False
executable example-complex
hs-source-dirs: examples/complex
main-is: Main.lhs
default-language: Haskell2010
default-extensions: OverloadedStrings
ghc-options: -threaded -Wall -O2 "-with-rtsopts=-T"
other-modules:
build-depends: base,
iohk-monitoring,
async,
bytestring,
mtl,
random,
text,
unordered-containers
if os(windows)
build-depends: Win32
else
build-depends: unix
if os(linux)
build-depends: download
if !flag(disable-aggregation)
cpp-options: -DENABLE_AGGREGATION
if !flag(disable-ekg)
cpp-options: -DENABLE_EKG
if !flag(disable-gui)
cpp-options: -DENABLE_GUI
if !flag(disable-monitoring)
cpp-options: -DENABLE_MONITORING
if !flag(disable-observables)
cpp-options: -DENABLE_OBSERVABLES
if flag(disable-examples)
buildable: False
executable example-performance
hs-source-dirs: examples/performance
main-is: Main.lhs
default-language: Haskell2010
default-extensions: OverloadedStrings
ghc-options: -threaded -Wall -O2 -with-rtsopts=-T
other-modules:
build-depends: base,
iohk-monitoring,
async,
criterion,
text,
unordered-containers
if flag(disable-examples) || !flag(performance-test-queue)
buildable: False

107
iohk-monitoring/src/Cardano/BM/Backend/Switchboard.lhs

@ -18,9 +18,7 @@
module Cardano.BM.Backend.Switchboard
(
Switchboard
, MockSwitchboard (..)
, mainTraceConditionally
, traceMock
, readLogBuffer
, effectuate
, realize
@ -35,12 +33,11 @@ import qualified Control.Concurrent.Async as Async
import Control.Concurrent.MVar (MVar, newEmptyMVar, newMVar,
modifyMVar_, putMVar, readMVar, tryReadMVar, tryTakeMVar,
withMVar)
import Control.Concurrent.STM (TVar, atomically, modifyTVar, retry)
import Control.Concurrent.STM (atomically, retry)
import qualified Control.Concurrent.STM.TBQueue as TBQ
import Control.Exception.Safe (throwM)
import Control.Monad (forM_, when, void)
import Data.Aeson (FromJSON, ToJSON)
import Data.Maybe (fromMaybe)
import Data.Text (Text)
import qualified Data.Text.IO as TIO
import Data.Time.Clock (getCurrentTime)
@ -57,7 +54,7 @@ import Cardano.BM.Data.MessageCounter (resetCounters, sendAndResetAfte
updateMessageCounters)
import Cardano.BM.Data.Severity
import Cardano.BM.Data.SubTrace (SubTrace (..))
import Cardano.BM.Data.Tracer (Tracer (..), traceWith)
import Cardano.BM.Data.Tracer (Tracer (..))
import qualified Cardano.BM.Backend.TraceAcceptor
import qualified Cardano.BM.Backend.Log
import qualified Cardano.BM.Backend.LogBuffer
@ -73,22 +70,10 @@ import Cardano.BM.Backend.ExternalAbstraction (NoPipe)
import qualified Cardano.BM.Backend.Aggregation
#endif
#ifdef ENABLE_EKG
import qualified Cardano.BM.Backend.EKGView
#endif
#ifdef ENABLE_GRAYLOG
import qualified Cardano.BM.Backend.Graylog
#endif
#ifdef ENABLE_MONITORING
import qualified Cardano.BM.Backend.Monitoring
#endif
#ifdef ENABLE_GUI
import qualified Cardano.BM.Backend.Editor
#endif
\end{code}
%endif
@ -346,7 +331,8 @@ readLogBuffer switchboard = do
\end{code}
\subsubsection{Realizing the backends according to configuration}\label{code:setupBackends}\index{Switchboard!setupBackends}
\subsubsection{Realizing the backends according to configuration}
\label{code:setupBackends}\index{Switchboard!setupBackends}
\begin{code}
setupBackends :: (FromJSON a, ToJSON a)
=> [BackendKind]
@ -378,20 +364,6 @@ setupBackend' MonitoringBK _ _ = do
TIO.hPutStrLn stderr "disabled! will not setup backend 'Monitoring'"
return Nothing
#endif
#ifdef ENABLE_EKG
setupBackend' EKGViewBK c sb = do
let basetrace = mainTraceConditionally c sb
be :: Cardano.BM.Backend.EKGView.EKGView a <- Cardano.BM.Backend.EKGView.realizefrom c basetrace sb
return $ Just MkBackend
{ bEffectuate = Cardano.BM.Backend.EKGView.effectuate be
, bUnrealize = Cardano.BM.Backend.EKGView.unrealize be
}
#else
setupBackend' EKGViewBK _ _ = do
TIO.hPutStrLn stderr "disabled! will not setup backend 'EKGView'"
return Nothing
#endif
#ifdef ENABLE_AGGREGATION
setupBackend' AggregationBK c sb = do
let basetrace = mainTraceConditionally c sb
@ -406,42 +378,9 @@ setupBackend' AggregationBK _ _ = do
TIO.hPutStrLn stderr "disabled! will not setup backend 'Aggregation'"
return Nothing
#endif
#ifdef ENABLE_GUI
setupBackend' EditorBK c sb = do
port <- Config.getGUIport c
if port > 0
then do
let trace = mainTraceConditionally c sb
be :: Cardano.BM.Backend.Editor.Editor a <- Cardano.BM.Backend.Editor.realizefrom c trace sb
return $ Just MkBackend
{ bEffectuate = Cardano.BM.Backend.Editor.effectuate be
, bUnrealize = Cardano.BM.Backend.Editor.unrealize be
}
else
return Nothing
#else
setupBackend' EditorBK _ _ = do
TIO.hPutStrLn stderr "disabled! will not setup backend 'Editor'"
return Nothing
#endif
#ifdef ENABLE_GRAYLOG
setupBackend' GraylogBK c sb = do
port <- Config.getGraylogPort c
if port > 0
then do
let trace = mainTraceConditionally c sb
be :: Cardano.BM.Backend.Graylog.Graylog a <- Cardano.BM.Backend.Graylog.realizefrom c trace sb
return $ Just MkBackend
{ bEffectuate = Cardano.BM.Backend.Graylog.effectuate be
, bUnrealize = Cardano.BM.Backend.Graylog.unrealize be
}
else
return Nothing
#else
setupBackend' GraylogBK _ _ = do
TIO.hPutStrLn stderr "disabled! will not setup backend 'Graylog'"
return Nothing
#endif
setupBackend' EditorBK _ _ = return Nothing
setupBackend' GraylogBK _ _ = return Nothing
setupBackend' EKGViewBK _ _ = return Nothing
setupBackend' KatipBK _ _ = return Nothing
setupBackend' LogBufferBK _ _ = return Nothing
setupBackend' (TraceAcceptorBK pipePath) c sb = do
@ -469,35 +408,3 @@ type PipeType =
#endif
\end{code}
\subsubsection{MockSwitchboard}\label{code:MockSwitchboard}\index{MockSwitchboard}
|MockSwitchboard| is useful for tests since it keeps the |LogObject|s
to be output in a list.
\begin{code}
newtype MockSwitchboard a = MockSB (TVar [LogObject a])
instance IsEffectuator MockSwitchboard a where
effectuate (MockSB tvar) item = atomically $ modifyTVar tvar ((:) item)
handleOverflow _ = pure ()
\end{code}
\subsubsection{traceMock}\label{code:traceMock}\index{traceMock}
A |Tracer| which forwards |LogObject|s to |MockSwitchboard| simulating
functionality of |mainTraceConditionally|.
\begin{code}
traceMock :: MockSwitchboard a -> Config.Configuration -> Tracer IO (LogObject a)
traceMock ms config =
Tracer $ \item@(LogObject loggername _ _) -> do
traceWith mainTrace item
subTrace <- fromMaybe Neutral <$> Config.findSubTrace config loggername
case subTrace of
TeeTrace secName ->
traceWith mainTrace item{ loName = secName }
_ -> return ()
where
mainTrace = mainTraceConditionally config ms
\end{code}

2
iohk-monitoring/src/Cardano/BM/Data/Output.lhs

@ -47,7 +47,7 @@ data ScribeKind = FileSK
| JournalSK
#endif
| DevNullSK
| UserDefinedSK
| UserDefinedSK ScribeId
deriving (Generic, Eq, Ord, Show, Read, FromJSON, ToJSON)
\end{code}

2
iohk-monitoring/src/Cardano/BM/Plugin.lhs

@ -4,6 +4,7 @@
%if style == newcode
\begin{code}
{-# LANGUAGE MultiParamTypeClasses #-}
module Cardano.BM.Plugin
( Plugin (..)
, loadPlugin
@ -27,6 +28,7 @@ data Plugin a = BackendPlugin (Backend a) BackendId
| ScribePlugin Scribe ScribeId
\end{code}
\subsubsection{Plugin behaviour}
\subsubsection{Integrating plugins}
\begin{code}

2
iohk-monitoring/test/Cardano/BM/Test/Structured.lhs

@ -21,9 +21,9 @@ import Cardano.BM.Data.LogItem
import Cardano.BM.Tracing hiding (setupTrace)
import Cardano.BM.Data.Tracer
import Cardano.BM.Data.SubTrace
-- import Cardano.BM.Backend.Switchboard (MockSwitchboard (..))
import qualified Cardano.BM.Setup as Setup
import Cardano.BM.Test.Mock (MockSwitchboard (..))
import Cardano.BM.Test.Trace (TraceConfiguration (..), setupTrace)
import Test.Tasty (TestTree, testGroup)
import Test.Tasty.HUnit (Assertion , assertBool, testCase)

3
iohk-monitoring/test/Cardano/BM/Test/Trace.lhs

@ -45,7 +45,6 @@ import Cardano.BM.Data.Observable
import Cardano.BM.Data.Output
import Cardano.BM.Data.Severity
import Cardano.BM.Data.SubTrace
import Cardano.BM.Backend.Switchboard (MockSwitchboard (..))
#ifdef ENABLE_OBSERVABLES
import Cardano.BM.Counters (getMonoClock)
import Cardano.BM.Data.Aggregated
@ -53,11 +52,11 @@ import Cardano.BM.Data.Counter
import qualified Cardano.BM.Observer.Monadic as MonadicObserver
import qualified Cardano.BM.Observer.STM as STMObserver
#endif
import Cardano.BM.Backend.Switchboard (traceMock)
import qualified Cardano.BM.Setup as Setup
import Cardano.BM.Trace (Trace, appendName, logDebug, logInfo,
logInfoS, logNotice, logWarning, logError, logCritical,
logAlert, logEmergency)
import Cardano.BM.Test.Mock (MockSwitchboard (..), traceMock)
import Test.Tasty (TestTree, testGroup)
import Test.Tasty.HUnit (Assertion, assertBool, testCase,

5
lobemo-examples/CHANGELOG.md

@ -0,0 +1,5 @@
# Revision history for lobemo-examples
## 0.1.0.0 -- YYYY-mm-dd
* First version. Released on an unsuspecting world.

202
lobemo-examples/LICENSE

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

2
lobemo-examples/Setup.hs

@ -0,0 +1,2 @@
import Distribution.Simple
main = defaultMain

20
iohk-monitoring/examples/complex/Main.lhs → lobemo-examples/complex/Main.lhs

@ -35,7 +35,7 @@ import qualified Data.HashMap.Strict as HM
import Data.Text (Text, pack)
import System.Random
import Cardano.BM.Configuration (Configuration)
import Cardano.BM.Backend.Editor
import qualified Cardano.BM.Configuration.Model as CM
import Cardano.BM.Data.Aggregated (Measurable (..))
import Cardano.BM.Data.AggregatedKind
@ -51,6 +51,7 @@ import Cardano.BM.Data.Observable
import Cardano.BM.Observer.Monadic (bracketObserveIO)
import qualified Cardano.BM.Observer.STM as STM
#endif
import Cardano.BM.Plugin
import Cardano.BM.Setup
import Cardano.BM.Trace
@ -68,12 +69,6 @@ prepare_configuration = do
CM.setSetupBackends c [ KatipBK
#ifdef ENABLE_AGGREGATION
, AggregationBK
#endif
#ifdef ENABLE_EKG
, EKGViewBK
#endif
#ifdef ENABLE_GUI
, EditorBK
#endif
, MonitoringBK
, TraceForwarderBK
@ -181,13 +176,10 @@ prepare_configuration = do
CM.setAggregatedKind c "complex.random.rr" (Just StatsAK)
CM.setAggregatedKind c "complex.random.ewma.rr" (Just (EwmaAK 0.42))
#ifdef ENABLE_GUI
CM.setBackends c "#aggregation.complex.random" (Just [EditorBK])
CM.setBackends c "#aggregation.complex.random.ewma" (Just [EditorBK])
CM.setBackends c "#messagecounters.switchboard" (Just [EditorBK, KatipBK])
#endif
#ifdef ENABLE_EKG
CM.setSubTrace c "#messagecounters.monitoring" $ (Just Neutral)
CM.setBackends c "#aggregation.complex.message" (Just [EKGViewBK, MonitoringBK])
CM.setBackends c "#aggregation.complex.monitoring" (Just [MonitoringBK])
@ -196,10 +188,7 @@ prepare_configuration = do
CM.setLogOutput c "iohk-monitoring/log-pipe"
CM.setPrometheusPort c 12800
#endif
#ifdef ENABLE_GUI
CM.setGUIport c 13790
#endif
CM.setMonitors c $ HM.fromList
[ ( "complex.monitoring"
, ( Just (Compare "monitMe" (GE, (OpMeasurable 10)))
@ -374,7 +363,10 @@ main = do
c <- prepare_configuration
-- create initial top-level Trace
(tr :: Trace IO Text, _sb) <- setupTrace_ c "complex"
(tr :: Trace IO Text, sb) <- setupTrace_ c "complex"
-- load plugins
_ <- loadPlugin <$> Cardano.BM.Backend.Editor.plugin c tr sb
logNotice tr "starting program; hit CTRL-C to terminate"
-- user can watch the progress only if EKG is enabled.

75
lobemo-examples/lobemo-examples.cabal

@ -0,0 +1,75 @@
cabal-version: 2.0
name: lobemo-examples
version: 0.1.0.0
synopsis: examples of logging, benchmarking, and monitoring
-- description:
homepage: https://github.com/input-output-hk/iohk-monitoring-framework
-- bug-reports:
license: Apache-2.0
license-file: LICENSE
author: Alexander Diemand
maintainer: operations@iohk.io
-- copyright:
category: Benchmarking
build-type: Simple
extra-source-files: CHANGELOG.md
executable example-simple
main-is: Main.lhs
-- other-modules:
default-extensions: OverloadedStrings
other-extensions: CPP, FlexibleInstances, MultiParamTypeClasses, ScopedTypeVariables
ghc-options: -threaded -Wall -O2 "-with-rtsopts=-T"
build-depends: base ^>=4.12.0.0
hs-source-dirs: simple
default-language: Haskell2010
build-depends: base,
aeson,
iohk-monitoring,
lobemo-backend-editor,
async,
bytestring,
mtl
if os(windows)
build-depends: Win32
else
build-depends: unix
executable example-complex
hs-source-dirs: complex
main-is: Main.lhs
default-language: Haskell2010
default-extensions: OverloadedStrings
ghc-options: -threaded -Wall -O2 "-with-rtsopts=-T"
other-modules:
build-depends: base,
iohk-monitoring,
lobemo-backend-editor,
async,
bytestring,
mtl,
random,
text,
unordered-containers
if os(windows)
build-depends: Win32
else
build-depends: unix
if os(linux)
build-depends: download
executable example-performance
hs-source-dirs: performance
main-is: Main.lhs
default-language: Haskell2010
default-extensions: OverloadedStrings
ghc-options: -threaded -Wall -O2 -with-rtsopts=-T
other-modules:
build-depends: base,
iohk-monitoring,
async,
criterion,
text,
unordered-containers

0
iohk-monitoring/examples/performance/Main.lhs → lobemo-examples/performance/Main.lhs

0
iohk-monitoring/examples/performance/README.md → lobemo-examples/performance/README.md

0
iohk-monitoring/examples/simple/Main.lhs → lobemo-examples/simple/Main.lhs

202
plugins/backend-editor/LICENSE

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

5
plugins/backend-editor/NOTICE

@ -0,0 +1,5 @@
Copyright 2019 IOHK
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.txt
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.

4
plugins/backend-editor/README.md

@ -0,0 +1,4 @@
# backend for interactively managing configuration
access it via a browser on http://localhost:12789

2
plugins/backend-editor/Setup.hs

@ -0,0 +1,2 @@
import Distribution.Simple
main = defaultMain

41
plugins/backend-editor/lobemo-backend-editor.cabal

@ -0,0 +1,41 @@
cabal-version: 2.0
name: lobemo-backend-editor
version: 0.1.0.0
synopsis: provides a backend implementation to interactively manage configuration
-- description:
homepage: https://github.com/input-output-hk/iohk-monitoring-framework
-- bug-reports:
license: Apache-2.0
license-files: LICENSE, NOTICE
author: Alexander Diemand
maintainer: operations@iohk.io
copyright: 2019 IOHK
category: Benchmarking
build-type: Simple
extra-source-files: README.md
library
exposed-modules: Cardano.BM.Backend.Editor
-- other-modules:
-- other-extensions:
default-extensions: OverloadedStrings
build-depends: base >=4.11,
iohk-monitoring,
aeson,
async,
bytestring,
directory,
filepath,
safe,
safe-exceptions,
text,
time,
threepenny-gui,
unordered-containers
if os(windows)
build-depends: Win32
else
build-depends: unix
hs-source-dirs: src
default-language: Haskell2010

14
iohk-monitoring/src/Cardano/BM/Backend/Editor.lhs → plugins/backend-editor/src/Cardano/BM/Backend/Editor.lhs

@ -14,6 +14,8 @@ module Cardano.BM.Backend.Editor
, effectuate
, realizefrom
, unrealize
-- * Plugin
, plugin
) where
import Prelude hiding (lookup)
@ -48,6 +50,7 @@ import Cardano.BM.Data.Severity
import Cardano.BM.Data.SubTrace
import Cardano.BM.Data.Trace
import Cardano.BM.Backend.LogBuffer
import Cardano.BM.Plugin (Plugin (..))
import Cardano.BM.Rotator (tsformat)
\end{code}
@ -66,6 +69,17 @@ of log messages.
The GUI is built on top of \emph{Threepenny-GUI} (\url{http://hackage.haskell.org/package/threepenny-gui}).
The appearance is due to \emph{w3-css} (\url{https://www.w3schools.com/w3css}).
\subsubsection{Plugin definition}
\begin{code}
plugin :: (IsEffectuator s a, ToJSON a, FromJSON a) => Configuration -> Trace IO a -> s a -> IO (Plugin a)
plugin config trace sb = do
be :: Cardano.BM.Backend.Editor.Editor a <- realizefrom config trace sb
return $ BackendPlugin
(MkBackend { bEffectuate = effectuate be, bUnrealize = unrealize be })
"editor"
\end{code}
\subsubsection{Structure of Editor}\label{code:Editor}\index{Editor}
\begin{code}
type EditorMVar a = MVar (EditorInternal a)
Loading…
Cancel
Save