Документация Grafana Документация GlaberGraph Как код Наблюдаемость как код Grafana CLI grafanactl CLI (устарело)

Установка и настройка CLI grafanactl

Инструмент командной строки grafanactl позволяет аутентифицироваться, управлять несколькими средами и выполнять административные задачи через REST API Grafana — всё это из терминала. Он доступен для Grafana OSS, Enterprise и Cloud.

Установка Grafana CLI grafanactl

Проект можно установить одним из следующих поддерживаемых способов:

1. Загрузить готовый бинарный файл

Загрузите последний бинарный файл для вашей платформы со страницы релизов.

Готовые бинарные файлы доступны для различных операционных систем и архитектур. Откройте страницу последнего релиза и прокрутите вниз до раздела Assets.

Чтобы установить бинарный файл, следуйте инструкциям ниже:

1. Загрузите архив для нужной операционной системы и архитектуры
2. Распакуйте архив
3. Переместите исполняемый файл в нужный каталог
4. Убедитесь, что этот каталог включён в переменную среды PATH
5. Проверьте, что у файла есть права на выполнение

2. Собрать из исходного кода

Чтобы собрать grafanactl из исходного кода, необходимо:

• Установленный git
• Установленный go версии 1.24 (или выше)

Bash Copy

go install github.com/grafana/grafanactl/cmd/grafanactl@latest

Настройка grafanactl

Настроить grafanactl можно двумя способами: с помощью переменных среды или через файл конфигурации.

• Переменные среды идеальны для сред CI и поддерживают единственный контекст. Полный список поддерживаемых переменных среды доступен в справочной документации.
• Файлы конфигурации позволяют управлять несколькими контекстами, что упрощает переключение между разными экземплярами Grafana.

Настройка Grafana CLI с помощью переменных среды

Grafana CLI взаимодействует с Grafana через REST API, для чего требуются учётные данные аутентификации.

Как минимум задайте URL вашего экземпляра Grafana и идентификатор организации:

Bash Copy

GRAFANA_SERVER='http://localhost:3000' GRAFANA_ORG_ID='1' grafanactl config check

В зависимости от метода аутентификации вам также может потребоваться задать:

• Токен для сервисной учётной записи Grafana (рекомендуется)
• Имя пользователя и пароль для базовой аутентификации

Чтобы сохранить конфигурацию, рассмотрите создание контекста.

Использование контекстов конфигурации

Контексты позволяют легко переключаться между несколькими экземплярами Grafana.

По умолчанию CLI использует контекст с именем default. Чтобы настроить его, используйте:

Bash Copy

grafanactl config set contexts.default.grafana.server http://localhost:3000
grafanactl config set contexts.default.grafana.org-id 1

Аутентификация с помощью токена сервисной учётной записи:

Bash Copy

grafanactl config set contexts.default.grafana.token service-account-token

Или используйте базовую аутентификацию:

Bash Copy

grafanactl config set contexts.default.grafana.user admin
grafanactl config set contexts.default.grafana.password admin

Дополнительные контексты можно задать таким же образом:

Bash Copy

grafanactl config set contexts.staging.grafana.server https://staging.grafana.example
grafanactl config set contexts.staging.grafana.org-id 1

Настройка Grafana CLI с помощью файлов конфигурации

Grafana CLI хранит свою конфигурацию в YAML-файле. Расположение файла конфигурации определяется CLI в следующем порядке:

1. Если указан флаг --config, используется указанный файл.
2. Если задана переменная $XDG_CONFIG_HOME: $XDG_CONFIG_HOME/grafanactl/config.yaml
3. Если задана переменная $HOME: $HOME/.config/grafanactl/config.yaml
4. Если задана переменная $XDG_CONFIG_DIRS: $XDG_CONFIG_DIRS/grafanactl/config.yaml

Полезные команды

Проверить текущую конфигурацию:

Bash Copy

grafanactl config check

Вывести список всех доступных контекстов:

Bash Copy

grafanactl config list-contexts

Переключиться на определённый контекст:

Bash Copy

grafanactl config use-context staging

Просмотреть полную конфигурацию:

Bash Copy

grafanactl config view