diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,9 @@ +# Changelog + +`grafdhall` uses [PVP Versioning][1]. + +## 0.1.0.0 + +* Initially created. + +[1]: https://pvp.haskell.org diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# grafdhall + +[![Hackage](https://img.shields.io/hackage/v/grafdhall.svg?logo=haskell)](https://hackage.haskell.org/package/grafdhall) +[![Apache-2.0 license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) + +`grafdhall` takes [Grafana][grafana] dashboards in Dhall format, and submits them to a grafana service. + +The CLI expects the following environment variables: + +- `GRAFANA_URL` : the url of the service. +- `GRAFANA_PASS` : the password of the user. +- `GRAFANA_USER` : the name of the user, defaults to `admin`. + +Uses the [dhall-grafana][dhall-grafana] bindings to write the dashboards, checkout the +[examples](./examples/). + +## Contribute + +Build the project: + +``` +$ cabal build +``` + +Run the cli: + +``` +$ cabal run grafdhall -- --help +``` + +[grafana]: https://grafana.com +[dhall-grafana]: https://github.com/weeezes/dhall-grafana diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,87 @@ +{-# LANGUAGE DerivingStrategies #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE OverloadedLists #-} +{-# LANGUAGE OverloadedStrings #-} + +module Main (main) where + +import Data.Aeson (Value (Array, Bool, Number, Object, String), encode) +import qualified Data.Aeson.KeyMap as HM (lookup) +import qualified Data.ByteString.Char8 as BS +import Data.Maybe (fromMaybe) +import qualified Data.Text as T +import Dhall (inputExpr) +import Dhall.JSON (Conversion (..), convertToHomogeneousMaps, dhallToJSON, omitNull) +import Network.HTTP.Client + ( RequestBody (RequestBodyLBS), + Response (responseStatus), + applyBasicAuth, + httpNoBody, + method, + parseRequest, + requestBody, + requestHeaders, + ) +import Network.HTTP.Client.TLS (newTlsManager) +import Network.HTTP.Types (Status (statusCode)) +import System.Environment (getArgs, getEnv, lookupEnv) + +defaultConversion :: Conversion +defaultConversion = + Conversion + { mapKey = "mapKey", + mapValue = "mapValue" + } + +postDashboard :: Value -> IO () +postDashboard dashboard = do + grafanaUrl <- getEnv "GRAFANA_URL" + grafanaPass <- BS.pack <$> getEnv "GRAFANA_PASS" + grafanaUser <- BS.pack . fromMaybe "admin" <$> lookupEnv "GRAFANA_USER" + initReq <- parseRequest $ grafanaUrl <> "/api/dashboards/db" + let req = + applyBasicAuth grafanaUser grafanaPass $ + initReq + { method = "POST", + requestHeaders = [("Content-Type", "application/json")], + requestBody = RequestBodyLBS (encode body) + } + manager <- newTlsManager + resp <- httpNoBody req manager + case statusCode $ responseStatus resp of + 200 -> putStrLn $ "Dashboard updated: " <> dashboardName + _ -> error $ "Got " <> show resp + where + getString :: Value -> String + getString = \case + String txt -> T.unpack txt + _ -> error "Not a string" + body = + Object + [ ("dashboard", dashboard), + ("folderId", Number 0), + ("overwrite", Bool True) + ] + dashboardName = getString $ case dashboard of + Object attrs -> fromMaybe (error "title missing") $ HM.lookup "title" attrs + _ -> error "Dashboard is not an object" + +postDashboards :: Value -> IO () +postDashboards = \case + Array xs -> mapM_ postDashboard xs + x -> postDashboard x + +load :: FilePath -> IO () +load fp = do + confExpr <- inputExpr (T.pack fp) + case dhallToJSON (convertToHomogeneousMaps defaultConversion confExpr) of + Right v -> postDashboards (omitNull v) + Left err -> error ("Could not convert configuration to JSON: " <> show err) + +main :: IO () +main = do + args <- getArgs + case args of + ["--help"] -> putStrLn "usage: grafdhall ./conf.dhall" + [fp] -> load fp + _ -> putStrLn "usage: grafdhall ./conf.dhall" diff --git a/examples/zuul-tenant-usage.dhall b/examples/zuul-tenant-usage.dhall new file mode 100644 --- /dev/null +++ b/examples/zuul-tenant-usage.dhall @@ -0,0 +1,116 @@ +let Grafana = + https://raw.githubusercontent.com/weeezes/dhall-grafana/f78d2887939dcb555a47a4b85a91a3d6b38ec2ea/package.dhall sha256:a0e1b5432090944fa671efce0085c6049019ae0d00ca289c268b4528d1cd39af + +let Prelude = + https://prelude.dhall-lang.org/v17.0.0/package.dhall sha256:10db3c919c25e9046833df897a8ffe2701dc390fa0893d958c3430524be5a43e + +let Tenant = { Type = { name : Text, id : Text } } + +let tenants = + [ { name = "Fedora", id = "fedora" } + , { name = "RDO", id = "rdoproject_org" } + , { name = "Packit", id = "packit-service" } + , { name = "Local", id = "local" } + ] + +let gauge = + \(measurement : Text) -> + Grafana.MetricsTargets.InfluxTarget + { groupBy = + [ { type = "time", params = [ "\$__interval" ] } + , { type = "fill", params = [ "previous" ] } + ] + , measurement + , orderByTime = "ASC" + , policy = "default" + , refId = "A" + , rawQuery = False + , query = "" + , resultFormat = "time_series" + , select = + [ [ { type = "field", params = [ "value" ] } + , { type = "distinct", params = [] : List Text } + ] + ] + , tags = [ { key = "metric_type", operator = "=", value = "gauge" } ] + } + +let resource-panel = + \(title : Text) -> + \(measurement : Text) -> + Grafana.Panels.mkGraphPanel + Grafana.GraphPanel::{ + , title + , gridPos = { x = 0, y = 1, w = 24, h = 8 } + , targets = [ gauge measurement ] + } + +let panels = + \(tenant : Text) -> + [ Grafana.Panels.mkTextPanel + Grafana.TextPanel::{ + , title = "Generated with grafdhall" + , gridPos = { x = 0, y = 0, w = 24, h = 1 } + , content = + '' + # This dashboard is generated with grafdhall + '' + } + , resource-panel + "Instances" + "zuul.nodepool.resources.tenant.${tenant}.instances" + , resource-panel + "Cores" + "zuul.nodepool.resources.tenant.${tenant}.cores" + , resource-panel "Memory" "zuul.nodepool.resources.tenant.${tenant}.ram" + ] + +let all-panel = + \(measurement : Text) -> + Grafana.Panels.mkGraphPanel + Grafana.GraphPanel::{ + , title = "Resources usage: ${measurement}" + , gridPos = { x = 0, y = 0, w = 24, h = 8 } + , targets = + Prelude.List.map + Tenant.Type + Grafana.MetricsTargets + ( \(tenant : Tenant.Type) -> + gauge + "zuul.nodepool.resources.tenant.${tenant.id}.${measurement}" + ) + tenants + } + +let tenant-dashboard = + \(tenant : Tenant.Type) -> + Grafana.Dashboard::{ + , title = "Tenant ${tenant.name} resources usage" + , panels = Grafana.Utils.generateIds (panels tenant.id) + , uid = Some "${tenant.name}-tenant-resources" + , editable = True + } + +let tenant-dashboards = + Prelude.List.map + Tenant.Type + Grafana.Dashboard.Type + tenant-dashboard + tenants + +let all-tenant-dashboard = + Grafana.Dashboard::{ + , title = "Tenants resource usage" + , uid = Some "all-tenants-resources" + , panels = + Grafana.Utils.generateIds + ( Prelude.List.map + Text + (Natural -> Grafana.Panels.Panels) + all-panel + [ "instances", "cores", "ram" ] + ) + , editable = True + } + +in [ all-tenant-dashboard ] # tenant-dashboards diff --git a/grafdhall.cabal b/grafdhall.cabal new file mode 100644 --- /dev/null +++ b/grafdhall.cabal @@ -0,0 +1,62 @@ +cabal-version: 2.4 +name: grafdhall +version: 0.1.0.0 +synopsis: Configure grafana dashboards from Dhall expression +description: + grafdhall takes Grafana dashboards in Dhall format, and submits them to a grafana service. + . +homepage: https://github.com/softwarefactory-project/grafdhall#readme +bug-reports: https://github.com/softwarefactory-project/grafdhall/issues +license: Apache-2.0 +license-file: LICENSE +author: Tristan de Cacqueray +maintainer: Tristan de Cacqueray +copyright: 2021 Red Hat +category: System +build-type: Simple +extra-doc-files: README.md + CHANGELOG.md + examples/*.dhall +tested-with: GHC == 8.10.4 + +source-repository head + type: git + location: https://github.com/softwarefactory-project/grafdhall.git + +common common-options + build-depends: base < 5 + , aeson + , bytestring + , dhall + , dhall-json + , http-client + , http-client-tls + , http-types + , text + , unordered-containers + + ghc-options: -Wall + -Wcompat + -Widentities + -Wincomplete-uni-patterns + -Wincomplete-record-updates + if impl(ghc >= 8.0) + ghc-options: -Wredundant-constraints + if impl(ghc >= 8.2) + ghc-options: -fhide-source-paths + if impl(ghc >= 8.4) + ghc-options: -Wmissing-export-lists + -Wpartial-fields + if impl(ghc >= 8.8) + ghc-options: -Wmissing-deriving-strategies + + default-language: Haskell2010 + +executable grafdhall + import: common-options + hs-source-dirs: app + main-is: Main.hs + + ghc-options: -threaded + -rtsopts + -with-rtsopts=-N