О пакетах поддержки GitHub Enterprise Server

О пакетах поддержки

Support bundle — это сжатый архив диагностических данных из вашего GitHub Enterprise Server экземпляра. Вы можете использовать пакеты поддержки для работы с Служба поддержки GitHub по проблемам и для создания отчётов Health Check, которые обобщают конфигурацию, состояние и активность вашего экземпляра.

Когда генерировать пакет поддержки

Сгенерируйте пакет поддержки в нескольких сценариях:

Расследование заявок в поддержку

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

Анализ Health Check

Вы можете создать пакет поддержки для отчёта Health Check. Проверка состояния анализирует данные вашего пакета поддержки и отчитывается о состоянии вашей экземпляри, его безопасности, операциях с Git и использовании API. Для получения дополнительной информации см. Создание проверки работоспособности для предприятия.

Содержимое поддерживающего пучка

Пакеты поддержки содержат несколько категорий данных из вашего экземпляра. Точное содержание зависит от вашей версии и конфигурации GitHub Enterprise Server.

Информация о системе и экземплярах

Пакеты поддержки включают диагностические данные о настройках и среде вашего экземпляра, такие как информация о версии, конфигурации системы, лицензионные данные и результат ghe-diagnostics команды. Полный список диагностической информации смотрите в разделе AUTOTITLE.

Файлы журналов

Пакеты поддержки включают лог-файлы из системных сервисов, приложений и баз данных вашего экземпляра. Объём собранных журнальных данных зависит от типа пучка. Чтобы узнать больше о доступных файлах журнала, смотрите Сведения о системных журналах.

Стандартные и расширенные расслоения

Существует два типа пакетов поддержки. Стандартный набор меньше и быстрее в генерации, тогда как расширенный пакет предоставляет более подробные данные для глубокого устранения неполадок.

	Стандартное расслоение	Расширенный пучок (`-x` флаг)

          **Длительность логарифма** | 2 дня | 8 дней |

Служба поддержки GitHub подскажет, какой тип пакета генерировать. Если сомневаетесь, создайте расширенный пакет, чтобы убедиться, что все диагностические данные доступны. Вы также можете указать пользовательскую длительность логарифма с помощью флага --period (например, --period '4 days').

Статус службы и показатели

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

Информация о высокой доступности

Если ваш экземпляр использует высокую доступность или кластеризацию, пакеты поддержки включают:

Статус репликации и информация о задержках
Конфигурация узла кластера
Детали реплики кэша

Конфиденциальность и безопасность данных

Пакеты поддержки разработаны для помощи в диагностике проблем при защите конфиденциальной информации:

        **Очистка**: Конфиденциальные данные, такие как пароли, токены и приватные ключи, удаляются или скрываются перед сбором.

        **Нет содержимого репозитория**: Пакеты поддержки не включают содержимое ваших Git-репозиториев, такое как исходный код, данные комита или содержимое файлов.

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

        **Информация о лицензии**: В комплекте есть название вашей организации и ссылка на лицензию, чтобы Служба поддержки GitHub могли идентифицировать ваш экземпляр.

Когда вы предоставляете пакет поддержки для Служба поддержки GitHub, GitHub использует данные только для ответа на ваш запрос в поддержку. Для подробностей о том, как GitHub обрабатывает ваши данные, см. Заявление о конфиденциальности GitHub.

Размер пакета поддержки и время генерации

Размер пакета поддержки и время генерации зависят от:

Размер экземпляра и уровень активности
Количество и размер репозиториев
Длительность времени с момента последнего вращения бревна
Независимо от того, использует ли экземпляр кластеризацию или высокую доступность

Типичные пакеты поддержки варьируются от нескольких сотен МБ до нескольких ГБ. Создание пакета может занять от нескольких минут для небольших экземпляров до более часа для очень больших или сильно загруженных экземпляров.

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

        **Загрузка системы**: Создание пакета поддержки использует ресурсы ввода-вывода процессора, памяти и диска.

        **Тайминг**: Если возможно, генерируйте пакеты поддержки в непиковые часы.

        **Режим обслуживания**: Если у вашего экземпляра серьёзные проблемы с производительностью, подумайте о включении режима обслуживания перед созданием пакета поддержки, чтобы убедиться, что он успешно завершится. Для получения дополнительной информации см. [AUTOTITLE](/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode).

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

Команда ghe-support-bundle автоматически выполняется с наименьшим приоритетом CPU и I/O, поэтому производственные нагрузки имеют приоритет. Чтобы ещё больше снизить использование ресурсов во время генерации, вы можете использовать следующие флаги:

        `--no-async` (`-n`): Запускает коллекции последовательно, а не параллельно, снижая конкуренцию ресурсов.

        `--num-jobs 1` (`-l 1`): Ограничивает параллелизм одной веткой коллекции. По умолчанию — одна треть от доступного количества процессоров.

Например, для генерации и загрузки расширенного пакета с минимальным влиянием на производительность:

ghe-support-bundle -x -u --no-async --num-jobs 1

Связь с другими диагностическими инструментами

Пакеты поддержки работают вместе с другими функциями мониторинга и диагностики:

Диагностические файлы

Команда генерирует меньший диагностический файл, ghe-diagnostics содержащий подмножество информации из полного пакета поддержки. Диагностические файлы полезны для быстрых проверок состояния или когда не удаётся сгенерировать полный пакет поддержки. Диагностический вывод также входит в каждый пакет поддержки.

Панели мониторинга

Страница Monitor в Консоль управления предоставляет данные в реальном времени и исторические метрики вашего экземпляра. Для получения дополнительной информации см. About support bundles for GitHub Enterprise Server.

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

Аспекты кластеризации

Если вы используете кластеризацию GitHub Enterprise Server, можно сгенерировать:

        **Пучки на узлы**: поддерживающие пучки для отдельных узлов кластера.

        **Пучки кластера**: Объединённый пучок из всех узлов кластера, использующий `ghe-cluster-support-bundle`.

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

Неудачная генерация пакетов поддержки

Наиболее частой причиной неудачной генерации пучка является недостаток свободного места на диске в /data/user/tmp. Поддерживающие пакеты собираются в этом каталоге до сжатия, поэтому нужно достаточно места для хранения несжатых данных. Проверьте доступное пространство перед генерацией пакета:

df -h /data/user/tmp

Если поколение не получается или занимает необычно много времени, освободите место и /data/user/tmp попробуйте снова. Если проблемы сохраняются, свяжитесь с Служба поддержки GitHub для получения помощи. В качестве альтернативы можно сгенерировать меньший диагностический файл с помощью команды ghe-diagnostics .

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

        [автозаголовок](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs)

        [автозаголовок](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-support-bundle)

        [автозаголовок](/support/contacting-github-support/providing-data-to-github-support)

О пакетах поддержки GitHub Enterprise Server

В этой статье