Предоставление данных для службы поддержки GitHub

Сведения о файлах диагностики и пакетах поддержки

Чтобы упростить устранение неполадок с экземпляром GitHub Enterprise Server в вашей среде, Поддержка GitHub может запросить один или несколько типов данных.

Данные	Формат файла	Описание
Файл диагностики	Открытый текст	Содержит сведения о параметрах и среде экземпляра.
Пакет поддержки	Архив	По умолчанию содержит файл диагностика и файлы журнала с очисткой за последние два дня.
Пакет расширенной поддержки	Архив	Содержит файл диагностика и файлы журнала с очисткой за последние восемь дней.

Сведения об очистке файлов журнала

Маркеры проверки подлинности, ключи и секреты удаляются из файлов журналов в следующих каталогах журналов, содержащихся в пакете поддержки или файле диагностики:

• alambic-logs
• babeld-logs
• codeload-logs
• enterprise-manage-logs
• github-logs
• hookshot-logs
• lfs-server-logs
• semiotic-logs
• task-dispatcher-logs
• pages-logs
• registry-logs
• render-logs
• svn-bridge-logs

Создание и отправка диагностических файлов

Файлы диагностики — это обзор параметров и среды экземпляра GitHub Enterprise Server, которые содержат:

• сведения о клиентской лицензии, включая название компании, дату окончания срока действия и количество пользовательских лицензий;
• номера версий и хэши SHA;
• архитектура виртуальной машины;
• имя узла, частный режим, параметры SSL;
• списки загрузки и процессов;
• Параметры сети
• метод проверки подлинности и подробности;
• количество репозиториев, пользователей и другие данные установки.

Можно скачать диагностику для своего экземпляра из Консоль управления или с помощью программы командной строки ghe-diagnostics.

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

Вы можете создать файл диагностики из Консоль управления, если у вас нет доступа по протоколу SSH.

1. В учетной записи администратора GitHub Enterprise Server в правом верхнем углу любой страницы щелкните .

2. Если вы еще не на странице "Администратор сайта", в левом верхнем углу щелкните Администратор сайта. 1. На боковой панели Администратор сайта щелкните Консоль управления.

3. При появлении запроса введите пароль Консоль управления. 1. На верхней панели навигации щелкните Поддержка.

   

4. Нажмите кнопку Скачать диагностические сведения.

Создание диагностического файла с помощью SSH

Этот метод можно использовать без входа в Консоль управления.

Используйте служебную программу командной строки ghe-diagnostics для получения диагностических сведений для вашего экземпляра.

$ ssh -p122 admin@HOSTNAME -- 'ghe-diagnostics' > diagnostics.txt

Создание и отправка пакетов поддержки

После отправки запроса на поддержку мы можем попросить вас предоставить нашей команде пакет поддержки. Пакет поддержки — это архив tar со сжатием gzip, который включает диагностические данные и важные журналы из вашего экземпляра, такие как:

• журналы, связанные с проверкой подлинности, которые могут быть полезны при устранении ошибок проверки подлинности или настройке LDAP, CAS или SAML;
• журнал Консоль управления;
• github-logs/exceptions.log: сведения об ошибках с кодом 500, возникших на сайте;
• github-logs/audit.log: журналы аудита GitHub Enterprise Server;
• babeld-logs/babeld.log: журналы прокси Git;
• system-logs/haproxy.log: журналы HAProxy;
• elasticsearch-logs/github-enterprise.log: журналы Elasticsearch;
• configuration-logs/ghe-config.log: журналы конфигурации GitHub Enterprise Server;
• collectd/logs/collectd.log: журналы Collectd;
• mail-logs/mail.log: журналы доставки электронной почты SMTP.

Дополнительные сведения см. в разделе Сведения о журнале аудита для предприятия.

Пакеты поддержки включают журналы за последние два дня по умолчанию. Можно указать точную длительность в часах или днях. Чтобы предоставить журналы за последние восемь дней, можно скачать расширенный пакет поддержки. Дополнительные сведения см. в разделе Создание и отправка расширенных пакетов поддержки.

Создание пакета поддержки в Консоль управления

Эти действия можно использовать для создания и отправки пакета поддержки, если вы можете получить доступ к веб-версии Консоль управления и имеете исходящий доступ к Интернету.

1. В учетной записи администратора GitHub Enterprise Server в правом верхнем углу любой страницы щелкните .

2. Если вы еще не на странице "Администратор сайта", в левом верхнем углу щелкните Администратор сайта. 1. На боковой панели Администратор сайта щелкните Консоль управления.

3. При появлении запроса введите пароль Консоль управления. 1. На верхней панели навигации щелкните Поддержка.

   

4. Щелкните Скачать пакет поддержки.

5. Если инженер службы поддержки предоставил вам ссылку для отправки пакета поддержки, используйте эту ссылку. В противном случае перейдите на страницу https://support.github.com/ и войдите (при появлении запроса) в учетную запись предприятия, у которой есть право на поддержку. 1. Перейдите на страницу https://support.github.com/uploads и отправьте пакет поддержки.

Создание пакета поддержки с помощью SSH

Эти действия можно использовать для создания пакета поддержки и совместного использования его, если у вас есть доступ по протоколу SSH к экземпляр GitHub Enterprise Server и есть исходящий доступ к Интернету.

1. Скачайте пакет поддержки через SSH:

   $ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz

   Дополнительные сведения о команде см. в ghe-support-bundle разделе Служебные программы командной строки.
2. Если инженер службы поддержки предоставил вам ссылку для отправки пакета поддержки, используйте эту ссылку. В противном случае перейдите на страницу https://support.github.com/ и войдите (при появлении запроса) в учетную запись предприятия, у которой есть право на поддержку. 1. Перейдите на страницу https://support.github.com/uploads и отправьте пакет поддержки.

Отправка пакета поддержки с использованием учетной записи предприятия

1. Перейдите к GitHub.com.

2. В правом верхнем углу GitHub.com щелкните фотографию профиля и выберите Ваши предприятия.

3. В списке предприятий щелкните предприятие, которое требуется просмотреть. 1. На боковой панели корпоративной учетной записи щелкните Параметры. 1. В разделе параметров щелкните Лицензия.

4. В разделе "Справка по GitHub Enterprise" нажмите Отправить пакет поддержки.

   

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

6. В разделе "Отправить пакет поддержки для Поддержка GitHub Enterprise" нажмите кнопку Выбрать файл или перетащите файл пакета поддержки в поле Выбрать файл, чтобы выбрать пакет поддержки.

7. Щелкните Отправить.

Отправка пакета поддержки напрямую по SSH

Можно отправить пакет поддержки напрямую на наш сервер, если:

• У вас есть доступ по протоколу SSH к экземпляр GitHub Enterprise Server.
• Исходящие подключения HTTPS через TCP-порт 443 разрешены из экземпляр GitHub Enterprise Server в enterprise-bundles.github.com и esbtoolsproduction.blob.core.windows.net.

1. Отправьте пакет на наш сервер пакетов поддержки:

   $ ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u'

Создание и отправка расширенных пакетов поддержки

Пакеты поддержки включают журналы за последние два дня по умолчанию, а пакеты расширенной поддержки включают журналы за последние восемь дней. Если события, которые изучает Поддержка GitHub произошли более двух дней назад, мы можем попросить вас предоставить расширенный пакет поддержки. Вам потребуется доступ по протоколу SSH для скачивания расширенного пакета. Нельзя скачать расширенный пакет с помощью Консоль управления.

Чтобы избежать создания слишком больших пакетов, пакеты содержат только журналы, которые не были ротированы и сжаты. Ротация журналов в GitHub Enterprise Server выполняется с различной периодичностью (ежедневно или еженедельно) для разных файлов журналов в зависимости от того, насколько большим ожидается их размер.

Создание пакета расширенной поддержки с помощью SSH

Эти действия можно использовать для создания и совместного использования расширенного пакета поддержки, если у вас есть доступ по протоколу SSH к экземпляр GitHub Enterprise Server и у вас есть исходящий доступ к Интернету.

1. Скачайте пакет расширенной поддержки через SSH, добавив флаг -x в команду ghe-support-bundle:

   $ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o -x' > support-bundle.tgz

2. Если инженер службы поддержки предоставил вам ссылку для отправки пакета поддержки, используйте эту ссылку. В противном случае перейдите на страницу https://support.github.com/ и войдите (при появлении запроса) в учетную запись предприятия, у которой есть право на поддержку. 1. Перейдите на страницу https://support.github.com/uploads и отправьте пакет поддержки.

Отправка пакета расширенной поддержки напрямую с помощью SSH

Можно отправить пакет поддержки напрямую на наш сервер, если:

• У вас есть доступ по протоколу SSH к экземпляр GitHub Enterprise Server.
• Исходящие подключения HTTPS через TCP-порт 443 разрешены из экземпляр GitHub Enterprise Server в enterprise-bundles.github.com и esbtoolsproduction.blob.core.windows.net.

1. Отправьте пакет на наш сервер пакетов поддержки:

   $ ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u -x'

Дополнительные материалы

• "Сведения о поддержке GitHub"
• "Создание проверки работоспособности для предприятия"