@ -22,25 +22,23 @@ The plugin.json file is required for all plugins. When Grafana starts, it scans
| `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. |
| `dependencies` | [object](#dependencies) | **Yes** | Dependency information related to Grafana and other plugins. |
| `$schema` | string | No | Schema definition for the plugin.json file. Used primarily for schema validation. |
| `alerting` | boolean | No | For data source plugins, if the plugin supports alerting. |
| `alerting` | boolean | No | For data source plugins, if the plugin supports alerting. Requires `backend` to be set to `true`. |
| `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 |
| `autoEnabled` | boolean | No | Set to true for app plugins that should be enabled and pinned to the navigation bar 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. |
| `category` | string | No | Plugin category used on the "Add data source" page. Possible values are: `tsdb`, `logging`, `cloud`, `tracing`, `profiling`, `sql`, `enterprise`, `iot`, `other`. |
| `enterpriseFeatures` | [object](#enterprisefeatures) | No | Grafana Enterprise 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. |
| `logs` | boolean | No | For data source plugins, if the plugin supports logs. It may be used to filter logs only features. |
| `metrics` | boolean | No | For data source plugins, if the plugin supports metric queries. Used to enable the plugin in the panel editor. |
| `preload` | boolean | No | Initialize plugin on startup. By default, the plugin initializes on first use. Useful for app plugins that should load without user interaction. |
| `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. |
| `streaming` | boolean | No | For data source plugins, if the plugin supports streaming. Used in Explore to start live streaming. |
| `tracing` | boolean | No | For data source plugins, if the plugin supports tracing. Used for example to link logs (e.g. Loki logs) with tracing plugins. |
## dependencies
@ -69,7 +67,7 @@ Plugin dependency. Used to display information about plugin dependencies in the
"description":"For data source plugins, if the plugin supports annotation queries."
},
"alerting":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports alerting."
},
"backend":{
"type":"boolean",
"description":"If the plugin has a backend component."
},
"executable":{
"type":"string",
"description":"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."
},
"preload":{
"type":"boolean",
"description":"Initialize plugin on startup. By default, the plugin initializes on first use."
},
"state":{
"type":"string",
"description":"Marks a plugin as a pre-release.",
"enum":["alpha","beta"]
},
"includes":{
"type":"array",
"description":"Resources to include in plugin.",
"items":{
"type":"object",
"additionalItems":false,
"properties":{
"uid":{
"type":"string",
"description":"Unique identifier of the included resource"
"description":"(Legacy) The Angular component to use for a page."
},
"role":{
"type":"string",
"description":"The minimum role a user must have to see this page in the navigation menu.",
"enum":["Admin","Editor","Viewer"]
},
"path":{
"type":"string",
"description":"Used for app plugins."
},
"addToNav":{
"type":"boolean",
"description":"Add the include to the navigation menu."
},
"defaultNav":{
"type":"boolean",
"description":"Page or dashboard when user clicks the icon in the side menu."
},
"icon":{
"type":"string",
"description":"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)."
}
}
}
},
"logs":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports logs."
},
"skipDataQuery":{
"type":"boolean",
"description":"For panel plugins. Hides the query editor."
},
"metrics":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports metric queries. Used in Explore."
},
"streaming":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports streaming."
},
"tables":{
"type":"boolean",
"description":"This is an undocumented feature."
},
"tracing":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports tracing."
},
"hiddenQueries":{
"type":"boolean",
"description":"For data source plugins, include hidden queries in the data request."
},
"autoEnabled":{
"type":"boolean",
"description":"Set to true for app plugins that should be enabled by default in all orgs"
},
"info":{
"type":"object",
"description":"Metadata for the plugin. Some fields are used on the plugins page in Grafana and others on grafana.com if the plugin is published.",
@ -308,6 +148,166 @@
}
}
},
"name":{
"type":"string",
"description":"Human-readable name of the plugin that is shown to the user in the UI."
},
"dependencies":{
"type":"object",
"description":"Dependency information related to Grafana and other plugins.",
"required":["grafanaDependency"],
"additionalProperties":false,
"properties":{
"grafanaVersion":{
"type":"string",
"description":"(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.",
"pattern":"^([0-9]+)(\\.[0-9x]+)?(\\.[0-9x])?$"
},
"grafanaDependency":{
"type":"string",
"description":"Required Grafana version for this plugin. Validated using https://github.com/npm/node-semver.",
"description":"Grafana Enterprise specific features",
"additionalProperties":true,
"properties":{
"healthDiagnosticsErrors":{
"type":"boolean",
"description":"Enable/Disable health diagnostics errors. Requires Grafana >=7.5.5.",
"default":false
}
}
},
"executable":{
"type":"string",
"description":"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."
},
"hideFromList":{
"type":"boolean",
"description":"[internal only] Excludes the plugin from listings in Grafana's UI. Only allowed for `builtIn` plugins."
},
"includes":{
"type":"array",
"description":"Resources to include in plugin.",
"items":{
"type":"object",
"additionalItems":false,
"properties":{
"uid":{
"type":"string",
"description":"Unique identifier of the included resource"
"description":"(Legacy) The Angular component to use for a page."
},
"role":{
"type":"string",
"description":"The minimum role a user must have to see this page in the navigation menu.",
"enum":["Admin","Editor","Viewer"]
},
"path":{
"type":"string",
"description":"Used for app plugins."
},
"addToNav":{
"type":"boolean",
"description":"Add the include to the navigation menu."
},
"defaultNav":{
"type":"boolean",
"description":"Page or dashboard when user clicks the icon in the side menu."
},
"icon":{
"type":"string",
"description":"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)."
}
}
}
},
"logs":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports logs. It may be used to filter logs only features."
},
"metrics":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports metric queries. Used to enable the plugin in the panel editor."
},
"pascalName":{
"type":"string",
"description":"[internal only] The PascalCase name for the plugin. Used for creating machine-friendly identifiers, typically in code generation. If not provided, defaults to name, but title-cased and sanitized (only alphabetical characters allowed).",
"pattern":"^([A-Z][a-zA-Z]{1,62})$"
},
"preload":{
"type":"boolean",
"description":"Initialize plugin on startup. By default, the plugin initializes on first use. Useful for app plugins that should load without user interaction."
},
"queryOptions":{
"type":"object",
"description":"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.",
@ -461,17 +461,22 @@
}
}
},
"enterpriseFeatures":{
"type":"object",
"description":"Grafana Enterprise specific features.",
"additionalProperties":true,
"properties":{
"healthDiagnosticsErrors":{
"type":"boolean",
"description":"Enable/Disable health diagnostics errors. Requires Grafana >=7.5.5.",
"default":false
}
}
"skipDataQuery":{
"type":"boolean",
"description":"For panel plugins. Hides the query editor."
},
"state":{
"type":"string",
"description":"Marks a plugin as a pre-release.",
"enum":["alpha","beta"]
},
"streaming":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports streaming. Used in Explore to start live streaming."
},
"tracing":{
"type":"boolean",
"description":"For data source plugins, if the plugin supports tracing. Used for example to link logs (e.g. Loki logs) with tracing plugins."
Andres Martinez Gotor
2 years ago
committed by