{"id":15062595,"url":"https://github.com/yoomoney/grafana-dashboard-plugin","last_synced_at":"2025-10-04T22:31:18.677Z","repository":{"id":143714848,"uuid":"158902048","full_name":"yoomoney/grafana-dashboard-plugin","owner":"yoomoney","description":"Gradle plugin for grafana dashboards publication","archived":true,"fork":false,"pushed_at":"2022-04-11T15:05:16.000Z","size":663,"stargazers_count":16,"open_issues_count":2,"forks_count":6,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-03T19:25:44.422Z","etag":null,"topics":["backend","cicd","gradle-plugin","grafana","grafana-dashboard","grafana-dashboard-dsl","grafana-dashboard-plugin","kotlin"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yoomoney.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-24T04:23:18.000Z","updated_at":"2023-11-06T10:42:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"d3e078b2-8e4d-4d8a-aff9-0701d241e1cd","html_url":"https://github.com/yoomoney/grafana-dashboard-plugin","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/yoomoney/grafana-dashboard-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoomoney%2Fgrafana-dashboard-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoomoney%2Fgrafana-dashboard-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoomoney%2Fgrafana-dashboard-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoomoney%2Fgrafana-dashboard-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yoomoney","download_url":"https://codeload.github.com/yoomoney/grafana-dashboard-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoomoney%2Fgrafana-dashboard-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278386095,"owners_count":25978109,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","cicd","gradle-plugin","grafana","grafana-dashboard","grafana-dashboard-dsl","grafana-dashboard-plugin","kotlin"],"created_at":"2024-09-24T23:43:22.203Z","updated_at":"2025-10-04T22:31:18.672Z","avatar_url":"https://github.com/yoomoney.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://api.travis-ci.com/yoomoney/grafana-dashboard-plugin.svg?branch=master)](https://travis-ci.com/yoomoney/grafana-dashboard-plugin)\n[![codecov](https://codecov.io/gh/yoomoney/grafana-dashboard-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/yoomoney/grafana-dashboard-plugin)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n# Grafana Dashboard Plugin\n\nPlugin for automatic dashboards creation in [Grafana](https://grafana.com)\n\n# Motivation\n\nThe primary goal of this project is to ease support and maintenance of dashboards in grafana. \n\nWe, a team at YooMoney, have many dashboards for our projects, and it's often hard to answer these questions:\n\n* Who created the dashboard?\n* What it's purpose?\n* Is it working correctly?\n* How can i reuse some dashboards?\n\nSo, to come up to the solution to these answers, we do as following:\n\n* Store dashboards in vcs with application code\n* Have CI jobs for updating dashboards contents\n* Use [Grafana Dashboard Dsl](https://github.com/yoomoney-tech/grafana-dashboard-dsl) for declaring dashboards\n\nThese methods of creating and maintaining dashboards allow us:\n\n* See author and changes made in particular dashboards\n* Ease of understanding what metrics used for monitoring application\n* In case of broken dashboard quickly understand and fix the problems\n* Reuse parts of whole contents of dashboards in other application\n\n# Usage\n\n```groovy\nplugins {\n    id 'ru.yoomoney.gradle.plugins.grafana-dashboard-plugin' version '2.0.5'\n}\n\ngrafana {\n    // Required, URL to Grafana\n    url = 'https://grafana.example.ru'\n    \n    // Required, Grafana authentication API token \n    apiToken = 'apiToken'\n    \n    // Directory with dashboards descriptions, default is: 'grafana'\n    dir = 'grafana'\n    \n    // Folder id to save to, default is: '0'\n    folderId = '0'\n    \n    // Overwrite existing dashboards, default is: true    \n    overwrite = true\n    \n    // Additional classpath to use during dashboard scripts evaluation\n    classpath = null\n   \n    // Print collected dashboards to stdout, default is: false\n    printCollectedDashboards = false\n\n    // Trust all SSL certificates, default is: false\n    trustAllSslCertificates = false\n}\n```\n\n# How does it work?\n\nThe plugin supports two work scenarios.\n1. Scans the folder, configured in settings (grafana.dir)\n2. Scans the artifacts, declare in grafanaDashboardsCompile configuration\n\nScans for files with dashboards description, in following formats:\n\n* JSON (file extension `.json`)\n* Kotlin Script (file extension `.kts`)\n\nThen use task called `uploadGrafanaDashboards` to publish your dashboards, or `collectGrafanaDashboards` for print \nyour dashboards to stdout.\n\n## JSON\n\nSimple format, uploaded to grafana as is.\nYou can check up description in Grafana -\u003e Dashboard -\u003e Settings -\u003e JSON Model.\n\n## Kotlin Script\n\nFor this format, plugin executes files with kotlin code and expects that\nan output is a description of dashboards in JSON format.\n\nIt is most useful when used with another one of our projects: [Grafana Dashboard Dsl](https://github.com/yoomoney-tech/grafana-dashboard-dsl)\n\nSourceSet was separated into grafanaFromArtifact and grafanaFromDir for the purpose to announce different versions of dsl.\nJust add a dependency to build script, in the `grafanaFromDirCompile` and `grafanaFromArtifactCompile` source set, \nas follows:\n\n```groovy\ndependencies {\n    grafanaFromDirCompile 'ru.yoomoney.tech:grafana-dashboard-dsl:1.2.0'\n    grafanaFromArtifactCompile 'ru.yoomoney.tech:grafana-dashboard-dsl:1.1.0'\n}\n```\n\n# How to contribute?\n\nJust fork the repo and send us a pull request.\n\nMake sure your branch builds without any warnings/issues.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoomoney%2Fgrafana-dashboard-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoomoney%2Fgrafana-dashboard-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoomoney%2Fgrafana-dashboard-plugin/lists"}