grafana / grafana-plugin-repository Goto Github PK

The plugin repository for plugins that are published on grafana.com.

JavaScript 97.65% Shell 2.35%

grafana-plugin-repository's Introduction

Community plugins

We originally created this repository years ago to accept plugin submissions from the Grafana community. With more than 150 plugins now published, it has become obvious that the community plugins are instrumental in Grafana's success. Due to this, we've make the process of submitting plugins easier.

You can now submit and maintain your plugin directly from your Grafana Cloud account!

This also means that we're starting the process of deprecating this repository. Here's how it affects you:

If your pull request has been triaged by us already and is waiting for review, you don't need to do anything. We'll continue to review the remaining plugin submissions in the pipeline.
If you'd like, you can migrate your current plugin submission by submitting it through the new submission flow. Let us know that you'd like to use the new flow by updating your pull request. Please keep the pull request open to keep your position in the review queue.
If you're submitting a new plugin or an update to an existing plugin, please use the new submission flow. We won't accept any new plugin submissions on this repository.

If you have any questions, create a new issue, or send an email to [email protected].

Submit your plugin

Before you submit your plugin, we ask that you read our guidelines and frequently asked questions.

Sign in to your Grafana Cloud account.
In the left menu, under Org settings, click My Plugins.
Click Submit Plugin.
Enter the information requested by the form.
- OS & Architecture:
  - Select Single if your plugin archive contains binaries for multiple architectures.
  - Select Multiple if you'd like to submit separate plugin archives for each architecture. This can lead to faster downloads since users can select the specific architecture on which they want to install the plugin.
- URL: A URL that points to a ZIP archive of your packaged plugin.
- MD5: The MD5 hash of the plugin specified by the URL.
- The remaining questions help us determine the signature level for your plugin.
Click Submit.

After you have submitted your plugin, we run an automated validation to make sure it adheres to our guidelines. Once your submission passes the validation, it's placed in a review queue.

All submissions are manually inspected by a plugin reviewer. For every new plugin, we perform a manual review that includes the following checks:

Code review: For quality and security purposes, we review the source code for the plugin. If you're unable to make the source code publicly available, let us know in a comment on your plugin submission.
Tests: We install your plugin on one of our Grafana instances to test it for basic use. For more advanced plugins, we may ask you to assist us in configuring a test environment for the plugin. This test environment will be used whenever you submit an plugin update.

Maintain your plugin

To submit an update for an already published plugin:

Sign in to your Grafana Cloud account.
In the left menu, under Org settings, click My Plugins.
Click Submit Update for the plugin you want to update.
Enter the information requested by the form.
- OS & Architecture:
  - Select Single if your plugin archive contains binaries for multiple architectures.
  - Select Multiple if you'd like to submit separate plugin archives for each architecture. This can lead to faster downloads since users can select the specific architecture they want to install the plugin on.
- URL: A URL that points to a ZIP archive of your packaged plugin.
- MD5: The MD5 hash of the plugin specified by the URL.
Click Submit.

Guidelines

To speed up the time it takes to review your plugin:

Check that your plugin is ready for review using the plugin validator.
Read our 6 tips for improving your Grafana plugin before you publish

FAQ

Do I need to submit a private plugin?: No. Please only submit plugins that you wish to make publicly available for the Grafana community.
How long does it take to review my submission?: We're not able to give an estimate at this time, though we're constantly working on improving the time it takes to review a plugin.

grafana-plugin-repository's People

Contributors

Stargazers

Watchers

Forkers

alexanderzobnin j-white hitripod bentekkie felixbarny stagemonitor ivanarkhipov mtanda prajwalrao abhisant grafana-druid-plugin clackner-gpa foursquare andybaumgar jotak neocat tomer-amir-vonage belugacdn peregrinogris ryantxu vertamedia vavrusa naiconovalabs novalabs yehonatanvonage project-fifo zeppafi sileht chris7 cryptobioz petrslavotinek linar-jether digrich ddurieux safchain samhatchett fzakaria vinothrajasekar lostinbrittany corpglory gauravshah lazin pkarmaka cinek810 rpufky grafanaplus statseeker eeishaan marcuscalidus nzvereff jeroensoeters moogjet pueteam ambud yesoreyeram adremsoft citilogics dracoblue ammpio peay quanganhtran smartmakers flespi-software ssirois fatcloud janchorizo bobrik gretamosa knaky41 miton18 sbueringer flant carlosdoki goodwinos akruman riclolsen petemyron bitmovin briangann mbarekh lucasarona dalavancloud mxswat untu digitalkaoz hulien22 rangerrick dlopes7 farshidtz languyen85 algenty altinity plixer briandav22 taoran34 aocenas bureau14 davidglvn knonomura mananarya22

grafana-plugin-repository's Issues

Subproject or project URL

Is it possible to use a subproject github URL for the plugin or does it need to be a full project URL i.e. will this work? https://github.com/srotya/sidewinder/tree/development/grafana

Plugin auxmoney-waterfall-panel is not installable by grafana-cli

Hi,

we added a new panel plugin in #863 and installed it successfully in our production environment using the ZIP file provided at grafana.com. Now, an external user tried to install it by grafana-cli in his/her environment, but got the error ( see auxmoney/grafana-waterfall-panel#8 ):

failed to find plugin 'auxmoney-waterfall-panel' in plugin repository. Please check if plugin ID is correct

I can reproduce this behaviour in a fresh grafana docker environment, and additionally, grafana plugins list-remote does not even show our plugin, which explains the error at install time.

What steps do we need to make in order to make our plugin available for grafana-cli? Did we misconfigure something?

Thanks in advance,
best regards,
@cawolf

Error with Zabbix plugin in Grafana

Uncaught (in promise)
Object
config:
data: {datasourceId: 37, method: "apiinfo.version", params: {…}}
headers: {Content-Type: "application/json", X-Grafana-Org-Id: 1}
hideFromInspector: false
method: "POST"
retry: 0
url: "api/datasources/37/resources/zabbix-api"
proto: Object
data:
error: "Internal Server Error"
message: "Post "https://xxxxxxx/zabbix/api_jsonprc": context deadline exceeded"
proto: Object
status: 500
statusText: "Internal Server Error"
proto:
constructor: ƒ Object()
hasOwnProperty: ƒ hasOwnProperty()
isPrototypeOf: ƒ isPrototypeOf()
propertyIsEnumerable: ƒ propertyIsEnumerable()
toLocaleString: ƒ toLocaleString()
toString: ƒ toString()
valueOf: ƒ valueOf()
defineGetter: ƒ defineGetter()
defineSetter: ƒ defineSetter()
lookupGetter: ƒ lookupGetter()
lookupSetter: ƒ lookupSetter()
get proto: ƒ proto()
set proto: ƒ proto()

installed plugins not showing grafana:7.3.7

Hi,
I created new image from grafana:7.3.7 and the plugin does not apear in the list
the docker looks as follows:
from grafana/grafana:7.3.7
RUN grafana-cli plugins install grafana-worldmap-panel

i see the plugin within the instance, however not picked up..:
bash-5.0$ ls /var/lib/grafana/plugins
grafana-worldmap-panel
any idea?
Thanks,
Amit

Installed Plugins are not showing in dashboard

I have installed some plugins to use it for plotting data . These plugins are showing in plugin folder but not in dashboard while selecting visualization . Please see attached images.

change category property to type

Dist folder alternatives?

Do I have to version a dist folder? Isn't there any alternative? Thanks!

Cannot submit an update for an already published plugin

Hello,
I am the maintainer of bigquery-grafana plugin by DoiT International.
I am willing to submit a version 2.0.3 update for our plugin.
When I am trying to use the new submission method described on your README im running into an error.

You did not explain how should I configure grafana cloud to recognise me as a part of a team which already has a live plugin, so it will appear on Published Plugins section and will allow me to update plugin
When im trying to use submit plugin im getting this error:
Plugin id contains incorrect org. Expected: ofircohen, but got: doitintl.

How should I act?
@daniellee @marcusolsson

Merge Pull Request

Hi All,

We really need this pull request to be merged. Ive been trying to get this merged for a while now with no response.

#879

publication planified ?

Hi grafana team,
I am the author Flowcharting plugin.
I have increasingly issues on the project, maybe the number of users increases too (any stats on it ?).
To schedule releases, I need to know the frequency of publication.
Is there a rule? How can I help you in quality analysis? required deliverable ?

BR
Arnaud

Add circle ci and json lint validation (so we dont accidentally checkin broken json)

Change plugin name and owner

Hi,

We would like to change the organisation of linksmart-sensorthings-datasource plugin. See linksmart/grafana-sensorthings-datasource#58.

I am the maintainer of this plugin and have been submitting all the updates from the beginning; see PRs.

Could you guide us on how to perform the following:

Change the name from linksmart-sensorthings-datasource to frost-sensorthings-datasource
Change owner from LinkSmart to FraunhoferIOSB

Thanks a lot

Empty pages on developer docs

I'm trying to follow the guide on how to publish a plugin.
But when clicking on few links, they are broken as they result in empty pages:

https://grafana.com/docs/grafana/latest/plugins/developing/plugin-review-guidelines/
https://grafana.com/docs/grafana/latest/plugins/developing/

Thanks !

Worst docs and tutorials for plug in dev

Id like to work with you to develop a solid tut on plug in dev.

Please improve response times

As developers we depend on the Grafana plugin repository for discoverability of our plugins. Other projects like e.g. node-red have found less restrictive plugin mechanisms by utilising e.g. npm and keywords but for the time being it is this repository.

Review and merge times are abyssal:

#320 took 14 days without any comment. Sofar.
#301 took > 24 days
#300 took about a month

I'm kindly asking Grafana to improve response times for reviewing and merging plugins. While I understand that this might not be highest priority our plugins contribute to the success of Grafana and do deserve some more attention.

financial charts support

I hope that grafana can release a financial plugin like trading view,or just support trading view

"Review Guidelines" link in .github/PULL_REQUEST_TEMPLATE.md is outdated

http://docs.grafana.org/plugins/developing/plugin-review-guidelines/ shows nothing.

GitHub bot for handling PRs

Recently I added more checks into CircleCI configuration. It's really helpful and let you know if something wrong in the pushed plugin. But if it fails, you have to go to the CircleCI and look into the logs. The same thing with warnings. There's no possibility to show warnings with CircleCI - the build is only green or red.
Would be much better to have a kind of PR summary posted after all checks are finished. Something like codecov does:

It's possible via GitHub API, but in this case, you have to write your script and add it into CircleCI config. The problem is a github token. In order to allow script to publish a comment, you have to pass api token into the script. It may be done with CircleCI env variables, but if you want to run this script for the external PRs you need to allow passing env variables to external PRs. It's not a secure way, because external user can change a circleci config and get access to github token.

So the good alternative is to build our own github bot (with probot, for instance). Bot is listening for webhooks and can run checks and post PR summary. Another benefit from this approach - we automate issue triage and add some labels like new plugin, update, and, for example, priority based on plugin popularity.

It's related to #332 as well.

Server 500 when validate plugin

Server 500 when validate plugin...

here is repo

Vonage Grafana_Status_panel version out of date in repo

This is currently in the file (https://github.com/grafana/grafana-plugin-repository/blob/master/repo.json) :

      "id": "vonage-status-panel",
      "type": "panel",
      "url": "https://github.com/Vonage/Grafana_Status_panel",
      "versions": [
        {
          "version": "1.0.10",
          "commit": "ca77e0dd94b27088f071f8d61a67fe0256faca2f",
          "url": "https://github.com/Vonage/Grafana_Status_panel"
        },

However, on the web page it's 1.0.11:

https://grafana.com/grafana/plugins/vonage-status-panel/

This is preventing users from using it, as the 1.0.10 is not properly signed, apparently.

Thanks!

Plugin github url are wrong

Currently github plugin url are generated with the plugin name instead of using the one in repo.json.

little question with toolkit

Hi Grafana team,

A little question, with grafana-toolkit, should the dist directory be part of the delivery git or you build it ?

BR
Arnaud

sign plugin by npx failed on Ubuntu 20.04

$ nodejs --version
v10.19.0
$ npm --version
6.14.4
$ npx --version
6.14.4
$ yarn --version
0.32+git

$ npx @grafana/toolkit plugin:sign
Building manifest...
TypeError: fs_1.default.promises.opendir is not a function
at /home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/src/plugins/manifest.js:17:80
at step (/home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:140:27)
at Object.next (/home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:121:57)
at resume (/home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:210:48)
at /home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:209:125
at new Promise ()
at Object.i.(anonymous function) [as next] (/home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:209:67)
at Object. (/home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/src/plugins/manifest.js:94:49)
at step (/home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:140:27)
at Object.next (/home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:121:57)
at fulfilled (/home/shuduo/.npm/_npx/18445/lib/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:111:62)
at process._tickCallback (internal/process/next_tick.js:68:7)
at Function.Module.runMain (internal/modules/cjs/loader.js:834:11)
at findNodeScript.then.existing (/usr/share/nodejs/libnpx/index.js:268:14)

Why the linter expects a README.md under src/ ?

Hello.

I am trying to add my traceroute-map-panel plugin to the repository.

When running yarn lint, it shows error:
FAIL: ["Failed to fetch README.md from GitHub: NotFoundError: Couldn't load https://api.github.com/repos/Gowee/traceroute-map-panel/contents/src/README.md?ref=ae2c031292ff52495cac10f070e086be27a67406: 404 {\"message\":\"Not Found\",\"documentation_url\":\"https://developer.github.com/v3/repos/contents/#get-contents\"}"] .

It seems to attempt to load src/README.md, which is 404 NOT FOUND, instead of README.md. Is it by design so that an additional README.md is required in src/ or I get something wrong?

I randomly check some plugins: the grafana-kdb-datasource-ws plugin has two README.md while the grafana-zabbix plugin has no src/README.md.

Here is my addition in repo.json:

{
  "id": "gowee-traceroute-map-panel",
  "type": "panel",
  "url": "https://github.com/Gowee/traceroute-map-panel",
  "versions": [
    {
      "version": "0.2.0",
      "commit": "ae2c031292ff52495cac10f070e086be27a67406",
      "url": "https://github.com/Gowee/traceroute-map-panel"
    }        
  ]
}

quicklog-panel-plugin

Hi!

I made a new panel plugin. I would like to share with grafana community. I cloned this repository: https://github.com/marcusolsson/grafana-hexmap-panel

When a create new tag (release) my signature flow fails. Here is what I got: https://github.com/ui3o/grafana-quick-log-panel/runs/2833780981?check_suite_focus=true#step:13:12

Run yarn sign
yarn run v1.22.10
$ grafana-toolkit plugin:sign
  Building manifest...
  Signing manifest...
  Error: Error signing manifest: Field is required: rootUrls
      at Object.<anonymous> (/home/runner/work/grafana-quick-log-panel/grafana-quick-log-panel/node_modules/@grafana/toolkit/src/plugins/manifest.js:165:31)
      at step (/home/runner/work/grafana-quick-log-panel/grafana-quick-log-panel/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:140:27)
      at Object.throw (/home/runner/work/grafana-quick-log-panel/grafana-quick-log-panel/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:121:57)
      at rejected (/home/runner/work/grafana-quick-log-panel/grafana-quick-log-panel/node_modules/@grafana/toolkit/node_modules/tslib/tslib.js:112:69)
      at processTicksAndRejections (internal/process/task_queues.js:95:5)
Done in 1.32s.

I read this: https://grafana.com/docs/grafana/latest/administration/configuration/#root_url
I know if I want to use it on private server how it possible, but what do I need to do if I want to share?

Please help me to finish my flow. I hope I can give it to the community soon.

Thank you!

"A plugin with the specified slug already exists" show up when I submit my plugin

hi there,

I am trying to submit a data source (time-series database TDengine) plugin to Grafana with the new process. When I click the submit button, a msg shows up at the bottom "A plugin with the specified slug already exists" few seconds then disappeared. I did submit the plugin (#704) at an early time but it did not pass validation successfully. I don't if the error msg is related to my early submission. I wonder how to solve it now. Appreciated it if someone can help.

Shuduo | TAOS Data

grafana.net doesn't update README.md from plugin repository

https://grafana.com/grafana/plugins/vertamedia-clickhouse-datasource
contains README different than https://github.com/Vertamedia/clickhouse-grafana/blob/master/dist/README.md