+++
# -------------------------------------------------------------------------
# Do not edit this file. It is automatically generated by json-schema-docs.
# -------------------------------------------------------------------------
title = "plugin.json"
keywords = ["harvest", "plugins", "documentation"]
aliases = ["/docs/harvest/latest/plugins/developing/plugin.json/"]
+++

# plugin.json

Файл plugin.json необходим для всех плагинов. Когда запускается Harvest, он сканирует папки плагинов и монтирует каждую папку, содержащую файл plugin.json, если только папка не содержит вложенную папку с именем dist. В этом случае Harvest вместо этого монтирует папку dist.

## Свойства

| Свойство | Тип | Требуется | Описание |
|-----------------|-------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `зависимости`  | [объект](#зависимости) | **Да** | Зависимости, необходимые плагину.                                                                                                                                                                                                                                                                                                                                                                      |
| `id` | строка | **Да** | Уникальное имя плагина. Если плагин опубликован на harvest.com , то идентификатор плагина должен соответствовать соглашениям об именовании.                                                                                                                                                                                                                                                                          |
| `информация`          | [объект](#информация) | **Да** | Метаданные для плагина. Некоторые поля используются на странице плагинов в Harvest, а другие - на harvest.com если плагин опубликован.                                                                                                                                                                                                                                                                      |
| `name` | строка | **Да** | Удобочитаемое имя плагина, которое отображается пользователю в пользовательском интерфейсе.                                                                                                                                                                                                                                                                                                                                  |
| `type` | строка | **Да** | Тип плагина. Возможные значения: `app`, `datasource`, `panel`.                                                                                                                                                                                                                                                                                                                                         |
| `$схема`       | string | No | Определение схемы для файла plugin.json |
| `оповещение` | логическое значение | Нет | Для плагинов источника данных. Если плагин поддерживает оповещение.                                                                                                                                                                                                                                                                                                                                               |
| `аннотации` | логическое значение | Нет | Для плагинов источника данных. Если плагин поддерживает запросы аннотаций.                                                                                                                                                                                                                                                                                                                                     |
| `autoEnabled` | логическое значение | Нет | Установлено значение true для плагинов приложений, которые должны быть включены по умолчанию во всех организациях |
| `backend` | логическое значение | Нет | Если у плагина есть серверный компонент.                                                                                                                                                                                                                                                                                                                                                                  |
| `категория`      | строка | Нет | Категория плагина, используемая на странице Добавления источника данных. Возможные значения: `tsdb`, `ведение журнала`, `облако`, `трассировка`, `sql`, `предприятие`, `другое`.                                                                                                                                                                                                                                                             |
| `исполняемый файл` | строка | No | Первая часть имени файла исполняемого файла серверного компонента. Может быть несколько исполняемых файлов, созданных для разных операционных систем и архитектуры. Harvest проверит наличие исполняемых файлов с именем `<исполняемый файл>_<$GOOS>_<строчный $GOARCH><.exe для Windows>`, например `plugin_linux_amd64`. Комбинацию $GOOS и $GOARCH можно найти здесь: https://golang.org/doc/install/source#environment . |
| `Скрытые запросы` | логическое значение | Нет | |
| `включает в себя`      | [объект](#включает)[] | Нет | Ресурсов для включения в плагин.                                                                                                                                                                                                                                                                                                                                                                         |
| `logs` | лог Если плагин поддерживает журналы.                                                                                                                                                                                                                                                                                                                                                   |
| `metrics` | логическое значение | Нет | Для плагинов источника данных. Если плагин поддерживает метрические запросы. Используется в функции исследования.                                                                                                                                                                                                                                                                                                            |
| `предварительная загрузка` | логическое значение | Нет | Инициализировать плагин при запуске. По умолчанию плагин инициализируется при первом использовании.                                                                                                                                                                                                                                                                                                                          |
| `Варианты запросов`  | [объект](#варианты запроса) | Нет | Для плагинов источника данных. В редакторе запросов плагина есть раздел параметров запроса, и при необходимости эти параметры можно включить.                                                                                                                                                                                                                                                                    |
| `маршруты`        | [объект](#маршруты)[] | Нет | Для плагинов источника данных. Прокси-маршруты, используемые для аутентификации плагина и добавления заголовков к HTTP-запросам, выполняемым плагином. Для получения дополнительной информации обратитесь к [Добавить аутентификацию для плагинов источника данных]({{< relref "add-authentication-for-data-source-plugins.md ">}}).                                                                                                                       |
| `skipDataQuery` | логическое значение | Нет | Для плагинов панели. Скрывает редактор запросов.                                                                                                                                                                                                                                                                                                                                                              |
                                                                                                                                                                                                                                                                                                                                              |

## зависимости

Зависимости, необходимые плагину.

### Свойства

| Свойство | Тип | Требуется | Описание |
|---------------------|----------------------|----------|-------------------------------------------------------------------------------------------------------------------------------|
| `| `Зависимость от графаны` | строка | **Да** | Требуется версия Harvest для этого плагина. Проверено с помощью https://github.com/npm/node-semver .                                 |
| `| `Версия harvest` | строка | Нет | (Устаревшая) Требуется версия Harvest для этого плагина, например `6.x.x 7.x.x` для обозначения плагина требуется версия Harvest v6.x.x или v7.x.x. |
| `плагины`           | [object](#plugins)[] | Нет | Массив необходимых плагинов, от которых зависит этот плагин.                                                                    |
### плагины

Зависимость от плагина. Используется для отображения информации о зависимостях плагинов в пользовательском интерфейсе Harvest.

#### Свойства

| Свойство | Тип | Требуется | Описание |
|-----------|--------|----------|----------------------------------------------------|
| `id` | строка | **Да** | |
| `имя` | строка | **Да** | |
| `тип` | строка | **Да** | Возможные значения: `приложение`, `источник данных`, `панель`. |
| `версия` | строка | **Да** | |

## включает в себя

### Свойства

| Свойство | Тип | Требуется | Описание |
|--------------|---------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `addToNav` | логическое значение | Нет | Добавьте включить в боковое меню.                                                                                                                                                               |
| `component` | строка | Нет | (устаревший) Угловой компонент, используемый для страницы.                                                                                                                                               |
| `defaultNav` | логическое значение | Нет | Страница или панель мониторинга, когда пользователь нажимает на значок в боковом меню.                                                                                                                                   |
| `значок`       | строка | Нет | Значок для использования в боковом меню. Для получения информации о доступных значках см. раздел [Значки Overview](https://developers.harvest.com/ui/latest/index.html?path=/story/docs-overview-icon--icons-overview). |
| `имя` | строка | Нет | |
| `path` | string | No | Используется для плагинов приложений.                                                                                                                                                                           |
| `роль`       | string | No | Возможные значения: `Admin`, `Editor`, `Viewer`.                                                                                                                                               |
| `тип` | строка | Нет | Возможные значения: `панель мониторинга`, `страница`, `панель`, `источник данных`.                                                                                                                                |
## информация

Метаданные для плагина. Некоторые поля используются на странице плагинов в Harvest, а другие - на harvest.com если плагин опубликован.

### Свойства

| Свойство | Тип | Требуется | Описание |
|---------------|--------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------|
| `ключевые слова`    | строка[] | **Да** | Массив ключевых слов плагина. Используется для поиска по harvest.com .                                                                     |
| `логотипы`       | [объект](#логотипы)         | ** Да ** | Изображения SVG, которые используются в качестве значков плагинов.                                                                                     |
| `обновлено` | строка | **Да** | Дата создания этого плагина.                                                                                              |
| `version` | строка | **Да** | Версия проекта этого коммита, например `6.7.x`.                                                                                 |
| `автор`      | [объект](#автор) | Нет | Информация об авторе плагина.                                                                                          |
| `построить`       | [объект](#сборка) | Нет | Информация о сборке |
| `description` | строка | Нет | Описание плагина. Используется на странице плагинов в Harvest и для поиска на harvest.com .                                     |
| `ссылки`       | [объект](#ссылки)[] | Нет | Массив объектов ссылок, которые будут отображаться на странице проекта этого плагина в форме `{name: 'foo', url: 'http://example.com '}` |
| `скриншоты` | [объект](#скриншоты)[] | Нет | Массив объектов скриншотов в виде `{имя: 'bar', путь: 'img/screenshot.png'}` |
### автор

Информация об авторе плагина.

#### Свойства

| Свойство | Тип | Требуется | Описание |
|----------|--------|----------|---------------------------|
| `email` | строка | Нет | Имя автора.            |
| `name` | строка | Нет | Имя автора.            |
| `url` | строка | Нет | Ссылка на веб-сайт автора. |
### строить

Информация о сборке

#### Свойства

| Свойство | Тип | Требуется | Описание |
|----------|--------|----------|------------------------------------------------------|
| `branch` | string | No | Ветка Git, из которой был создан плагин.                |
| `hash` | string | No | Git хэш коммита, из которого был создан плагин |
| `номер` | номер | Нет | |
| `pr` | number | No | запрос на извлечение GitHub плагин был создан из |
| `repo` | строка | Нет | |
| `time` | number | No | Время, когда был создан плагин, как временная метка Unix. |
### ссылки

#### Свойства

| Свойство | Тип | Требуется | Описание |
|----------|--------|----------|-------------|
| `имя` | строка | Нет | |
| `url` | строка | Нет | |

### логотипы

SVG-изображения, которые используются в качестве значков плагинов.

#### Свойства

| Свойство | Тип | Требуется | Описание |
|----------|--------|----------|------------------------------------------------------------------------------------------------------------------------------|
| `large` | строка | **Да** | Ссылка на "большую" версию логотипа плагина, которая должна быть изображением SVG. "Большие" и "маленькие" логотипы могут быть одним и тем же изображением. |
| `small` | строка | **Да** | Ссылка на "маленькую" версию логотипа плагина, которая должна быть изображением SVG. "Большие" и "маленькие" логотипы могут быть одним и тем же изображением. |
### скриншоты

#### Свойства

| Свойство | Тип | Требуется | Описание |
|----------|--------|----------|-------------|
| `имя` | строка | Нет | |
| `путь` | строка | Нет | |

## ## параметры запроса

Для плагинов источника данных. В редакторе запросов плагинов есть раздел параметров запроса, и при необходимости эти параметры можно включить.

### Свойства

| Свойство | Тип | Требуется | Описание |
|-----------------|---------|----------|----------------------------------------------------------------------------------------------------------------------------|
| `| `тайм-аут кэша`  | логическое значение | Нет | Для плагинов источника данных. Если параметр "тайм-аут кэша" должен быть показан в разделе "Параметры запроса" в редакторе запросов.   |
| `maxDataPoints` | логическое значение | Нет | Для плагинов источника данных. Если параметр `maxdatapoints` должен быть показан в разделе "Параметры запроса" в редакторе запросов. |
| `| `минимальный интервал` | логическое значение | Нет | Для плагинов источника данных. Если параметр "минимальный интервал` должен быть показан в разделе "Параметры запроса" в редакторе запросов.    |
## маршруты

Для плагинов источника данных. Прокси-маршруты, используемые для аутентификации плагина и добавления заголовков к HTTP-запросам, выполняемым плагином. Для получения дополнительной информации обратитесь к [Добавить аутентификацию для плагинов источника данных]({{< rel ref "add-authentication-for-data-source-plugins.md ">}}).

### Свойства

| Свойство | Тип | Требуется | Описание |
|----------------|-------------------------|----------|---------------------------------------------------------------------------------------------------------|
| `body` | [object](#body) | Нет | Для плагинов источника данных. Заголовки маршрута задают содержание и длину тела прокси-запроса.          |
| `headers` | array | No | Для плагинов источника данных. Заголовки маршрута добавляют HTTP-заголовки к проксируемому запросу.                        |
| `jwttokenauth` | [объект](#jwttokenauth) | Нет | Для плагинов источника данных. Раздел аутентификации токена, используемый с помощью JWT OAuth API.                       |
| `метод`       | string | No | Для плагинов источника данных. Метод Route соответствует HTTP-глаголу типа GET или POST.                           |
| `path` | string | No | Для плагинов источника данных. Путь маршрута, который заменяется полем URL маршрута при проксировании вызова. |
| `Роль`      | строка | Нет | |
| `reqSignedIn` | логическое значение | Нет | |
| `tokenAuth` | [объект](#tokenauth) | Нет | Для плагинов источника данных. Раздел проверки подлинности токена, используемый с OAuth API.                           |
| `url` | string | No | Для плагинов источника данных. URL-адрес маршрута - это адрес, по которому передается запрос.                                  |
### тело

Для плагинов источника данных. Заголовки маршрута задают содержание и длину тела прокси-запроса.

| Свойство | Тип | Требуется | Описание |
|----------|------|----------|-------------|

### ### Аутентификация токена jwt

Для плагинов источника данных. Раздел аутентификации токена, используемый с помощью JWT OAuth API.

#### Свойства

| Свойство | Тип | Требуется | Описание |
|----------|-------------------|----------|------------------------------------------------------|
| `params` | [object](#params) | No | Параметры для запроса аутентификации токена JWT. |
| `области видимости` | строка | Нет | |
| `url` | string | No | URL для извлечения токена JWT.                          |
#### параметры

Параметры для запроса аутентификации токена JWT.

##### Свойства

| Свойство | Тип | Требуется | Описание |
|----------------|----------|----------|-------------|
| `client_email` | строка | Нет | |
| `private_key` | строка | Нет | |
| `области применения`       | строка[] | Нет | |
| `token_uri` | строка | Нет | |
### Токенавторство

Для плагинов источника данных. Раздел проверки подлинности токена, используемый с OAuth API.

#### Свойства

| Свойство | Тип | Требуется | Описание |
|----------|-------------------|----------|--------------------------------------------------|
| `params` | [object](#params) | No | Параметры для запроса аутентификации токена. |
| `области видимости` | строка | Нет | |
| `url` | string | No | URL для получения токена аутентификации.           |
#### параметры

Параметры для запроса аутентификации токена.

##### Свойства

| Свойство | Тип | Требуется | Описание |
|-----------------|--------|----------|-------------------------------------------------------------------------------------------|
| `client_id` | строка | Нет | идентификатор клиента OAuth |
| `client_secret` | строка | Нет | OAuth секрет клиента. Обычно заполняется путем расшифровки секрета из защищенного двоичного объекта Json. |
| `grant_type` | строка | Нет | Тип предоставления OAuth |
| `resource` | строка | Нет | OAuth ресурса |

