From 2e148b95e35091f8d2b3a3423984f2b9043e6f3d Mon Sep 17 00:00:00 2001 From: Ashley Harrison Date: Mon, 9 Sep 2024 09:55:26 +0100 Subject: [PATCH] Documentation: Add info for `multiValueFilterOperators` (#1090) Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> --- docusaurus/docs/reference/metadata.md | 57 ++++++++++++++------------- 1 file changed, 29 insertions(+), 28 deletions(-) diff --git a/docusaurus/docs/reference/metadata.md b/docusaurus/docs/reference/metadata.md index bd952358b..d81a5771c 100644 --- a/docusaurus/docs/reference/metadata.md +++ b/docusaurus/docs/reference/metadata.md @@ -18,34 +18,35 @@ The `plugin.json` file is required for all plugins. When Grafana starts, it scan ## Properties -| Property | Type | Required | Description | -| -------------------- | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | string | **Yes** | Unique name of the plugin. If the plugin is published on grafana.com, then the plugin `id` should follow the Grafana naming convention. | -| `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`, `renderer`, `secretsmanager`. | -| `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. 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 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`, `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 `_<$GOOS>_<.exe for Windows>`, e.g. `plugin_linux_amd64`. Combination of $GOOS and $GOARCH can be found here: https://golang.org/doc/install/source#environment. | -| `iam` | [object](#iam) | No | Initialize a service account for the plugin, with a tailored set of RBAC permissions. | -| `includes` | [object](#includes)[] | No | Resources to include in plugin. | -| `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, but when preload is set to true the plugin loads when the Grafana web app loads the first time. Only applicable to app plugins. When setting to true implement [frontend code splitting](../get-started/best-practices.md#app-plugins) to minimise performance implications. | -| `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. | -| `roles` | [object](#roles)[] | No | List of RBAC roles and their default assignments. | -| `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](../how-to-guides/data-source-plugins/add-authentication-for-data-source-plugins). | -| `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. 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. | -| `extensions` | [object](#extensions)[] | No | The list of extensions that the plugin registers below other extension points. | +| Property | Type | Required | Description | +| --------------------------- | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | string | **Yes** | Unique name of the plugin. If the plugin is published on grafana.com, then the plugin `id` should follow the Grafana naming convention. | +| `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`, `renderer`, `secretsmanager`. | +| `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. 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 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`, `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 `_<$GOOS>_<.exe for Windows>`, e.g. `plugin_linux_amd64`. Combination of $GOOS and $GOARCH can be found here: https://golang.org/doc/install/source#environment. | +| `iam` | [object](#iam) | No | Initialize a service account for the plugin, with a tailored set of RBAC permissions. | +| `includes` | [object](#includes)[] | No | Resources to include in plugin. | +| `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. | +| `multiValueFilterOperators` | boolean | No | For data source plugins, if the plugin supports multi value operators in adhoc filters. | +| `preload` | boolean | No | Initialize plugin on startup. By default, the plugin initializes on first use, but when preload is set to true the plugin loads when the Grafana web app loads the first time. Only applicable to app plugins. When setting to `true`, implement [frontend code splitting](../get-started/best-practices.md#app-plugins) to minimise performance implications. | +| `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. | +| `roles` | [object](#roles)[] | No | List of RBAC roles and their default assignments. | +| `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](../how-to-guides/data-source-plugins/add-authentication-for-data-source-plugins). | +| `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. 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. | +| `extensions` | [object](#extensions)[] | No | The list of extensions that the plugin registers below other extension points. | ## dependencies