Acerca de los paquetes de soporte técnico para GitHub Enterprise Server

Acerca de las agrupaciones de soporte técnico

Un paquete de soporte es un archivo comprimido de datos de diagnóstico de su instancia GitHub Enterprise Server. Puede usar paquetes de soporte para trabajar con Soporte de GitHub en problemas y generar informes de comprobación del estado que resumen la configuración, el estado y la actividad de su instancia.

Cuándo generar un paquete de soporte técnico

Genere un paquete de soporte técnico en varios escenarios:

Investigación de tickets de soporte técnico

Soporte de GitHub puede solicitar un paquete de soporte técnico al investigar problemas de rendimiento, errores de servicio, problemas de autenticación u otros problemas operativos. Abra primero una incidencia de soporte técnico, luego genere el paquete e incluya el número de incidencia para asociarlo con su caso. Para obtener más información, consulte Utilidades de la línea de comandos.

Análisis de salud

Puede generar un paquete de soporte para crear un informe de verificación del estado. Las comprobaciones de estado analizan los datos de agrupación de soporte técnico e informan sobre el estado, la seguridad, las operaciones de Git y el uso de la API de la instancia. Para obtener más información, vea Generar una evaluación de salud para su empresa.

Contenido de un paquete de soporte técnico

Los paquetes de soporte técnico contienen varias categorías de datos de la instancia. El contenido exacto depende de la GitHub Enterprise Server versión y la configuración.

Información del sistema e instancia

Los paquetes de soporte técnico incluyen datos de diagnóstico sobre la configuración y el entorno de la instancia, como la información de versión, la configuración del sistema, los detalles de licencia y la salida del ghe-diagnostics comando. Para obtener una lista completa de la información de diagnóstico, consulte Proporcionar datos al soporte técnico de GitHub.

Archivos de registro

Los paquetes de soporte técnico incluyen archivos de registro de los servicios del sistema, las aplicaciones y las bases de datos de la instancia. La cantidad de datos de registro recopilados depende del tipo de agrupación. Para más información sobre los archivos de registro disponibles, consulte Acerca de los registros del sistema.

Agrupaciones estándar y extendidas

Hay dos tipos de agrupaciones de soporte técnico. Una agrupación estándar es más pequeña y más rápida de generar, mientras que un lote extendido proporciona datos más completos para la solución de problemas en profundidad.

	Paquete estándar	Paquete extendido (-x bandera)
Duración del registro	2 días	8 días
Archivos de registro rotados	Excluido	Se incluye
Volcados de núcleo	Excluido	Se incluye
Informe de uso de disco	Excluido	Se incluye
Registros de Hotpatch	Solo lo más reciente	Todas las versiones

Soporte de GitHub indicará qué tipo de agrupación se va a generar. En caso de duda, genere un paquete extendido para asegurarse de que todos los datos de diagnóstico están disponibles. También puede especificar una duración de registro personalizada mediante la --period marca (por ejemplo, --period '4 days').

Estado y métricas del servicio

Los paquetes de soporte técnico incluyen el estado actual del estado del servicio, la información del proceso, las métricas de rendimiento y los archivos de configuración de los servicios clave que se ejecutan en la instancia.

Información de alta disponibilidad

Si la instancia usa alta disponibilidad o agrupación en clústeres, los conjuntos de soporte técnico incluyen:

• Información de latencia y estado de replicación
• Configuración del nodo de clúster
• Detalles de la réplica de cache

Seguridad y privacidad de datos

Los paquetes de soporte técnico están diseñados para ayudar a diagnosticar problemas al proteger la información confidencial:

• Saneamiento: los datos confidenciales, como contraseñas, tokens y claves privadas, se quitan o ofuscan antes de su recopilación.
• Sin contenido del repositorio: los paquetes de soporte técnico no incluyen el contenido de los repositorios de Git, como el código fuente, los datos de confirmación o el contenido del archivo.
• Datos de usuario: los paquetes de soporte técnico no incluyen información de perfil de usuario más allá de lo que aparece en los registros del sistema.
• Información de licencia: El paquete incluye el nombre de su organización y la referencia de la licencia para que Soporte de GitHub pueda identificar su instancia.

Al proporcionar una agrupación de soporte técnico a Soporte de GitHub, GitHub usa los datos solo para abordar la solicitud de soporte técnico. Para obtener más información sobre cómo GitHub controla los datos, consulte la GitHub Declaración de privacidad.

Tamaño del paquete de soporte y tiempo de generación

El tamaño del paquete de soporte y el tiempo de generación varían en función de:

• Tamaño de instancia y nivel de actividad
• Número y tamaño de repositorios
• Período de tiempo desde la última rotación del registro
• Si la instancia usa la agrupación en clústeres o la alta disponibilidad

Los paquetes de compatibilidad típicos van de unos cientos de MB a varios GB. La generación de una agrupación puede tardar de unos minutos en instancias más pequeñas a más de una hora para instancias muy grandes o muy cargadas.

Los paquetes de soporte grandes pueden afectar al rendimiento de las instancias durante la generación. Tenga en cuenta lo siguiente.

• Carga del sistema: la generación de un paquete de soporte utiliza recursos de CPU, memoria y E/S de disco.
• Tiempo: Si es posible, genere paquetes de soporte durante las horas de poca actividad.
• Modo de mantenimiento: si la instancia tiene problemas de rendimiento graves, considere la posibilidad de habilitar el modo de mantenimiento antes de generar una agrupación de soporte técnico para asegurarse de que se completa correctamente. Para obtener más información, vea Habilitar y programar el modo de mantenimiento.

Reducción del impacto en el rendimiento

El ghe-support-bundle comando se ejecuta automáticamente en la menor prioridad de CPU y E/S, por lo que las cargas de trabajo de producción tienen prioridad. Para reducir aún más el uso de recursos durante la generación, puede usar estas marcas:

• --no-async (-n): ejecuta colecciones secuencialmente en lugar de en paralelo, lo que reduce la contención de recursos.
• --num-jobs 1 (-l 1): limita el paralelismo a un único hilo de colección. El valor predeterminado es un tercio del recuento de CPU disponible.

Por ejemplo, para generar y cargar un paquete extendido con un impacto mínimo en el rendimiento:

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

Relación con otras herramientas de diagnóstico

Las agrupaciones de soporte técnico funcionan junto con otras características de supervisión y diagnóstico:

Archivos de diagnóstico

El ghe-diagnostics comando genera un archivo de diagnóstico más pequeño que contiene un subconjunto de información a partir de un conjunto de soporte técnico completo. Los archivos de diagnóstico son útiles para comprobaciones rápidas de estado o cuando no se puede generar un paquete de soporte técnico completo. La salida de diagnóstico también se incluye en cada paquete de soporte.

Supervisión de paneles

La página Monitor de Consola de administración proporciona métricas en tiempo real e históricas sobre la instancia. Para obtener más información, vea Acerca de los paneles de supervisión.

Generación y uso compartido de conjuntos de compatibilidad

Puede generar y compartir paquetes de soporte mediante Consola de administración o la línea de comandos. Para obtener instrucciones detalladas, consulte Proporcionar datos al soporte técnico de GitHub.

Consideraciones para la agrupación en clústeres

Si usa GitHub Enterprise Server la agrupación en clústeres, puede generar:

• Agrupaciones por nodo: admite agrupaciones para nodos de clúster individuales.
• Agrupaciones de clústeres: un lote combinado de todos los nodos de clúster mediante ghe-cluster-support-bundle.

Soporte de GitHub indicará qué tipo de paquete generar según el problema que esté investigando.

Generación de paquete de soporte con errores

La causa más común de la generación fallida del paquete es el espacio libre insuficiente en el disco en /data/user/tmp. Los paquetes de soporte técnico se ensamblan en este directorio antes de la compresión, por lo que necesita espacio suficiente para contener los datos sin comprimir. Compruebe el espacio disponible antes de generar una agrupación:

df -h /data/user/tmp

Si se produce un error en la generación o tarda mucho tiempo, libere espacio en /data/user/tmp e inténtelo de nuevo. Si los problemas persisten, póngase en contacto con Soporte de GitHub para obtener ayuda. Como alternativa, puede generar un archivo de diagnóstico más pequeño mediante el ghe-diagnostics comando .

Lectura adicional

• Acerca de los registros del sistema
• Utilidades de la línea de comandos
• Proporcionar datos al soporte técnico de GitHub