Keepfast

Введение

Keepfast — это инструмент для анализа производительности, который позволяет анализировать сборку и производительность страниц веб-сайтов, создавать отчёты о производительности и предлагать рекомендации по оптимизации. Это делает мониторинг производительности более удобным.

Основные функции:

• анализ и создание отчётов о сборке, которые позволяют наглядно сравнивать две версии сборки, чтобы как можно раньше выявить проблемы со сборкой;
• тестирование производительности сайта на основе Lighthouse, предоставление различных показателей производительности и соответствующих рекомендаций;
• поддержка Gitee API, позволяющая генерировать отчёт о производительности при каждом новом коммите в репозитории Gitee, а также отслеживать показатели производительности и оценки.

Предварительный просмотр

Посетите эту страницу, чтобы просмотреть эффект отчёта о производительности: https://gitee.com/gitee-frontend/keepfast/commit/19cc7807bfedc13f67ce005d45dec8d3fec79597.

Установка

npm install -g lighthouse @gitee/keepfast

Использование

Создание файла конфигурации

Сначала создайте файл конфигурации для своего проекта:

# Перейдите в каталог вашего проекта
cd /path/to/your/repo

# Инициализируйте файл конфигурации
keepfast init

Затем отредактируйте файл keepfast.config.js, заполните информацию о репозитории. Если ваш проект создан и управляется Vue CLI, вы можете оставить остальную часть конфигурации без изменений.

Генерация отчёта

Запустите тест производительности и сохраните отчёт в файле ./report.json:

keepfast report ./report.json

Загрузка отчёта

Загрузка отчёта вызовет вызов Gitee API. Чтобы Keepfast мог работать с вашим репозиторием, вам необходимо предоставить личный токен доступа. Вы можете создать его на странице Настройки > Личные токены доступа. После создания выполните следующую команду, чтобы добавить переменную среды:

export GITEE_API_ACCESS_TOKEN=ваш личный токен

После этого выполните следующую команду для загрузки отчёта:

keepfast upload ./report.json

Если в текущей ветке есть соответствующий запрос на вытягивание, отчёт будет загружен в комментарии к этому запросу. В противном случае он будет загружен на страницу сведений о текущем коммите.

Использование в Gitee Go

Gitee Go — это служба CI/CD (непрерывной интеграции и непрерывной доставки), предоставляемая Gitee. Пользователи могут автоматизировать процесс сборки и интеграции, создавая собственные процессы сборки.

Создайте файл конвейера в главной ветке вашего репозитория, используя следующую конфигурацию:

version: '1.0'
name: keepfast
displayName: Анализ производительности сборки переднего плана
triggers:
  trigger: auto
  pr:
    branches:
      include:
        - master
variables:
  global:
    - KEEPFAST_API_TOKEN
stages:
  - name: keepfast
    displayName: Анализ производительности сборки переднего плана
    strategy: naturally
    trigger: auto
    steps:
      - step: build@nodejs
        name: keepfast
        displayName: keepfast
        nodeVersion: 14.16.0
        commands:
          - set -e
          - export GITEE_API_ACCESS_TOKEN=$KEEPFAST_API_TOKEN
          - npm install -g yarn lighthouse @gitee/keepfast
          - keepfast upload --branch $GITEE_SOURCE_BRANCH --use-message "Анализ начался, пожалуйста, подождите..."
          - yum install -y epel-release procps chromium
          - yum groupinstall -y "Development Tools"
          - npm install
          - keepfast report --branch $GITEE_SOURCE_BRANCH ./report.json
          - keepfast upload --branch $GITEE_SOURCE_BRANCH ./report.json
        artifacts:
          - name: BUILD_ARTIFACT
            path:
              - ./report.json
        caches:
          - ~/.npm
          - ~/.yarn
          - /var/cache/yum

Затем установите значение переменной среды KEEPFAST_API_TOKEN на странице управления переменными среды репозитория.

Часто задаваемые вопросы

Почему я должен выбрать Keepfast вместо таких инструментов, как lighthouse-ci?

Если вы соответствуете следующим условиям, попробуйте Keepfast:

• у вас есть несколько долгосрочных проектов переднего плана, и вы предъявляете высокие требования к их производительности сборки и производительности загрузки страниц, и вам нужна автоматизация для мониторинга производительности;
• вы являетесь платным пользователем корпоративной версии Gitee и все ваши проекты переднего плана размещены на Gitee; вам нужен инструмент мониторинга производительности, которым можно пользоваться в службе Gitee Go;
• вам не хочется тратить время на изучение и тестирование аналогичных инструментов; вы можете быстро попробовать Keepfast, просто следуя этому документу и копируя команды.

По сравнению с xxxx, функций слишком мало!

Если у вас есть хорошие идеи и предложения по анализу производительности, вы можете обратиться к нам.

Лицензия GPLv3