Администрирование Grafana с помощью CLI сервера Grafana
Вы можете администрировать свой инстанс Grafana с помощью CLI сервера Grafana — небольшого исполняемого файла, поставляемого вместе с сервером Grafana.
CLI сервера Grafana содержит команды plugins и admin, а также глобальные параметры. Чтобы вывести их список, выполните:
grafana cli -hДополнительные сведения читайте далее.
Запуск CLI сервера Grafana
Вы можете запустить CLI сервера Grafana на той же машине, на которой работает сервер Grafana.
Для запуска CLI у вас есть следующие варианты:
- Добавьте путь к бинарным файлам Grafana в переменную окружения
PATH. - Если ваш текущий каталог — это каталог
bin, выполните./grafana cli. - В противном случае вы можете указать полный путь к исполняемому файлу. Например,
/usr/share/grafana/bin/grafanaв Linux иC:\Program Files\GrafanaLabs\grafana\bin\grafana.exeв Windows.
Общий синтаксис команд в CLI сервера Grafana:
grafana cli [global options] command [command options] [arguments...]Note
Некоторые команды, например установка или удаление плагинов, в Linux требуют
sudo. Если вы работаете в Windows, запустите Windows PowerShell от имени администратора.
Глобальные параметры
CLI сервера Grafana позволяет временно переопределять некоторые настройки Grafana по умолчанию. За исключением --help и --version, большинство глобальных параметров используются только разработчиками.
Каждый глобальный параметр применяется только к той команде, в которой он используется. Например, --pluginsDir value не изменяет постоянно место, где Grafana сохраняет плагины. Он изменяет его только для той команды, в которой вы применяете этот параметр.
Отображение справки CLI сервера Grafana
--help или -h отображает справку, включая пути по умолчанию и сведения о конфигурации Docker.
Пример:
grafana cli -hОтображение версии CLI сервера Grafana
--version или -v выводит версию CLI сервера Grafana, запущенную в данный момент.
Пример:
grafana cli -vПереопределение каталога плагинов по умолчанию
--pluginsDir value переопределяет путь к месту, где ваш локальный инстанс Grafana хранит плагины. Используйте этот параметр, если вы хотите установить, обновить или удалить плагин не в каталоге по умолчанию («/var/lib/grafana/plugins») [$GF_PLUGIN_DIR].
Пример:
grafana cli --pluginsDir "/var/lib/grafana/devplugins" plugins install <plugin-id>Переопределение URL репозитория плагинов по умолчанию
--repo value позволяет скачивать и устанавливать или обновлять плагины из репозитория, отличного от репозитория Grafana по умолчанию.
Пример:
grafana cli --repo "https://example.com/plugins" plugins install <plugin-id>Переопределение URL .zip плагина по умолчанию
--pluginUrl value позволяет скачать .zip-файл, содержащий плагин, из локального URL вместо скачивания из источника Grafana по умолчанию.
Пример:
grafana cli --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>Переопределение Transport Layer Security
Внимание: Отключение TLS — это значительный риск для безопасности. Мы не рекомендуем использовать этот параметр.
--insecure позволяет отключить проверку Transport Layer Security (TLS) (небезопасно). Это может понадобиться, если вы скачиваете плагин из источника, отличного от источника по умолчанию.
Пример:
grafana cli --insecure --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>Включение отладочного журналирования
--debug или -d включает отладочное журналирование. Отладочный вывод возвращается и отображается в терминале.
Пример:
grafana cli --debug plugins install <plugin-id>Переопределение параметра конфигурации
--configOverrides — это аргумент командной строки, который действует как переопределение через переменную окружения.
Например, вы можете использовать его, чтобы перенаправить журналирование в другой файл (возможно, чтобы журналировать установку плагинов в Grafana Cloud) или при сбросе пароля администратора, когда у вас нестандартные значения некоторых важных параметров конфигурации (например, местонахождение базы данных).
Пример:
grafana cli --configOverrides cfg:default.paths.log=/dev/null plugins install <plugin-id>Переопределение значения homepath
Задаёт путь для установки/домашнего пути Grafana; по умолчанию используется рабочий каталог. Вам не нужно использовать этот параметр, если при работе с CLI вы находитесь в каталоге установки Grafana.
Пример:
grafana cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>Переопределение файла конфигурации
--config value переопределяет расположение по умолчанию, в котором Grafana ожидает файл конфигурации. Дополнительную информацию о настройке Grafana и расположениях файла конфигурации по умолчанию см. в разделе Configuration.
Пример:
grafana cli --config "/etc/configuration/" admin reset-admin-password mynewpasswordКоманды plugins
Grafana CLI позволяет устанавливать, обновлять и управлять плагинами Grafana. Дополнительную информацию об установке плагинов см. на странице плагинов.
Все перечисленные команды применяются к репозиториям и каталогам Grafana по умолчанию. Вы можете переопределить значения по умолчанию с помощью глобальных параметров.
Вывод списка доступных плагинов
grafana cli plugins list-remoteУстановка последней версии плагина
grafana cli plugins install <plugin-id>Установка определённой версии плагина
grafana cli plugins install <plugin-id> <version>Вывод списка установленных плагинов
grafana cli plugins lsОбновление всех установленных плагинов
grafana cli plugins update-allОбновление одного плагина
grafana cli plugins update <plugin-id>Удаление одного плагина
grafana cli plugins remove <plugin-id>Команды admin
Команды admin доступны только в Grafana 4.1 и более поздних версиях.
Показ всех команд admin
grafana cli adminСброс пароля администратора
grafana cli admin reset-admin-password <new password> сбрасывает пароль пользователя admin с помощью CLI. Это может понадобиться, если вы потеряли пароль администратора. По умолчанию эта команда использует ID пользователя admin по умолчанию, равный 1. Если вам известен ID пользователя admin, вы можете указать ID пользователя с помощью флага --user-id. Если флаг --user-id не указан и команда не может найти пользователя admin, она возвращает список имён пользователей и ID текущих администраторов. По этому списку вы можете определить ID пользователя admin и выполнить команду снова с флагом --user-id.
Если используются два флага для задания homepath и пути к файлу конфигурации, то выполнение команды возвращает эту ошибку:
Could not find config defaults, make sure homepath command line parameter is set or working directory is homepath
Чтобы исправить это, используйте глобальный параметр --homepath, чтобы указать домашний путь Grafana по умолчанию для этой команды:
grafana cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>Если вы не потеряли пароль администратора, мы рекомендуем изменить пароль пользователя в пользовательских настройках (User Preferences) или на вкладке Server Admin > User.
Если вам нужно задать пароль в скрипте, вы можете использовать Grafana User API.
Сброс пароля администратора
Если вы установили Grafana с помощью Homebrew, вы можете сбросить пароль администратора следующей командой:
/opt/homebrew/opt/grafana/bin/grafana cli --config /opt/homebrew/etc/grafana/grafana.ini --homepath /opt/homebrew/opt/grafana/share/grafana --configOverrides cfg:default.paths.data=/opt/homebrew/var/lib/grafana admin reset-admin-password <new password>Сброс пароля администратора для Grafana, развёрнутого с помощью Grafana Operator и использующего внешнюю базу данных
Если вы разворачиваете Grafana с помощью Grafana Operator и настраиваете Grafana на использование внешней базы данных PostgreSQL или MySQL, укажите в команде как homepath, так и файл конфигурации:
grafana cli --homepath /usr/share/grafana --config /etc/grafana/grafana.ini admin reset-admin-password <new password>Если вы этого не сделаете, CLI:
- Не увидит информацию о подключении к базе данных, так как она находится в каталоге вне домашнего пути Grafana
- Настроит базу данных SQLite по умолчанию в
/var/lib/grafanaи сбросит пароль в ней, а не во внешней базе данных
Миграция данных и шифрование паролей
data-migration запускает скрипт, который переносит или очищает данные в вашей базе данных.
encrypt-datasource-passwords переносит пароли из незащищённых полей в поле secure_json_data. Возвращает ok, если не возникла ошибка. Безопасно выполнять несколько раз.
Пример:
grafana cli admin data-migration encrypt-datasource-passwords