mirror of https://github.com/grafana/grafana
Actually remove the plugins docs now that all the links are redirected to https://grafana.com/developers/ (#75638)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>pull/75890/head
Jack Baldry
2 years ago
committed by
GitHub
parent
cb0344d2c2
commit
3409c1b857
@ -1,52 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../plugins/developing/ |
||||
description: Resources for creating Grafana plugins |
||||
title: Plugin developer's guide |
||||
weight: 200 |
||||
--- |
||||
|
||||
# Grafana plugin developer's guide |
||||
|
||||
You can extend Grafana's built-in capabilities with plugins. Plugins enable Grafana to accomplish specialized tasks, custom-tailored to your requirements. By making a plugin for your organization, you can connect Grafana to other data sources, ticketing tools, and CI/CD tooling. |
||||
|
||||
You can create plugins for private use or contribute them to the open source community by publishing to the [Grafana plugin catalog](https://grafana.com/grafana/plugins/). This catalog has hundreds of other community and commercial plugins. |
||||
|
||||
If you are a Grafana plugin developer or want to become one, this plugin developer's guide contains the tutorials and reference materials to help you get started. |
||||
|
||||
## Plugin basics |
||||
|
||||
- **Panel plugins** - Visualize data and navigate between dashboards. |
||||
- **Data source plugins** - Link to new databases or other sources of data. |
||||
- **App plugins** - Create rich applications for custom out-of-the-box experiences. |
||||
|
||||
> **Note:** To learn more about the types of plugins you can build, refer to the [Plugin management]({{< relref "../../administration/plugin-management" >}}) documentation. |
||||
|
||||
## Contents of this developer's guide |
||||
|
||||
The following topics are covered in this guide: |
||||
|
||||
- **[Get started with plugins]({{< relref "./get-started-with-plugins" >}})** - Start developing Grafana plugins with the [Create-plugin](https://www.npmjs.com/package/@grafana/create-plugin) tool. |
||||
- **[Introduction to plugin development]({{< relref "./introduction-to-plugin-development" >}})** - Learn the fundamentals of Grafana plugin development: frontend and backend development processes, data frames, error handling, and more. |
||||
- **[Create a Grafana plugin]({{< relref "./create-a-grafana-plugin" >}})** - If you're familiar with plugin creation, use the tutorials for creating panel plugins, data source plugins, and more to deepen your knowledge. |
||||
- **[Migrate a plugin]({{< relref "./migration-guide" >}})** - Learn how to upgrade from a previous version of a Grafana plugin, rewrite an old Angular plugin in React, or update to a newer version. |
||||
- **[Publish a Grafana plugin]({{< relref "./publish-a-plugin" >}})** - Learn about publishing a plugin to the Grafana plugin catalog, including publishing criteria, packaging, and deployment. |
||||
- **[Reference]({{< relref "metadata.md" >}})** - Description of the `plugin.json` schema and plugin metadata. |
||||
|
||||
## Go further |
||||
|
||||
Learn more about additional tools and see plugin type examples. |
||||
|
||||
### User interface creation |
||||
|
||||
> > > > > > > 13be068919 (Docs: Plugin doc review for chunk 1-A (#67070)) |
||||
|
||||
Explore the many UI components in our [Grafana UI library](https://developers.grafana.com/ui). |
||||
|
||||
### Plugin examples |
||||
|
||||
Grafana Labs provides a number of best practice example plugins for different use cases to help you quickly get started. Browse our [plugin examples](https://github.com/grafana/grafana-plugin-examples). |
||||
|
||||
### SDK |
||||
|
||||
Learn more about [Grafana Plugin SDK for Go]({{< relref "./backend/grafana-plugin-sdk-for-go" >}}). |
||||
@ -1,166 +0,0 @@ |
||||
--- |
||||
title: Add anonymous usage reporting |
||||
--- |
||||
|
||||
# Add anonymous usage reporting |
||||
|
||||
Add anonymous usage tracking to your plugin to send [reporting events]({{< relref "../../setup-grafana/configure-grafana/#reporting_enabled" >}}) that describe how your plugin is being used to a tracking system configured by your Grafana server administrator. |
||||
|
||||
## Event reporting |
||||
|
||||
In this section, we show an example of tracking usage data from a query editor and receiving a report back from the analytics service. |
||||
|
||||
### Sample query editor |
||||
|
||||
Let's say you have a `QueryEditor` that looks similar to the example below. It has a `CodeEditor` field where you can write your query and a query type selector so you can select the kind of query result that you expect to return: |
||||
|
||||
```ts |
||||
import React, { ReactElement } from 'react'; |
||||
import { InlineFieldRow, InlineField, Select, CodeEditor } from '@grafana/ui'; |
||||
import type { EditorProps } from './types'; |
||||
|
||||
export function QueryEditor(props: EditorProps): ReactElement { |
||||
const { datasource, query, onChange, onRunQuery } = props; |
||||
const queryType = { value: query.value ?? 'timeseries' }; |
||||
const queryTypes = [ |
||||
{ |
||||
label: 'Timeseries', |
||||
value: 'timeseries', |
||||
}, |
||||
{ |
||||
label: 'Table', |
||||
value: 'table', |
||||
}, |
||||
]; |
||||
|
||||
const onChangeQueryType = (type: string) => { |
||||
onChange({ |
||||
...query, |
||||
queryType: type, |
||||
}); |
||||
runQuery(); |
||||
}; |
||||
|
||||
const onChangeRawQuery = (rawQuery: string) => { |
||||
onChange({ |
||||
...query, |
||||
rawQuery: type, |
||||
}); |
||||
runQuery(); |
||||
}; |
||||
|
||||
return ( |
||||
<> |
||||
<div> |
||||
<CodeEditor |
||||
height="200px" |
||||
showLineNumbers={true} |
||||
language="sql" |
||||
onBlur={onChangeRawQuery} |
||||
value={query.rawQuery} |
||||
/> |
||||
</div> |
||||
<InlineFieldRow> |
||||
<InlineField label="Query type" grow> |
||||
<Select options={queryTypes} onChange={onChangeQueryType} value={queryType} /> |
||||
</InlineField> |
||||
</InlineFieldRow> |
||||
</> |
||||
); |
||||
} |
||||
``` |
||||
|
||||
### Track usage with `usePluginInteractionReporter` |
||||
|
||||
Let's say that you want to track how the usage looks between time series and table queries. |
||||
|
||||
What you want to do is to add the `usePluginInteractionReporter` to fetch a report function that takes two arguments: |
||||
|
||||
- Required: An event name that begins with `grafana_plugin_`. It is used to identify the interaction being made. |
||||
- Optional: Attached contextual data. In our example, that is the query type. |
||||
|
||||
```ts |
||||
import React, { ReactElement } from 'react'; |
||||
import { InlineFieldRow, InlineField, Select, CodeEditor } from '@grafana/ui'; |
||||
import { usePluginInteractionReporter } from '@grafana/runtime'; |
||||
import type { EditorProps } from './types'; |
||||
|
||||
export function QueryEditor(props: EditorProps): ReactElement { |
||||
const { datasource, query, onChange, onRunQuery } = props; |
||||
const report = usePluginInteractionReporter(); |
||||
|
||||
const queryType = { value: query.value ?? 'timeseries' }; |
||||
const queryTypes = [ |
||||
{ |
||||
label: 'Timeseries', |
||||
value: 'timeseries', |
||||
}, |
||||
{ |
||||
label: 'Table', |
||||
value: 'table', |
||||
}, |
||||
]; |
||||
|
||||
const onChangeQueryType = (type: string) => { |
||||
onChange({ |
||||
...query, |
||||
queryType: type, |
||||
}); |
||||
runQuery(); |
||||
}; |
||||
|
||||
const onChangeRawQuery = (rawQuery: string) => { |
||||
onChange({ |
||||
...query, |
||||
rawQuery: type, |
||||
}); |
||||
|
||||
report('grafana_plugin_executed_query', { |
||||
query_type: queryType.value, |
||||
}); |
||||
|
||||
runQuery(); |
||||
}; |
||||
|
||||
return ( |
||||
<> |
||||
<div> |
||||
<CodeEditor |
||||
height="200px" |
||||
showLineNumbers={true} |
||||
language="sql" |
||||
onBlur={onChangeRawQuery} |
||||
value={query.rawQuery} |
||||
/> |
||||
</div> |
||||
<InlineFieldRow> |
||||
<InlineField label="Query type" grow> |
||||
<Select options={queryTypes} onChange={onChangeQueryType} value={queryType} /> |
||||
</InlineField> |
||||
</InlineFieldRow> |
||||
</> |
||||
); |
||||
} |
||||
``` |
||||
|
||||
### Data returned from the analytics service |
||||
|
||||
When you use `usePluginInteractionReporter`, the report function that is handed back to you automatically attaches contextual data about the plugin you are tracking to the events. |
||||
|
||||
In our example, the following information is sent to the analytics service configured by the Grafana server administrator: |
||||
|
||||
```ts |
||||
{ |
||||
type: 'interaction', |
||||
payload: { |
||||
interactionName: 'grafana_plugin_executed_query', |
||||
grafana_version: '9.2.1', |
||||
plugin_type: 'datasource', |
||||
plugin_version: '1.0.0', |
||||
plugin_id: 'grafana-example-datasource', |
||||
plugin_name: 'Example', |
||||
datasource_uid: 'qeSI8VV7z', // will only be added for datasources |
||||
query_type: 'timeseries' |
||||
} |
||||
} |
||||
``` |
||||
@ -1,459 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../plugins/developing/auth-for-datasources/ |
||||
- /docs/grafana/next/developers/plugins/authentication/ |
||||
title: Add authentication for data source plugins |
||||
--- |
||||
|
||||
# Add authentication for data source plugins |
||||
|
||||
Grafana plugins can perform authenticated requests against a third-party API by using the _data source proxy_ or through a custom a _backend plugin_. |
||||
|
||||
## Choose an authentication method |
||||
|
||||
Configure your data source plugin to authenticate against a third-party API in one of either of two ways: |
||||
|
||||
- Use the [_data source proxy_](#authenticate-using-the-data-source-proxy) method, or |
||||
- Build a [_backend plugin_](#authenticate-using-a-backend-plugin). |
||||
|
||||
| Case | Use | |
||||
| ----------------------------------------------------------------------------------------------- | ------------------------------- | |
||||
| Do you need to authenticate your plugin using Basic Auth or API keys? | Use the data source proxy. | |
||||
| Does your API support OAuth 2.0 using client credentials? | Use the data source proxy. | |
||||
| Does your API use a custom authentication method that isn't supported by the data source proxy? | Use a backend plugin. | |
||||
| Does your API communicate over a protocol other than HTTP? | Build and use a backend plugin. | |
||||
| Does your plugin require alerting support? | Build and use a backend plugin. | |
||||
|
||||
## Encrypt data source configuration |
||||
|
||||
Data source plugins have two ways of storing custom configuration: `jsonData` and `secureJsonData`. |
||||
|
||||
Users with the Viewer role can access data source configuration such as the contents of `jsonData` in cleartext. If you've enabled anonymous access, anyone who can access Grafana in their browser can see the contents of `jsonData`. |
||||
|
||||
Users of [Grafana Enterprise](https://grafana.com/products/enterprise/grafana/) can restrict access to data sources to specific users and teams. For more information, refer to [Data source permissions](https://grafana.com/docs/grafana/latest/enterprise/datasource_permissions). |
||||
|
||||
> **Important:** Do not use `jsonData` with sensitive data such as password, tokens, and API keys. If you need to store sensitive information, use `secureJsonData` instead. |
||||
|
||||
> **Note:** You can see the settings that the current user has access to by entering `window.grafanaBootData` in the developer console of your browser. |
||||
|
||||
### Store configuration in `secureJsonData` |
||||
|
||||
If you need to store sensitive information, use `secureJsonData` instead of `jsonData`. Whenever the user saves the data source configuration, the secrets in `secureJsonData` are sent to the Grafana server and encrypted before they're stored. |
||||
|
||||
Once you have encrypted the secure configuration, it can no longer be accessed from the browser. The only way to access secrets after they've been saved is by using the [_data source proxy_](#authenticate-using-the-data-source-proxy). |
||||
|
||||
### Add secret configuration to your data source plugin |
||||
|
||||
To demonstrate how you can add secrets to a data source plugin, let's add support for configuring an API key. |
||||
|
||||
1. Create a new interface in `types.ts` to hold the API key: |
||||
```ts |
||||
export interface MySecureJsonData { |
||||
apiKey?: string; |
||||
} |
||||
``` |
||||
1. Add type information to your `secureJsonData` object by updating the props for your `ConfigEditor` to accept the interface as a second type parameter. Access the value of the secret from the `options` prop inside your `ConfigEditor`: |
||||
|
||||
```ts |
||||
interface Props extends DataSourcePluginOptionsEditorProps<MyDataSourceOptions, MySecureJsonData> {} |
||||
``` |
||||
|
||||
```ts |
||||
const { secureJsonData, secureJsonFields } = options; |
||||
const { apiKey } = secureJsonData; |
||||
``` |
||||
|
||||
> **Note:** You can do this until the user saves the configuration; when the user saves the configuration, Grafana clears the value. After that, you can use `secureJsonFields` to determine whether the property has been configured. |
||||
|
||||
1. To securely update the secret in your plugin's configuration editor, update the `secureJsonData` object using the `onOptionsChange` prop: |
||||
|
||||
```ts |
||||
const onAPIKeyChange = (event: ChangeEvent<HTMLInputElement>) => { |
||||
onOptionsChange({ |
||||
...options, |
||||
secureJsonData: { |
||||
apiKey: event.target.value, |
||||
}, |
||||
}); |
||||
}; |
||||
``` |
||||
|
||||
1. Define a component that can accept user input: |
||||
|
||||
```ts |
||||
<Input |
||||
type="password" |
||||
placeholder={secureJsonFields?.apiKey ? 'configured' : ''} |
||||
value={secureJsonData.apiKey ?? ''} |
||||
onChange={onAPIKeyChange} |
||||
/> |
||||
``` |
||||
|
||||
1. Optional: If you want the user to be able to reset the API key, then you need to set the property to `false` in the `secureJsonFields` object: |
||||
|
||||
```ts |
||||
const onResetAPIKey = () => { |
||||
onOptionsChange({ |
||||
...options, |
||||
secureJsonFields: { |
||||
...options.secureJsonFields, |
||||
apiKey: false, |
||||
}, |
||||
secureJsonData: { |
||||
...options.secureJsonData, |
||||
apiKey: '', |
||||
}, |
||||
}); |
||||
}; |
||||
``` |
||||
|
||||
Now that users can configure secrets, the next step is to see how we can add them to our requests. |
||||
|
||||
## Authenticate using the data source proxy |
||||
|
||||
Once the user has saved the configuration for a data source, the secret data source configuration will no longer be available in the browser. Encrypted secrets can only be accessed on the server. So how do you add them to your request? |
||||
|
||||
The Grafana server comes with a proxy that lets you define templates for your requests: _proxy routes_. Grafana sends the proxy route to the server, decrypts the secrets along with other configuration, and adds them to the request before sending it. |
||||
|
||||
> **Note:** Be sure not to confuse the data source proxy with the [auth proxy]({{< relref "../../setup-grafana/configure-security/configure-authentication/auth-proxy/" >}}). The data source proxy is used to authenticate a data source, while the auth proxy is used to log into Grafana itself. |
||||
|
||||
### Add a proxy route to your plugin |
||||
|
||||
To forward requests through the Grafana proxy, you need to configure one or more _proxy routes_. A proxy route is a template for any outgoing request that is handled by the proxy. You can configure proxy routes in the [plugin.json](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/) file. |
||||
|
||||
1. Add the route to `plugin.json`: |
||||
|
||||
```json |
||||
"routes": [ |
||||
{ |
||||
"path": "example", |
||||
"url": "https://api.example.com" |
||||
} |
||||
] |
||||
``` |
||||
|
||||
> **Note:** You need to restart the Grafana server every time you make a change to your `plugin.json` file. |
||||
|
||||
1. In the `DataSource`, extract the proxy URL from `instanceSettings` to a class property called `url`: |
||||
|
||||
```ts |
||||
export class DataSource extends DataSourceApi<MyQuery, MyDataSourceOptions> { |
||||
url?: string; |
||||
|
||||
constructor(instanceSettings: DataSourceInstanceSettings<MyDataSourceOptions>) { |
||||
super(instanceSettings); |
||||
|
||||
this.url = instanceSettings.url; |
||||
} |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
1. In the `query` method, make a request using `BackendSrv`. The first section of the URL path needs to match the `path` of your proxy route. The data source proxy replaces `this.url + routePath` with the `url` of the route. Based on our example, the URL for the request would be `https://api.example.com/v1/users`: |
||||
|
||||
```ts |
||||
import { getBackendSrv } from '@grafana/runtime'; |
||||
``` |
||||
|
||||
```ts |
||||
const routePath = '/example'; |
||||
|
||||
getBackendSrv().datasourceRequest({ |
||||
url: this.url + routePath + '/v1/users', |
||||
method: 'GET', |
||||
}); |
||||
``` |
||||
|
||||
### Add a dynamic proxy route to your plugin |
||||
|
||||
Grafana sends the proxy route to the server, where the data source proxy decrypts any sensitive data and interpolates the template variables with the decrypted data before making the request. |
||||
|
||||
To add user-defined configuration to your routes: |
||||
|
||||
- Use `.JsonData` for configuration stored in `jsonData`. For example, where `projectId` is the name of a property in the `jsonData` object: |
||||
|
||||
```json |
||||
"routes": [ |
||||
{ |
||||
"path": "example", |
||||
"url": "https://api.example.com/projects/{{ .JsonData.projectId }}" |
||||
} |
||||
] |
||||
``` |
||||
|
||||
- Use `.SecureJsonData` for sensitive data stored in `secureJsonData`. For example, where `password` is the name of a property in the `secureJsonData` object: |
||||
|
||||
```json |
||||
"routes": [ |
||||
{ |
||||
"path": "example", |
||||
"url": "https://{{ .JsonData.username }}:{{ .SecureJsonData.password }}@api.example.com" |
||||
} |
||||
] |
||||
``` |
||||
|
||||
In addition to adding the URL to the proxy route, you can also add headers, URL parameters, and a request body. |
||||
|
||||
#### Add HTTP headers to a proxy route |
||||
|
||||
Here's an example of adding `name` and `content` as HTTP headers: |
||||
|
||||
```json |
||||
"routes": [ |
||||
{ |
||||
"path": "example", |
||||
"url": "https://api.example.com", |
||||
"headers": [ |
||||
{ |
||||
"name": "Authorization", |
||||
"content": "Bearer {{ .SecureJsonData.apiToken }}" |
||||
} |
||||
] |
||||
} |
||||
] |
||||
``` |
||||
|
||||
#### Add URL parameters to a proxy route |
||||
|
||||
Here's an example of adding `name` and `content` as URL parameters: |
||||
|
||||
```json |
||||
"routes": [ |
||||
{ |
||||
"path": "example", |
||||
"url": "http://api.example.com", |
||||
"urlParams": [ |
||||
{ |
||||
"name": "apiKey", |
||||
"content": "{{ .SecureJsonData.apiKey }}" |
||||
} |
||||
] |
||||
} |
||||
] |
||||
``` |
||||
|
||||
#### Add a request body to a proxy route |
||||
|
||||
Here's an example of adding `username` and `password` to the request body: |
||||
|
||||
```json |
||||
"routes": [ |
||||
{ |
||||
"path": "example", |
||||
"url": "http://api.example.com", |
||||
"body": { |
||||
"username": "{{ .JsonData.username }}", |
||||
"password": "{{ .SecureJsonData.password }}" |
||||
} |
||||
} |
||||
] |
||||
``` |
||||
|
||||
### Add an OAuth 2.0 proxy route to your plugin |
||||
|
||||
Since your request to each route is made server-side with OAuth 2.0 authentication, only machine-to-machine requests are supported. In order words, if you need to use a different grant than client credentials, you need to implement it yourself. |
||||
|
||||
To authenticate using OAuth 2.0, add a `tokenAuth` object to the proxy route definition. If necessary, Grafana performs a request to the URL defined in `tokenAuth` to retrieve a token before making the request to the URL in your proxy route. Grafana automatically renews the token when it expires. |
||||
|
||||
Any parameters defined in `tokenAuth.params` are encoded as `application/x-www-form-urlencoded` and sent to the token URL. |
||||
|
||||
```json |
||||
{ |
||||
"routes": [ |
||||
{ |
||||
"path": "api", |
||||
"url": "https://api.example.com/v1", |
||||
"tokenAuth": { |
||||
"url": "https://api.example.com/v1/oauth/token", |
||||
"params": { |
||||
"grant_type": "client_credentials", |
||||
"client_id": "{{ .SecureJsonData.clientId }}", |
||||
"client_secret": "{{ .SecureJsonData.clientSecret }}" |
||||
} |
||||
} |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
## Authenticate using a backend plugin |
||||
|
||||
While the data source proxy supports the most common authentication methods for HTTP APIs, using proxy routes has a few limitations: |
||||
|
||||
- Proxy routes only support HTTP or HTTPS. |
||||
- Proxy routes don't support custom token authentication. |
||||
|
||||
If any of these limitations apply to your plugin, you need to add a [backend plugin]({{< relref "backend/" >}}). Because backend plugins run on the server, they can access decrypted secrets, which makes it easier to implement custom authentication methods. |
||||
|
||||
The decrypted secrets are available from the `DecryptedSecureJSONData` field in the instance settings. |
||||
|
||||
```go |
||||
func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
instanceSettings := req.PluginContext.DataSourceInstanceSettings |
||||
|
||||
if apiKey, exists := settings.DecryptedSecureJSONData["apiKey"]; exists { |
||||
// Use the decrypted API key. |
||||
} |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
## Forward OAuth identity for the logged-in user |
||||
|
||||
If your data source uses the same OAuth provider as Grafana itself, for example using [Generic OAuth Authentication]({{< relref "../../setup-grafana/configure-security/configure-authentication/generic-oauth/" >}}), then your data source plugin can reuse the access token for the logged-in Grafana user. |
||||
|
||||
To allow Grafana to pass the access token to the plugin, update the data source configuration and set the `jsonData.oauthPassThru` property to `true`. The [DataSourceHttpSettings](https://developers.grafana.com/ui/latest/index.html?path=/story/data-source-datasourcehttpsettings--basic) settings provide a toggle, the **Forward OAuth Identity** option, for this. You can also build an appropriate toggle to set `jsonData.oauthPassThru` in your data source configuration page UI. |
||||
|
||||
When configured, Grafana can forward authorization HTTP headers such as `Authorization` or `X-ID-Token` to a backend data source. This information is available across the `QueryData`, `CallResource` and `CheckHealth` requests. |
||||
|
||||
To get Grafana to forward the headers, create a HTTP client using the [Grafana plugin SDK for Go](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go/backend/httpclient) and set the `ForwardHTTPHeaders` option to `true` (by default, it's set to `false`). This package exposes request information which can be subsequently forwarded downstream and/or used directly within the plugin. |
||||
|
||||
```go |
||||
func NewDatasource(settings backend.DataSourceInstanceSettings) (instancemgmt.Instance, error) { |
||||
opts, err := settings.HTTPClientOptions() |
||||
if err != nil { |
||||
return nil, fmt.Errorf("http client options: %w", err) |
||||
} |
||||
|
||||
// Important: Reuse the same client for each query to avoid using all available connections on a host. |
||||
|
||||
opts.ForwardHTTPHeaders = true |
||||
|
||||
cl, err := httpclient.New(opts) |
||||
if err != nil { |
||||
return nil, fmt.Errorf("httpclient new: %w", err) |
||||
} |
||||
return &Datasource{ |
||||
httpClient: cl, |
||||
}, nil |
||||
} |
||||
|
||||
func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
// Necessary to keep the Context, since the injected middleware is configured there |
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://some-url", nil) |
||||
if err != nil { |
||||
return nil, fmt.Errorf("new request with context: %w", err) |
||||
} |
||||
// Authorization header will be automatically injected if oauthPassThru is configured |
||||
resp, err := ds.httpClient.Do(req) |
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
You can see a full working plugin example here: [datasource-http-backend](https://github.com/grafana/grafana-plugin-examples/tree/main/examples/datasource-http-backend). |
||||
|
||||
### Extract a header from an HTTP request |
||||
|
||||
If you need to access the HTTP header information directly, you can also extract that information from the request: |
||||
|
||||
```go |
||||
func (ds *dataSource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { |
||||
token := strings.Fields(req.GetHTTPHeader(backend.OAuthIdentityTokenHeaderName)) |
||||
var ( |
||||
tokenType = token[0] |
||||
accessToken = token[1] |
||||
) |
||||
idToken := req.GetHTTPHeader(backend.OAuthIdentityIDTokenHeaderName) // present if user's token includes an ID token |
||||
|
||||
// ... |
||||
return &backend.CheckHealthResult{Status: backend.HealthStatusOk}, nil |
||||
} |
||||
|
||||
func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
token := strings.Fields(req.GetHTTPHeader(backend.OAuthIdentityTokenHeaderName)) |
||||
var ( |
||||
tokenType = token[0] |
||||
accessToken = token[1] |
||||
) |
||||
idToken := req.GetHTTPHeader(backend.OAuthIdentityIDTokenHeaderName) |
||||
|
||||
for _, q := range req.Queries { |
||||
// ... |
||||
} |
||||
} |
||||
|
||||
func (ds *dataSource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error { |
||||
token := req.GetHTTPHeader(backend.OAuthIdentityTokenHeaderName) |
||||
idToken := req.GetHTTPHeader(backend.OAuthIdentityIDTokenHeaderName) |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
## Work with cookies |
||||
|
||||
### Forward cookies for the logged-in user |
||||
|
||||
Your data source plugin can forward cookies for the logged-in Grafana user to the data source. Use the [DataSourceHttpSettings](https://developers.grafana.com/ui/latest/index.html?path=/story/data-source-datasourcehttpsettings--basic) component on the data source's configuration page. It provides the **Allowed cookies** option, where you can specify the cookie names. |
||||
|
||||
When configured, as with [authorization headers](#forward-oauth-identity-for-the-logged-in-user), these cookies are automatically injected if you use the SDK HTTP client. |
||||
|
||||
### Extract cookies for the logged-in user |
||||
|
||||
You can also extract the cookies in the `QueryData`, `CallResource` and `CheckHealth` requests if required. |
||||
|
||||
**`QueryData`** |
||||
|
||||
```go |
||||
func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
cookies:= req.GetHTTPHeader(backend.CookiesHeaderName) |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
**`CallResource`** |
||||
|
||||
```go |
||||
func (ds *dataSource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error { |
||||
cookies:= req.GetHTTPHeader(backend.CookiesHeaderName) |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
**`CheckHealth`** |
||||
|
||||
```go |
||||
func (ds *dataSource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { |
||||
cookies:= req.GetHTTPHeader(backend.CookiesHeaderName) |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
## Forward user header for the logged-in user |
||||
|
||||
When [send_user_header]({{< relref "../../setup-grafana/configure-grafana/_index.md#send_user_header" >}}) is enabled, Grafana passes the user header to the plugin using the `X-Grafana-User` header. You can forward this header as well as [authorization headers](#forward-oauth-identity-for-the-logged-in-user) or [configured cookies](#forward-cookies-for-the-logged-in-user). |
||||
|
||||
**`QueryData`** |
||||
|
||||
```go |
||||
func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
u := req.GetHTTPHeader("X-Grafana-User") |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
**`CallResource`** |
||||
|
||||
```go |
||||
func (ds *dataSource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error { |
||||
u := req.GetHTTPHeader("X-Grafana-User") |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
**`CheckHealth`** |
||||
|
||||
```go |
||||
func (ds *dataSource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { |
||||
u := req.GetHTTPHeader("X-Grafana-User") |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
@ -1,110 +0,0 @@ |
||||
--- |
||||
title: Add distributed tracing for backend plugins |
||||
--- |
||||
|
||||
# Add distributed tracing for backend plugins |
||||
|
||||
> **Note:** This feature requires at least Grafana 9.5.0, and your plugin needs to be built at least with grafana-plugins-sdk-go v0.157.0. If you run a plugin with tracing features on an older version of Grafana, tracing is disabled. |
||||
|
||||
Distributed tracing allows backend plugin developers to create custom spans in their plugins, and send them to the same endpoint and with the same propagation format as the main Grafana instance. The tracing context is also propagated from the Grafana instance to the plugin, so the plugin's spans will be correlated to the correct trace. |
||||
|
||||
## Plugin configuration |
||||
|
||||
Plugin tracing must be enabled manually on a per-plugin basis, by specifying `tracing = true` in the plugin's config section: |
||||
|
||||
```ini |
||||
[plugin.myorg-myplugin-datasource] |
||||
tracing = true |
||||
``` |
||||
|
||||
## OpenTelemetry configuration in Grafana |
||||
|
||||
Grafana supports [OpenTelemetry](https://opentelemetry.io/) for distributed tracing. If Grafana is configured to use a deprecated tracing system (Jaeger or OpenTracing), then tracing is disabled in the plugin provided by the SDK and configured when calling `datasource.Manage | app.Manage`. |
||||
|
||||
OpenTelemetry must be enabled and configured for the Grafana instance. Please refer to the [Grafana configuration documentation]( |
||||
{{< relref "../../setup-grafana/configure-grafana/#tracingopentelemetry" >}}) for more information. |
||||
|
||||
Refer to the [OpenTelemetry Go SDK](https://pkg.go.dev/go.opentelemetry.io/otel) for in-depth documentation about all the features provided by OpenTelemetry. |
||||
|
||||
> **Note:** If tracing is disabled in Grafana, `backend.DefaultTracer()` returns a no-op tracer. |
||||
|
||||
## Implement tracing in your plugin |
||||
|
||||
> **Note:** Make sure you are using at least grafana-plugin-sdk-go v0.157.0. You can update with `go get -u github.com/grafana/grafana-plugin-sdk-go`. |
||||
|
||||
### Configure a global tracer |
||||
|
||||
When OpenTelemetry tracing is enabled on the main Grafana instance and tracing is enabled for a plugin, the OpenTelemetry endpoint address and propagation format is passed to the plugin during startup. These parameters are used to configure a global tracer. |
||||
|
||||
1. Use `datasource.Manage` or `app.Manage` to run your plugin to automatically configure the global tracer. Specify any custom attributes for the default tracer using `CustomAttributes`: |
||||
|
||||
```go |
||||
func main() { |
||||
if err := datasource.Manage("MY_PLUGIN_ID", plugin.NewDatasource, datasource.ManageOpts{ |
||||
TracingOpts: tracing.Opts{ |
||||
// Optional custom attributes attached to the tracer's resource. |
||||
// The tracer will already have some SDK and runtime ones pre-populated. |
||||
CustomAttributes: []attribute.KeyValue{ |
||||
attribute.String("my_plugin.my_attribute", "custom value"), |
||||
}, |
||||
}, |
||||
}); err != nil { |
||||
log.DefaultLogger.Error(err.Error()) |
||||
os.Exit(1) |
||||
} |
||||
} |
||||
``` |
||||
|
||||
1. Once you have configured tracing, use the global tracer like this: |
||||
|
||||
```go |
||||
tracing.DefaultTracer() |
||||
``` |
||||
|
||||
This returns an [OpenTelemetry `trace.Tracer`](https://pkg.go.dev/go.opentelemetry.io/otel/trace#Tracer) for creating spans. |
||||
|
||||
**Example:** |
||||
|
||||
```go |
||||
func (d *Datasource) query(ctx context.Context, pCtx backend.PluginContext, query backend.DataQuery) (backend.DataResponse, error) { |
||||
ctx, span := tracing.DefaultTracer().Start( |
||||
ctx, |
||||
"query processing", |
||||
trace.WithAttributes( |
||||
attribute.String("query.ref_id", query.RefID), |
||||
attribute.String("query.type", query.QueryType), |
||||
attribute.Int64("query.max_data_points", query.MaxDataPoints), |
||||
attribute.Int64("query.interval_ms", query.Interval.Milliseconds()), |
||||
attribute.Int64("query.time_range.from", query.TimeRange.From.Unix()), |
||||
attribute.Int64("query.time_range.to", query.TimeRange.To.Unix()), |
||||
), |
||||
) |
||||
defer span.End() |
||||
log.DefaultLogger.Debug("query", "traceID", trace.SpanContextFromContext(ctx).TraceID()) |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
### Tracing gRPC calls |
||||
|
||||
When tracing is enabled, a new span is created automatically for each gRPC call (`QueryData`, `CheckHealth`, etc.), both on Grafana's side and on the plugin's side. The plugin SDK also injects the trace context into the `context.Context` that is passed to those methods. |
||||
|
||||
You can retrieve the [trace.SpanContext](https://pkg.go.dev/go.opentelemetry.io/otel/trace#SpanContext) with `tracing.SpanContextFromContext` by passing the original `context.Context` to it: |
||||
|
||||
```go |
||||
func (d *Datasource) query(ctx context.Context, pCtx backend.PluginContext, query backend.DataQuery) (backend.DataResponse, error) { |
||||
spanCtx := trace.SpanContextFromContext(ctx) |
||||
traceID := spanCtx.TraceID() |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
### Tracing HTTP requests |
||||
|
||||
When tracing is enabled, a `TracingMiddleware` is also added to the default middleware stack to all HTTP clients created using the `httpclient.New` or `httpclient.NewProvider`, unless you specify custom middleware. This middleware creates spans for each outgoing HTTP request and provides some useful attributes and events related to the request's lifecycle. |
||||
|
||||
## Plugin example |
||||
|
||||
Refer to the [datasource-http-backend plugin example](https://github.com/grafana/grafana-plugin-examples/tree/main/examples/datasource-http-backend) for a complete example of a plugin with full distributed tracing support. |
||||
@ -1,73 +0,0 @@ |
||||
--- |
||||
title: Add query editor help |
||||
--- |
||||
|
||||
# Add query editor help |
||||
|
||||
Query editors support the addition of a help component to display examples of potential queries. When the user clicks on one of the examples, the query editor is automatically updated. This helps the user to make faster queries. |
||||
|
||||
1. In the `src` directory of your plugin, create a file `QueryEditorHelp.tsx` with the following content: |
||||
|
||||
```ts |
||||
import React from 'react'; |
||||
import { QueryEditorHelpProps } from '@grafana/data'; |
||||
|
||||
export default (props: QueryEditorHelpProps) => { |
||||
return <h2>My cheat sheet</h2>; |
||||
}; |
||||
``` |
||||
|
||||
1. Configure the plugin to use `QueryEditorHelp`: |
||||
|
||||
```ts |
||||
import QueryEditorHelp from './QueryEditorHelp'; |
||||
``` |
||||
|
||||
```ts |
||||
export const plugin = new DataSourcePlugin<DataSource, MyQuery, MyDataSourceOptions>(DataSource) |
||||
.setConfigEditor(ConfigEditor) |
||||
.setQueryEditor(QueryEditor) |
||||
.setQueryEditorHelp(QueryEditorHelp); |
||||
``` |
||||
|
||||
1. Create a few examples of potential queries: |
||||
|
||||
```ts |
||||
import React from 'react'; |
||||
import { QueryEditorHelpProps, DataQuery } from '@grafana/data'; |
||||
|
||||
const examples = [ |
||||
{ |
||||
title: 'Addition', |
||||
expression: '1 + 2', |
||||
label: 'Add two integers', |
||||
}, |
||||
{ |
||||
title: 'Subtraction', |
||||
expression: '2 - 1', |
||||
label: 'Subtract an integer from another', |
||||
}, |
||||
]; |
||||
|
||||
export default (props: QueryEditorHelpProps) => { |
||||
return ( |
||||
<div> |
||||
<h2>Cheat Sheet</h2> |
||||
{examples.map((item, index) => ( |
||||
<div className="cheat-sheet-item" key={index}> |
||||
<div className="cheat-sheet-item__title">{item.title}</div> |
||||
{item.expression ? ( |
||||
<div |
||||
className="cheat-sheet-item__example" |
||||
onClick={(e) => props.onClickExample({ refId: 'A', queryText: item.expression } as DataQuery)} |
||||
> |
||||
<code>{item.expression}</code> |
||||
</div> |
||||
) : null} |
||||
<div className="cheat-sheet-item__label">{item.label}</div> |
||||
</div> |
||||
))} |
||||
</div> |
||||
); |
||||
}; |
||||
``` |
||||
@ -1,30 +0,0 @@ |
||||
--- |
||||
title: Add support for annotations |
||||
--- |
||||
|
||||
# Add support for annotations |
||||
|
||||
You can add support to your plugin for annotations that will insert information into Grafana alerts. This guide explains how to add support for [annotations]({{< relref "../../dashboards/build-dashboards/annotate-visualizations/#querying-other-data-sources " >}}) to a data source plugin. |
||||
|
||||
## Support annotations in your data source plugin |
||||
|
||||
To enable annotations, simply add two lines of code to your plugin. Grafana uses your default query editor for editing annotation queries. |
||||
|
||||
1. Add `"annotations": true` to the [plugin.json]({{< relref "metadata/" >}}) file to let Grafana know that your plugin supports annotations. |
||||
|
||||
**In `plugin.json`:** |
||||
|
||||
```json |
||||
{ |
||||
"annotations": true |
||||
} |
||||
``` |
||||
|
||||
2. In `datasource.ts`, override the `annotations` property from `DataSourceApi` (or `DataSourceWithBackend` for backend data sources). For the default behavior, set `annotations` to an empty object. |
||||
|
||||
**In `datasource.ts`:** |
||||
|
||||
```ts |
||||
annotations: { |
||||
} |
||||
``` |
||||
@ -1,70 +0,0 @@ |
||||
--- |
||||
title: Add features to Explore queries |
||||
--- |
||||
|
||||
# Add features for Explore queries |
||||
|
||||
[Explore]({{< relref "../../explore/" >}}) allows users can make ad-hoc queries without the use of a dashboard. This is useful when they want to troubleshoot or learn more about the data. |
||||
|
||||
Your data source supports Explore by default and uses the existing query editor for the data source. This guide explains how to extend functionality for Explore queries in a data source plugin. |
||||
|
||||
## Add an Explore-specific query editor |
||||
|
||||
To extend Explore functionality for your data source, define an Explore-specific query editor. |
||||
|
||||
1. Create a file `ExploreQueryEditor.tsx` in the `src` directory of your plugin, with content similar to this: |
||||
|
||||
```ts |
||||
import React from 'react'; |
||||
|
||||
import { QueryEditorProps } from '@grafana/data'; |
||||
import { QueryField } from '@grafana/ui'; |
||||
import { DataSource } from './DataSource'; |
||||
import { MyQuery, MyDataSourceOptions } from './types'; |
||||
|
||||
type Props = QueryEditorProps<DataSource, MyQuery, MyDataSourceOptions>; |
||||
|
||||
export default (props: Props) => { |
||||
return <h2>My Explore-specific query editor</h2>; |
||||
}; |
||||
``` |
||||
|
||||
1. Modify your base query editor in `QueryEditor.tsx` to render the Explore-specific query editor. For example: |
||||
|
||||
```ts |
||||
// [...] |
||||
import { CoreApp } from '@grafana/data'; |
||||
import ExploreQueryEditor from './ExploreQueryEditor'; |
||||
|
||||
type Props = QueryEditorProps<DataSource, MyQuery, MyDataSourceOptions>; |
||||
|
||||
export default (props: Props) => { |
||||
const { app } = props; |
||||
|
||||
switch (app) { |
||||
case CoreApp.Explore: |
||||
return <ExploreQueryEditor {...props} />; |
||||
default: |
||||
return <div>My base query editor</div>; |
||||
} |
||||
}; |
||||
``` |
||||
|
||||
## Select a preferred visualization type |
||||
|
||||
By default, Explore should select an appropriate and useful visualization for your data. It can figure out whether the returned data is time series data or logs or something else, and creates the right type of visualization. |
||||
|
||||
However, if you want a custom visualization, you can add a hint to your returned data frame by setting the `meta' attribute to `preferredVisualisationType`. |
||||
|
||||
Construct a data frame with specific metadata like this: |
||||
|
||||
``` |
||||
const firstResult = new MutableDataFrame({ |
||||
fields: [...], |
||||
meta: { |
||||
preferredVisualisationType: 'logs', |
||||
}, |
||||
}); |
||||
``` |
||||
|
||||
For possible options, refer to [PreferredVisualisationType](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/data.ts#L25). |
||||
@ -1,198 +0,0 @@ |
||||
--- |
||||
title: Add support for variables in plugins |
||||
--- |
||||
|
||||
# Add support for variables in plugins |
||||
|
||||
Variables are placeholders for values, and you can use them to create templated queries, and dashboard or panel links. For more information on variables, refer to [Templates and variables]({{< relref "../../dashboards/variables/" >}}). |
||||
|
||||
In this guide, you'll see how you can turn a query string like this: |
||||
|
||||
```sql |
||||
SELECT * FROM services WHERE id = "$service" |
||||
``` |
||||
|
||||
into |
||||
|
||||
```sql |
||||
SELECT * FROM services WHERE id = "auth-api" |
||||
``` |
||||
|
||||
Grafana provides a couple of helper functions to interpolate variables in a string template. Let's see how you can use them in your plugin. |
||||
|
||||
## Interpolate variables in panel plugins |
||||
|
||||
For panels, the `replaceVariables` function is available in the `PanelProps`. |
||||
|
||||
Add `replaceVariables` to the argument list, and pass a user-defined template string to it: |
||||
|
||||
```ts |
||||
export function SimplePanel({ options, data, width, height, replaceVariables }: Props) { |
||||
const query = replaceVariables('Now displaying $service'); |
||||
|
||||
return <div>{query}</div>; |
||||
} |
||||
``` |
||||
|
||||
## Interpolate variables in data source plugins |
||||
|
||||
For data sources, you need to use the `getTemplateSrv`, which returns an instance of `TemplateSrv`. |
||||
|
||||
1. Import `getTemplateSrv` from the `runtime` package: |
||||
|
||||
```ts |
||||
import { getTemplateSrv } from '@grafana/runtime'; |
||||
``` |
||||
|
||||
1. In your `query` method, call the `replace` method with a user-defined template string: |
||||
|
||||
```ts |
||||
async query(options: DataQueryRequest<MyQuery>): Promise<DataQueryResponse> { |
||||
const query = getTemplateSrv().replace('SELECT * FROM services WHERE id = "$service"', options.scopedVars); |
||||
|
||||
const data = makeDbQuery(query); |
||||
|
||||
return { data }; |
||||
} |
||||
``` |
||||
|
||||
## Format multi-value variables |
||||
|
||||
When a user selects multiple values for a variable, the value of the interpolated variable depends on the [variable format]({{< relref "../../dashboards/variables/variable-syntax/#advanced-variable-format-options" >}}). |
||||
|
||||
A data source plugin can define the default format option when no format is specified by adding a third argument to the interpolation function. |
||||
|
||||
Let's change the SQL query to use CSV format by default: |
||||
|
||||
```ts |
||||
getTemplateSrv().replace('SELECT * FROM services WHERE id IN ($service)', options.scopedVars, 'csv'); |
||||
``` |
||||
|
||||
Now, when users write `$service`, the query looks like this: |
||||
|
||||
```sql |
||||
SELECT * FROM services WHERE id IN (admin,auth,billing) |
||||
``` |
||||
|
||||
For more information on the available variable formats, refer to [Advanced variable format options]({{< relref "../../dashboards/variables/variable-syntax/#advanced-variable-format-options" >}}). |
||||
|
||||
## Set a variable from your plugin |
||||
|
||||
Not only can you read the value of a variable, you can also update the variable from your plugin. Use `locationService.partial(query, replace)`. |
||||
|
||||
The following example shows how to update a variable called `service`. |
||||
|
||||
- `query` contains the query parameters you want to update. The query parameters that control variables are prefixed with `var-`. |
||||
- `replace: true` tells Grafana to update the current URL state rather than creating a new history entry. |
||||
|
||||
```ts |
||||
import { locationService } from '@grafana/runtime'; |
||||
``` |
||||
|
||||
```ts |
||||
locationService.partial({ 'var-service': 'billing' }, true); |
||||
``` |
||||
|
||||
> **Note:** Grafana queries your data source whenever you update a variable. Excessive updates to variables can slow down Grafana and lead to a poor user experience. |
||||
|
||||
## Add support for query variables to your data source |
||||
|
||||
A [query variable]({{< relref "../../dashboards/variables/add-template-variables/#add-a-query-variable" >}}) is a type of variable that allows you to query a data source for the values. By adding support for query variables to your data source plugin, users can create dynamic dashboards based on data from your data source. |
||||
|
||||
Let's start by defining a query model for the variable query: |
||||
|
||||
```ts |
||||
export interface MyVariableQuery { |
||||
namespace: string; |
||||
rawQuery: string; |
||||
} |
||||
``` |
||||
|
||||
For a data source to support query variables, override the `metricFindQuery` in your `DataSourceApi` class. The `metricFindQuery` function returns an array of `MetricFindValue` which has a single property, `text`: |
||||
|
||||
```ts |
||||
async metricFindQuery(query: MyVariableQuery, options?: any) { |
||||
// Retrieve DataQueryResponse based on query. |
||||
const response = await this.fetchMetricNames(query.namespace, query.rawQuery); |
||||
|
||||
// Convert query results to a MetricFindValue[] |
||||
const values = response.data.map(frame => ({ text: frame.name })); |
||||
|
||||
return values; |
||||
} |
||||
``` |
||||
|
||||
> **Note:** By default, Grafana provides a basic query model and editor for simple text queries. If that's all you need, then leave the query type as `string`: |
||||
|
||||
```ts |
||||
async metricFindQuery(query: string, options?: any) |
||||
``` |
||||
|
||||
Let's create a custom query editor to allow the user to edit the query model. |
||||
|
||||
1. Create a `VariableQueryEditor` component: |
||||
|
||||
```ts |
||||
import React, { useState } from 'react'; |
||||
import { MyVariableQuery } from './types'; |
||||
|
||||
interface VariableQueryProps { |
||||
query: MyVariableQuery; |
||||
onChange: (query: MyVariableQuery, definition: string) => void; |
||||
} |
||||
|
||||
export const VariableQueryEditor: React.FC<VariableQueryProps> = ({ onChange, query }) => { |
||||
const [state, setState] = useState(query); |
||||
|
||||
const saveQuery = () => { |
||||
onChange(state, `${state.query} (${state.namespace})`); |
||||
}; |
||||
|
||||
const handleChange = (event: React.FormEvent<HTMLInputElement>) => |
||||
setState({ |
||||
...state, |
||||
[event.currentTarget.name]: event.currentTarget.value, |
||||
}); |
||||
|
||||
return ( |
||||
<> |
||||
<div className="gf-form"> |
||||
<span className="gf-form-label width-10">Namespace</span> |
||||
<input |
||||
name="namespace" |
||||
className="gf-form-input" |
||||
onBlur={saveQuery} |
||||
onChange={handleChange} |
||||
value={state.namespace} |
||||
/> |
||||
</div> |
||||
<div className="gf-form"> |
||||
<span className="gf-form-label width-10">Query</span> |
||||
<input |
||||
name="rawQuery" |
||||
className="gf-form-input" |
||||
onBlur={saveQuery} |
||||
onChange={handleChange} |
||||
value={state.rawQuery} |
||||
/> |
||||
</div> |
||||
</> |
||||
); |
||||
}; |
||||
``` |
||||
|
||||
Grafana saves the query model whenever one of the text fields loses focus (`onBlur`) and then previews the values returned by `metricFindQuery`. |
||||
|
||||
The second argument to `onChange` allows you to set a text representation of the query that will appear next to the name of the variable in the variables list. |
||||
|
||||
1. Configure your plugin to use the query editor: |
||||
|
||||
```ts |
||||
import { VariableQueryEditor } from './VariableQueryEditor'; |
||||
|
||||
export const plugin = new DataSourcePlugin<DataSource, MyQuery, MyDataSourceOptions>(DataSource) |
||||
.setQueryEditor(QueryEditor) |
||||
.setVariableQueryEditor(VariableQueryEditor); |
||||
``` |
||||
|
||||
That's it! You can now try out the plugin by adding a [query variable]({{< relref "../../dashboards/variables/add-template-variables/#add-a-query-variable" >}}) to your dashboard. |
||||
@ -1,97 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../plugins/developing/backend-plugins-guide/ |
||||
keywords: |
||||
- grafana |
||||
- plugins |
||||
- backend |
||||
- plugin |
||||
- backend-plugins |
||||
- documentation |
||||
title: Backend plugins |
||||
--- |
||||
|
||||
# Backend plugins |
||||
|
||||
The Grafana plugin system for backend development allows you to integrate Grafana with virtually anything and offer custom visualizations. This document explains the system's background, use cases, and key features. |
||||
|
||||
## Background |
||||
|
||||
Grafana added support for _frontend plugins_ in version 3.0 so that the Grafana community could create custom panels and data sources. It was wildly successful and has made Grafana much more useful for our user community. |
||||
|
||||
However, one limitation of these plugins is that they run on the client side, in the browser. Therefore, they can't support use cases that require server-side features. |
||||
|
||||
Since Grafana v7.0, we have supported server-side plugins that remove this limitation. We use the term _backend plugin_ to denote that a plugin has a backend component. A backend plugin usually requires frontend components as well. For example, some backend data source plugins need query editor components on the frontend. |
||||
|
||||
## Use cases for implementing a backend plugin |
||||
|
||||
The following examples give some common use cases for backend plugins: |
||||
|
||||
- Enable [Grafana Alerting]({{< relref "../../../alerting/" >}}) for data sources. |
||||
- Connect to SQL database servers and other non-HTTP services that normally can't be connected to from a browser. |
||||
- Keep state between users, for example, by query caching for data sources. |
||||
- Use custom authentication methods and/or authorization checks that aren't supported in Grafana. |
||||
- Use a custom data source request proxy (refer to [Resources]({{< relref "#resources" >}}) for more information). |
||||
|
||||
## Grafana backend plugin system |
||||
|
||||
The Grafana backend plugin system is based on HashiCorp's [Go Plugin System over RPC](https://github.com/hashicorp/go-plugin). Our implementation of the Grafana server launches each backend plugin as a subprocess and communicates with it over [gRPC](https://grpc.io/). |
||||
|
||||
### Benefits for plugin development |
||||
|
||||
Grafana's approach has benefits for developers: |
||||
|
||||
- **Stability:** Plugins can't crash your Grafana process: a panic in a plugin doesn't panic the server. |
||||
- **Ease of development:** Plugins can be written in any language that supports gRPC (for example, write a Go application and run `go build`). |
||||
- **Security:** Plugins only have access to the interfaces and arguments given to them, not to the entire memory space of the process. |
||||
|
||||
### Capabilities of the backend plugin system |
||||
|
||||
Grafana's backend plugin system exposes several key capabilities, or building blocks, that your backend plugin can implement: |
||||
|
||||
- Query data |
||||
- Resources |
||||
- Health checks |
||||
- Collect metrics |
||||
- Streaming |
||||
|
||||
#### Query data |
||||
|
||||
The query data capability allows a backend plugin to handle data source queries that are submitted from a [dashboard]({{< relref "../../../dashboards/" >}}), [Explore]({{< relref "../../../explore/" >}}) or [Grafana Alerting]({{< relref "../../../alerting/" >}}). The response contains [data frames]({{< relref "../data-frames/" >}}), which are used to visualize metrics, logs, and traces. |
||||
|
||||
{{% admonition type="note" %}} Backend data source plugins are required to implement the query data capability.{{% |
||||
/admonition %}} |
||||
|
||||
#### Resources |
||||
|
||||
The resources capability allows a backend plugin to handle custom HTTP requests sent to the Grafana HTTP API and respond with custom HTTP responses. Here, the request and response formats can vary. For example, you can use JSON, plain text, HTML, or static resources such as images and files, and so on. |
||||
|
||||
Compared to the query data capability, where the response contains data frames, the resources capability gives the plugin developer more flexibility for extending and opening up Grafana for new and interesting use cases. |
||||
|
||||
### Use cases |
||||
|
||||
Examples of use cases for implementing resources: |
||||
|
||||
- Implement a custom data source proxy to provide certain authentication, authorization, or other requirements that are not supported in Grafana's [built-in data proxy]({{< relref "../../http_api/data_source/#data-source-proxy-calls" >}}). |
||||
- Return data or information in a format suitable for use within a data source query editor to provide auto-complete functionality. |
||||
- Return static resources such as images or files. |
||||
- Send a command to a device, such as a microcontroller or IoT device. |
||||
- Request information from a device, such as a microcontroller or IoT device. |
||||
- Extend Grafana's HTTP API with custom resources, methods and actions. |
||||
- Use [chunked transfer encoding](https://en.wikipedia.org/wiki/Chunked_transfer_encoding) to return large data responses in chunks or to enable certain streaming capabilities. |
||||
|
||||
#### Health checks |
||||
|
||||
The health checks capability allows a backend plugin to return the status of the plugin. For data source backend plugins, the health check is automatically called when a user edits a data source and selects _Save & Test_ in the UI. |
||||
|
||||
A plugin's health check endpoint is exposed in the Grafana HTTP API and allows external systems to continuously poll the plugin's health to make sure that it's running and working as expected. |
||||
|
||||
#### Collect metrics |
||||
|
||||
A backend plugin can collect and return runtime, process, and custom metrics using the text-based Prometheus [exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/). If you're using the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go/" >}}) to implement your backend plugin, then the [Prometheus instrumentation library for Go applications](https://github.com/prometheus/client_golang) is built-in. This SDK gives you Go runtime metrics and process metrics out of the box. You can use the [Prometheus instrumentation library](https://github.com/prometheus/client_golang) to add custom metrics to instrument your backend plugin. |
||||
|
||||
The Grafana HTTP API offers an endpoint (`/api/plugins/<plugin id>/metrics`) that allows you to configure a Prometheus instance to scrape the metrics. |
||||
|
||||
#### Streaming |
||||
|
||||
The streaming capability allows a backend plugin to handle data source queries that are streaming. For more information, refer to [Build a streaming data source plugin]({{<relref "../build-a-streaming-data-source-plugin.md">}}) |
||||
@ -1,28 +0,0 @@ |
||||
--- |
||||
keywords: |
||||
- grafana |
||||
- plugins |
||||
- backend |
||||
- plugin |
||||
- backend-plugins |
||||
- sdk |
||||
- documentation |
||||
title: Grafana Plugin SDK for Go |
||||
--- |
||||
|
||||
# Grafana plugin SDK for Go |
||||
|
||||
The [Grafana plugin SDK for Go](https://pkg.go.dev/mod/github.com/grafana/grafana-plugin-sdk-go?tab=overview) is a [Go](https://golang.org/) module that provides a set of [packages](https://pkg.go.dev/mod/github.com/grafana/grafana-plugin-sdk-go?tab=packages) that you can use to implement a backend plugin. |
||||
|
||||
The plugin SDK provides a high-level framework with APIs, utilities, and tooling. By using the SDK, you can avoid the need to learn the details of the [plugin protocol]({{< relref "plugin-protocol/" >}}) and RPC communication protocol, so you don't have to manage either one. |
||||
|
||||
## Versioning |
||||
|
||||
The Grafana plugin Go SDK is still in development. It is based on the [plugin protocol]({{< relref "plugin-protocol/" >}}), which is versioned separately and is considered stable. However, from time to time, we might introduce breaking changes in the SDK. |
||||
|
||||
When we update the plugin SDK, those plugins that use an older version of the SDK should still work with Grafana. However, these older plugins may be unable to use the new features and capabilities we introduce in updated SDK versions. |
||||
|
||||
## See also |
||||
|
||||
- [SDK source code](https://github.com/grafana/grafana-plugin-sdk-go) |
||||
- [Go reference documentation](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go) |
||||
@ -1,45 +0,0 @@ |
||||
--- |
||||
keywords: |
||||
- grafana |
||||
- plugins |
||||
- backend |
||||
- plugin |
||||
- backend-plugins |
||||
- documentation |
||||
title: Plugin protocol |
||||
--- |
||||
|
||||
# Plugin protocol |
||||
|
||||
The Grafana server uses a physical wire protocol to communicate with backend plugins. This protocol establishes a contract between Grafana and backend plugins to allow them to communicate with each other. |
||||
|
||||
## Developing with the plugin protocol |
||||
|
||||
{{% admonition type="caution" %}} We strongly recommend that backend plugin development not be implemented directly against the protocol. Instead, we prefer that you use the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go/" >}}) that implements this protocol and provides higher-level APIs. {{% |
||||
/admonition %}} |
||||
|
||||
If you choose to develop against the plugin protocol directly, you can do so using [Protocol Buffers](https://developers.google.com/protocol-buffers) (that is, protobufs) with [gRPC](https://grpc.io/). |
||||
|
||||
Grafana's plugin protocol protobufs are available in the [GitHub repository](https://github.com/grafana/grafana-plugin-sdk-go/blob/master/proto/backend.proto). |
||||
|
||||
{{% admonition type="note" %}} |
||||
The plugin protocol lives in the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go/" >}}) because Grafana itself uses parts of the SDK as a dependency. |
||||
{{% /admonition %}} |
||||
|
||||
## Versioning |
||||
|
||||
From time to time, Grafana will offer additions of services, messages, and fields in the latest version of the plugin protocol. We don't expect these updates to introduce any breaking changes. However, if we must introduce breaking changes to the plugin protocol, we'll create a new major version of the plugin protocol. |
||||
|
||||
Grafana will release new major versions of the plugin protocol alongside new major Grafana releases. When this happens, we'll support both the old and the new plugin protocol for some time to make sure existing backend plugins continue to work. |
||||
|
||||
The plugin protocol attempts to follow Grafana's versioning. However, that doesn't mean we will automatically create a new major version of the plugin protocol when a new major release of Grafana is released. |
||||
|
||||
## Writing plugins without Go |
||||
|
||||
If you want to write a backend plugin in a language other than Go, then it's possible as long as the language supports gRPC. However, we recommend that you develop your plugin in Go for several reasons: |
||||
|
||||
- We offer an official plugin SDK. |
||||
- The compiled output is a single binary. |
||||
- Writing for multiple platforms is easy. Typically, no additional dependencies must be installed on the target platform. |
||||
- Small footprint for binary size. |
||||
- Small footprint for resource usage. |
||||
@ -1,148 +0,0 @@ |
||||
--- |
||||
title: Build a logs data source plugin |
||||
--- |
||||
|
||||
# Build a logs data source plugin |
||||
|
||||
Grafana data source plugins support metrics, logs, and other data types. The steps to build a logs data source plugin are largely the same as for a metrics data source, but there are a few differences which we will explain in this guide. |
||||
|
||||
## Before you begin |
||||
|
||||
This guide assumes that you're already familiar with how to [Build a data source plugin](/tutorials/build-a-data-source-plugin/) for metrics. We recommend that you review this material before continuing. |
||||
|
||||
## Add logs support to your data source |
||||
|
||||
To add logs support to an existing data source, you need to: |
||||
|
||||
1. Enable logs support |
||||
1. Construct the log data |
||||
|
||||
When these steps are done, then you can improve the user experience with one or more [optional features](#enhance-your-logs-data-source-plugin-with-optional-features). |
||||
|
||||
### Step 1: Enable logs support |
||||
|
||||
Tell Grafana that your data source plugin can return log data, by adding `"logs": true` to the [plugin.json]({{< relref "metadata/" >}}) file. |
||||
|
||||
```json |
||||
{ |
||||
"logs": true |
||||
} |
||||
``` |
||||
|
||||
### Step 2: Construct the log data |
||||
|
||||
As it does with metrics data, Grafana expects your plugin to return log data as a [data frame]({{< relref "data-frames/" >}}). |
||||
|
||||
To return log data, return a data frame with at least one time field and one text field from the data source's `query` method. |
||||
|
||||
**Example:** |
||||
|
||||
```ts |
||||
const frame = new MutableDataFrame({ |
||||
refId: query.refId, |
||||
fields: [ |
||||
{ name: 'time', type: FieldType.time }, |
||||
{ name: 'content', type: FieldType.string }, |
||||
], |
||||
}); |
||||
|
||||
frame.add({ time: 1589189388597, content: 'user registered' }); |
||||
frame.add({ time: 1589189406480, content: 'user logged in' }); |
||||
``` |
||||
|
||||
That's all you need to start returning log data from your data source. Go ahead and try it out in [Explore]({{< relref "../../explore/" >}}) or by adding a [Logs panel]({{< relref "../../panels-visualizations/visualizations/logs/" >}}). |
||||
|
||||
Congratulations, you just wrote your first logs data source plugin! Next, let's look at a couple of features that can further improve the experience for the user. |
||||
|
||||
## Enhance your logs data source plugin with optional features |
||||
|
||||
Add visualization type hints, labels, and other optional features to logs. |
||||
|
||||
### Add a preferred visualization type hint to the data frame |
||||
|
||||
To make sure Grafana recognizes data as logs and shows logs visualization automatically in Explore, set `meta.preferredVisualisationType` to `'logs'` in the returned data frame. See [Selecting preferred visualisation section]({{< relref "add-support-for-explore-queries/#selecting-preferred-visualisation" >}}) |
||||
|
||||
**Example:** |
||||
|
||||
```ts |
||||
const frame = new MutableDataFrame({ |
||||
refId: query.refId, |
||||
meta: { |
||||
preferredVisualisationType: 'logs', |
||||
}, |
||||
fields: [ |
||||
{ name: 'time', type: FieldType.time }, |
||||
{ name: 'content', type: FieldType.string }, |
||||
], |
||||
}); |
||||
``` |
||||
|
||||
### Add labels to your logs |
||||
|
||||
Many log systems let you query logs based on metadata, or _labels_, to help filter log lines. |
||||
|
||||
Add labels to a stream of logs by setting the `labels` property on the Field. |
||||
|
||||
**Example**: |
||||
|
||||
```ts |
||||
const frame = new MutableDataFrame({ |
||||
refId: query.refId, |
||||
fields: [ |
||||
{ name: 'time', type: FieldType.time }, |
||||
{ name: 'content', type: FieldType.string, labels: { filename: 'file.txt' } }, |
||||
], |
||||
}); |
||||
|
||||
frame.add({ time: 1589189388597, content: 'user registered' }); |
||||
frame.add({ time: 1589189406480, content: 'user logged in' }); |
||||
``` |
||||
|
||||
### Extract detected fields from your logs |
||||
|
||||
Add additional information about each log line by supplying more data frame fields. |
||||
|
||||
If a data frame has more than one text field, then Grafana assumes the first field in the data frame to be the actual log line. Grafana treats subsequent text fields as [detected fields]({{< relref "../../explore/#labels-and-detected-fields" >}}). |
||||
|
||||
Any number of custom fields can be added to your data frame; Grafana comes with two dedicated fields: `levels` and `id`. |
||||
|
||||
#### Levels |
||||
|
||||
To set the level for each log line, add a `level` field. |
||||
|
||||
**Example:** |
||||
|
||||
```ts |
||||
const frame = new MutableDataFrame({ |
||||
refId: query.refId, |
||||
fields: [ |
||||
{ name: 'time', type: FieldType.time }, |
||||
{ name: 'content', type: FieldType.string, labels: { filename: 'file.txt' } }, |
||||
{ name: 'level', type: FieldType.string }, |
||||
], |
||||
}); |
||||
|
||||
frame.add({ time: 1589189388597, content: 'user registered', level: 'info' }); |
||||
frame.add({ time: 1589189406480, content: 'unknown error', level: 'error' }); |
||||
``` |
||||
|
||||
#### 'id' for assigning unique identifiers to log lines |
||||
|
||||
By default, Grafana offers basic support for deduplicating log lines. You can improve the support by adding an `id` field to explicitly assign identifiers to each log line. |
||||
|
||||
**Example:** |
||||
|
||||
```ts |
||||
const frame = new MutableDataFrame({ |
||||
refId: query.refId, |
||||
fields: [ |
||||
{ name: 'time', type: FieldType.time }, |
||||
{ name: 'content', type: FieldType.string, labels: { filename: 'file.txt' } }, |
||||
{ name: 'level', type: FieldType.string }, |
||||
{ name: 'id', type: FieldType.string }, |
||||
], |
||||
}); |
||||
|
||||
frame.add({ time: 1589189388597, content: 'user registered', level: 'info', id: 'd3b07384d113edec49eaa6238ad5ff00' }); |
||||
frame.add({ time: 1589189406480, content: 'unknown error', level: 'error', id: 'c157a79031e1c40f85931829bc5fc552' }); |
||||
``` |
||||
@ -1,151 +0,0 @@ |
||||
--- |
||||
title: Build a streaming data source plugin |
||||
--- |
||||
|
||||
# Build a streaming data source plugin |
||||
|
||||
In Grafana, you can set your dashboards to automatically refresh at a certain interval, no matter what data source you use. Unfortunately, this means that your queries are requesting all the data to be sent again, regardless of whether the data has actually changed. Adding streaming to a plugin helps reduce queries so your dashboard is only updated when new data becomes available. |
||||
|
||||
## Before you begin |
||||
|
||||
This guide assumes that you're already familiar with how to [Build a data source plugin](/tutorials/build-a-data-source-plugin/). |
||||
|
||||
Grafana uses [RxJS](https://rxjs.dev/) to continuously send data from a data source to a panel visualization. |
||||
|
||||
> **Note:** To learn more about RxJs, refer to the [RxJS documentation](https://rxjs.dev/guide/overview). |
||||
|
||||
## Add streaming to your data source |
||||
|
||||
Enable streaming for your data source plugin to update your dashboard when new data becomes available. |
||||
|
||||
For example, a streaming data source plugin can connect to a websocket, or subscribe to a message bus, and update the visualization whenever a new message is available. |
||||
|
||||
### Step 1: Edit the `plugin.json` file |
||||
|
||||
Enable streaming for your data source in the `plugin.json` file. |
||||
|
||||
```json |
||||
{ |
||||
"streaming": true |
||||
} |
||||
``` |
||||
|
||||
### Step 2: Change the signature of the `query` method |
||||
|
||||
Modify the signature of the `query` method to return an `Observable` from the `rxjs` package. Make sure you remove the `async` keyword. |
||||
|
||||
```ts |
||||
import { Observable } from 'rxjs'; |
||||
``` |
||||
|
||||
```ts |
||||
query(options: DataQueryRequest<MyQuery>): Observable<DataQueryResponse> { |
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
### Step 3: Create an `Observable` instance for each query |
||||
|
||||
Create an `Observable` instance for each query, and then combine them all using the `merge` function from the `rxjs` package. |
||||
|
||||
```ts |
||||
import { Observable, merge } from 'rxjs'; |
||||
``` |
||||
|
||||
```ts |
||||
const observables = options.targets.map((target) => { |
||||
return new Observable<DataQueryResponse>((subscriber) => { |
||||
// ... |
||||
}); |
||||
}); |
||||
|
||||
return merge(...observables); |
||||
``` |
||||
|
||||
### Step 4: Create a `CircularDataFrame` instance |
||||
|
||||
In the `subscribe` function, create a `CircularDataFrame` instance. |
||||
|
||||
```ts |
||||
import { CircularDataFrame } from '@grafana/data'; |
||||
``` |
||||
|
||||
```ts |
||||
const frame = new CircularDataFrame({ |
||||
append: 'tail', |
||||
capacity: 1000, |
||||
}); |
||||
|
||||
frame.refId = query.refId; |
||||
frame.addField({ name: 'time', type: FieldType.time }); |
||||
frame.addField({ name: 'value', type: FieldType.number }); |
||||
``` |
||||
|
||||
Circular data frames have a limited capacity. When a circular data frame reaches its capacity, the oldest data point is removed. |
||||
|
||||
### Step 5: Send the updated data frame |
||||
|
||||
Use `subscriber.next()` to send the updated data frame whenever you receive new updates. |
||||
|
||||
```ts |
||||
import { LoadingState } from '@grafana/data'; |
||||
``` |
||||
|
||||
```ts |
||||
const intervalId = setInterval(() => { |
||||
frame.add({ time: Date.now(), value: Math.random() }); |
||||
|
||||
subscriber.next({ |
||||
data: [frame], |
||||
key: query.refId, |
||||
state: LoadingState.Streaming, |
||||
}); |
||||
}, 500); |
||||
|
||||
return () => { |
||||
clearInterval(intervalId); |
||||
}; |
||||
``` |
||||
|
||||
> **Note:** In practice, you'd call `subscriber.next` as soon as you receive new data from a websocket or a message bus. In the example above, data is being received every 500 milliseconds. |
||||
|
||||
### Example code for final `query` method |
||||
|
||||
```ts |
||||
query(options: DataQueryRequest<MyQuery>): Observable<DataQueryResponse> { |
||||
const streams = options.targets.map(target => { |
||||
const query = defaults(target, defaultQuery); |
||||
|
||||
return new Observable<DataQueryResponse>(subscriber => { |
||||
const frame = new CircularDataFrame({ |
||||
append: 'tail', |
||||
capacity: 1000, |
||||
}); |
||||
|
||||
frame.refId = query.refId; |
||||
frame.addField({ name: 'time', type: FieldType.time }); |
||||
frame.addField({ name: 'value', type: FieldType.number }); |
||||
|
||||
const intervalId = setInterval(() => { |
||||
frame.add({ time: Date.now(), value: Math.random() }); |
||||
|
||||
subscriber.next({ |
||||
data: [frame], |
||||
key: query.refId, |
||||
state: LoadingState.Streaming, |
||||
}); |
||||
}, 100); |
||||
|
||||
return () => { |
||||
clearInterval(intervalId); |
||||
}; |
||||
}); |
||||
}); |
||||
|
||||
return merge(...streams); |
||||
} |
||||
``` |
||||
|
||||
One limitation with this example is that the panel visualization is cleared every time you update the dashboard. If you have access to historical data, you can add it, or _backfill_ it, to the data frame before the first call to `subscriber.next()`. |
||||
|
||||
For another example of a streaming plugin, refer to the [streaming websocket example](https://github.com/grafana/grafana-plugin-examples/tree/main/examples/datasource-streaming-websocket) on GitHub. |
||||
@ -1,27 +0,0 @@ |
||||
--- |
||||
description: How-to topics for plugin development |
||||
title: Create a plugin |
||||
--- |
||||
|
||||
# Create a Grafana plugin |
||||
|
||||
This section contains how-to topics for developing Grafana plugins. |
||||
|
||||
- [Build a Grafana plugin](https://grafana.github.io/plugin-tools/docs/creating-a-plugin) |
||||
- [Build a panel plugin](https://grafana.com/tutorials/build-a-panel-plugin/) |
||||
- [Build a data source plugin](https://grafana.com/tutorials/build-a-data-source-plugin/) |
||||
- [Build a data source backend plugin](https://grafana.com/tutorials/build-a-data-source-backend-plugin/) |
||||
- [Build a logs data source plugin]({{< relref "../build-a-logs-data-source-plugin.md">}}) |
||||
- [Build a streaming data source plugin]({{< relref "../build-a-streaming-data-source-plugin.md">}}) |
||||
- Extend a Grafana plugin |
||||
- [Add annotations]({{< relref "add-support-for-annotations.md">}}) |
||||
- [Add anonymous usage reporting]({{< relref "add-anonymous-usage-reporting.md">}}) |
||||
- [Add authentication for a data source plugin]({{< relref "add-authentication-for-data-source-plugins.md">}}) |
||||
- [Add Explore queries]({{< relref "add-support-for-explore-queries.md">}}) |
||||
- [Add query editor help]({{< relref "add-query-editor-help.md">}}) |
||||
- [Add variables]({{< relref "add-support-for-variables.md">}}) |
||||
- [Create panel option editors]({{< relref "custom-panel-option-editors.md">}}) |
||||
- [Sign a plugin]({{< relref "sign-a-plugin.md">}}) |
||||
- [Automate development with CI](https://grafana.github.io/plugin-tools/docs/ci) |
||||
- [Create nested plugins](https://grafana.github.io/plugin-tools/docs/nested-plugins) |
||||
- [Extend configurations](https://grafana.github.io/plugin-tools/docs/advanced-configuration) |
||||
@ -1,74 +0,0 @@ |
||||
--- |
||||
title: Work with cross-plugin links |
||||
description: Learn how to add plugin links to a Grafana app plugin |
||||
--- |
||||
|
||||
# Work with cross-plugin links |
||||
|
||||
With the Plugins extension API, app plugins can register extension points of their own to display other plugins links. This is called _cross-plugin linking_, and you can use it to create more immersive user experiences with installed plugins. |
||||
|
||||
## Available extension points within plugins |
||||
|
||||
An extension point is a location in another plugin's UI where your plugin can insert links. All extension point IDs within plugins should follow the naming convention `plugins/<plugin-id>/<extension-point-id>`. |
||||
|
||||
## How to create an extension point within a plugin |
||||
|
||||
Use the `getPluginExtensions` method in `@grafana/runtime` to create an extension point within your plugin. An extension point is a way to specify where in the plugin UI other plugins links are rendered. |
||||
|
||||
{{% admonition type="note" %}} |
||||
Creating an extension point in a plugin creates a public interface for other plugins to interact with. Changes to the extension point ID or its context could break any plugin that attempts to register a link inside your plugin. |
||||
{{% /admonition %}} |
||||
|
||||
The `getPluginExtensions` method takes an object consisting of the `extensionPointId`, which must begin `plugin/<pluginId>`, and any contextual information that you want to provide. The `getPluginExtensions` method returns a list of `extensionLinks` that your program can loop over: |
||||
|
||||
```typescript |
||||
import { getPluginExtensions } from '@grafana/runtime'; |
||||
import { isPluginExtensionLink } from '@grafana/data'; |
||||
import { LinkButton } from '@grafana/ui'; |
||||
|
||||
function AppExtensionPointExample() { |
||||
const { extensions } = getPluginExtensions({ |
||||
extensionPointId: 'plugin/another-app-plugin/menu', |
||||
context: { |
||||
pluginId: 'another-app-plugin', |
||||
}, |
||||
}); |
||||
|
||||
if (extensions.length === 0) { |
||||
return null; |
||||
} |
||||
|
||||
return ( |
||||
<div> |
||||
{extensions.map((extension) => { |
||||
if (isPluginExtensionLink(extension)) { |
||||
return ( |
||||
<LinkButton href={extension.path} title={extension.description} key={extension.key}> |
||||
{extension.title} |
||||
</LinkButton> |
||||
); |
||||
} |
||||
|
||||
return null; |
||||
})} |
||||
</div> |
||||
); |
||||
} |
||||
``` |
||||
|
||||
The preceding example shows a component that renders `<LinkButton />` components for all link extensions that other plugins registered for the `plugin/another-app-plugin/menu` extension point ID. The context is passed as the second parameter to `getPluginExtensions`, which uses `Object.freeze` to make the context immutable before passing it to other plugins. |
||||
|
||||
## Insert links into another plugin |
||||
|
||||
Create links for other plugins in the same way you [extend the Grafana application UI]({{< relref "./extend-the-grafana-ui-with-links" >}}) with a link. Don't specify a `grafana/...` extension point. Instead, specify the plugin extension point `plugin/<pluginId>/<extensionPointId>`. |
||||
|
||||
Given the preceding example, use a plugin link such as the following: |
||||
|
||||
```typescript |
||||
new AppPlugin().configureExtensionLink({ |
||||
title: 'Go to basic app', |
||||
description: 'Will navigate the user to the basic app', |
||||
extensionPointId: 'plugin/another-app-plugin/menu', |
||||
path: '/a/myorg-basic-app/one', |
||||
}); |
||||
``` |
||||
@ -1,119 +0,0 @@ |
||||
--- |
||||
title: Build a custom panel option editor |
||||
--- |
||||
|
||||
# Build a custom panel option editor |
||||
|
||||
The Grafana plugin platform comes with a range of editors that allow your users to customize a panel. The standard editors cover the most common types of options, such as text input and boolean switches. If you don't find the editor you're looking for, you can build your own. |
||||
|
||||
## Panel option editor basics |
||||
|
||||
The simplest editor is a React component that accepts two props: |
||||
|
||||
- **`value`**: the current value of the option |
||||
- **`onChange`**: updates the option's value |
||||
|
||||
The editor in the example below lets the user toggle a boolean value by clicking a button: |
||||
|
||||
**SimpleEditor.tsx** |
||||
|
||||
```ts |
||||
import React from 'react'; |
||||
import { Button } from '@grafana/ui'; |
||||
import { StandardEditorProps } from '@grafana/data'; |
||||
|
||||
export const SimpleEditor: React.FC<StandardEditorProps<boolean>> = ({ value, onChange }) => { |
||||
return <Button onClick={() => onChange(!value)}>{value ? 'Disable' : 'Enable'}</Button>; |
||||
}; |
||||
``` |
||||
|
||||
To use a custom panel option editor, use the `addCustomEditor` on the `OptionsUIBuilder` object in your `module.ts` file and set the `editor` property to the name of your custom editor component. |
||||
|
||||
**module.ts** |
||||
|
||||
```ts |
||||
export const plugin = new PanelPlugin<SimpleOptions>(SimplePanel).setPanelOptions((builder) => { |
||||
return builder.addCustomEditor({ |
||||
id: 'label', |
||||
path: 'label', |
||||
name: 'Label', |
||||
editor: SimpleEditor, |
||||
}); |
||||
}); |
||||
``` |
||||
|
||||
## Add settings to your panel option editor |
||||
|
||||
You can use your custom editor to customize multiple possible settings. To add settings to your editor, set the second template variable of `StandardEditorProps` to an interface that contains the settings you want to configure. Access the editor settings through the `item` prop. |
||||
|
||||
Here's an example of an editor that populates a drop-down with a range of numbers. The `Settings` interface defines the range of the `from` and `to` properties. |
||||
|
||||
**SimpleEditor.tsx** |
||||
|
||||
```ts |
||||
interface Settings { |
||||
from: number; |
||||
to: number; |
||||
} |
||||
|
||||
export const SimpleEditor: React.FC<StandardEditorProps<number, Settings>> = ({ item, value, onChange }) => { |
||||
const options: Array<SelectableValue<number>> = []; |
||||
|
||||
// Default values |
||||
const from = item.settings?.from ?? 1; |
||||
const to = item.settings?.to ?? 10; |
||||
|
||||
for (let i = from; i <= to; i++) { |
||||
options.push({ |
||||
label: i.toString(), |
||||
value: i, |
||||
}); |
||||
} |
||||
|
||||
return <Select options={options} value={value} onChange={(selectableValue) => onChange(selectableValue.value)} />; |
||||
}; |
||||
``` |
||||
|
||||
You can now configure the editor for each option by configuring the `settings` property to call `addCustomEditor`: |
||||
|
||||
```ts |
||||
export const plugin = new PanelPlugin<SimpleOptions>(SimplePanel).setPanelOptions((builder) => { |
||||
return builder.addCustomEditor({ |
||||
id: 'index', |
||||
path: 'index', |
||||
name: 'Index', |
||||
editor: SimpleEditor, |
||||
settings: { |
||||
from: 1, |
||||
to: 10, |
||||
}, |
||||
}); |
||||
}); |
||||
``` |
||||
|
||||
## Use query results in your panel option editor |
||||
|
||||
Option editors can access the results from the last query. This lets you update your editor dynamically based on the data returned by the data source. |
||||
|
||||
The editor context is available through the `context` prop. The data frames returned by the data source are available under `context.data`. |
||||
|
||||
**SimpleEditor.tsx** |
||||
|
||||
```ts |
||||
export const SimpleEditor: React.FC<StandardEditorProps<string>> = ({ item, value, onChange, context }) => { |
||||
const options: SelectableValue<string>[] = []; |
||||
|
||||
if (context.data) { |
||||
const frames = context.data; |
||||
|
||||
for (let i = 0; i < frames.length; i++) { |
||||
options.push({ |
||||
label: frames[i].name, |
||||
value: frames[i].name, |
||||
}); |
||||
} |
||||
} |
||||
|
||||
return <Select options={options} value={value} onChange={(selectableValue) => onChange(selectableValue.value)} />; |
||||
}; |
||||
``` |
||||
@ -1,204 +0,0 @@ |
||||
--- |
||||
title: Data frames |
||||
--- |
||||
|
||||
# Data frames |
||||
|
||||
Grafana supports a variety of different data sources, each with its own data model. To make this possible, Grafana consolidates the query results from each of these data sources into one unified data structure called a _data frame_. |
||||
|
||||
The data frame structure is a concept that's borrowed from data analysis tools like the [R programming language](https://www.r-project.org) and [Pandas](https://pandas.pydata.org/). |
||||
|
||||
> Data frames are available in Grafana 7.0+, and replaced the Time series and Table structures with a more generic data structure that can support a wider range of data types. |
||||
|
||||
This document gives an overview of the data frame structure, and of how data is handled within Grafana. |
||||
|
||||
### Data frame fields |
||||
|
||||
A data frame is a collection of _fields_, where each field corresponds to a column. Each field, in turn, consists of a collection of values and metadata, such as the data type of those values. |
||||
|
||||
```ts |
||||
export interface Field<T = any, V = Vector<T>> { |
||||
/** |
||||
* Name of the field (column) |
||||
*/ |
||||
name: string; |
||||
/** |
||||
* Field value type (string, number, and so on) |
||||
*/ |
||||
type: FieldType; |
||||
/** |
||||
* Meta info about how field and how to display it |
||||
*/ |
||||
config: FieldConfig; |
||||
|
||||
/** |
||||
* The raw field values |
||||
* In Grafana 10, this accepts both simple arrays and the Vector interface |
||||
* In Grafana 11, the Vector interface will be removed |
||||
*/ |
||||
values: V | T[]; |
||||
|
||||
/** |
||||
* When type === FieldType.Time, this can optionally store |
||||
* the nanosecond-precison fractions as integers between |
||||
* 0 and 999999. |
||||
*/ |
||||
nanos?: number[]; |
||||
|
||||
labels?: Labels; |
||||
|
||||
/** |
||||
* Cached values with appropriate display and id values |
||||
*/ |
||||
state?: FieldState | null; |
||||
|
||||
/** |
||||
* Convert a value for display |
||||
*/ |
||||
display?: DisplayProcessor; |
||||
|
||||
/** |
||||
* Get value data links with variables interpolated |
||||
*/ |
||||
getLinks?: (config: ValueLinkConfig) => Array<LinkModel<Field>>; |
||||
} |
||||
``` |
||||
|
||||
Let's look at an example. The following table demonstrates a data frame with two fields, _time_ and _temperature_: |
||||
|
||||
| time | temperature | |
||||
| ------------------- | ----------- | |
||||
| 2020-01-02 03:04:00 | 45.0 | |
||||
| 2020-01-02 03:05:00 | 47.0 | |
||||
| 2020-01-02 03:06:00 | 48.0 | |
||||
|
||||
Each field has three values, and each value in a field must share the same type. In this case, all values in the `time` field are timestamps, and all values in the `temperature` field are numbers. |
||||
|
||||
One restriction on data frames is that all fields in the frame must be of the same length to be a valid data frame. |
||||
|
||||
### Field configurations |
||||
|
||||
Each field in a data frame contains optional information about the values in the field, such as units, scaling, and so on. |
||||
|
||||
By adding field configurations to a data frame, Grafana can configure visualizations automatically. For example, you could configure Grafana to automatically set the unit provided by the data source. |
||||
|
||||
## Data transformations |
||||
|
||||
We have seen how field configs contain type information, and they also have another role. Data frame fields enable _data transformations_ within Grafana. |
||||
|
||||
A data transformation is any function that accepts a data frame as input, and returns another data frame as output. By using data frames in your plugin, you get a range of transformations for free. |
||||
|
||||
To learn more about data transformations in Grafana, refer to [Transform data](https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/transform-data/). |
||||
|
||||
## Data frames as time series |
||||
|
||||
A data frame with at least one time field is considered a _time series_. |
||||
|
||||
For more information on time series, refer to our [Introduction to time series]({{< relref "../../fundamentals/timeseries/" >}}). |
||||
|
||||
### Wide format |
||||
|
||||
When a collection of time series shares the same _time index_—the time fields in each time series are identical—they can be stored together, in a _wide_ format. By reusing the time field, less data is sent to the browser. |
||||
|
||||
In this example, the `cpu` usage from each host shares the time index, so we can store them in the same data frame: |
||||
|
||||
```text |
||||
Name: Wide |
||||
Dimensions: 3 fields by 2 rows |
||||
+---------------------+-----------------+-----------------+ |
||||
| Name: time | Name: cpu | Name: cpu | |
||||
| Labels: | Labels: host=a | Labels: host=b | |
||||
| Type: []time.Time | Type: []float64 | Type: []float64 | |
||||
+---------------------+-----------------+-----------------+ |
||||
| 2020-01-02 03:04:00 | 3 | 4 | |
||||
| 2020-01-02 03:05:00 | 6 | 7 | |
||||
+---------------------+-----------------+-----------------+ |
||||
``` |
||||
|
||||
However, if the two time series don't share the same time values, they are represented as two distinct data frames: |
||||
|
||||
```text |
||||
Name: cpu |
||||
Dimensions: 2 fields by 2 rows |
||||
+---------------------+-----------------+ |
||||
| Name: time | Name: cpu | |
||||
| Labels: | Labels: host=a | |
||||
| Type: []time.Time | Type: []float64 | |
||||
+---------------------+-----------------+ |
||||
| 2020-01-02 03:04:00 | 3 | |
||||
| 2020-01-02 03:05:00 | 6 | |
||||
+---------------------+-----------------+ |
||||
|
||||
Name: cpu |
||||
Dimensions: 2 fields by 2 rows |
||||
+---------------------+-----------------+ |
||||
| Name: time | Name: cpu | |
||||
| Labels: | Labels: host=b | |
||||
| Type: []time.Time | Type: []float64 | |
||||
+---------------------+-----------------+ |
||||
| 2020-01-02 03:04:01 | 4 | |
||||
| 2020-01-02 03:05:01 | 7 | |
||||
+---------------------+-----------------+ |
||||
``` |
||||
|
||||
A typical use for the wide format is when multiple time series are collected by the same process. In this case, every measurement is made at the same interval and therefore shares the same time values. |
||||
|
||||
### Long format |
||||
|
||||
Some data sources return data in a _long_ format (also called _narrow_ format). This is a common format returned by, for example, SQL databases. |
||||
|
||||
In the long format, string values are represented as separate fields rather than as labels. As a result, a data form in long form may have duplicated time values. |
||||
|
||||
Grafana can detect and convert data frames in long format into wide format. |
||||
|
||||
For example, the following data frame appears in long format: |
||||
|
||||
```text |
||||
Name: Long |
||||
Dimensions: 4 fields by 4 rows |
||||
+---------------------+-----------------+-----------------+----------------+ |
||||
| Name: time | Name: aMetric | Name: bMetric | Name: host | |
||||
| Labels: | Labels: | Labels: | Labels: | |
||||
| Type: []time.Time | Type: []float64 | Type: []float64 | Type: []string | |
||||
+---------------------+-----------------+-----------------+----------------+ |
||||
| 2020-01-02 03:04:00 | 2 | 10 | foo | |
||||
| 2020-01-02 03:04:00 | 5 | 15 | bar | |
||||
| 2020-01-02 03:05:00 | 3 | 11 | foo | |
||||
| 2020-01-02 03:05:00 | 6 | 16 | bar | |
||||
+---------------------+-----------------+-----------------+----------------+ |
||||
``` |
||||
|
||||
The above table can be converted into a data frame in wide format like this: |
||||
|
||||
```text |
||||
Name: Wide |
||||
Dimensions: 5 fields by 2 rows |
||||
+---------------------+------------------+------------------+------------------+------------------+ |
||||
| Name: time | Name: aMetric | Name: bMetric | Name: aMetric | Name: bMetric | |
||||
| Labels: | Labels: host=foo | Labels: host=foo | Labels: host=bar | Labels: host=bar | |
||||
| Type: []time.Time | Type: []float64 | Type: []float64 | Type: []float64 | Type: []float64 | |
||||
+---------------------+------------------+------------------+------------------+------------------+ |
||||
| 2020-01-02 03:04:00 | 2 | 10 | 5 | 15 | |
||||
| 2020-01-02 03:05:00 | 3 | 11 | 6 | 16 | |
||||
+---------------------+------------------+------------------+------------------+------------------+ |
||||
``` |
||||
|
||||
<<<<<<< HEAD |
||||
|
||||
> **Note:** Not all panels support the wide time series data frame format. To keep full backward compatibility Grafana has introduced a transformation that you can use to convert from the wide to the long format. For usage information, refer to the [Prepare time series-transformation]({{< relref "../../panels-visualizations/query-transform-data/transform-data/#prepare-time-series" >}}). |
||||
|
||||
## Technical references |
||||
|
||||
The concept of a data frame in Grafana is borrowed from data analysis tools like the [R programming language](https://www.r-project.org), and [Pandas](https://pandas.pydata.org/). Other technical references are provided below. |
||||
|
||||
### Apache Arrow |
||||
|
||||
The data frame structure is inspired by, and uses the [Apache Arrow Project](https://arrow.apache.org/). Javascript Data frames use Arrow Tables as the underlying structure, and the backend Go code serializes its Frames in Arrow Tables for transmission. |
||||
|
||||
### Javascript |
||||
|
||||
The Javascript implementation of data frames is in the [`/src/dataframe` folder](https://github.com/grafana/grafana/tree/main/packages/grafana-data/src/dataframe) and [`/src/types/dataframe.ts`](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/dataFrame.ts) of the [`@grafana/data` package](https://github.com/grafana/grafana/tree/main/packages/grafana-data). |
||||
|
||||
### Go |
||||
|
||||
For documentation on the Go implementation of data frames, refer to the [github.com/grafana/grafana-plugin-sdk-go/data package](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go/data?tab=doc). |
||||
@ -1,178 +0,0 @@ |
||||
--- |
||||
title: Develop with a local environment |
||||
--- |
||||
|
||||
# Develop with a local environment |
||||
|
||||
Follow the steps in this guide to set up a development environment where you run Grafana and your plugin locally. With this setup, you can see your changes as you add them. |
||||
|
||||
## Run Grafana in your host |
||||
|
||||
To clone and run Grafana locally: |
||||
|
||||
1. Download and set up Grafana. Refer to the [developer-guide](https://github.com/grafana/grafana/blob/HEAD/contribute/developer-guide.md). |
||||
|
||||
2. Grafana looks for plugins, by default, in its `data/plugins` directory. You can create a symbolic link to your plugin repository to detect new changes: |
||||
|
||||
```bash |
||||
ln -s <plugin-path>/dist data/plugins/<plugin-name> |
||||
``` |
||||
|
||||
3. Optional: If the preceding step doesn't work for you (for example, if you are running on Windows), then modify the default path in the Grafana configuration. Find the default path at `conf/custom.ini`) and point it to your plugin's directory: |
||||
|
||||
```ini |
||||
[paths] |
||||
plugins = <path-to-your-plugin-parent-directory> |
||||
``` |
||||
|
||||
## Run Grafana with docker-compose |
||||
|
||||
Another option is to run Grafana with docker-compose so that it runs in a container. To do so, create the `docker-compose` file in your plugin directory. |
||||
|
||||
{{% admonition type="note" %}} |
||||
If your plugin already includes a docker-compose file, then skip this step. |
||||
{{% /admonition %}} |
||||
|
||||
```yaml |
||||
version: '3.7' |
||||
|
||||
services: |
||||
grafana: |
||||
# Change latest with your target version, if needed |
||||
image: grafana/grafana:latest |
||||
ports: |
||||
- 3000:3000/tcp |
||||
volumes: |
||||
# Use your plugin folder (for example, redshift-datasource) |
||||
- ./dist:/var/lib/grafana/plugins/<plugin-folder> |
||||
- ./provisioning:/etc/grafana/provisioning |
||||
environment: |
||||
- TERM=linux |
||||
- GF_LOG_LEVEL=debug |
||||
- GF_DATAPROXY_LOGGING=true |
||||
- GF_DEFAULT_APP_MODE=development |
||||
``` |
||||
|
||||
## Run your plugin in development mode |
||||
|
||||
Finally, start your plugin in development mode. Go to your plugin's root directory and follow these steps: |
||||
|
||||
1. Build your plugin backend and start the frontend in watch mode: |
||||
|
||||
```bash |
||||
mage -v |
||||
yarn watch |
||||
``` |
||||
|
||||
2. Start the Grafana backend and frontend: |
||||
|
||||
1. For a local copy of Grafana, go to the directory with Grafana source code and run: |
||||
|
||||
```bash |
||||
make run |
||||
``` |
||||
|
||||
```bash |
||||
yarn start |
||||
``` |
||||
|
||||
2. Or, with docker-compose, in your plugin directory, run: |
||||
|
||||
```bash |
||||
docker-compose up |
||||
``` |
||||
|
||||
After this, you should be able to see your plugin listed in Grafana, and then you can test your changes. |
||||
|
||||
If you make a change in the frontend, you must refresh your browser. However, changes in the backend may require that you rebuild your plugin binaries and reload the plugin (`mage && mage reloadPlugin` for local development, or run `docker-compose up` again if you are using docker-compose). |
||||
|
||||
## Run your backend plugin with a debugger |
||||
|
||||
{{% admonition type="note" %}} |
||||
The following method only works with a local Grafana instance and currently doesn't work with Docker. |
||||
{{% /admonition %}} |
||||
|
||||
Running a backend plugin with a debugger is supported in Visual Studio Code and GoLand out of the box, but it can also work with any other IDE or debugger. |
||||
|
||||
You can run a backend plugin and attach a debugger to it, which allows you to set breakpoints and debug your backend plugin directly from your IDE of choice: |
||||
|
||||
1. Go to your plugin's folder. |
||||
|
||||
1. Check your `go.mod` to make sure `grafana-plugin-sdk-go` are at least on `v0.156.0` |
||||
- If not, update it to the latest version: |
||||
``` |
||||
go get -u github.com/grafana/grafana-plugin-sdk-go |
||||
``` |
||||
1. Build your plugin at least once: |
||||
``` |
||||
yarn build && mage |
||||
``` |
||||
1. Install your plugin into your local Grafana instance. |
||||
|
||||
Now that your plugin is ready to run, follow the instructions bellow for your IDE of choice. |
||||
|
||||
### Visual Studio Code |
||||
|
||||
1. If it's not already present, go to your plugin's folder and place the following file inside `.vscode/launch.json`: |
||||
|
||||
```json |
||||
{ |
||||
"version": "0.2.0", |
||||
"configurations": [ |
||||
{ |
||||
"name": "Standalone debug mode", |
||||
"type": "go", |
||||
"request": "launch", |
||||
"mode": "debug", |
||||
"program": "${workspaceFolder}/pkg", |
||||
"env": {}, |
||||
"args": ["-standalone"] |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
1. Press `F5` to run your plugin in debug mode. |
||||
1. If Grafana isn't already running, run it. |
||||
|
||||
> If you re-run the configuration, Grafana automatically reloads the plugin. |
||||
|
||||
### GoLand |
||||
|
||||
1. Create a new Run/Debug configuration: |
||||
|
||||
- **Run kind**: Package |
||||
- **Package path**: your `pkg` package |
||||
- **Program arguments**: `-standalone` |
||||
|
||||
1. Run the config (with or without the debugger). |
||||
|
||||
1. If Grafana isn't already running, run it. |
||||
|
||||
{{% admonition type="note" %}} |
||||
If you re-run the configuration, Grafana automatically reloads the plugin. |
||||
{{% /admonition %}} |
||||
|
||||
### Other IDEs |
||||
|
||||
Configure your code editor to run the following steps: |
||||
|
||||
1. Build the executable file with debug flags. |
||||
``` |
||||
mage build:debug |
||||
``` |
||||
1. Run the plugin's executable file (inside `dist`) with `-standalone -debug` flags. |
||||
``` |
||||
./gpx_xyz_linux_amd64 -standalone -debug |
||||
``` |
||||
1. Attach a debugger to the process. |
||||
|
||||
1. If Grafana isn't already running, run it. |
||||
|
||||
> If you re-run the configuration, Grafana automatically reloads the plugin. |
||||
|
||||
### Notes |
||||
|
||||
- All logs are printed in the plugin's `stdout` rather than in Grafana logs. |
||||
- If the backend plugin doesn't serve requests after you turn off debug mode, you can force a reset to the standalone mode. To do so, delete the files `dist/standalone.txt`, `dist/pid.txt`, and the executable file, and then restart Grafana. |
||||
- Grafana doesn't support debugging backend plugins running inside Docker. But this is a [planned enhancement](https://github.com/grafana/grafana-plugin-sdk-go/issues/685). |
||||
@ -1,65 +0,0 @@ |
||||
--- |
||||
title: Work with error handling |
||||
--- |
||||
|
||||
# Work with error handling |
||||
|
||||
This guide explains how to handle errors in plugins and provides suggestions for common scenarios. |
||||
|
||||
## Provide usable defaults |
||||
|
||||
Allow the user to learn your plugin in small steps. Provide a useful default configuration so that: |
||||
|
||||
- The user can get started right away. |
||||
- You can avoid unnecessary error messages. |
||||
|
||||
For example, by selecting the first field of an expected type, the panel can display a visualization without any user configuration. If a user explicitly selects a field, then use that one. Otherwise, default to the first field of type `string`: |
||||
|
||||
```ts |
||||
const numberField = frame.fields.find((field) => |
||||
options.numberFieldName ? field.name === options.numberFieldName : field.type === FieldType.number |
||||
); |
||||
``` |
||||
|
||||
## Display error messages |
||||
|
||||
To display an error message to the user, `throw` an `Error` with the message you want to display: |
||||
|
||||
```ts |
||||
throw new Error('An error occurred'); |
||||
``` |
||||
|
||||
Grafana displays the error message in the top-left corner of the panel. |
||||
|
||||
{{< figure src="/static/img/docs/panel_error.png" class="docs-image--no-shadow" max-width="850px" >}} |
||||
|
||||
We recommend that you avoid displaying overly technical error messages to the user. If you want to let technical users report an error, consider logging it to the console instead. |
||||
|
||||
```ts |
||||
try { |
||||
failingFunction(); |
||||
} catch (err) { |
||||
console.error(err); |
||||
throw new Error('Something went wrong'); |
||||
} |
||||
``` |
||||
|
||||
> **Note:** Grafana displays the exception message in the UI as written, so use grammatically correct sentences. For more information, refer to the [Documentation style guide](https://github.com/grafana/grafana/blob/main/contribute/style-guides/documentation-style-guide.md). |
||||
|
||||
## Common error scenarios |
||||
|
||||
Here are some examples of situations where you might want to display an error to the user. |
||||
|
||||
### Invalid query response |
||||
|
||||
Users have full freedom when they create data source queries for panels. If your panel plugin requires a specific format for the query response, then use the panel canvas to guide the user. |
||||
|
||||
```ts |
||||
if (!numberField) { |
||||
throw new Error('Query result is missing a number field'); |
||||
} |
||||
|
||||
if (frame.length === 0) { |
||||
throw new Error('Query returned an empty result'); |
||||
} |
||||
``` |
||||
@ -1,12 +0,0 @@ |
||||
--- |
||||
description: Get started guide |
||||
title: Get started with plugins |
||||
--- |
||||
|
||||
# Get started with Grafana plugins |
||||
|
||||
This section contains guidance for building plugins. |
||||
|
||||
- [Get started with creating a plugin](https://grafana.github.io/plugin-tools/docs/getting-started) |
||||
- [Types of Grafana plugins](https://grafana.com/docs/grafana/latest/administration/plugin-management/) |
||||
- [Set up your development environment](https://grafana.github.io/plugin-tools/docs/docker) |
||||
@ -1,13 +0,0 @@ |
||||
--- |
||||
description: Conceptual topics for plugin development |
||||
title: Introduction to plugin development |
||||
--- |
||||
|
||||
# Introduction to Grafana plugin development |
||||
|
||||
This section contains topics related to the key concepts for Grafana plugin development. |
||||
|
||||
- [Backend plugins]({{< relref "../backend/" >}}) |
||||
- [Grafana plugin SDK for Go]({{< relref "../backend/grafana-plugin-sdk-for-go.md" >}}) |
||||
- [Plugin protocol]({{< relref "../backend/plugin-protocol.md" >}}) |
||||
- [Data frames]({{< relref "data-frames.md">}}) |
||||
@ -1,131 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../plugins/development/ |
||||
- /docs/grafana/next/plugins/datasources/ |
||||
- /docs/grafana/next/plugins/developing/development/ |
||||
- /docs/grafana/next/plugins/panels/ |
||||
title: Legacy plugins |
||||
--- |
||||
|
||||
# Legacy plugins |
||||
|
||||
> **Note:** Since Grafana 7.0, writing plugins using Angular is no longer recommended. If you're looking to build a new plugin, refer to [Plugins]({{< relref "../" >}}). |
||||
|
||||
You can extend Grafana by writing your own plugins and then share them with other users in [our plugin repository](https://grafana.com/plugins). |
||||
|
||||
Grafana already has a strong community of contributors and plugin developers. By making it easier to develop and install plugins with resources such as this guide, we hope that the community can grow even stronger and develop new plugins that we would never think about. |
||||
|
||||
## Short version |
||||
|
||||
1. [Set up Grafana](https://github.com/grafana/grafana/blob/main/contribute/developer-guide.md) |
||||
1. Clone an example plugin into `/var/lib/grafana/plugins` or `data/plugins` (relative to grafana git repo if you're running development version from source dir) |
||||
1. Use one of our example plugins as a starting point |
||||
|
||||
Example plugins |
||||
|
||||
- ["Hello World" panel using Angular](https://github.com/grafana/simple-angular-panel) |
||||
- ["Hello World" panel using React](https://github.com/grafana/simple-react-panel) |
||||
- [Simple json data source](https://github.com/grafana/simple-json-datasource) |
||||
- [Clock panel](https://github.com/grafana/clock-panel) |
||||
- [Pie chart panel](https://github.com/grafana/piechart-panel) |
||||
|
||||
You might also be interested in the available tutorials around authoring a plugin. |
||||
|
||||
- [Grafana Tutorials](https://grafana.com/tutorials/) |
||||
|
||||
## What languages? |
||||
|
||||
Since everything turns into JavaScript, it's up to you to choose which language you want. That said, it's probably a good idea to choose es6 or TypeScript, because we use es6 classes in Grafana. So it's easier to get inspiration from the Grafana repo if you choose one of those languages. |
||||
|
||||
## Buildscript |
||||
|
||||
You can use any build system that supports systemjs. All the built content should end up in a folder named `dist` and be committed to the repository. By committing the dist folder, the person who installs your plugin does not have to run any build script. All of our example plugins have a build script configured. |
||||
|
||||
## Keep your plugin up to date |
||||
|
||||
New versions of Grafana can sometimes cause plugins to break. Check out our [PLUGIN_DEV.md](https://github.com/grafana/grafana/blob/main/PLUGIN_DEV.md) doc for changes in |
||||
Grafana that can impact your plugin. |
||||
|
||||
## Metadata |
||||
|
||||
See the [coding styleguide]({{< relref "style-guide/" >}}) for details on the metadata. |
||||
|
||||
## module.(js|ts) |
||||
|
||||
This is the entry point for every plugin. This is the place where you should export |
||||
your plugin implementation. Depending on what kind of plugin you are developing you |
||||
will be expected to export different things. You can find what's expected for [datasource]({{< relref "data-sources/" >}}), [panels]({{< relref "panels/" >}}) |
||||
and [apps]({{< relref "apps/" >}}) plugins in the documentation. |
||||
|
||||
The Grafana SDK is quite small so far and can be found here: |
||||
|
||||
- [SDK file in Grafana](https://github.com/grafana/grafana/blob/main/public/app/plugins/sdk.ts) |
||||
|
||||
The SDK contains three different plugin classes: PanelCtrl, MetricsPanelCtrl and QueryCtrl. For plugins of the panel type, the module.js file should export one of these. There are some extra classes for [data sources]({{< relref "data-sources/" >}}). |
||||
|
||||
Example: |
||||
|
||||
```javascript |
||||
import { ClockCtrl } from './clock_ctrl'; |
||||
|
||||
export { ClockCtrl as PanelCtrl }; |
||||
``` |
||||
|
||||
The module class is also where css for the dark and light themes is imported: |
||||
|
||||
```javascript |
||||
import { loadPluginCss } from 'app/plugins/sdk'; |
||||
import WorldmapCtrl from './worldmap_ctrl'; |
||||
|
||||
loadPluginCss({ |
||||
dark: 'plugins/grafana-worldmap-panel/css/worldmap.dark.css', |
||||
light: 'plugins/grafana-worldmap-panel/css/worldmap.light.css', |
||||
}); |
||||
|
||||
export { WorldmapCtrl as PanelCtrl }; |
||||
``` |
||||
|
||||
## Start developing your plugin |
||||
|
||||
There are three ways that you can start developing a Grafana plugin. |
||||
|
||||
1. Set up a Grafana development environment. [(described here)](https://github.com/grafana/grafana/blob/main/contribute/developer-guide.md) and place your plugin in the `data/plugins` folder. |
||||
1. Install Grafana and place your plugin in the plugins directory which is set in your [config file](/administration/configuration). By default this is `/var/lib/grafana/plugins` on Linux systems. |
||||
1. Place your plugin directory anywhere you like and specify it grafana.ini. |
||||
|
||||
We encourage people to set up the full Grafana environment so that you can get inspiration from the rest of the Grafana code base. |
||||
|
||||
When Grafana starts, it scans the plugin folders and mounts every folder that contains a plugin.json file unless |
||||
the folder contains a subfolder named dist. In that case, Grafana mounts the dist folder instead. |
||||
This makes it possible to have both built and src content in the same plugin Git repo. |
||||
|
||||
## Grafana Events |
||||
|
||||
There are a number of Grafana events that a plugin can hook into: |
||||
|
||||
- `init-edit-mode` can be used to add tabs when editing a panel |
||||
- `panel-teardown` can be used for clean up |
||||
- `data-received` is an event in that is triggered on data refresh and can be hooked into |
||||
- `data-snapshot-load` is an event triggered to load data when in snapshot mode. |
||||
- `data-error` is used to handle errors on dashboard refresh. |
||||
|
||||
If a panel receives data and hooks into the `data-received` event then it should handle snapshot mode too. Otherwise the panel will not work if saved as a snapshot. [Getting Plugins to work in Snapshot Mode]({{< relref "snapshot-mode/" >}}) describes how to add support for this. |
||||
|
||||
## Examples |
||||
|
||||
We have three different examples that you can fork/download to get started developing your Grafana plugin. |
||||
|
||||
- [simple-json-datasource](https://github.com/grafana/simple-json-datasource) (small data source plugin for querying json data from backends) |
||||
- [simple-app-plugin](https://github.com/grafana/simple-app-plugin) |
||||
- [clock-panel](https://github.com/grafana/clock-panel) |
||||
- [singlestat-panel](https://github.com/grafana/grafana/tree/main/public/app/plugins/panel/singlestat) |
||||
- [piechart-panel](https://github.com/grafana/piechart-panel) |
||||
|
||||
## Other Articles |
||||
|
||||
- [Getting Plugins to work in Snapshot Mode]({{< relref "snapshot-mode/" >}}) |
||||
- [Plugin Defaults and Editor Mode]({{< relref "defaults-and-editor-mode/" >}}) |
||||
- [Grafana Plugin Code Styleguide]({{< relref "style-guide/" >}}) |
||||
- [Grafana Apps]({{< relref "apps/" >}}) |
||||
- [Grafana Data Sources]({{< relref "data-sources/" >}}) |
||||
- [plugin.json Schema]({{< relref "../metadata/" >}}) |
||||
@ -1,58 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../../plugins/developing/apps/ |
||||
keywords: |
||||
- grafana |
||||
- plugins |
||||
- documentation |
||||
title: Legacy app plugins |
||||
--- |
||||
|
||||
# Legacy app plugins |
||||
|
||||
App plugins are Grafana plugins that can bundle data source and panel plugins within one package. They also enable the plugin author to create custom pages within Grafana. The custom pages enable the plugin author to include things like documentation, sign-up forms, or to control other services with HTTP requests. |
||||
|
||||
Data source and panel plugins will show up like normal plugins. The app pages will be available in the main menu. |
||||
|
||||
{{< figure class="float-right" src="/static/img/docs/v3/app-in-main-menu.png" caption="App in Main Menu" >}} |
||||
|
||||
## Enabling app plugins |
||||
|
||||
After installing an app, it has to be enabled before it shows up as a data source or panel. You can do that on the app page in the configuration tab. |
||||
|
||||
## Developing an App Plugin |
||||
|
||||
An App is a bundle of panels, dashboards and/or data source(s). There is nothing different about developing panels and data sources for an app. |
||||
|
||||
Apps have to be enabled in Grafana and should import any included dashboards when the user enables it. A ConfigCtrl class should be created and the dashboards imported in the postUpdate hook. See example below: |
||||
|
||||
```javascript |
||||
export class ConfigCtrl { |
||||
/** @ngInject */ |
||||
constructor($scope, $injector, $q) { |
||||
this.$q = $q; |
||||
this.enabled = false; |
||||
this.appEditCtrl.setPostUpdateHook(this.postUpdate.bind(this)); |
||||
} |
||||
|
||||
postUpdate() { |
||||
if (!this.appModel.enabled) { |
||||
return; |
||||
} |
||||
|
||||
// TODO, whatever you want |
||||
console.log('Post Update:', this); |
||||
} |
||||
} |
||||
ConfigCtrl.templateUrl = 'components/config/config.html'; |
||||
``` |
||||
|
||||
If possible, a link to a dashboard or custom page should be shown after enabling the app to guide the user to the appropriate place. |
||||
|
||||
{{< figure class="float-right" src="/static/img/docs/app_plugin_after_enable.png" caption="After enabling" >}} |
||||
|
||||
### Develop your own App |
||||
|
||||
> Our goal is not to have a very extensive documentation but rather have actual |
||||
> code that people can look at. An example implementation of an app can be found |
||||
> in this [example app repo](https://github.com/grafana/simple-app-plugin) |
||||
@ -1,184 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../../plugins/developing/datasources/ |
||||
keywords: |
||||
- grafana |
||||
- plugins |
||||
- documentation |
||||
title: Legacy data source plugins |
||||
--- |
||||
|
||||
# Legacy data source plugins |
||||
|
||||
Data source plugins enable people to develop plugins for any database that |
||||
communicates over HTTP. Its up to the plugin to transform the data into |
||||
time series data so that any grafana panel can then show it. |
||||
|
||||
## Data source development |
||||
|
||||
> Our goal is not to have a very extensive documentation but rather have actual |
||||
> code that people can look at. Example implementations of a data source can be |
||||
> found in these repos: |
||||
|
||||
> - [simple-json-datasource](https://github.com/grafana/simple-json-datasource) |
||||
> - [simple-datasource](https://github.com/grafana/simple-datasource) |
||||
> - [simple-json-backend-datasource](https://github.com/grafana/simple-json-backend-datasource) |
||||
|
||||
To interact with the rest of grafana the plugins module file can export 4 different components. |
||||
|
||||
- Datasource (Required) |
||||
- QueryCtrl (Required) |
||||
- ConfigCtrl (Required) |
||||
- AnnotationsQueryCtrl |
||||
|
||||
## Plugin json |
||||
|
||||
There are two data source specific settings for the plugin.json |
||||
|
||||
```json |
||||
"metrics": true, |
||||
"annotations": false, |
||||
``` |
||||
|
||||
These settings indicate what kind of data the plugin can deliver. At least one of them has to be true. |
||||
|
||||
## Data source |
||||
|
||||
The javascript object that communicates with the database and transforms data to times series. |
||||
|
||||
The Data source should contain the following functions: |
||||
|
||||
```javascript |
||||
query(options); // used by panels to get data |
||||
testDatasource(); // used by data source configuration page to make sure the connection is working |
||||
annotationQuery(options); // used by dashboards to get annotations |
||||
metricFindQuery(options); // used by query editor to get metric suggestions. |
||||
``` |
||||
|
||||
### testDatasource |
||||
|
||||
When a user clicks on the _Save & Test_ button when adding a new data source, the details are first saved to the database and then the `testDatasource` function that is defined in your data source plugin will be called. It is recommended that this function makes a query to the data source that will also test that the authentication details are correct. This is so the data source is correctly configured when the user tries to write a query in a new dashboard. |
||||
|
||||
### Query |
||||
|
||||
Request object passed to datasource.query function: |
||||
|
||||
```json |
||||
{ |
||||
"range": { "from": "2015-12-22T03:06:13.851Z", "to": "2015-12-22T06:48:24.137Z" }, |
||||
"interval": "5s", |
||||
"targets": [ |
||||
{ "refId": "B", "target": "upper_75" }, |
||||
{ "refId": "A", "target": "upper_90" } |
||||
], |
||||
"format": "json", |
||||
"maxDataPoints": 2495 // decided by the panel |
||||
} |
||||
``` |
||||
|
||||
There are two different kinds of results for data sources: |
||||
time series and table. Time series is the most common format and is supported by all data sources and panels. Table format is only supported by the InfluxDB data source and table panel. But we might see more of this in the future. |
||||
|
||||
Time series response from datasource.query. |
||||
An array of: |
||||
|
||||
```json |
||||
[ |
||||
{ |
||||
"target": "upper_75", |
||||
"datapoints": [ |
||||
[622, 1450754160000], |
||||
[365, 1450754220000] |
||||
] |
||||
}, |
||||
{ |
||||
"target": "upper_90", |
||||
"datapoints": [ |
||||
[861, 1450754160000], |
||||
[767, 1450754220000] |
||||
] |
||||
} |
||||
] |
||||
``` |
||||
|
||||
Table response from datasource.query. |
||||
An array of: |
||||
|
||||
```json |
||||
[ |
||||
{ |
||||
"columns": [ |
||||
{ |
||||
"text": "Time", |
||||
"type": "time", |
||||
"sort": true, |
||||
"desc": true |
||||
}, |
||||
{ |
||||
"text": "mean" |
||||
}, |
||||
{ |
||||
"text": "sum" |
||||
} |
||||
], |
||||
"rows": [ |
||||
[1457425380000, null, null], |
||||
[1457425370000, 1002.76215352, 1002.76215352] |
||||
], |
||||
"type": "table" |
||||
} |
||||
] |
||||
``` |
||||
|
||||
### Annotation Query |
||||
|
||||
Request object passed to datasource.annotationQuery function: |
||||
|
||||
```json |
||||
{ |
||||
"range": { "from": "2016-03-04T04:07:55.144Z", "to": "2016-03-04T07:07:55.144Z" }, |
||||
"rangeRaw": { "from": "now-3h", "to": "now" }, |
||||
"annotation": { |
||||
"datasource": "generic datasource", |
||||
"enable": true, |
||||
"name": "annotation name" |
||||
}, |
||||
"dashboard": DashboardModel |
||||
} |
||||
``` |
||||
|
||||
Expected result from datasource.annotationQuery: |
||||
|
||||
```json |
||||
[ |
||||
{ |
||||
"annotation": { |
||||
"name": "annotation name", //should match the annotation name in grafana |
||||
"enabled": true, |
||||
"datasource": "generic datasource" |
||||
}, |
||||
"title": "Cluster outage", |
||||
"time": 1457075272576, |
||||
"text": "Joe causes brain split", |
||||
"tags": ["joe", "cluster", "failure"] |
||||
} |
||||
] |
||||
``` |
||||
|
||||
## QueryCtrl |
||||
|
||||
A JavaScript class that will be instantiated and treated as an Angular controller when the user edits metrics in a panel. This class has to inherit from the `app/plugins/sdk.QueryCtrl` class. |
||||
|
||||
Requires a static template or `templateUrl` variable which will be rendered as the view for this controller. |
||||
|
||||
## ConfigCtrl |
||||
|
||||
A JavaScript class that will be instantiated and treated as an Angular controller when a user tries to edit or create a new data source of this type. |
||||
|
||||
Requires a static template or `templateUrl` variable which will be rendered as the view for this controller. |
||||
|
||||
## AnnotationsQueryCtrl |
||||
|
||||
A JavaScript class that will be instantiated and treated as an Angular controller when the user chooses this type of data source in the templating menu in the dashboard. |
||||
|
||||
Requires a static template or `templateUrl` variable which will be rendered as the view for this controller. The fields that are bound to this controller are then sent to the Database objects annotationQuery function. |
||||
@ -1,33 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../../plugins/developing/panels/ |
||||
keywords: |
||||
- grafana |
||||
- plugins |
||||
- panel |
||||
- documentation |
||||
title: Legacy panel plugins |
||||
--- |
||||
|
||||
# Legacy panel plugins |
||||
|
||||
Panels are the main building blocks of dashboards. |
||||
|
||||
## Panel development |
||||
|
||||
### Scrolling |
||||
|
||||
The grafana dashboard framework controls the panel height. To enable a scrollbar within the panel the PanelCtrl needs to set the scrollable static variable: |
||||
|
||||
```javascript |
||||
export class MyPanelCtrl extends PanelCtrl { |
||||
static scrollable = true; |
||||
... |
||||
``` |
||||
|
||||
In this case, make sure the template has a single `<div>...</div>` root. The plugin loader will modify that element adding a scrollbar. |
||||
|
||||
### Examples |
||||
|
||||
- [clock-panel](https://github.com/grafana/clock-panel) |
||||
- [singlestat-panel](https://github.com/grafana/grafana/tree/main/public/app/plugins/panel/singlestat) |
||||
@ -1,181 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../../plugins/developing/plugin-review-guidelines/ |
||||
title: Legacy review guidelines |
||||
--- |
||||
|
||||
# Legacy review guidelines |
||||
|
||||
The Grafana team reviews all plugins that are published on Grafana.com. There are two areas we review, the metadata for the plugin and the plugin functionality. |
||||
|
||||
## Metadata |
||||
|
||||
The plugin metadata consists of a `plugin.json` file and the README.md file. The `plugin.json` file is used by Grafana to load the plugin, and the README.md file is shown in the plugins section of Grafana and the plugins section of https://grafana.com. |
||||
|
||||
### README.md |
||||
|
||||
The README.md file is shown on the plugins page in Grafana and the plugin page on Grafana.com. There are some differences between the GitHub markdown and the markdown allowed in Grafana/Grafana.com: |
||||
|
||||
- Cannot contain inline HTML. |
||||
- Any image links should be absolute links. For example: https://raw.githubusercontent.com/grafana/azure-monitor-datasource/master/dist/img/grafana_cloud_install.png |
||||
|
||||
The README should: |
||||
|
||||
- describe the purpose of the plugin. |
||||
- contain steps on how to get started. |
||||
|
||||
### Plugin.json |
||||
|
||||
The `plugin.json` file is the same concept as the `package.json` file for an npm package. When the Grafana server starts it will scan the plugin folders (all folders in the data/plugins subfolder) and load every folder that contains a `plugin.json` file unless the folder contains a subfolder named `dist`. In that case, the Grafana server will load the `dist` folder instead. |
||||
|
||||
A minimal `plugin.json` file: |
||||
|
||||
```json |
||||
{ |
||||
"type": "panel", |
||||
"name": "Clock", |
||||
"id": "yourorg-clock-panel", |
||||
|
||||
"info": { |
||||
"description": "Clock panel for grafana", |
||||
"author": { |
||||
"name": "Author Name", |
||||
"url": "http://yourwebsite.com" |
||||
}, |
||||
"keywords": ["clock", "panel"], |
||||
"version": "1.0.0", |
||||
"updated": "2018-03-24" |
||||
}, |
||||
|
||||
"dependencies": { |
||||
"grafanaVersion": "3.x.x", |
||||
"plugins": [] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
- The convention for the plugin id is **[grafana.com username/org]-[plugin name]-[datasource|app|panel]** and it has to be unique. The org **cannot** be `grafana` unless it is a plugin created by the Grafana core team. |
||||
|
||||
Examples: |
||||
|
||||
- raintank-worldping-app |
||||
- ryantxu-ajax-panel |
||||
- alexanderzobnin-zabbix-app |
||||
- hawkular-datasource |
||||
|
||||
- The `type` field should be either `datasource` `app` or `panel`. |
||||
- The `version` field should be in the form: x.x.x e.g. `1.0.0` or `0.4.1`. |
||||
|
||||
The full file format for `plugin.json` file is in [plugin.json](http://docs.grafana.org/plugins/developing/plugin.json/). |
||||
|
||||
## Plugin Language |
||||
|
||||
JavaScript, TypeScript, ES6 (or any other language) are all fine as long as the contents of the `dist` subdirectory are transpiled to JavaScript (ES5). |
||||
|
||||
## File and Directory Structure Conventions |
||||
|
||||
Here is a typical directory structure for a plugin. |
||||
|
||||
```bash |
||||
johnnyb-awesome-datasource |
||||
|-- dist |
||||
|-- src |
||||
| |-- img |
||||
| | |-- logo.svg |
||||
| |-- partials |
||||
| | |-- annotations.editor.html |
||||
| | |-- config.html |
||||
| | |-- query.editor.html |
||||
| |-- datasource.js |
||||
| |-- module.js |
||||
| |-- plugin.json |
||||
| |-- query_ctrl.js |
||||
|-- Gruntfile.js |
||||
|-- LICENSE |
||||
|-- package.json |
||||
|-- README.md |
||||
``` |
||||
|
||||
Most JavaScript projects have a build step. The generated JavaScript should be placed in the `dist` directory and the source code in the `src` directory. We recommend that the plugin.json file be placed in the src directory and then copied over to the dist directory when building. The `README.md` can be placed in the root or in the dist directory. |
||||
|
||||
Directories: |
||||
|
||||
- `src/` contains plugin source files. |
||||
- `src/partials` contains html templates. |
||||
- `src/img` contains plugin logos and other images. |
||||
- `dist/` contains built content. |
||||
|
||||
## HTML and CSS |
||||
|
||||
For the HTML on editor tabs, we recommend using the inbuilt Grafana styles rather than defining your own. This makes plugins feel like a more natural part of Grafana. If done correctly, the html will also be responsive and adapt to smaller screens. The `gf-form` css classes should be used for labels and inputs. |
||||
|
||||
Below is a minimal example of an editor row with one form group and two fields, a dropdown and a text input: |
||||
|
||||
```html |
||||
<div class="editor-row"> |
||||
<div class="section gf-form-group"> |
||||
<h5 class="section-heading">My Plugin Options</h5> |
||||
<div class="gf-form"> |
||||
<label class="gf-form-label width-10">Label1</label> |
||||
<div class="gf-form-select-wrapper max-width-10"> |
||||
<select |
||||
class="input-small gf-form-input" |
||||
ng-model="ctrl.panel.mySelectProperty" |
||||
ng-options="t for t in ['option1', 'option2', 'option3']" |
||||
ng-change="ctrl.onSelectChange()" |
||||
></select> |
||||
</div> |
||||
<div class="gf-form"> |
||||
<label class="gf-form-label width-10">Label2</label> |
||||
<input |
||||
type="text" |
||||
class="input-small gf-form-input width-10" |
||||
ng-model="ctrl.panel.myProperty" |
||||
ng-change="ctrl.onFieldChange()" |
||||
placeholder="suggestion for user" |
||||
ng-model-onblur |
||||
/> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
``` |
||||
|
||||
Use the `width-x` and `max-width-x` classes to control the width of your labels and input fields. Try to get labels and input fields to line up neatly by having the same width for all the labels in a group and the same width for all inputs in a group if possible. |
||||
|
||||
## Data Sources |
||||
|
||||
For more information about data sources, refer to the [basic guide for data sources](http://docs.grafana.org/plugins/developing/datasources/). |
||||
|
||||
### Configuration Page Guidelines |
||||
|
||||
- It should be as easy as possible for a user to configure a URL. If the data source is using the `datasource-http-settings` component, it should use the `suggest-url` attribute to suggest the default URL or a URL that is similar to what it should be (especially important if the URL refers to a REST endpoint that is not common knowledge for most users e.g. `https://yourserver:4000/api/custom-endpoint`). |
||||
|
||||
```html |
||||
<datasource-http-settings current="ctrl.current" suggest-url="http://localhost:8080"> </datasource-http-settings> |
||||
``` |
||||
|
||||
- The `testDatasource` function should make a query to the data source that will also test that the authentication details are correct. This is so the data source is correctly configured when the user tries to write a query in a new dashboard. |
||||
|
||||
#### Password Security |
||||
|
||||
If possible, any passwords or secrets should be saved in the `secureJsonData` blob. To encrypt sensitive data, the Grafana server's proxy feature must be used. The Grafana server has support for token authentication (OAuth) and HTTP Header authentication. If the calls have to be sent directly from the browser to a third-party API, this will not be possible and sensitive data will not be encrypted. |
||||
|
||||
Read more here about how [authentication for data sources]({{< relref "../add-authentication-for-data-source-plugins/" >}}) works. |
||||
|
||||
If using the proxy feature, the Configuration page should use the `secureJsonData` blob like this: |
||||
|
||||
- good: `<input type="password" class="gf-form-input" ng-model='ctrl.current.secureJsonData.password' placeholder="password"></input>` |
||||
- bad: `<input type="password" class="gf-form-input" ng-model='ctrl.current.password' placeholder="password"></input>` |
||||
|
||||
### Query Editor |
||||
|
||||
Each query editor is unique and can have a unique style. It should be adapted to what the users of the data source are used to. |
||||
|
||||
- Should use the Grafana CSS `gf-form` classes. |
||||
- Should be neat and tidy. Labels and fields in columns should be aligned and should be the same width if possible. |
||||
- The data source should be able to handle when a user toggles a query (by clicking on the eye icon) and not execute the query. This is done by checking the `hide` property - an [example](https://github.com/grafana/grafana/blob/e75840737e81f70b6d169df21eca86a624d4bdc4/public/app/plugins/datasource/postgres/datasource.ts#L73). |
||||
- Should not execute queries if fields in the Query Editor are empty and the query will throw an exception (defensive programming). |
||||
- Should handle errors. There are two main ways to do this: |
||||
- use the notification system in Grafana to show a toaster pop-up with the error message. For an example of a pop-up with the error message, refer to [code in triggers_panel_ctrl](https://github.com/alexanderzobnin/grafana-zabbix/blob/fdbbba2fb03f5f2a4b3b0715415e09d5a4cf6cde/src/panel-triggers/triggers_panel_ctrl.js#L467-L471). |
||||
- provide an error notification in the query editor like the MySQL/Postgres data sources do. For an example of error notification in the query editor, refer to [code in query_ctrl](https://github.com/grafana/azure-monitor-datasource/blob/b184d077f082a69f962120ef0d1f8296a0d46f03/src/query_ctrl.ts#L36-L51) and in the [html](https://github.com/grafana/azure-monitor-datasource/blob/b184d077f082a69f962120ef0d1f8296a0d46f03/src/partials/query.editor.html#L190-L193). |
||||
@ -1,76 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../../plugins/developing/snapshot-mode/ |
||||
title: Legacy snapshot mode |
||||
--- |
||||
|
||||
# Legacy snapshot mode |
||||
|
||||
{{< figure class="float-right" src="/static/img/docs/Grafana-snapshot-example.png" caption="A dashboard using snapshot data and not live data." >}} |
||||
|
||||
Grafana has this great feature where you can [save a snapshot of your dashboard]({{< relref "../../../dashboards/build-dashboards/view-dashboard-json-model" >}}). Instead of sending a screenshot of a dashboard to someone, you can send them a working, interactive Grafana dashboard with the snapshot data embedded inside it. The snapshot can be saved on your Grafana server and is available to all your co-workers. Raintank also hosts a [snapshot server](https://snapshots.raintank.io) if you want to send the snapshot to someone who does not have access to your Grafana server. |
||||
|
||||
{{< figure class="float-right" src="/static/img/docs/animated_gifs/snapshots.gif" caption="Selecting a snapshot" >}} |
||||
|
||||
This all works because Grafana saves a snapshot of the current data in the dashboard json instead of fetching the data from a data source. However, if you are building a custom panel plugin then this will not work straight out of the box. You will need to make some small (and easy!) changes first. |
||||
|
||||
## Enabling support for loading snapshot data |
||||
|
||||
Grafana automatically saves data from data sources in the dashboard json when the snapshot is created so we do not have to write any code for that. Enabling snapshot support for reading time series data is very simple. First in the constructor, we need to add an event handler for `data-snapshot-load`. This event is triggered by Grafana when the snapshot data is loaded from the dashboard json. |
||||
|
||||
```javascript |
||||
constructor($scope, $injector, contextSrv) { |
||||
super($scope, $injector); |
||||
... |
||||
this.events.on('init-edit-mode', this.onInitEditMode.bind(this)); |
||||
this.events.on('data-received', this.onDataReceived.bind(this)); |
||||
this.events.on('panel-teardown', this.onPanelTeardown.bind(this)); |
||||
this.events.on('data-snapshot-load', this.onDataSnapshotLoad.bind(this)); |
||||
``` |
||||
|
||||
Then we need to create a simple event handler that just forwards the data on to our regular `data-received` handler: |
||||
|
||||
```javascript |
||||
onDataSnapshotLoad(snapshotData) { |
||||
this.onDataReceived(snapshotData); |
||||
} |
||||
``` |
||||
|
||||
This will cover most use cases for snapshot support. Sometimes you will want to save data that is not time series data from a Grafana data source and then you have to do a bit more work to get snapshot support. |
||||
|
||||
## Saving custom data for snapshots |
||||
|
||||
Data that is not time series data from a Grafana data source is not saved automatically by Grafana. Saving custom data for snapshot mode has to be done manually. |
||||
|
||||
{{< figure class="float-right" src="/static/img/docs/Grafana-save-snapshot.png" caption="Save snapshot" >}} |
||||
|
||||
Grafana gives us a chance to save data to the dashboard json when it is creating a snapshot. In the 'data-received' event handler, you can check the snapshot flag on the dashboard object. If this is true, then Grafana is creating a snapshot and you can manually save custom data to the panel json. In the example, a new field called snapshotLocationData in the panel json is initialized with a snapshot of the custom data. |
||||
|
||||
```javascript |
||||
onDataReceived(dataList) { |
||||
if (!dataList) return; |
||||
|
||||
if (this.dashboard.snapshot && this.locations) { |
||||
this.panel.snapshotLocationData = this.locations; |
||||
} |
||||
``` |
||||
|
||||
Now the location data is saved in the dashboard json but we will have to load it manually as well. |
||||
|
||||
## Loading custom data for snapshots |
||||
|
||||
The example below shows a function that loads the custom data. The data source for the custom data (an external API in this case) is not available in snapshot mode so a guard check is made to see if there is any snapshot data available first. If there is, then the snapshot data is used instead of trying to load the data from the external API. |
||||
|
||||
```javascript |
||||
loadLocationDataFromFile(reload) { |
||||
if (this.map && !reload) return; |
||||
|
||||
if (this.panel.snapshotLocationData) { |
||||
this.locations = this.panel.snapshotLocationData; |
||||
return; |
||||
} |
||||
``` |
||||
|
||||
It is really easy to forget to add this support but it enables a great feature and can be used to demo your panel. |
||||
|
||||
If there is a panel plugin that you would like to be installed on the Raintank Snapshot server then please contact us via [Slack](https://slack.grafana.com) or [GitHub](https://github.com/grafana/grafana). |
||||
@ -1,193 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../../plugins/developing/code-styleguide/ |
||||
title: Legacy code style guide |
||||
--- |
||||
|
||||
# Legacy code style guide |
||||
|
||||
This guide has two parts. The first part describes the metadata and the second part is a styleguide for HTML/CSS and JavaScript in Grafana plugins and applies if you are using ES6 in your plugin. If using TypeScript then the [Angular TypeScript styleguide](https://angular.io/styleguide) is recommended. |
||||
|
||||
## Metadata |
||||
|
||||
The plugin metadata consists of a plugin.json file and the README.md file. These two files are used by Grafana and Grafana.com. |
||||
|
||||
### Plugin.json (mandatory) |
||||
|
||||
The plugin.json file is the same concept as the package.json file for an npm package. When Grafana starts it will scan the plugin folders and mount every folder that contains a plugin.json file unless the folder contains a subfolder named `dist`. In that case grafana will mount the `dist` folder instead. |
||||
|
||||
The most important fields are the first three, especially the id. The convention for the plugin id is **[github username/org]-[plugin name]-[datasource|app|panel]** and it has to be unique. |
||||
|
||||
Examples: |
||||
|
||||
```bash |
||||
raintank-worldping-app |
||||
grafana-simple-json-datasource |
||||
grafana-piechart-panel |
||||
mtanda-histogram-panel |
||||
``` |
||||
|
||||
For more information about the file format for `plugin.json` file, refer to [metadata]({{< relref "../metadata/" >}}). |
||||
|
||||
Minimal plugin.json: |
||||
|
||||
```javascript |
||||
{ |
||||
"type": "panel", |
||||
"name": "Clock", |
||||
"id": "yourorg-clock-panel", |
||||
|
||||
"info": { |
||||
"description": "Clock panel for grafana", |
||||
"author": { |
||||
"name": "Grafana Labs", |
||||
"url": "https://grafana.com" |
||||
}, |
||||
"keywords": ["clock", "panel"], |
||||
"version": "1.0.0", |
||||
"updated": "2015-03-24" |
||||
}, |
||||
|
||||
"dependencies": { |
||||
"grafanaVersion": "3.x.x", |
||||
"plugins": [ ] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
### README.md |
||||
|
||||
The README.md file is rendered both in the grafana.com plugins page, and within the Grafana application. The only difference from how GitHub renders markdown is that html is not allowed. |
||||
|
||||
## File and Directory Structure Conventions |
||||
|
||||
Here is a typical directory structure for a plugin. |
||||
|
||||
```bash |
||||
johnnyb-awesome-datasource |
||||
|-- dist |
||||
|-- spec |
||||
| |-- datasource_spec.js |
||||
| |-- query_ctrl_spec.js |
||||
| |-- test-main.js |
||||
|-- src |
||||
| |-- img |
||||
| | |-- logo.svg |
||||
| |-- partials |
||||
| | |-- annotations.editor.html |
||||
| | |-- config.html |
||||
| | |-- query.editor.html |
||||
| |-- datasource.js |
||||
| |-- module.js |
||||
| |-- plugin.json |
||||
| |-- query_ctrl.js |
||||
|-- Gruntfile.js |
||||
|-- LICENSE |
||||
|-- package.json |
||||
|-- README.md |
||||
``` |
||||
|
||||
Most JavaScript projects have a build step and most Grafana plugins are built using Babel and ES6. The generated JavaScript should be placed in the `dist` directory and the source code in the `src` directory. We recommend that the plugin.json file be placed in the src directory and then copied over to the dist directory when building. The `README.md` can be placed in the root or in the dist directory. |
||||
|
||||
Directories: |
||||
|
||||
- `src/` contains plugin source files. |
||||
- `src/partials` contains html templates. |
||||
- `src/img` contains plugin logos and other images. |
||||
- `spec/` contains tests (optional). |
||||
- `dist/` contains built content. |
||||
|
||||
## HTML and CSS |
||||
|
||||
For the HTML on editor tabs, we recommend using the inbuilt Grafana styles rather than defining your own. This makes plugins feel like a more natural part of Grafana. If done correctly, the html will also be responsive and adapt to smaller screens. The `gf-form` css classes should be used for labels and inputs. |
||||
|
||||
Below is a minimal example of an editor row with one form group and two fields, a dropdown and a text input: |
||||
|
||||
```html |
||||
<div class="editor-row"> |
||||
<div class="section gf-form-group"> |
||||
<h5 class="section-heading">My Plugin Options</h5> |
||||
<div class="gf-form"> |
||||
<label class="gf-form-label width-10">Label1</label> |
||||
<div class="gf-form-select-wrapper max-width-10"> |
||||
<select |
||||
class="input-small gf-form-input" |
||||
ng-model="ctrl.panel.mySelectProperty" |
||||
ng-options="t for t in ['option1', 'option2', 'option3']" |
||||
ng-change="ctrl.onSelectChange()" |
||||
></select> |
||||
</div> |
||||
<div class="gf-form"> |
||||
<label class="gf-form-label width-10">Label2</label> |
||||
<input |
||||
type="text" |
||||
class="input-small gf-form-input width-10" |
||||
ng-model="ctrl.panel.myProperty" |
||||
ng-change="ctrl.onFieldChange()" |
||||
placeholder="suggestion for user" |
||||
ng-model-onblur |
||||
/> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
``` |
||||
|
||||
Use the `width-x` and `max-width-x` classes to control the width of your labels and input fields. Try to get labels and input fields to line up neatly by having the same width for all the labels in a group and the same width for all inputs in a group if possible. |
||||
|
||||
## Build Scripts |
||||
|
||||
Our recommendation is to use whatever you usually use - Grunt, Gulp or npm scripts. Most plugins seems to use Grunt so that is probably the easiest to get started with if you do not have a preferred build system. The only requirement is that it supports systemjs which is required by Grafana to load plugins. |
||||
|
||||
## Linting |
||||
|
||||
We recommend that you use a linter for your JavaScript. For ES6, the standard linter is [eslint](http://eslint.org/). Rules for linting are described in an .eslintrc that is placed in the root directory. For an example of linting rules in a plugin, refer to [.eslintrc](https://github.com/grafana/worldmap-panel/blob/master/.eslintrc). |
||||
|
||||
### ES6 features |
||||
|
||||
1. Use `const` if a variable is not going to be reassigned. |
||||
1. Prefer to use `let` instead `var` ([Exploring ES6](http://exploringjs.com/es6/ch_core-features.html#_from-var-to-letconst)) |
||||
1. Use arrow functions, which don’t shadow `this` ([Exploring ES6](http://exploringjs.com/es6/ch_core-features.html#_from-function-expressions-to-arrow-functions)): |
||||
|
||||
```js |
||||
testDatasource() { |
||||
return this.getServerStatus() |
||||
.then(status => { |
||||
return this.doSomething(status); |
||||
}) |
||||
} |
||||
``` |
||||
|
||||
better than |
||||
|
||||
```js |
||||
testDatasource() { |
||||
var self = this; |
||||
return this.getServerStatus() |
||||
.then(function(status) { |
||||
return self.doSomething(status); |
||||
}) |
||||
} |
||||
``` |
||||
|
||||
1. Use native _Promise_ object: |
||||
|
||||
```js |
||||
metricFindQuery(query) { |
||||
if (!query) { |
||||
return Promise.resolve([]); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
better than |
||||
|
||||
```js |
||||
metricFindQuery(query) { |
||||
if (!query) { |
||||
return this.$q.when([]); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
1. If using Lodash, then be consistent and prefer that to the native ES6 array functions. |
||||
@ -1,254 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- ../../plugins/developing/plugin.json/ |
||||
keywords: |
||||
- grafana |
||||
- plugins |
||||
- documentation |
||||
title: plugin.json |
||||
--- |
||||
|
||||
# plugin.json |
||||
|
||||
The plugin.json file is required for all plugins. When Grafana starts, it scans the plugin folders and mounts every folder that contains a plugin.json file unless the folder contains a subfolder named dist. In that case, Grafana mounts the dist folder instead. |
||||
|
||||
## Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------------------- | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
||||
| `dependencies` | [object](#dependencies) | **Yes** | Dependencies needed by the plugin. | |
||||
| `id` | string | **Yes** | Unique name of the plugin. If the plugin is published on grafana.com, then the plugin id has to follow the naming conventions. | |
||||
| `info` | [object](#info) | **Yes** | Metadata for the plugin. Some fields are used on the plugins page in Grafana and others on grafana.com if the plugin is published. | |
||||
| `name` | string | **Yes** | Human-readable name of the plugin that is shown to the user in the UI. | |
||||
| `type` | string | **Yes** | Plugin type. Possible values are: `app`, `datasource`, `panel`. | |
||||
| `$schema` | string | No | Schema definition for the plugin.json file. | |
||||
| `alerting` | boolean | No | For data source plugins, if the plugin supports alerting. | |
||||
| `annotations` | boolean | No | For data source plugins, if the plugin supports annotation queries. | |
||||
| `autoEnabled` | boolean | No | Set to true for app plugins that should be enabled by default in all orgs | |
||||
| `backend` | boolean | No | If the plugin has a backend component. | |
||||
| `category` | string | No | Plugin category used on the Add data source page. Possible values are: `tsdb`, `logging`, `cloud`, `tracing`, `sql`, `enterprise`, `other`. | |
||||
| `enterpriseFeatures` | [object](#enterprisefeatures) | No | Grafana Enerprise specific features. | |
||||
| `executable` | string | No | The first part of the file name of the backend component executable. There can be multiple executables built for different operating system and architecture. Grafana will check for executables named `<executable>_<$GOOS>_<lower case $GOARCH><.exe for Windows>`, e.g. `plugin_linux_amd64`. Combination of $GOOS and $GOARCH can be found here: https://golang.org/doc/install/source#environment. | |
||||
| `hiddenQueries` | boolean | No | For data source plugins, include hidden queries in the data request. | |
||||
| `includes` | [object](#includes)[] | No | Resources to include in plugin. | |
||||
| `logs` | boolean | No | For data source plugins, if the plugin supports logs. | |
||||
| `metrics` | boolean | No | For data source plugins, if the plugin supports metric queries. Used in Explore. | |
||||
| `preload` | boolean | No | Initialize plugin on startup. By default, the plugin initializes on first use. | |
||||
| `queryOptions` | [object](#queryoptions) | No | For data source plugins. There is a query options section in the plugin's query editor and these options can be turned on if needed. | |
||||
| `routes` | [object](#routes)[] | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/). | |
||||
| `skipDataQuery` | boolean | No | For panel plugins. Hides the query editor. | |
||||
| `state` | string | No | Marks a plugin as a pre-release. Possible values are: `alpha`, `beta`. | |
||||
| `streaming` | boolean | No | For data source plugins, if the plugin supports streaming. | |
||||
| `tables` | boolean | No | This is an undocumented feature. | |
||||
| `tracing` | boolean | No | For data source plugins, if the plugin supports tracing. | |
||||
|
||||
## dependencies |
||||
|
||||
Dependencies needed by the plugin. |
||||
|
||||
### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| ------------------- | -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- | |
||||
| `grafanaDependency` | string | **Yes** | Required Grafana version for this plugin. Validated using https://github.com/npm/node-semver. | |
||||
| `grafanaVersion` | string | No | (Deprecated) Required Grafana version for this plugin, e.g. `6.x.x 7.x.x` to denote plugin requires Grafana v6.x.x or v7.x.x. | |
||||
| `plugins` | [object](#plugins)[] | No | An array of required plugins on which this plugin depends. | |
||||
|
||||
### plugins |
||||
|
||||
Plugin dependency. Used to display information about plugin dependencies in the Grafana UI. |
||||
|
||||
#### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| --------- | ------ | -------- | -------------------------------------------------- | |
||||
| `id` | string | **Yes** | | |
||||
| `name` | string | **Yes** | | |
||||
| `type` | string | **Yes** | Possible values are: `app`, `datasource`, `panel`. | |
||||
| `version` | string | **Yes** | | |
||||
|
||||
## enterpriseFeatures |
||||
|
||||
Grafana Enerprise specific features. |
||||
|
||||
### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| ------------------------- | ------- | -------- | ------------------------------------------------------------------- | |
||||
| `healthDiagnosticsErrors` | boolean | No | Enable/Disable health diagnostics errors. Requires Grafana >=7.5.5. | |
||||
|
||||
## includes |
||||
|
||||
### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
||||
| `addToNav` | boolean | No | Add the include to the side menu. | |
||||
| `component` | string | No | (Legacy) The Angular component to use for a page. | |
||||
| `defaultNav` | boolean | No | Page or dashboard when user clicks the icon in the side menu. | |
||||
| `icon` | string | No | Icon to use in the side menu. For information on available icon, refer to [Icons Overview](https://developers.grafana.com/ui/latest/index.html?path=/story/docs-overview-icon--icons-overview). | |
||||
| `name` | string | No | | |
||||
| `path` | string | No | Used for app plugins. | |
||||
| `role` | string | No | Possible values are: `Admin`, `Editor`, `Viewer`. | |
||||
| `type` | string | No | Possible values are: `dashboard`, `page`, `panel`, `datasource`. | |
||||
| `uid` | string | No | Unique identifier of the included resource | |
||||
|
||||
## info |
||||
|
||||
Metadata for the plugin. Some fields are used on the plugins page in Grafana and others on grafana.com if the plugin is published. |
||||
|
||||
### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| ------------- | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------- | |
||||
| `keywords` | string[] | **Yes** | Array of plugin keywords. Used for search on grafana.com. | |
||||
| `logos` | [object](#logos) | **Yes** | SVG images that are used as plugin icons. | |
||||
| `updated` | string | **Yes** | Date when this plugin was built. | |
||||
| `version` | string | **Yes** | Project version of this commit, e.g. `6.7.x`. | |
||||
| `author` | [object](#author) | No | Information about the plugin author. | |
||||
| `build` | [object](#build) | No | Build information | |
||||
| `description` | string | No | Description of plugin. Used on the plugins page in Grafana and for search on grafana.com. | |
||||
| `links` | [object](#links)[] | No | An array of link objects to be displayed on this plugin's project page in the form `{name: 'foo', url: 'http://example.com'}` | |
||||
| `screenshots` | [object](#screenshots)[] | No | An array of screenshot objects in the form `{name: 'bar', path: 'img/screenshot.png'}` | |
||||
|
||||
### author |
||||
|
||||
Information about the plugin author. |
||||
|
||||
#### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------- | ------ | -------- | ------------------------- | |
||||
| `email` | string | No | Author's name. | |
||||
| `name` | string | No | Author's name. | |
||||
| `url` | string | No | Link to author's website. | |
||||
|
||||
### build |
||||
|
||||
Build information |
||||
|
||||
#### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------- | ------ | -------- | ---------------------------------------------------- | |
||||
| `branch` | string | No | Git branch the plugin was built from. | |
||||
| `hash` | string | No | Git hash of the commit the plugin was built from | |
||||
| `number` | number | No | | |
||||
| `pr` | number | No | GitHub pull request the plugin was built from | |
||||
| `repo` | string | No | | |
||||
| `time` | number | No | Time when the plugin was built, as a Unix timestamp. | |
||||
|
||||
### links |
||||
|
||||
#### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------- | ------ | -------- | ----------- | |
||||
| `name` | string | No | | |
||||
| `url` | string | No | | |
||||
|
||||
### logos |
||||
|
||||
SVG images that are used as plugin icons. |
||||
|
||||
#### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------- | |
||||
| `large` | string | **Yes** | Link to the "large" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image. | |
||||
| `small` | string | **Yes** | Link to the "small" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image. | |
||||
|
||||
### screenshots |
||||
|
||||
#### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------- | ------ | -------- | ----------- | |
||||
| `name` | string | No | | |
||||
| `path` | string | No | | |
||||
|
||||
## queryOptions |
||||
|
||||
For data source plugins. There is a query options section in the plugin's query editor and these options can be turned on if needed. |
||||
|
||||
### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| --------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------- | |
||||
| `cacheTimeout` | boolean | No | For data source plugins. If the `cache timeout` option should be shown in the query options section in the query editor. | |
||||
| `maxDataPoints` | boolean | No | For data source plugins. If the `max data points` option should be shown in the query options section in the query editor. | |
||||
| `minInterval` | boolean | No | For data source plugins. If the `min interval` option should be shown in the query options section in the query editor. | |
||||
|
||||
## routes |
||||
|
||||
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/). |
||||
|
||||
### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------------- | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | |
||||
| `body` | [object](#body) | No | For data source plugins. Route headers set the body content and length to the proxied request. | |
||||
| `headers` | array | No | For data source plugins. Route headers adds HTTP headers to the proxied request. | |
||||
| `jwtTokenAuth` | [object](#jwttokenauth) | No | For data source plugins. Token authentication section used with an JWT OAuth API. | |
||||
| `method` | string | No | For data source plugins. Route method matches the HTTP verb like GET or POST. Multiple methods can be provided as a comma-separated list. | |
||||
| `path` | string | No | For data source plugins. The route path that is replaced by the route URL field when proxying the call. | |
||||
| `reqRole` | string | No | | |
||||
| `reqSignedIn` | boolean | No | | |
||||
| `tokenAuth` | [object](#tokenauth) | No | For data source plugins. Token authentication section used with an OAuth API. | |
||||
| `url` | string | No | For data source plugins. Route URL is where the request is proxied to. | |
||||
|
||||
### body |
||||
|
||||
For data source plugins. Route headers set the body content and length to the proxied request. |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------- | ---- | -------- | ----------- | |
||||
|
||||
### jwtTokenAuth |
||||
|
||||
For data source plugins. Token authentication section used with an JWT OAuth API. |
||||
|
||||
#### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------- | ----------------- | -------- | --------------------------------------------------------------------- | |
||||
| `params` | [object](#params) | No | Parameters for the JWT token authentication request. | |
||||
| `scopes` | string[] | No | The list of scopes that your application should be granted access to. | |
||||
| `url` | string | No | URL to fetch the JWT token. | |
||||
|
||||
#### params |
||||
|
||||
Parameters for the JWT token authentication request. |
||||
|
||||
##### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------------- | ------ | -------- | ----------- | |
||||
| `client_email` | string | No | | |
||||
| `private_key` | string | No | | |
||||
| `token_uri` | string | No | | |
||||
|
||||
### tokenAuth |
||||
|
||||
For data source plugins. Token authentication section used with an OAuth API. |
||||
|
||||
#### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| -------- | ----------------- | -------- | --------------------------------------------------------------------- | |
||||
| `params` | [object](#params) | No | Parameters for the token authentication request. | |
||||
| `scopes` | string[] | No | The list of scopes that your application should be granted access to. | |
||||
| `url` | string | No | URL to fetch the authentication token. | |
||||
|
||||
#### params |
||||
|
||||
Parameters for the token authentication request. |
||||
|
||||
##### Properties |
||||
|
||||
| Property | Type | Required | Description | |
||||
| --------------- | ------ | -------- | ----------------------------------------------------------------------------------------- | |
||||
| `client_id` | string | No | OAuth client ID | |
||||
| `client_secret` | string | No | OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob. | |
||||
| `grant_type` | string | No | OAuth grant type | |
||||
| `resource` | string | No | OAuth resource | |
||||
@ -1,10 +0,0 @@ |
||||
+++ |
||||
# ------------------------------------------------------------------------- |
||||
# Do not edit this file. It is automatically generated by json-schema-docs. |
||||
# ------------------------------------------------------------------------- |
||||
title = "plugin.json" |
||||
keywords = ["grafana", "plugins", "documentation"] |
||||
aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"] |
||||
+++ |
||||
|
||||
{{ .Markdown 1 }} |
||||
@ -1,815 +0,0 @@ |
||||
--- |
||||
title: Plugin migration guide |
||||
--- |
||||
|
||||
# Plugin migration guide |
||||
|
||||
## Introduction |
||||
|
||||
This guide helps you identify the steps required to update a plugin from the Grafana version it currently supports to newer versions of Grafana. |
||||
|
||||
> **Note:** If you've successfully migrated your plugin using this guide, then share your experiences with us! If you find missing information, then we encourage you to [submit an issue on GitHub](https://github.com/grafana/grafana/issues/new?title=Docs%20feedback:%20/developers/plugins/migration-guide.md) so that we can improve this guide! |
||||
|
||||
## Table of contents |
||||
|
||||
- [Plugin migration guide](#plugin-migration-guide) |
||||
- [Introduction](#introduction) |
||||
- [Table of contents](#table-of-contents) |
||||
- [From version 9.1.x to 9.2.x](#from-version-91x-to-92x) |
||||
- [React and React-dom as peer dependencies](#react-and-react-dom-as-peer-dependencies) |
||||
- [NavModelItem requires a valid icon name](#navmodelitem-requires-a-valid-icon-name) |
||||
- [Additional type availability](#additional-type-availability) |
||||
- [From version 8.x to 9.x](#from-version-8x-to-9x) |
||||
- [9.0 breaking changes](#90-breaking-changes) |
||||
- [theme.visualization.getColorByName replaces getColorForTheme](#themevisualizationgetcolorbyname-replaces-getcolorfortheme) |
||||
- [VizTextDisplayOptions replaces TextDisplayOptions](#viztextdisplayoptions-replaces-textdisplayoptions) |
||||
- [Changes in the internal of `backendSrv.fetch()`](#changes-in-the-internal-of-backendsrvfetch) |
||||
- [GrafanaTheme2 and useStyles2 replaces getFormStyles](#grafanatheme2-and-usestyles2-replaces-getformstyles) |
||||
- [/api/ds/query replaces /api/tsdb/query](#apidsquery-replaces-apitsdbquery) |
||||
- [selectOptionInTest has been removed](#selectoptionintest-has-been-removed) |
||||
- [Toolkit 9 and webpack](#toolkit-9-and-webpack) |
||||
- [From version 8.3.x to 8.4.x](#from-version-83x-to-84x) |
||||
- [Value Mapping Editor has been removed from @grafana-ui library](#value-mapping-editor-has-been-removed-from-grafana-ui-library) |
||||
- [Thresholds Editor has been removed from @grafana-ui library](#thresholds-editor-has-been-removed-from-grafana-ui-library) |
||||
- [8.4 deprecations](#84-deprecations) |
||||
- [LocationService replaces getLocationSrv](#locationservice-replaces-getlocationsrv) |
||||
- [From version 7.x.x to 8.x.x](#from-version-7xx-to-8xx) |
||||
- [Backend plugin v1 support has been dropped](#backend-plugin-v1-support-has-been-dropped) |
||||
- [1. Add dependency on grafana-plugin-sdk-go](#1-add-dependency-on-grafana-plugin-sdk-go) |
||||
- [2. Update the way you bootstrap your plugin](#2-update-the-way-you-bootstrap-your-plugin) |
||||
- [3. Update the plugin package](#3-update-the-plugin-package) |
||||
- [Sign and load backend plugins](#sign-and-load-backend-plugins) |
||||
- [Update react-hook-form from v6 to v7](#update-react-hook-form-from-v6-to-v7) |
||||
- [Update the plugin.json](#update-the-pluginjson) |
||||
- [Update imports to match emotion 11](#update-imports-to-match-emotion-11) |
||||
- [Update needed for app plugins using dashboards](#update-needed-for-app-plugins-using-dashboards) |
||||
- [8.0 deprecations](#80-deprecations) |
||||
- [Grafana theme v1](#grafana-theme-v1) |
||||
- [From version 6.2.x to 7.4.0](#from-version-62x-to-740) |
||||
- [Legend components](#legend-components) |
||||
- [From version 6.5.x to 7.3.0](#from-version-65x-to-730) |
||||
- [getColorForTheme changes](#getcolorfortheme-changes) |
||||
- [From version 6.x.x to 7.0.0](#from-version-6xx-to-700) |
||||
- [What's new in Grafana 7.0?](#whats-new-in-grafana-70) |
||||
- [New data format](#new-data-format) |
||||
- [Improved TypeScript support](#improved-typescript-support) |
||||
- [Grafana Toolkit](#grafana-toolkit) |
||||
- [Field options](#field-options) |
||||
- [Backend plugins](#backend-plugins) |
||||
- [Migrate a plugin from Angular to React](#migrate-a-plugin-from-angular-to-react) |
||||
- [Migrate a panel plugin](#migrate-a-panel-plugin) |
||||
- [Migrate a data source plugin](#migrate-a-data-source-plugin) |
||||
- [Migrate to data frames](#migrate-to-data-frames) |
||||
- [Troubleshoot plugin migration](#troubleshoot-plugin-migration) |
||||
|
||||
## From version 9.1.x to 9.2.x |
||||
|
||||
### React and React-dom as peer dependencies |
||||
|
||||
In earlier versions of Grafana packages `react` and `react-dom` were installed during a `yarn install` regardless of a plugins dependencies. In 9.2.0 the `@grafana` packages declare these react packages as peerDependencies and will need adding to a plugins `package.json` file for test commands to continue to run successfully. |
||||
|
||||
Example: |
||||
|
||||
```json |
||||
// before |
||||
"dependencies": { |
||||
"@grafana/data": "9.1.0", |
||||
"@grafana/ui": "9.1.0", |
||||
}, |
||||
|
||||
// after |
||||
"dependencies": { |
||||
"@grafana/data": "9.2.0", |
||||
"@grafana/ui": "9.2.0", |
||||
"react": "17.0.2", |
||||
"react-dom": "17.0.2" |
||||
}, |
||||
|
||||
``` |
||||
|
||||
### NavModelItem requires a valid icon name |
||||
|
||||
The typings of the `NavModelItem` have improved to only allow a valid `IconName` for the icon property. You can find the complete list of valid icons [here](https://github.com/grafana/grafana/blob/v9.2.0-beta1/packages/grafana-data/src/types/icon.ts). The icons specified in the list will work for older versions of Grafana 9. |
||||
|
||||
Example: |
||||
|
||||
```ts |
||||
// before |
||||
const model: NavModelItem = { |
||||
id: 'settings', |
||||
text: 'Settings', |
||||
icon: 'fa fa-cog', |
||||
url: `${baseUrl}/settings`, |
||||
}; |
||||
|
||||
// after |
||||
const model: NavModelItem = { |
||||
id: 'settings', |
||||
text: 'Settings', |
||||
icon: 'cog', |
||||
url: `${baseUrl}/settings`, |
||||
}; |
||||
``` |
||||
|
||||
### Additional type availability |
||||
|
||||
FieldProps, ModalProps, and QueryFieldProps are now exposed from `@grafana/ui`. They can be imported in the same way as other types. |
||||
|
||||
Example: |
||||
|
||||
```ts |
||||
import { FieldProps, ModalProps, QueryFieldProps } from '@grafana/ui'; |
||||
``` |
||||
|
||||
## From version 8.x to 9.x |
||||
|
||||
### 9.0 breaking changes |
||||
|
||||
#### theme.visualization.getColorByName replaces getColorForTheme |
||||
|
||||
`getColorForTheme` was removed, use `theme.visualization.getColorByName` instead |
||||
|
||||
Example: |
||||
|
||||
```ts |
||||
// before |
||||
fillColor: getColorForTheme(panel.sparkline.fillColor, config.theme) |
||||
|
||||
// after |
||||
fillColor: config.theme.visualization.getColorByName(panel.sparkline.fillColor), |
||||
``` |
||||
|
||||
#### VizTextDisplayOptions replaces TextDisplayOptions |
||||
|
||||
`TextDisplayOptions` was removed, use `VizTextDisplayOptions` instead |
||||
|
||||
Example: |
||||
|
||||
```ts |
||||
// before |
||||
interface Options { |
||||
... |
||||
text?: TextDisplayOptions; |
||||
... |
||||
} |
||||
|
||||
// after |
||||
interface Options { |
||||
... |
||||
text?: VizTextDisplayOptions; |
||||
... |
||||
} |
||||
``` |
||||
|
||||
#### Changes in the internal of `backendSrv.fetch()` |
||||
|
||||
We have changed the internals of `backendSrv.fetch()` to throw an error when the response is an incorrect JSON. Make sure to handle possible errors on the callsite where using `backendSrv.fetch()` (or any other `backendSrv` methods) |
||||
|
||||
```ts |
||||
// PREVIOUSLY: this was returning with an empty object {} - in case the response is an invalid JSON |
||||
return await getBackendSrv().post(`${API_ROOT}/${id}/install`); |
||||
|
||||
// AFTER THIS CHANGE: the following will throw an error - in case the response is an invalid JSON |
||||
return await getBackendSrv().post(`${API_ROOT}/${id}/install`); |
||||
``` |
||||
|
||||
#### GrafanaTheme2 and useStyles2 replaces getFormStyles |
||||
|
||||
We have removed the deprecated `getFormStyles` function from [grafana-ui](https://www.npmjs.com/package/@grafana/ui). Use `GrafanaTheme2` and the `useStyles2` hook instead |
||||
|
||||
#### /api/ds/query replaces /api/tsdb/query |
||||
|
||||
We have removed the deprecated `/api/tsdb/query` metrics endpoint. Use [/api/ds/query]({{< relref "../http_api/data_source/#query-a-data-source" >}}) instead |
||||
|
||||
#### selectOptionInTest has been removed |
||||
|
||||
The `@grafana/ui` package helper function `selectOptionInTest` used in frontend tests has been removed as it caused testing libraries to be bundled in the production code of Grafana. If you were using this helper function in your tests please update your code accordingly: |
||||
|
||||
```ts |
||||
// before |
||||
import { selectOptionInTest } from '@grafana/ui'; |
||||
// ...test usage |
||||
await selectOptionInTest(selectEl, 'Option 2'); |
||||
|
||||
// after |
||||
import { select } from 'react-select-event'; |
||||
// ...test usage |
||||
await select(selectEl, 'Option 2', { container: document.body }); |
||||
``` |
||||
|
||||
#### Toolkit 9 and webpack |
||||
|
||||
Plugins using custom Webpack configs could potentially break due to the changes between webpack@4 and webpack@5. Please refer to the [official migration guide](https://webpack.js.org/migrate/5/) for assistance. |
||||
|
||||
Webpack 5 does not include polyfills for node.js core modules by default (e.g. `buffer`, `stream`, `os`). This can result in failed builds for plugins. If polyfills are required it is recommended to create a custom webpack config in the root of the plugin repo and add the required fallbacks: |
||||
|
||||
```js |
||||
// webpack.config.js |
||||
|
||||
module.exports.getWebpackConfig = (config, options) => ({ |
||||
...config, |
||||
resolve: { |
||||
...config.resolve, |
||||
fallback: { |
||||
os: require.resolve('os-browserify/browser'), |
||||
stream: require.resolve('stream-browserify'), |
||||
timers: require.resolve('timers-browserify'), |
||||
}, |
||||
}, |
||||
}); |
||||
``` |
||||
|
||||
Please refer to the webpack build error messages or the [official migration guide](https://webpack.js.org/migrate/5/) for assistance with fallbacks. |
||||
|
||||
## From version 8.3.x to 8.4.x |
||||
|
||||
This section explains how to migrate Grafana v8.3.x plugins to the updated plugin system available in Grafana v8.4.x. Depending on your plugin, you need to perform one or more of the following steps. |
||||
|
||||
### Value Mapping Editor has been removed from @grafana-ui library |
||||
|
||||
Removed due to being an internal component. |
||||
|
||||
### Thresholds Editor has been removed from @grafana-ui library |
||||
|
||||
Removed due to being an internal component. |
||||
|
||||
### 8.4 deprecations |
||||
|
||||
#### LocationService replaces getLocationSrv |
||||
|
||||
In a previous release, we migrated to use a new routing system and introduced a new service for managing locations, navigation, and related information. In this release, we are making that new service the primary service. |
||||
|
||||
**Example:** Import the service. |
||||
|
||||
```ts |
||||
// before |
||||
import { getLocationSrv } from '@grafana/runtime'; |
||||
|
||||
// after |
||||
import { locationService } from '@grafana/runtime'; |
||||
``` |
||||
|
||||
**Example:** Navigate to a path and add a new record in the navigation history so that you can navigate back to the previous one. |
||||
|
||||
```ts |
||||
// before |
||||
getLocationSrv.update({ |
||||
path: '/route-to-navigate-to', |
||||
replace: false, |
||||
}); |
||||
|
||||
// after |
||||
locationService.push('/route-to-navigate-to'); |
||||
``` |
||||
|
||||
**Example:** Navigate to a path and replace the current record in the navigation history. |
||||
|
||||
```ts |
||||
// before |
||||
getLocationSrv.update({ |
||||
path: '/route-to-navigate-to', |
||||
replace: true, |
||||
}); |
||||
|
||||
// after |
||||
locationService.replace('/route-to-navigate-to'); |
||||
``` |
||||
|
||||
**Example:** Update the search or query parameter for the current route and add a new record in the navigation history so that you can navigate back to the previous one. |
||||
|
||||
```ts |
||||
// How to navigate to a new path |
||||
// before |
||||
getLocationSrv.update({ |
||||
query: { |
||||
value: 1, |
||||
}, |
||||
partial: true, |
||||
replace: false, |
||||
}); |
||||
|
||||
// after |
||||
locationService.partial({ value: 1 }); |
||||
``` |
||||
|
||||
**Example:** Update the search or query parameter for the current route and add replacing it in the navigation history. |
||||
|
||||
```ts |
||||
// before |
||||
getLocationSrv.update({ |
||||
query: { |
||||
'var-variable': 1, |
||||
}, |
||||
partial: true, |
||||
replace: true, |
||||
}); |
||||
|
||||
// after |
||||
locationService.partial({ 'var-variable': 1 }, true); |
||||
``` |
||||
|
||||
## From version 7.x.x to 8.x.x |
||||
|
||||
This section explains how to migrate Grafana v7.x.x plugins to the updated plugin system available in Grafana v8.x.x. Depending on your plugin, you need to perform one or more of the following steps. We have documented the breaking changes in Grafana v8.x.x and the steps you need to take to upgrade your plugin. |
||||
|
||||
### Backend plugin v1 support has been dropped |
||||
|
||||
Use the new [plugin sdk](https://github.com/grafana/grafana-plugin-sdk-go) to run your backend plugin running in Grafana 8. |
||||
|
||||
#### 1. Add dependency on grafana-plugin-sdk-go |
||||
|
||||
Add a dependency on the `https://github.com/grafana/grafana-plugin-sdk-go`. We recommend using [go modules](https://go.dev/blog/using-go-modules) to manage your dependencies. |
||||
|
||||
#### 2. Update the way you bootstrap your plugin |
||||
|
||||
Update your `main` package to bootstrap via the new plugin sdk. |
||||
|
||||
```go |
||||
// before |
||||
package main |
||||
|
||||
import ( |
||||
"github.com/grafana/grafana_plugin_model/go/datasource" |
||||
hclog "github.com/hashicorp/go-hclog" |
||||
plugin "github.com/hashicorp/go-plugin" |
||||
|
||||
"github.com/myorgid/datasource/pkg/plugin" |
||||
) |
||||
|
||||
func main() { |
||||
pluginLogger.Debug("Running GRPC server") |
||||
|
||||
ds, err := NewSampleDatasource(pluginLogger); |
||||
if err != nil { |
||||
pluginLogger.Error("Unable to create plugin"); |
||||
} |
||||
|
||||
plugin.Serve(&plugin.ServeConfig{ |
||||
HandshakeConfig: plugin.HandshakeConfig{ |
||||
ProtocolVersion: 1, |
||||
MagicCookieKey: "grafana_plugin_type", |
||||
MagicCookieValue: "datasource", |
||||
}, |
||||
Plugins: map[string]plugin.Plugin{ |
||||
"myorgid-datasource": &datasource.DatasourcePluginImpl{Plugin: ds}, |
||||
}, |
||||
GRPCServer: plugin.DefaultGRPCServer, |
||||
}) |
||||
} |
||||
|
||||
// after |
||||
package main |
||||
|
||||
import ( |
||||
"os" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend/log" |
||||
"github.com/grafana/grafana-plugin-sdk-go/backend/datasource" |
||||
|
||||
"github.com/myorgid/datasource/pkg/plugin" |
||||
) |
||||
|
||||
func main() { |
||||
log.DefaultLogger.Debug("Running GRPC server") |
||||
|
||||
if err := datasource.Manage("myorgid-datasource", NewSampleDatasource, datasource.ManageOpts{}); err != nil { |
||||
log.DefaultLogger.Error(err.Error()) |
||||
os.Exit(1) |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### 3. Update the plugin package |
||||
|
||||
Update your `plugin` package to use the new plugin sdk. |
||||
|
||||
```go |
||||
// before |
||||
package plugin |
||||
|
||||
import ( |
||||
"context" |
||||
|
||||
"github.com/grafana/grafana_plugin_model/go/datasource" |
||||
"github.com/hashicorp/go-hclog" |
||||
) |
||||
|
||||
func NewSampleDatasource(pluginLogger hclog.Logger) (*SampleDatasource, error) { |
||||
return &SampleDatasource{ |
||||
logger: pluginLogger, |
||||
}, nil |
||||
} |
||||
|
||||
type SampleDatasource struct{ |
||||
logger hclog.Logger |
||||
} |
||||
|
||||
func (d *SampleDatasource) Query(ctx context.Context, tsdbReq *datasource.DatasourceRequest) (*datasource.DatasourceResponse, error) { |
||||
d.logger.Info("QueryData called", "request", req) |
||||
// logic for querying your datasource. |
||||
} |
||||
|
||||
// after |
||||
package plugin |
||||
|
||||
import ( |
||||
"context" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/backend" |
||||
"github.com/grafana/grafana-plugin-sdk-go/backend/instancemgmt" |
||||
"github.com/grafana/grafana-plugin-sdk-go/backend/log" |
||||
"github.com/grafana/grafana-plugin-sdk-go/data" |
||||
) |
||||
|
||||
func NewSampleDatasource(_ backend.DataSourceInstanceSettings) (instancemgmt.Instance, error) { |
||||
return &SampleDatasource{}, nil |
||||
} |
||||
|
||||
type SampleDatasource struct{} |
||||
|
||||
|
||||
func (d *SampleDatasource) Dispose() { |
||||
// Clean up datasource instance resources. |
||||
} |
||||
|
||||
func (d *SampleDatasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { |
||||
log.DefaultLogger.Info("QueryData called", "request", req) |
||||
// logic for querying your datasource. |
||||
} |
||||
|
||||
func (d *SampleDatasource) CheckHealth(_ context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { |
||||
log.DefaultLogger.Info("CheckHealth called", "request", req) |
||||
// The main use case for these health checks is the test button on the |
||||
// datasource configuration page which allows users to verify that |
||||
// a datasource is working as expected. |
||||
} |
||||
``` |
||||
|
||||
### Sign and load backend plugins |
||||
|
||||
We strongly recommend that you not allow unsigned plugins in your Grafana installation. By allowing unsigned plugins, we cannot guarantee the authenticity of the plugin, which could compromise the security of your Grafana installation. |
||||
|
||||
To sign your plugin, see [Sign a plugin](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#sign-a-plugin). |
||||
|
||||
You can still run and develop an unsigned plugin by running your Grafana instance in [development mode](https://grafana.com/docs/grafana/latest/administration/configuration/#app_mode). Alternatively, you can use the [allow_loading_unsigned_plugins]({{< relref "../../setup-grafana/configure-grafana/#allow_loading_unsigned_plugins" >}}) configuration setting. |
||||
|
||||
### Update react-hook-form from v6 to v7 |
||||
|
||||
We have upgraded react-hook-form from version 6 to version 7. To make your forms compatible with version 7, refer to the [react-hook-form-migration-guide](https://react-hook-form.com/migrate-v6-to-v7/). |
||||
|
||||
### Update the plugin.json |
||||
|
||||
The property that defines which Grafana version your plugin supports has been renamed and now it is a range instead of a specific version. |
||||
|
||||
```json |
||||
// before |
||||
{ |
||||
"dependencies": { |
||||
"grafanaVersion": "7.5.x", |
||||
"plugins": [] |
||||
} |
||||
} |
||||
|
||||
// after |
||||
{ |
||||
"dependencies": { |
||||
"grafanaDependency": ">=8.0.0", |
||||
"plugins": [] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
### Update imports to match emotion 11 |
||||
|
||||
Grafana uses Emotion library to manage frontend styling. We have updated the Emotion package and this can affect your frontend plugin if you have custom styling. You only need to update the import statements to get it working in Grafana 8. |
||||
|
||||
```ts |
||||
// before |
||||
import { cx, css } from 'emotion'; |
||||
|
||||
// after |
||||
import { cx, css } from '@emotion/css'; |
||||
``` |
||||
|
||||
### Update needed for app plugins using dashboards |
||||
|
||||
To make side navigation work properly - app plugins targeting Grafana `8.+` and integrating into the side menu via [addToNav]({{< relref "metadata/#properties-4" >}}) property need to adjust their `plugin.json` and all dashboard json files to have a matching `uid`. |
||||
|
||||
**`plugin.json`** |
||||
|
||||
```json "linenos=inline,hl_lines=7,linenostart=1" |
||||
{ |
||||
"id": "plugin-id", |
||||
// ... |
||||
"includes": [ |
||||
{ |
||||
"type": "dashboard", |
||||
"name": "(Team) Situation Overview", |
||||
"path": "dashboards/example-dashboard.json", |
||||
"addToNav": true, |
||||
"defaultNav": false, |
||||
"uid": "l3KqBxCMz" |
||||
} |
||||
] |
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
**`dashboards/example-dashboard.json`** |
||||
|
||||
```json |
||||
{ |
||||
// ... |
||||
"title": "Example Dashboard", |
||||
"uid": "l3KqBxCMz", |
||||
"version": 1 |
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
### 8.0 deprecations |
||||
|
||||
#### Grafana theme v1 |
||||
|
||||
In Grafana 8 we have introduced a new improved version of our theming system. The previous version of the theming system is still available but is deprecated and will be removed in the next major version of Grafana. |
||||
|
||||
You can find more detailed information on how to apply the v2 theme [here](https://github.com/grafana/grafana/blob/main/contribute/style-guides/themes.md#theming-grafana). |
||||
|
||||
**How to style a functional component** |
||||
|
||||
The `useStyles` hook is the preferred way to access the theme when styling. It provides basic memoization and access to the theme object. |
||||
|
||||
```ts |
||||
// before |
||||
import React, { ReactElement } from 'react'; |
||||
import css from 'emotion'; |
||||
import { GrafanaTheme } from '@grafana/data'; |
||||
import { useStyles } from '@grafana/ui'; |
||||
|
||||
function Component(): ReactElement | null { |
||||
const styles = useStyles(getStyles); |
||||
} |
||||
|
||||
const getStyles = (theme: GrafanaTheme) => ({ |
||||
myStyle: css` |
||||
background: ${theme.colors.bodyBg}; |
||||
display: flex; |
||||
`, |
||||
}); |
||||
|
||||
// after |
||||
import React, { ReactElement } from 'react'; |
||||
import { css } from '@emotion/css'; |
||||
import { GrafanaTheme2 } from '@grafana/data'; |
||||
import { useStyles2 } from '@grafana/ui'; |
||||
|
||||
function Component(): ReactElement | null { |
||||
const theme = useStyles2(getStyles); |
||||
} |
||||
|
||||
const getStyles = (theme: GrafanaTheme2) => ({ |
||||
myStyle: css` |
||||
background: ${theme.colors.background.canvas}; |
||||
display: flex; |
||||
`, |
||||
}); |
||||
``` |
||||
|
||||
**How to use the theme in a functional component** |
||||
|
||||
```ts |
||||
// before |
||||
import React, { ReactElement } from 'react'; |
||||
import { useTheme } from '@grafana/ui'; |
||||
|
||||
function Component(): ReactElement | null { |
||||
const theme = useTheme(); |
||||
} |
||||
|
||||
// after |
||||
import React, { ReactElement } from 'react'; |
||||
import { useTheme2 } from '@grafana/ui'; |
||||
|
||||
function Component(): ReactElement | null { |
||||
const theme = useTheme2(); |
||||
// Your component has access to the theme variables now |
||||
} |
||||
``` |
||||
|
||||
**How to use the theme in a class component** |
||||
|
||||
```ts |
||||
// before |
||||
import React from 'react'; |
||||
import { Themeable, withTheme } from '@grafana/ui'; |
||||
|
||||
type Props = {} & Themeable; |
||||
|
||||
class Component extends React.Component<Props> { |
||||
render() { |
||||
const { theme } = this.props; |
||||
// Your component has access to the theme variables now |
||||
} |
||||
} |
||||
|
||||
export default withTheme(Component); |
||||
|
||||
// after |
||||
import React from 'react'; |
||||
import { Themeable2, withTheme2 } from '@grafana/ui'; |
||||
|
||||
type Props = {} & Themeable2; |
||||
|
||||
class Component extends React.Component<Props> { |
||||
render() { |
||||
const { theme } = this.props; |
||||
// Your component has access to the theme variables now |
||||
} |
||||
} |
||||
|
||||
export default withTheme2(Component); |
||||
``` |
||||
|
||||
**Gradually migrating components** |
||||
|
||||
If you need to use both the v1 and v2 themes due to using migrated and non-migrated components in the same context, use the `v1` property on the `v2` theme as described in the following example. |
||||
|
||||
```ts |
||||
function Component(): ReactElement | null { |
||||
const theme = useTheme2(); |
||||
return ( |
||||
<NonMigrated theme={theme.v1}> |
||||
<Migrated theme={theme] /> |
||||
</NonMigrate> |
||||
); |
||||
}; |
||||
``` |
||||
|
||||
## From version 6.2.x to 7.4.0 |
||||
|
||||
### Legend components |
||||
|
||||
The Legend components have been refactored and introduced the following changes within the `@grafana/ui` package. |
||||
|
||||
```ts |
||||
// before |
||||
import { LegendItem, LegendOptions, GraphLegend } from '@grafana/ui'; |
||||
|
||||
// after |
||||
import { VizLegendItem, VizLegendOptions, VizLegend } from '@grafana/ui'; |
||||
``` |
||||
|
||||
- `LegendPlacement` has been updated from `'under' | 'right' | 'over'` to `'bottom' | 'right'` so you can not place the legend above the visualization anymore. |
||||
- The `isVisible` in the `LegendItem` has been renamed to `disabled` in `VizLegendItem`. |
||||
|
||||
## From version 6.5.x to 7.3.0 |
||||
|
||||
### getColorForTheme changes |
||||
|
||||
The `getColorForTheme` function arguments have changed from `(color: ColorDefinition, theme?: GrafanaThemeType)` to `(color: string, theme: GrafanaTheme)`. |
||||
|
||||
```ts |
||||
// before |
||||
const color: ColorDefinition = { |
||||
hue: 'green'; |
||||
name: 'dark-green'; |
||||
variants: { |
||||
light: '#19730E' |
||||
dark: '#37872D' |
||||
}; |
||||
} |
||||
const themeType: GrafanaThemeType = 'dark'; |
||||
const themeColor = getColorForTheme(color, themeType); |
||||
|
||||
// after |
||||
const color = 'green'; |
||||
const theme: GrafanaTheme = useTheme(); |
||||
const themeColor = getColorForTheme(color, theme); |
||||
|
||||
``` |
||||
|
||||
## From version 6.x.x to 7.0.0 |
||||
|
||||
### What's new in Grafana 7.0? |
||||
|
||||
Grafana 7.0 introduced a whole new plugin platform based on React. The new platform supersedes the previous Angular-based plugin platform. |
||||
|
||||
Plugins built using Angular still work for the foreseeable future, but we encourage new plugin authors to develop with the new platform. |
||||
|
||||
#### New data format |
||||
|
||||
Along with the move to React, the new plugin platform introduced a new internal data format called [data frames](data-frames.md). |
||||
|
||||
Previously, data source plugins could send data either as time series or tables. With data frames, data sources can send any data in a table-like structure. This gives you more flexibility to visualize your data in Grafana. |
||||
|
||||
#### Improved TypeScript support |
||||
|
||||
While the previous Angular-based plugin SDK did support TypeScript, for the React platform, we’ve greatly improved the support. All our APIs are now TypeScript, which might require existing code to update to the new stricter type definitions. Grafana 7.0 also introduced several new APIs for plugin developers that take advantage of many of the new features in Grafana 7.0. |
||||
|
||||
#### Grafana Toolkit |
||||
|
||||
With Grafana 7.0, we released a new tool for making it easier to develop plugins. Before, you’d use Gulp, Grunt, or similar tools to generate the minified assets. Grafana Toolkit takes care of building and testing your plugin without complicated configuration files. |
||||
|
||||
For more information, refer to [@grafana/toolkit](https://www.npmjs.com/package/@grafana/toolkit). |
||||
|
||||
#### Field options |
||||
|
||||
Grafana 7.0 introduced the concept of _field options_, a new way of configuring your data before it gets visualized. Since this was not available in previous versions, any plugin that enables field-based configuration will not work in previous versions of Grafana. |
||||
|
||||
For plugins prior to Grafana 7.0, all options are considered _Display options_. The tab for field configuration isn't available. |
||||
|
||||
#### Backend plugins |
||||
|
||||
While backend plugins were available as an experimental feature in previous versions of Grafana, the support has been greatly improved for Grafana 7. Backend plugins for Grafana 7.0 are backwards-compatible and will continue to work. However, the old backend plugin system has been deprecated, and we recommend that you use the new SDK for backend plugins. |
||||
|
||||
Since Grafana 7.0 introduced signing of backend plugins, community plugins won’t load by default if they’re unsigned. |
||||
|
||||
### Migrate a plugin from Angular to React |
||||
|
||||
If you’re looking to migrate a plugin to the new plugin platform, then we recommend that you release it under a new major version. Consider keeping a release branch for the previous version to be able to roll out patch releases for versions prior to Grafana 7. |
||||
|
||||
While there's no 1-to-1 migration path from an Angular plugin to the new React platform, from early adopters, we’ve learned that one of the easiest ways to migrate is to: |
||||
|
||||
1. Create a new branch called `migrate-to-react`. |
||||
1. Start from scratch with one of the templates provided by Grafana Toolkit. |
||||
1. Move the existing code into the new plugin incrementally, one component at a time. |
||||
|
||||
#### Migrate a panel plugin |
||||
|
||||
Prior to Grafana 7.0, you would export a MetricsPanelCtrl from module.ts. |
||||
|
||||
**src/module.ts** |
||||
|
||||
```ts |
||||
import { MetricsPanelCtrl } from 'grafana/app/plugins/sdk'; |
||||
|
||||
class MyPanelCtrl extends MetricsPanelCtrl { |
||||
// ... |
||||
} |
||||
|
||||
export { MyPanelCtrl as PanelCtrl }; |
||||
``` |
||||
|
||||
Starting with 7.0, plugins now export a PanelPlugin from module.ts where MyPanel is a React component containing the props from PanelProps. |
||||
|
||||
**src/module.ts** |
||||
|
||||
```ts |
||||
import { PanelPlugin } from '@grafana/data'; |
||||
|
||||
export const plugin = new PanelPlugin<MyOptions>(MyPanel); |
||||
``` |
||||
|
||||
**src/MyPanel.tsx** |
||||
|
||||
```ts |
||||
import { PanelProps } from '@grafana/data'; |
||||
|
||||
interface Props extends PanelProps<SimpleOptions> {} |
||||
|
||||
export function MyPanel({ options, data, width, height }: Props) { |
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
#### Migrate a data source plugin |
||||
|
||||
While all plugins are different, we'd like to share a migration process that has worked for some of our users. |
||||
|
||||
1. Define your configuration model and `ConfigEditor`. For many plugins, the configuration editor is the simplest component so it's a good candidate to start with. |
||||
1. Implement the `testDatasource()` method on the class that extends `DataSourceApi` using the settings in your configuration model to make sure you can successfully configure and access the external API. |
||||
1. Implement the `query()` method. At this point, you can hard-code your query, because we haven’t yet implemented the query editor. The `query()` method supports both the new data frame response and the old TimeSeries response, so don’t worry about converting to the new format just yet. |
||||
1. Implement the `QueryEditor`. How much work this requires depends on how complex your query model is. |
||||
|
||||
By now, you should be able to release your new version. |
||||
|
||||
To fully migrate to the new plugin platform, convert the time series response to a data frame response. |
||||
|
||||
#### Migrate to data frames |
||||
|
||||
Before 7.0, data source and panel plugins exchanged data using either time series or tables. Starting with 7.0, plugins use the new data frame format to pass data from data sources to panels. |
||||
|
||||
Grafana 7.0 is backward compatible with the old data format used in previous versions. Panels and data sources using the old format will still work with plugins using the new data frame format. |
||||
|
||||
The `DataQueryResponse` returned by the `query` method can be either a [LegacyResponseData](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/datasource.ts#L419) or a [DataFrame](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/dataFrame.ts#L200). |
||||
|
||||
The [toDataFrame()](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/dataframe/processDataFrame.ts#L309) function converts a legacy response, such as `TimeSeries` or `Table`, to a `DataFrame`. Use it to gradually move your code to the new format. |
||||
|
||||
```ts |
||||
import { toDataFrame } from '@grafana/data'; |
||||
``` |
||||
|
||||
```ts |
||||
async query(options: DataQueryRequest<MyQuery>): Promise<DataQueryResponse> { |
||||
return { |
||||
data: options.targets.map(query => { |
||||
const timeSeries: TimeSeries = await doLegacyRequest(query); |
||||
return toDataFrame(timeSeries); |
||||
} |
||||
}; |
||||
} |
||||
``` |
||||
|
||||
### Troubleshoot plugin migration |
||||
|
||||
As of Grafana 7.0, backend plugins can now be cryptographically signed to verify their origin. By default, Grafana ignores unsigned plugins. For more information, refer to [Allow unsigned plugins]({{< relref "../../administration/plugin-management/#allow-unsigned-plugins" >}}). |
||||
@ -1,67 +0,0 @@ |
||||
--- |
||||
description: How to package a plugin |
||||
title: Package a plugin |
||||
--- |
||||
|
||||
By packaging a plugin, you can organize the plugin code and make it ready for use in your organization. |
||||
|
||||
## Package a plugin for distribution |
||||
|
||||
1. Build the plugin |
||||
|
||||
``` |
||||
yarn install --pure-lockfile |
||||
yarn build |
||||
``` |
||||
|
||||
1. Optional: If your data source plugin has a backend plugin, build it as well. |
||||
|
||||
``` |
||||
mage |
||||
``` |
||||
|
||||
Make sure that all the binaries are executable and have a `0755` (`-rwxr-xr-x`) permission. |
||||
|
||||
1. Sign the plugin. To learn more, refer to [Sign the plugin]({{< relref "./sign-a-plugin" >}}). |
||||
|
||||
1. Rename the `dist` directory to match your plugin ID, and then create a ZIP archive. |
||||
|
||||
``` |
||||
mv dist/ myorg-simple-panel |
||||
zip myorg-simple-panel-1.0.0.zip myorg-simple-panel -r |
||||
``` |
||||
|
||||
1. Optional: Verify that your plugin is packaged correctly using [zipinfo](https://linux.die.net/man/1/zipinfo). |
||||
It should look like this: |
||||
|
||||
``` |
||||
zipinfo grafana-clickhouse-datasource-1.1.2.zip |
||||
|
||||
Archive: grafana-clickhouse-datasource-1.1.2.zip |
||||
Zip file size: 34324077 bytes, number of entries: 22 |
||||
drwxr-xr-x 0 bx stor 22-Mar-24 23:23 grafana-clickhouse-datasource/ |
||||
-rw-r--r-- 1654 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/CHANGELOG.md |
||||
-rw-r--r-- 11357 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/LICENSE |
||||
-rw-r--r-- 2468 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/MANIFEST.txt |
||||
-rw-r--r-- 8678 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/README.md |
||||
drwxr-xr-x 0 bx stor 22-Mar-24 23:23 grafana-clickhouse-datasource/dashboards/ |
||||
-rw-r--r-- 42973 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/dashboards/cluster-analysis.json |
||||
-rw-r--r-- 56759 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/dashboards/data-analysis.json |
||||
-rw-r--r-- 39406 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/dashboards/query-analysis.json |
||||
-rwxr-xr-x 16469136 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_darwin_amd64 |
||||
-rwxr-xr-x 16397666 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_darwin_arm64 |
||||
-rwxr-xr-x 14942208 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_linux_amd64 |
||||
-rwxr-xr-x 14155776 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_linux_arm |
||||
-rwxr-xr-x 14548992 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_linux_arm64 |
||||
-rwxr-xr-x 15209472 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_windows_amd64.exe |
||||
drwxr-xr-x 0 bx stor 22-Mar-24 23:23 grafana-clickhouse-datasource/img/ |
||||
-rw-r--r-- 304 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/img/logo.png |
||||
-rw-r--r-- 1587 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/img/logo.svg |
||||
-rw-r--r-- 138400 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/module.js |
||||
-rw-r--r-- 808 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/module.js.LICENSE.txt |
||||
-rw-r--r-- 487395 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/module.js.map |
||||
-rw-r--r-- 1616 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/plugin.json |
||||
22 files, 92516655 bytes uncompressed, 34319591 bytes compressed: 62.9% |
||||
``` |
||||
|
||||
When you've packaged your plugin, you can proceed to [publishing a plugin]({{< relref "publish-a-plugin.md" >}}) or [installing a packaged plugin](https://grafana.com/docs/grafana/latest/administration/plugin-management/#install-a-packaged-plugin). |
||||
@ -1,131 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- share-a-plugin/ |
||||
description: Learn how to package and share your plugin. |
||||
title: Publish a plugin |
||||
type: docs |
||||
--- |
||||
|
||||
# Publish or update a plugin |
||||
|
||||
You've just built your plugin; now you want to share it with the world. |
||||
|
||||
In this guide, you'll learn how to package and share your plugin with others. |
||||
|
||||
The best way to share your plugin with the world is to publish it in the [Grafana plugin catalog]{{< relref "/plugins" >}}). |
||||
By having your plugin published on Grafana.com, more users will be able to discover your plugin. |
||||
|
||||
## Before you begin |
||||
|
||||
When you build a plugin from source, a `dist` folder is created. This folder contains the production build or _plugin assets_ for your plugin. |
||||
|
||||
To package a plugin, refer to [Package a plugin]{{< relref "package-a-plugin.md" >}}). |
||||
|
||||
### Follow our guidelines |
||||
|
||||
Get familiar with our plugin [publishing and signing criteria]({{< relref "./publishing-and-signing-criteria" >}}) |
||||
|
||||
### Do this for best results |
||||
|
||||
To speed up the time it takes to review your plugin: |
||||
|
||||
- Check that your plugin is ready for review using the [plugin validator](https://github.com/grafana/plugin-validator). |
||||
- Read our [6 tips for improving your Grafana plugin before you publish](/blog/2021/01/21/6-tips-for-improving-your-grafana-plugin-before-you-publish/). |
||||
- Refer to [plugin-examples](https://github.com/grafana/grafana-plugin-examples) to review best practices for building your plugin. |
||||
|
||||
## Publish your plugin |
||||
|
||||
Follow these steps to publish your plugin for the first time. |
||||
|
||||
1. [Sign in](/auth/sign-in) to your Grafana Cloud account. |
||||
1. In the left menu, under **Org settings**, click **My Plugins**. |
||||
1. Click **Submit Plugin**. The Create Plugin Submission form appears. |
||||
|
||||
{{< figure src="/static/img/docs/plugins/plugins-submission-create2.png" class="docs-image--no-shadow" max-width="650px" >}} |
||||
|
||||
1. 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. |
||||
- **Source Code URL:** A URL that points to a public Git repository or ZIP archive of your complete plugin source code. |
||||
- **MD5:** The MD5 hash of the plugin specified by the **URL**. |
||||
- The remaining questions help us determine the [signature level]({{< relref "./sign-a-plugin#plugin-signature-levels" >}}) for your plugin. |
||||
1. Click **Submit**. |
||||
After you submit your plugin, we run an automated validation to make sure it adheres to our guidelines. |
||||
Your submission is placed in the review queue after the submission is validated. |
||||
|
||||
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. |
||||
We use the test environment whenever you submit a plugin update. |
||||
|
||||
## Update your plugin |
||||
|
||||
To submit an **update** for an already published plugin: |
||||
|
||||
1. [Sign in](/auth/sign-in) to your Grafana Cloud account. |
||||
1. In the left menu, under **Org settings**, click **My Plugins**. |
||||
1. Click **Submit Update** for the plugin you want to update. The Create Plugin Submission form appears. |
||||
|
||||
{{< figure src="/static/img/docs/plugins/plugins-submission-create2.png" class="docs-image--no-shadow" max-width="650px" >}} |
||||
|
||||
1. 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. |
||||
- **Source Code URL:** A URL that points to a public Git repository or ZIP archive of your complete plugin source code. See [examples](#what-source-code-url-formats-are-supported). |
||||
- **MD5:** The MD5 hash of the plugin specified by the **URL**. |
||||
1. Click **Submit**. |
||||
|
||||
## Frequently asked questions |
||||
|
||||
### 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. |
||||
|
||||
### Can I decide a date when my plugin will be published? |
||||
|
||||
- No. We cannot guarantee specific publishing dates, as plugins are immediately published after a review based on our internal prioritization. |
||||
|
||||
### Can I see metrics of my plugin installs, downloads or usage? |
||||
|
||||
- No. We don't offer this information at the moment to plugin authors. |
||||
|
||||
### How can I update my plugin's catalog page? |
||||
|
||||
- The plugin's catalog page content is extracted from the plugin README file. |
||||
To update the plugin's catalog page, submit an updated plugin with the new content included in the README file. |
||||
|
||||
### Can I unlist my plugin from the Grafana plugin catalog in case of a bug? |
||||
|
||||
- In the event of a bug, unlisting the plugin from our catalog may be possible in exceptional cases, such as security concerns. However, we don't have control over the specific instances where the plugin is installed. |
||||
|
||||
### Can I distribute my plugin somewhere else other than the Grafana plugin catalog? |
||||
|
||||
- The official method for distributing Grafana plugins is through our catalog. Alternative methods, such as installing private or development plugins on local Grafana instances, are available as per the guidelines provided in [this guide]({{< relref "../../administration/plugin-management#install-plugin-on-local-grafana" >}}). |
||||
|
||||
### Can I still use Angular for my plugin? |
||||
|
||||
- No. We will not accept any new plugin submissions written in Angular. For more information, refer to our [Angular support deprecation documentation]({{< relref "../angular_deprecation" >}}). |
||||
|
||||
### Do plugin signatures expire? |
||||
|
||||
- Plugin signatures do not currently expire. |
||||
|
||||
### What source code URL formats are supported? |
||||
|
||||
- Using a tag or branch: `https://github.com/grafana/clock-panel/tree/v2.1.3` |
||||
- A tag or branch and the code is in a subdirectory (important for mono repos): `https://github.com/grafana/clock-panel/tree/v2.1.3/plugin/` (here, the plugin contains the plugin code) |
||||
- Using the latest main or master branch commit: `https://github.com/grafana/clock-panel/` (not recommended, it's better to pass a tag or branch) |
||||
@ -1,13 +0,0 @@ |
||||
--- |
||||
description: Topics related to plugin publishing |
||||
title: Publish a plugin |
||||
--- |
||||
|
||||
<<<<<<< HEAD |
||||
|
||||
# Publish a plugin |
||||
|
||||
This section contains topics related to publishing Grafana plugins. |
||||
|
||||
- [Publishing and signing criteria]({{< relref "../publishing-and-signing-criteria.md">}}) |
||||
- [Publish or update a plugin]({{< relref "../publish-or-update-a-plugin.md">}}) |
||||
@ -1,128 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- share-a-plugin/ |
||||
description: Learn how to package and share your plugin. |
||||
title: Publish or update a plugin |
||||
type: docs |
||||
--- |
||||
|
||||
# Publish or update a plugin |
||||
|
||||
You've just built your plugin; now you want to share it with the world. |
||||
|
||||
In this guide, you'll learn how to package and share your plugin with others. |
||||
|
||||
The best way to share your plugin with the world is to publish it in the [Grafana plugin catalog]{{< relref "/plugins" >}}). |
||||
By having your plugin published on Grafana.com, more users will be able to discover your plugin. |
||||
|
||||
## Before you begin |
||||
|
||||
When you build a plugin from source, a `dist` folder is created. This folder contains the production build or _plugin assets_ for your plugin. |
||||
|
||||
To package a plugin, refer to [Package a plugin]{{< relref "package-a-plugin.md" >}}). |
||||
|
||||
### Follow our guidelines |
||||
|
||||
Get familiar with our plugin [publishing and signing criteria]({{< relref "./publishing-and-signing-criteria" >}}) |
||||
|
||||
### Do this for best results |
||||
|
||||
To speed up the time it takes to review your plugin: |
||||
|
||||
- Check that your plugin is ready for review using the [plugin validator](https://github.com/grafana/plugin-validator). |
||||
- Read our [6 tips for improving your Grafana plugin before you publish](/blog/2021/01/21/6-tips-for-improving-your-grafana-plugin-before-you-publish/). |
||||
- Refer to [plugin-examples](https://github.com/grafana/grafana-plugin-examples) to review best practices for building your plugin. |
||||
|
||||
## Publish your plugin |
||||
|
||||
Follow these steps to publish your plugin for the first time. |
||||
|
||||
1. [Sign in](/auth/sign-in) to your Grafana Cloud account. |
||||
1. In the left menu, under **Org settings**, click **My Plugins**. |
||||
1. Click **Submit Plugin**. The Create Plugin Submission dialog appears. |
||||
|
||||
{{< figure src="/static/img/docs/plugins/plugins-submission-create2.png" class="docs-image--no-shadow" max-width="650px" >}} |
||||
|
||||
1. 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. |
||||
- **Source Code URL:** A URL that points to a public Git repository or ZIP archive of your complete plugin source code. |
||||
- **MD5:** The MD5 hash of the plugin specified by the **URL**. |
||||
- The remaining questions help us determine the [signature level]({{< relref "./sign-a-plugin#plugin-signature-levels" >}}) for your plugin. |
||||
1. Click **Submit**. |
||||
After you submit 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. |
||||
We use the test environment whenever you submit a plugin update. |
||||
|
||||
## Update your plugin |
||||
|
||||
To submit an **update** for an already published plugin: |
||||
|
||||
1. [Sign in](/auth/sign-in) to your Grafana Cloud account. |
||||
1. In the left menu, under **Org settings**, click **My Plugins**. |
||||
1. Click **Submit Update** for the plugin you want to update. The Create Plugin Submission dialog appears. |
||||
{{< figure src="/static/img/docs/plugins/plugins-submission-create2.png" class="docs-image--no-shadow" max-width="650px" >}} |
||||
1. 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. |
||||
- **Source Code URL:** A URL that points to a public Git repository or ZIP archive of your complete plugin source code. See [examples](#what-source-code-url-formats-are-supported). |
||||
- **MD5:** The MD5 hash of the plugin specified by the **URL**. |
||||
1. Click **Submit**. |
||||
|
||||
## Frequently asked questions |
||||
|
||||
### 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. |
||||
|
||||
### Can I decide a date when my plugin will be published? |
||||
|
||||
- No. We cannot guarantee specific publishing dates, as plugins are immediately published after a review based on our internal prioritization. |
||||
|
||||
### Can I see metrics of my plugin installs, downloads or usage? |
||||
|
||||
- No. We don't offer this information at the moment to plugin authors. |
||||
|
||||
### How can I update my plugin's catalog page? |
||||
|
||||
- The plugin's catalog page content is extracted from the plugin README file. |
||||
To update the plugin's catalog page, submit an updated plugin with the new content included in the README file. |
||||
|
||||
### Can I unlist my plugin from the Grafana plugin catalog in case of a bug? |
||||
|
||||
- In the event of a bug, unlisting the plugin from our catalog may be possible in exceptional cases, such as security concerns. However, we don't have control over the instances where the plugin is installed. |
||||
|
||||
### Can I distribute my plugin somewhere else other than the Grafana plugin catalog? |
||||
|
||||
- The official method for distributing Grafana plugins is through our catalog. Alternative methods, such as installing private or development plugins on local Grafana instances, are available as per the guidelines provided in [this guide]({{< relref "../../administration/plugin-management#install-plugin-on-local-grafana" >}}). |
||||
|
||||
### Can I still use Angular for my plugin? |
||||
|
||||
- No. We will not accept any new plugin submissions written in Angular. For more information, refer to our [Angular support deprecation documentation]({{< relref "../angular_deprecation" >}}). |
||||
|
||||
### Do plugin signatures expire? |
||||
|
||||
- Plugin signatures do not currently expire. |
||||
|
||||
### What source code URL formats are supported? |
||||
|
||||
- Using a tag or branch: `https://github.com/grafana/clock-panel/tree/v2.1.3` |
||||
- Using a tag or branch and the code is in a subdirectory (important for mono repos): `https://github.com/grafana/clock-panel/tree/v2.1.3/plugin/` (here, the plugin contains the plugin code) |
||||
- Using the latest main or master branch commit: `https://github.com/grafana/clock-panel/` (not recommended, it's better to pass a tag or branch) |
||||
@ -1,22 +0,0 @@ |
||||
--- |
||||
title: Plugin publishing and signing criteria |
||||
--- |
||||
|
||||
# Plugin publishing and signing criteria |
||||
|
||||
Grafana plugins must adhere to the Grafana Labs [Plugin Policy](https://grafana.com/legal/plugins/). Our review process for publishing and signing will examine your compliance with this policy. |
||||
|
||||
> **Important:** Grafana Labs reserves the right to decline or remove any plugin at its discretion. Failure to comply with publishing and signing criteria may result in immediate removal from the Grafana plugin catalog. |
||||
|
||||
## Plugin licensing |
||||
|
||||
Plugins must be licensed under one of the following AGPL compliant licenses for publishing to the Grafana plugin catalog: |
||||
|
||||
- AGPL-3.0 |
||||
- Apache-2.0 |
||||
- BSD |
||||
- GPL-3.0 |
||||
- LGPL-3.0 |
||||
- MIT |
||||
|
||||
If contributing a plugin on behalf of an organization, be sure to seek guidance from your legal team. |
||||
@ -1,10 +0,0 @@ |
||||
--- |
||||
description: Reference topics. |
||||
title: Reference |
||||
--- |
||||
|
||||
# Reference |
||||
|
||||
This section contains a metadata reference for plugin development. |
||||
|
||||
- [{{< relref "plugin.json">}}](metadata.md) |
||||
@ -1,140 +0,0 @@ |
||||
--- |
||||
title: Sign a plugin |
||||
--- |
||||
|
||||
# Sign a plugin |
||||
|
||||
Grafana requires all plugins to be signed so that we can verify their authenticity with [signature verification]({{< relref "../../administration/plugin-management#plugin-signatures" >}}). |
||||
|
||||
All Grafana Labs-authored backend plugins, including Enterprise plugins, are signed. By [default]({{< relref "../../administration/plugin-management#allow-unsigned-plugins" >}}), Grafana **requires** all plugins to be signed in order for them to be loaded. |
||||
|
||||
Before you can sign your plugin, you need to decide whether you want to sign it as a _public_ or a _private_ plugin. |
||||
|
||||
To make your plugin publicly available outside of your organization, sign your plugin under a _community_ or _commercial_ [signature level](#plugin-signature-levels). Public plugins are available from the [Grafana plugin catalog](https://grafana.com/plugins) and can be installed by anyone. |
||||
|
||||
<<<<<<< HEAD |
||||
For more information on how to install a public plugin, refer to [Install Grafana plugins]({{< relref "../../administration/plugin-management#install-a-plugin" >}}). |
||||
|
||||
# If you intend to only use the plugin within your organization, you can to sign it under a _private_ [signature level](#plugin-signature-levels). |
||||
|
||||
If you intend to only use the plugin within your organization, sign it under a _private_ [signature level](#plugin-signature-levels). |
||||
|
||||
> > > > > > > 13be068919 (Docs: Plugin doc review for chunk 1-A (#67070)) |
||||
|
||||
## Generate an API key |
||||
|
||||
To verify ownership of your plugin, generate an API key that you'll use every time you need to sign a new version of your plugin. |
||||
|
||||
1. [Create a Grafana Cloud account](https://grafana.com/signup). |
||||
|
||||
1. Make sure that the first part of the plugin ID matches the slug of your Grafana Cloud account. |
||||
|
||||
You can find the plugin ID in the `plugin.json` file inside your plugin directory. For example, if your account slug is `acmecorp`, you need to prefix the plugin ID with `acmecorp-`. |
||||
|
||||
1. [Create a Grafana Cloud API key](https://grafana.com/docs/grafana-cloud/reference/create-api-key/) with the **PluginPublisher** role. |
||||
|
||||
## Sign a public plugin |
||||
|
||||
Public plugins need to be reviewed by the Grafana team before you can sign them. |
||||
|
||||
<<<<<<< HEAD |
||||
|
||||
1. Submit your plugin for [review]({{< relref "package-a-plugin/#publishing-your-plugin-for-the-first-time" >}}) |
||||
2. When your plugin is approved, you're granted a plugin signature level. **Without a plugin signature level, you won't be able to sign your plugin**. |
||||
3. # In your plugin directory, sign the plugin with the API key you just created. Grafana Sign Plugin creates a [MANIFEST.txt](#plugin-manifest) file in the `dist` directory of your plugin. |
||||
4. Submit your plugin for [review]({{< relref "publish-a-plugin/#publishing-your-plugin-for-the-first-time" >}}) |
||||
5. If we approve your plugin, you're granted a plugin signature level. You need this signature level to proceed. |
||||
6. In your plugin directory, sign the plugin with the API key you just created. Grafana Sign Plugin creates a [MANIFEST.txt](#plugin-manifest) file in the `dist` directory of your plugin: |
||||
|
||||
> > > > > > > 13be068919 (Docs: Plugin doc review for chunk 1-A (#67070)) |
||||
|
||||
```bash |
||||
export GRAFANA_API_KEY=<YOUR_API_KEY> |
||||
npx @grafana/sign-plugin |
||||
``` |
||||
|
||||
## Sign a private plugin |
||||
|
||||
1. In your plugin directory, sign the plugin with the API key you just created. Grafana Sign Plugin creates a [MANIFEST.txt](#plugin-manifest) file in the `dist` directory of your plugin. |
||||
|
||||
```bash |
||||
export GRAFANA_API_KEY=<YOUR_API_KEY> |
||||
npx @grafana/sign-plugin --rootUrls https://example.com/grafana |
||||
``` |
||||
|
||||
1. After the `rootUrls` flag, enter a comma-separated list of URLs for the Grafana instances where you intend to install the plugin. |
||||
|
||||
## Plugin signature levels |
||||
|
||||
To sign a plugin, you need to select the _signature level_ that you want to sign it under. The signature level of your plugin determines how you can distribute it. |
||||
|
||||
You can sign your plugin under three different _signature levels_: _private_, _community_, and _commercial_. |
||||
|
||||
| **Plugin Level** | **Paid Subscription Required?** | **Description** | |
||||
| ---------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
||||
| Private | No;<br>Free of charge | <p>You can create and sign a Private plugin for any technology at no charge.</p><p>Private plugins are intended for use on your own installation of Grafana. They may not be distributed to the Grafana community, and they are not published in the Grafana plugin catalog.</p> | |
||||
| Community | No;<br>Free of charge | <p>You can create, sign, and distribute plugins at no charge, provided that all dependent technologies are open source and not for profit.</p><p>Community plugins are published in the official Grafana catalog, and are available to the entire Grafana community.</p> | |
||||
| Commercial | Yes;<br>Commercial plugin subscription required | <p>You can create, sign, and distribute plugins with dependent technologies that are closed source or commercially backed. To do so, enter into a Commercial plugin subscription with Grafana Labs.</p><p>Commercial plugins are published on the Grafana plugin catalog, and are available to the entire Grafana community.</p> | |
||||
|
||||
For instructions on how to sign a plugin under the Community and Commercial signature level, refer to [Sign a public plugin](#sign-a-public-plugin). |
||||
|
||||
For instructions on how to sign a plugin under the Private signature level, refer to [Sign a private plugin](#sign-a-private-plugin). |
||||
|
||||
## Plugin manifest |
||||
|
||||
For Grafana to verify the digital signature of a plugin, the plugin must include a signed manifest file, `MANIFEST.txt`. The signed manifest file contains two sections: |
||||
|
||||
- **Signed message -** Contains plugin metadata and plugin files with their respective checksums (SHA256). |
||||
- **Digital signature -** Created by encrypting the signed message using a private key. Grafana has a public key built-in that can be used to verify that the digital signature has been encrypted using the expected private key. |
||||
|
||||
**Example** |
||||
|
||||
```txt |
||||
-----BEGIN PGP SIGNED MESSAGE----- |
||||
Hash: SHA512 |
||||
|
||||
{ |
||||
"manifestVersion": "2.0.0", |
||||
"signatureType": "community", |
||||
"signedByOrg": "myorgid", |
||||
"signedByOrgName": "My Org", |
||||
"plugin": "myorgid-simple-panel", |
||||
"version": "1.0.0", |
||||
"time": 1602753404133, |
||||
"keyId": "7e4d0c6a708866e7", |
||||
"files": { |
||||
"LICENSE": "12ab7a0961275f5ce7a428e662279cf49bab887d12b2ff7bfde738346178c28c", |
||||
"module.js.LICENSE.txt": "0d8f66cd4afb566cb5b7e1540c68f43b939d3eba12ace290f18abc4f4cb53ed0", |
||||
"module.js.map": "8a4ede5b5847dec1c6c30008d07bef8a049408d2b1e862841e30357f82e0fa19", |
||||
"plugin.json": "13be5f2fd55bee787c5413b5ba6a1fae2dfe8d2df6c867dadc4657b98f821f90", |
||||
"README.md": "2d90145b28f22348d4f50a81695e888c68ebd4f8baec731fdf2d79c8b187a27f", |
||||
"module.js": "b4b6945bbf3332b08e5e1cb214a5b85c82557b292577eb58c8eb1703bc8e4577" |
||||
} |
||||
} |
||||
-----BEGIN PGP SIGNATURE----- |
||||
Version: OpenPGP.js v4.10.1 |
||||
Comment: https://openpgpjs.org |
||||
|
||||
wqEEARMKAAYFAl+IE3wACgkQfk0ManCIZudpdwIHTCqjVzfm7DechTa7BTbd |
||||
+dNIQtwh8Tv2Q9HksgN6c6M9nbQTP0xNHwxSxHOI8EL3euz/OagzWoiIWulG |
||||
7AQo7FYCCQGucaLPPK3tsWaeFqVKy+JtQhrJJui23DAZLSYQYZlKQ+nFqc9x |
||||
T6scfmuhWC/TOcm83EVoCzIV3R5dOTKHqkjIUg== |
||||
=GdNq |
||||
-----END PGP SIGNATURE----- |
||||
``` |
||||
|
||||
## Troubleshooting |
||||
|
||||
### Why do I get a "Modified signature" error? |
||||
|
||||
In some cases an invalid `MANIFEST.txt` is generated because of an issue when signing the plugin on Windows. You can fix this by replacing all double backslashes, `\\`, with a forward slash, `/`, in the `MANIFEST.txt` file. You need to do this every time you sign your plugin. |
||||
|
||||
### Why do I get a "Field is required: `rootUrls`" error for my public plugin? |
||||
|
||||
With a **public** plugin, your plugin doesn't have a plugin signature level assigned to it yet. A Grafana team member will assign a signature level to your plugin once it has been reviewed and approved. For more information, refer to [Sign a public plugin](#sign-a-public-plugin). |
||||
|
||||
### Why do I get a "Field is required: `rootUrls`" error for my private plugin? |
||||
|
||||
With a **private** plugin, you need to add a `rootUrls` flag to the `plugin:sign` command. The `rootUrls` must match the [root_url]({{< relref "../../setup-grafana/configure-grafana/#root_url" >}}) configuration. For more information, refer to [Sign a private plugin](#sign-a-private-plugin). |
||||
|
||||
If you still get this error, make sure that the API key was generated by a Grafana Cloud account that matches the first part of the plugin ID. |
||||
@ -1,121 +0,0 @@ |
||||
--- |
||||
title: Work with data frames |
||||
--- |
||||
|
||||
# Work with data frames |
||||
|
||||
The [data frame]({{< relref "data-frames" >}}) is a columnar data structure that allows for efficient querying of large amounts of data. Since data frames are a central concept when developing plugins for Grafana, in this guide we'll look at some ways you can use them. |
||||
|
||||
The `DataFrame` interface contains a `name` and an array of `fields` where each field contains the name, type, and the values for the field. |
||||
|
||||
> **Note:** If you want to migrate an existing plugin to use the data frame format, refer to [Migrate to data frames]({{< relref "migration-guide/#migrate-to-data-frames" >}}). |
||||
|
||||
## Create a data frame |
||||
|
||||
If you build a data source plugin, then you'll most likely want to convert a response from an external API to a data frame. Let's look at how to do this. |
||||
|
||||
Let's start with creating a simple data frame that represents a time series. The easiest way to create a data frame is to use the `toDataFrame` function. |
||||
|
||||
```ts |
||||
// Need to be of the same length. |
||||
const timeValues = [1599471973065, 1599471975729]; |
||||
const numberValues = [12.3, 28.6]; |
||||
|
||||
// Create data frame from values. |
||||
const frame = toDataFrame({ |
||||
name: 'http_requests_total', |
||||
fields: [ |
||||
{ name: 'Time', type: FieldType.time, values: timeValues }, |
||||
{ name: 'Value', type: FieldType.number, values: numberValues }, |
||||
], |
||||
}); |
||||
``` |
||||
|
||||
> **Note:** Data frames representing time series contain at least a `time` field and a `number` field. By convention, built-in plugins use `Time` and `Value` as field names for data frames containing time series data. |
||||
|
||||
As you can see from the example, to create data frames like this, your data must already be stored as columnar data. If you already have the records in the form of an array of objects, then you can pass it to `toDataFrame`. In this case, `toDataFrame` tries to guess the schema based on the types and names of the objects in the array. To create complex data frames this way, be sure to verify that you get the schema you expect. |
||||
|
||||
```ts |
||||
const series = [ |
||||
{ Time: 1599471973065, Value: 12.3 }, |
||||
{ Time: 1599471975729, Value: 28.6 }, |
||||
]; |
||||
|
||||
const frame = toDataFrame(series); |
||||
frame.name = 'http_requests_total'; |
||||
``` |
||||
|
||||
## Read values from a data frame |
||||
|
||||
When you're building a panel plugin, the data frames returned by the data source are available from the `data` prop in your panel component. |
||||
|
||||
```ts |
||||
function SimplePanel({ data: Props }) { |
||||
const frame = data.series[0]; |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
Before you start reading the data, think about what data you expect. For example, to visualize a time series you need at least one time field and one number field. |
||||
|
||||
```ts |
||||
const timeField = frame.fields.find((field) => field.type === FieldType.time); |
||||
const valueField = frame.fields.find((field) => field.type === FieldType.number); |
||||
``` |
||||
|
||||
Other types of visualizations might need multiple dimensions. For example, a bubble chart that uses three numeric fields: the X-axis, Y-axis, and one for the radius of each bubble. In this case, instead of hard coding the field names, we recommend that you let the user choose the field to use for each dimension. |
||||
|
||||
```ts |
||||
const x = frame.fields.find((field) => field.name === xField); |
||||
const y = frame.fields.find((field) => field.name === yField); |
||||
const size = frame.fields.find((field) => field.name === sizeField); |
||||
|
||||
for (let i = 0; i < frame.length; i++) { |
||||
const row = [x?.values.get(i), y?.values.get(i), size?.values.get(i)]; |
||||
|
||||
// ... |
||||
} |
||||
``` |
||||
|
||||
Alternatively, you can use the `DataFrameView`, which gives you an array of objects that contain a property for each field in the frame. |
||||
|
||||
```ts |
||||
const view = new DataFrameView(frame); |
||||
|
||||
view.forEach((row) => { |
||||
console.log(row[options.xField], row[options.yField], row[options.sizeField]); |
||||
}); |
||||
``` |
||||
|
||||
## Display values from a data frame |
||||
|
||||
Field options let the user control how Grafana displays the data in a data frame. |
||||
|
||||
To apply the field options to a value, use the `display` method on the corresponding field. The result contains information such as the color and suffix to use when display the value. |
||||
|
||||
```ts |
||||
const valueField = frame.fields.find((field) => field.type === FieldType.number); |
||||
|
||||
return ( |
||||
<div> |
||||
{valueField |
||||
? valueField.values.toArray().map((value) => { |
||||
const displayValue = valueField.display!(value); |
||||
return ( |
||||
<p style={{ color: displayValue.color }}> |
||||
{displayValue.text} {displayValue.suffix ? displayValue.suffix : ''} |
||||
</p> |
||||
); |
||||
}) |
||||
: null} |
||||
</div> |
||||
); |
||||
``` |
||||
|
||||
To apply field options to the name of a field, use `getFieldDisplayName`. |
||||
|
||||
```ts |
||||
const valueField = frame.fields.find((field) => field.type === FieldType.number); |
||||
const valueFieldName = getFieldDisplayName(valueField, frame); |
||||
``` |
||||
Loading…
Reference in new issue