Poste indicador: cuando los puntos de interrupción no son suficientes

En un artículo anterior, aprendimos sobre las razones de la inestabilidad de las pruebas unitarias y cómo lidiar con ellas. Ahora queremos considerar una de las nuevas herramientas de Apple para depurar y perfilar código. Estamos hablando del marco de registro os_log presentado en WWDC 2018, que fue ampliado por la herramienta de análisis de rendimiento, os_signpost.



En uno de los sprints, tuvimos la tarea de implementar la generación de un documento pdf en el lado del cliente. Completamos la tarea y demostramos con éxito los resultados al equipo. Pero queríamos asegurarnos de la efectividad de los matices técnicos de la decisión. Signpost nos ayudó con esto. Con él, pudimos acelerar la visualización del documento varias veces.

Para obtener más información sobre la tecnología de aplicación os_signpost, vea dónde puede ayudarlo y cómo ya nos ha ayudado, vaya debajo del gato.

Profundizando en el tema

Hay muchas aplicaciones en el teléfono del usuario, y todas ellas usan recursos comunes del sistema: CPU, RAM, red, batería, etc. Si su aplicación realiza sus tareas y no se bloquea, esto no significa que funcione de manera eficiente y correcta. A continuación, describimos los casos que puede encontrar.

Un algoritmo subóptimo puede conducir a una larga carga de CPU.

• Al comienzo de la aplicación, después de 20 segundos de espera, el sistema cerrará la aplicación y el usuario ni siquiera verá la primera pantalla. En este caso, el sistema establecerá un informe de bloqueo, cuya característica distintiva será el tipo de excepción: EXC_CRASH (SIGKILL) con el tipo 0x8badf00d .
  
• Los procesos intensivos en recursos en el subproceso en segundo plano pueden afectar la capacidad de respuesta de la interfaz de usuario, aumentar el consumo de batería y obligar a la aplicación a finalizar el sistema (si la CPU se sobrecalienta durante mucho tiempo).
  

Cajas de RAM:

Las especificaciones para los teléfonos en el sitio web de Apple no proporcionan información sobre la RAM, pero otras fuentes proporcionan la siguiente asignación de memoria para los modelos de teléfonos:

Tipo	4S	5 5	5C	5s	6 6	6P	6S	6SP
RAM, GB	0.5 0.5	1	1	1	1	1	2	2

Tipo	SE	X	7 7	7P	8	8P	XS	XSM	Xr
RAM, GB	2	3	2	3	2	3	4 4	4 4	3

Cuando hay muy poca RAM libre, iOS comienza a buscar memoria para liberar, enviando simultáneamente una advertencia de memoria a todas las aplicaciones en ejecución. Este proceso afecta implícitamente la CPU y la batería del dispositivo. Si se ignora la advertencia de memoria y la asignación de memoria continúa, el sistema finaliza por la fuerza el proceso de solicitud. Para el usuario, esto parece un bloqueo, sin retrocesos en el informe del bloqueo.

Uso excesivo de solicitudes de red . Esto también conduce a una disminución en la duración de la batería. La duplicación de solicitudes y / o la falta de cancelación de solicitudes innecesarias también conduce a un uso ineficiente de la CPU.

No te olvides de CoreLocation . Cuanto más a menudo y con mayor precisión solicitemos la ubicación del usuario, más se gasta la batería del dispositivo. Para verificar la exactitud del procesamiento de los casos descritos, sugerimos usar os_signpost para perfilar los procesos de la aplicación y luego analizar los datos obtenidos.

Integración de herramientas en el proyecto.

En el nivel superior, el proceso de creación de un PDF consta de tres pasos:

1. recibir datos a través de la red;
2. formación de documentos;
3. mostrar en la pantalla: decidimos dividir y registrar las etapas de generación de documentos, comenzando por el usuario haciendo clic en el botón "Generar" y terminando con la visualización del documento en la pantalla.

Supongamos que nos enfrentamos a la tarea de analizar una solicitud de red asincrónica. El marcado en el código se verá así:

import os.signpost let pointsOfInterestLog = OSLog(subsystem: "com.example.your-app", category: . pointsOfInterest) let networkLog = OSLog(subsystem: "com.example.your-app", category: "NetworkOperations") os_signpost(.event, log: pointsOfInterestLog, name: "Start work") os_signpost(.begin, log: networkLog, name: "Overall work") for element in elements { os_signpost(.begin, log: networkLog, name: "Element work") makeWork(for: element) os_signpost(.end, log: networkLog, name: "Element work") } os_signpost(.end, log: networkLog, name: "Overall work") 

Los pasos para usar el poste indicador son los siguientes:

• Importe el marco os.signpost.
  
• Cree una instancia de OSLog. Vale la pena considerar que hay varios tipos de eventos: para eventos de intervalo (por ejemplo, una solicitud de red), puede usar una categoría arbitraria, y para eventos simultáneos (por ejemplo, hacer clic en un botón), la categoría predefinida pointsOfInterest / OS_LOG_CATEGORY_POINTS_OF_INTEREST.
  
• Para eventos de intervalo, llame a la función os_signpost con el tipo .begin y .end al principio y al final de la etapa bajo investigación. Para eventos simultáneos, use el tipo .event.
  
• Si el código bajo investigación se puede ejecutar de forma asíncrona, agregue una ID de señalización, que le permitirá separar los intervalos del mismo tipo de operaciones con diferentes objetos.
  
• Opcionalmente, puede agregar datos adicionales (metadatos) a los eventos enviados. Por ejemplo, el tamaño de las imágenes descargadas a través de la red o el número de la página PDF generada. Dicha información ayudará a comprender qué sucede exactamente en la etapa investigada de la ejecución del código.
  

Del mismo modo en obj-c:

 @import os.signpost; os_log_t pointsOfInterestLog = os_log_create("com.example.your-app",   OS_LOG_CATEGORY_POINTS_OF_INTEREST); os_log_t networkLog = os_log_create("com.example.your-app",   "NetworkOperations"); os_signpost_id_t operationIdentifier = os_signpost_id_generate(networkLog); os_signpost_event_emit(pointsOfInterestLog, operationIdentifier, "Start work"); os_signpost_interval_begin(networkLog, operationIdentifier, "Overall work"); for element in elements { os_signpost_id_t elementIdentifier = os_signpost_id_make_with_pointer(networkLog, element); os_signpost_interval_begin(networkLog, elementIdentifier, "Element work"); [element makeWork]; os_signpost_interval_end(networkLog, elementIdentifier, "Element work"); } os_signpost_interval_end(networkLog, operationIdentifier, "Overall work"); 

A una nota. Si el proyecto debe ejecutarse en iOS antes de la versión 12.0, Xcode ofrecerá ajustar las llamadas os_signpost en la construcción if #available. Para no saturar el código, puede colocar esta lógica en una clase separada.

Vale la pena considerar que os_signpost requiere un literal de cadena estática como parámetro del nombre del evento. Para agregar una escritura más estricta, puede crear una enumeración con tipos de eventos y, en la implementación de la clase, asignarlos a literales de cadena. Poner OSLog en una clase separada agregará la lógica para deshabilitarlo para el esquema de lanzamiento (hay un comando OSLog separado para esto).

 import os.signpost let networkLog: OSLog if ProcessInfo.processInfo.environment.keys.contains("SIGNPOSTS_FOR_NETWORK") { networkLog = OSLog(subsystem: "com.example.your-app", category: "NetworkOperations" } else { networkLog = .disabled } 

Puede agregar valores de cualquier propiedad a la marca de evento con los siguientes decodificadores de tipo para un formato conveniente:

Tipo de valor	Especificador personalizado	Salida de ejemplo
tiempo_t	% {time_t} d	2016-01-12 19:41:37
timeval	% {timeval}. * P	2016-01-12 19: 41: 37.774236
especificación de tiempo	% {timespec}. * P	2016-01-12 19: 41: 37.2382382823
errno	% {errno} d	Tubo roto
iec-bytes	% {iec-bytes} d	2.64 MiB
bitrate	% {bitrate} d	123 kbps
velocidad de bits iec	% {iec-bitrate} d	118 kibps
uuid_t	% {uuid_t}. * 16P % {uuid_t}. * P	10742E39-0657-41F8-AB99-878C5EC2DCAA

Ahora, al perfilar la aplicación, los eventos de os_signpost se enviarán a los instrumentos en forma de datos tabulares. Para cambiar a herramientas, use el método abreviado de teclado Cmd + I, luego seleccione la herramienta necesaria para la creación de perfiles. Para ver los datos marcados, solo active las herramientas os_signpost y Punto de interés en el lado derecho de la interfaz de la herramienta.



Por defecto, los eventos se agrupan en categorías y se muestran en una tabla, donde se calculan su número y estadísticas sobre el tiempo de ejecución. Además, hay una pantalla gráfica en la línea de tiempo, que facilita la comparación de los eventos recibidos con los resultados en otras herramientas. También existe la posibilidad de personalizar la visualización de estadísticas y escribir sistemas expertos, pero este tema merece un artículo aparte.

Ejemplos de uso

Caso No. 1. PDFKit vs WKWebView

Mediante el uso de os_signpost, vimos que para documentos pequeños (un par de páginas) el paso más largo fue el último paso, mostrar el documento, en lugar de trabajar con una red o gráficos. Esto nos llevó a la decisión de reemplazar WKWebView con PDFView , lo que aceleró la visualización del documento de 1,5 segundos a 30 milisegundos. En los gráficos, se ve así:


Mostrar un documento PDF (WKWebView) en Time Profiler


Mostrar un documento PDF (PDFView) en Time Profiler

Los datos resultantes se pueden implementar en otras herramientas que proporciona Xcode. Como mostró la herramienta de asignaciones, la ganancia en velocidad de descarga se logró al aumentar el uso de RAM.

Caso No. 2. Advertencia de baja memoria

Un documento PDF se genera de forma asíncrona, y su formación requiere la asignación de una cantidad significativa de memoria. En caso de memoria insuficiente, decidimos agregar la capacidad de detener la operación asincrónica de crear un documento.

Como sabe, cuando usa NSOperationQueue, el método cancelAllOperation libera una cola existente, pero no detiene las operaciones que ya se están ejecutando. De esto concluimos que en la implementación de la operación es necesario determinar periódicamente su condición y dejar de funcionar. Por lo tanto, libera recursos si está configurado en estado Cancelado.

El siguiente paso es una operación asincrónica que debemos verificar para cancelar. Pero al mismo tiempo, no está claro con qué frecuencia hacer esta verificación. Teníamos dos opciones: verificación línea por línea y verificación página por página. os_signpost también ayudó aquí. Al final resultó que, agregando un cheque por cancelación en el ciclo línea por línea de renderizar la tabla en el documento, aumentamos el tiempo que tardó en generar el documento (en 150 páginas) en 2 veces. La segunda opción era más óptima en términos de rendimiento y en realidad no aumentó el tiempo que llevó crear el documento. Como resultado, cuando recibimos el evento de advertencia de memoria, cancelamos la operación mediante programación y mostramos la pantalla de error para el usuario.

Para asegurarnos de que la memoria se libere, también podemos usar os_signpost. Esta vez agregando un marcador sobre el inicio del evento en el método didRecieveMemoryWarning y un marcador sobre el final en viewDidLoad de la pantalla de error. Por cierto, puede emular un evento de memoria insuficiente en el simulador (shift + command + m).

Caso No. 3. Actualizar restricciones

Poste indicador puede ser útil en el proceso de diseño. Para crear restricciones, utilizamos el marco de albañilería . La documentación para el marco dice que se recomienda usar el método updateConstraints () para crear restricciones. Pero Apple desaconseja hacerlo, y puede verificar esto con el marcado de señalización.



De acuerdo con la documentación de Apple, updateConstraints solo debe usarse para cambiar restricciones si no podemos hacerlo en el lugar donde ocurrió el cambio.



Después de analizar los resultados, llegamos a la conclusión de que la llamada updateConstraints no es tan frecuente en nuestra aplicación, aproximadamente cada vez que aparece la vista en la pantalla.
A pesar de esto, para evitar posibles defectos de rendimiento, recomendamos seguir los consejos de Apple al respecto.

Conclusiones

En 2018, Apple brindó a los desarrolladores la oportunidad de expandir de manera independiente las herramientas de creación de perfiles. Por supuesto, puede usar otras herramientas de depuración: puntos de interrupción, salida a la consola, temporizadores, perfiladores personalizados. Pero tardan más tiempo en implementarse o no siempre dan una imagen completa de lo que está sucediendo.

En el próximo artículo, consideraremos cómo usar la información recibida del panel de manera más eficiente escribiendo nuestro propio sistema experto (Custom Instruments).

---

Enlaces utiles

• Medición del rendimiento mediante el registro (WWDC)
  
• Crear instrumentos personalizados (WWDC)
  
• Lo nuevo en depuración de energía (WWDC)
  
• Memoria profunda de iOS (WWDC)
  
• Enfoques prácticos para un gran rendimiento de la aplicación (WWDC)
  
• Diseño automático de alto rendimiento (WWDC)
  
• Comprender y analizar informes de bloqueo de aplicaciones
  
• Registro
  
• Lista de dispositivos iOS
  
• Uso de señales para la optimización del rendimiento en iOS
  
• Comenzando con las señales
  
• API de os_signpost 尝鲜
  

El artículo fue escrito con @victoriaqb - Victoria Kashlina, desarrolladora de iOS.