Edit JsonData object

patrickju · May 6, 2019, 6:46pm

I’m writing a datasource plugin with a backend component and everything is working fine.

I’d like to be able to edit the jsonData object of the datasource that will be persisted by Grafana. Either from the datasource class of the frontend or from the backend part. Can I do this?

daniellee · May 10, 2019, 6:59pm

Yes, if you inject the backendSrv service into your constructor then you have access to the Grafana api and can update the jsonData for the datasource.

You need to fetch the datasource first. Here is an example from the kubernetes app:

github.com

grafana/kubernetes-app/blob/master/src/components/clusters/clusterConfig.ts#L192-L203


getPrometheusDatasources() {
  var self = this;
  return this.backendSrv.get('/api/datasources')
  .then((result) => {
    // self.hostedMetricsDS = _.filter(result, obj =>
    //   /grafana.net\/(graphite|prometheus)$/.test(obj.url)
    // );
    self.datasources = _.filter(result, {
      "type": "prometheus"
    });
  });
}

Then you can save it with backendSrv.put:

github.com

grafana/kubernetes-app/blob/master/src/components/clusters/clusterConfig.ts#L294-L300


saveDatasource() {
  if (this.cluster.id) {
    return this.backendSrv.put('/api/datasources/' + this.cluster.id, this.cluster);
  } else {
    return this.backendSrv.post('/api/datasources', this.cluster);
  }
}

patrickju · May 11, 2019, 7:03am

Thanks a lot!

Is something similar possible from a datasource backend plugin component? I see that built-in datasources have access to it, e.g. stackdriver, see https://github.com/grafana/grafana/blob/6724aaeff9a332dc73b4ee0f8abe0621f7253142/pkg/tsdb/stackdriver/stackdriver.go#L96. Is something like this possible from a datasource backend plugin?

daniellee · May 14, 2019, 10:11pm

You mean if it is possible to get access to the jsonData blob from the backend in Go?

Yes, the DatasourceRequest object has a DatasourceInfo field. It is passed in as the second parameter to the Query function.

github.com

grafana/simple-json-backend-datasource/blob/master/pkg/datasource.go#L26


	plugin "github.com/hashicorp/go-plugin"
	"golang.org/x/net/context"
	"golang.org/x/net/context/ctxhttp"
)


type JsonDatasource struct {
	plugin.NetRPCUnsupportedPlugin
	logger hclog.Logger
}


func (ds *JsonDatasource) Query(ctx context.Context, tsdbReq *datasource.DatasourceRequest) (*datasource.DatasourceResponse, error) {
	ds.logger.Debug("Query", "datasource", tsdbReq.Datasource.Name, "TimeRange", tsdbReq.TimeRange)


	queryType, err := GetQueryType(tsdbReq)
	if err != nil {
		return nil, err
	}


	ds.logger.Debug("createRequest", "queryType", queryType)


	switch queryType {

patrickju · May 15, 2019, 3:12pm

But can I also write to it? I don’t think I can edit it, right?

My specific use-case: I’m using a backend datasource plugin to deal with some non-standard OAuth authentication issue I’m having. I can’t use Grafana’s OAuth support because of some detail. Everything works great with my backend plugin but it would be great if it could store e.g. the refresh token in a secure way. But I don’t think this is possible for datasource backend plugins. Is this correct? Could I submit this as a feature request to the Github repository?

Topic		Replies	Views
Data source API, getDataSourceSrv() help Grafana Plugin Development	1	407	May 18, 2022
jsonData field for datasource plugins Grafana Plugin Development	1	576	December 1, 2017
I am building a DataSource Plugin, use getBackendSrv to Get data from an external API, but the request still made from the browser Grafana Plugin Development	5	137	July 13, 2024
Backend Datasource : Request Object Null Grafana Plugin Development	5	1840	April 10, 2017
How to get datasource list and datasource form from another datasource? Grafana Plugin Development	2	1211	May 11, 2019

Edit JsonData object

Related topics