настроить: iosappv2 [App47]

1. Требуемые шаги:
2. Загрузите встроенный агент
3. Описание файлов
4. Включите встроенную библиотеку агентов в свой проект
5. Контрольный список файлов
6. Библиотека App47
7. Библиотека инструментов Google
8. Настройте встроенный агент
9. Добавьте файл EmbeddedAgentSettings.plist для установки дополнительных параметров конфигурации
10. Отправка кэшированных данных
11. Добавить Crash Log Management
12. Ручной захват
13. Захват GTM
14. Добавление операторов регистрации в ваше приложение
15. Добавление синхронизированных событий в ваше приложение
16. Добавление общих событий в ваше приложение
17. Использование групп конфигурации в вашем приложении
18. Отправка кэшированных данных

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

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

Встроенный агент - это мост между вашим мобильным приложением и службой App47. Он предоставляет простой в использовании API для записи времени и продолжительности сеансов, сообщений журнала и событий производительности. После того, как вы добавили свое приложение iOS на панель мониторинга App47, обязательно запишите идентификатор приложения, так как он будет использоваться для настройки агента после установки.

Требуемые шаги:

Необязательные шаги:

• Добавьте файл EmbeddedAgentSettings.plist для установки дополнительных параметров конфигурации

• Добавить Crash Log Management

• Добавьте операторы журналирования, чтобы зафиксировать условия отладки и ошибок

• Добавить синхронизированные события для сбора данных о производительности

• Добавьте общие события для захвата поведения пользователя

• Использование групп конфигурации

Загрузите встроенный агент

Загрузите сжатый образ встроенного агента (файл DMG) из: Ресурсный центр App47

Как только вы загрузили файл, откройте файл DMG, и вы должны увидеть следующие файлы:

Описание файлов

Описание файла Обязательно? EmbeddedAgent.h Заголовочный файл для встроенного агента Да EmbeddedAgentSettings.plist Дополнительные параметры для настройки встроенного агента. Нет GoogleToolbox Необходимые файлы из проекта с открытым исходным кодом Google Toolbox для поддержки записи журналов сбоев. Да, если используется UncaughExceptionHandler и GoogleToolbox еще не включен в проект. JSON (требуется для версий агента ниже 1.9) Библиотека SBJSON, используемая для обмена сообщениями с сервисом. Да, если библиотека SBJSON еще не включена в ваш проект. libEmbeddedAgent.a Скомпилированная библиотека встроенного агента (i386, armv6, armv7, armv7s). Эта библиотека использует генератор UUID для создания уникального идентификатора для каждого экземпляра приложения, используйте его при развертывании через iTunes App Store. Да, если вы хотите, чтобы информация о географическом местоположении отправлялась встроенным агентом. CoreLocation.framework должен быть включен в ваш проект. libEmbeddedAgentWithNo CoreLocation.a Скомпилированная толстая (i386, armv6, armv7, armv7s) библиотека встроенного агента без CoreLocation.Framework. Эта библиотека использует генератор UUID для создания уникального идентификатора для каждого экземпляра приложения, используйте его при развертывании через iTunes App Store. Да, если вам не нужна информация о географическом местоположении. libGMStackStrace.a Скомпилированная жирная (i386, armv6, armv7, armv7s) библиотека Google Stack Trace Toolkit, включите эту библиотеку, если вы работаете в проекте, настроенном для ARC. Да, только если вы работаете в проекте, настроенном для ARC, и у вас еще нет включенного набора инструментов Google.

Включите встроенную библиотеку агентов в свой проект

Создайте папку в своем проекте и скопируйте содержимое файла DMG во вновь созданную папку

Добавьте эти файлы в свой проект, щелкнув правой кнопкой мыши по проекту или в папке по вашему выбору.

Примечание. Скопируйте в этот каталог файл libEmbeddedAgent.a или libEmbeddedAgentWithNoCoreLocation.a.

Directory Выберите каталог App47 и нажмите « Добавить» .

 Примечание. Если вы уже используете в своем приложении библиотеку SBJSON или GoogleToolbox, не включайте эти каталоги.

Контрольный список файлов

Есть несколько способов включить App47 в ваше приложение iOS, пожалуйста, убедитесь, что вы выбрали только один вариант в каждой группе ниже.

Библиотека App47

Выберите только одну из библиотек libEmbeddedAgent, выбор более одной приведет к ошибкам компиляции.

• libEmbeddedAgent.a - используйте это, если вы просматриваете iTunes и хотите получить данные GEO.

• libEmbeddedAgentWithNoCoreLocation.a - используйте этот параметр, если вы используете iTunes и НЕ хотите данных GEO.

Библиотека инструментов Google

Включите либо каталог GoogleToolbox, либо файл libGMStackTrace.a, но не оба вместе.

Если у вас есть проект ARC и вы используете каталог GoogleToolbox, убедитесь, что вы исключили файлы из компилятора ARC. прочитайте эту статью о том, как это сделать, исключить их.

Если вы используете файл libGMStackTrace.a, включите флаг -all_load в флаг компоновщика.

Настройте встроенный агент

Самый простой способ настроить встроенный агент - включить файл «EmbeddedAgent.h» и использовать селектор configureAgentWithAppID: с идентификатором приложения, полученным из панели мониторинга App47. Эта конфигурация будет записывать начало сеанса, продолжительность, местоположение и захватывать соответствующее устройство и информацию о приложении.

#import "MyAppAppDelegate.h" #import "MyAppViewController.h" #import "EmbeddedAgent.h" @implementation MyAppAppDelegate @synthesize window = _window; @synthesize viewController = _viewController; - (BOOL) приложение: (UIApplication *) приложение didFinishLaunchingWithOptions: (NSDictionary *) launchOptions {// Точка переопределения для настройки после запуска приложения. [EmbeddedAgent configureAgentWithAppID: @ "4d556ab4530a69fb4b000002"]; self.window.rootViewController = self.viewController; [self.window makeKeyAndVisible]; вернуть ДА; }

Добавьте файл EmbeddedAgentSettings.plist для установки дополнительных параметров конфигурации

Агент также можно настроить с помощью включенного файла EmbeddedAgentSettings.plist, который содержит идентификатор приложения, а также дополнительные параметры для встроенного агента.

Параметры конфигурации

Имя Тип Описание По умолчанию Обязательно? application id String Идентификатор приложения, указанный на вашей панели управления. Нет Да Частота обновления конфигурации Число Количество дней, в течение которых агент должен обновлять свою конфигурацию с помощью службы. Значение 0,5 приведет к тому, что агент будет обновлять свою конфигурацию каждые 12 часов. 1 Интервал загрузки данных без задержки Число Число секунд, которое следует ждать после запуска, прежде чем отправлять данные в службу. Это позволяет вашему приложению запускаться и реагировать, не конкурируя за ценные ресурсы процессора и сети. 1 Не отправлять фактический идентификатор устройства Boolean Больше не используется, пожалуйста, удалите из файла plist. НЕТ Не показывать активность сети Boolean Если при отправке данных в службу должен быть включен индикатор сети в строке состояния. Если для этого значения установлено значение YES, индикатор сетевой активности включается и выключается при отправке данных, в противном случае индикатор не обновляется при отправке данных. ДА Нет конечной точки конфигурации String Полный URL-адрес конечной точки конфигурации для службы API. Производственный API-сервер App47 Нет уровня ведения журнала агента Строка Уровень ведения журнала для агента. Он будет регистрировать информацию только при запуске в симуляторе, а не на устройстве. Допустимые значения: «отладка», «информация», «предупреждение», «ошибка». error Нет отправлять события немедленно Boolean Если общие и синхронизированные события должны быть отправлены немедленно или объединены вместе и отправлены в начале следующего сеанса, такого как данные журнала и сеанса. ДА Нет загрузки при выходе Boolean Попытка загрузки сеанса, журнала и всех оставшихся данных о событиях при выходе. Требуется iOS 4.0. Когда приложение переводится в фоновый режим, агент пытается загрузить свои данные на сервер с помощью фоновой задачи iOS. Нет Нет сбой захвата Boolean Устаревший (см. Параметр «Формат захвата сбоя захвата»): Параметр конфигурации для захвата журналов сбоя через агент, используемый вместо InstallExceptionHandlers, не использует оба метода. Нет Нет Формат сбоя захвата String Настройте агент для захвата сбоя, используя метод «GTM» или «символический». Не записывать журналы сбоев Нет

При использовании EmbeddedAgentSettings.plist необходимо использовать следующий селектор конфигурации.

#import "MyAppAppDelegate.h" #import "MyAppViewController.h" #import "EmbeddedAgent.h" @implementation MyAppAppDelegate @synthesize window = _window; @synthesize viewController = _viewController; - (BOOL) приложение: (UIApplication *) приложение didFinishLaunchingWithOptions: (NSDictionary *) launchOptions {// Точка переопределения для настройки после запуска приложения. [EmbeddedAgent configureAgent]; self.window.rootViewController = self.viewController; [self.window makeKeyAndVisible]; вернуть ДА; }

Отправка кэшированных данных

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

[EmbeddedAgent sendCachedData];

Добавить Crash Log Management

Существует три способа сбора информации в журнале сбоев для приложения iOS. Пожалуйста, выберите один из методов ниже, не реализуйте несколько методов в приложении sam.

Ручной захват

Если вы хотите, чтобы информация из журнала сбоев регистрировалась и отправлялась в службу App47, добавьте следующий обработчик handleUncaughException в ваш делегат приложения. Это будет фиксировать любую информацию о сбоях локально. Информация о сбое будет загружена при следующем запуске приложения. Это будет использовать метод Google Toolkit для записи журналов сбоев.

void handleUncaughtException (NSException * исключение) {EALogCrashException (исключение, @ "Сбой приложения"); } - (BOOL) application: (UIApplication *) application didFinishLaunchingWithOptions: (NSDictionary *) launchOptions {// Точка переопределения для настройки после запуска приложения. [EmbeddedAgent configureAgent]; NSSetUncaughtExceptionHandler (& handleUncaughtException); self.window.rootViewController = self.viewController; [self.window makeKeyAndVisible]; вернуть ДА; }

Захват GTM

Чтобы перехватить все исключения сбоя, используйте метод InstallExceptionHandlers, чтобы зарегистрировать обработчики по умолчанию для необработанных исключений и обработчиков сигналов. Это аналогично настройке «GTM» и «формата сбоя при захвате» в файле EmbeddedAgentSettings.plist.

- (BOOL) приложение: (UIApplication *) приложение didFinishLaunchingWithOptions: (NSDictionary *) launchOptions {// Точка переопределения для настройки после запуска приложения. [EmbeddedAgent configureAgent]; [EmbeddedAgent InstallExceptionHandlers]; self.window.rootViewController = self.viewController; [self.window makeKeyAndVisible]; вернуть ДА; }

Захватить журнал сбоев в формате журнала сбоев iOS и обозначить его службой. Сконфигурируйте файл EmbeddedAgentSettings.plist с настройкой «формат записи при сбое» ⇒ «символизировать».

Это будет использовать PL Crash Reporter Library чтобы зафиксировать сбой локально на устройстве. Журнал сбоев будет загружен на сервер при следующем запуске приложения. Это не побуждает пользователя загружать журнал сбоев.

Если ваш журнал сбоев не полностью символизирован, пожалуйста, смотрите наш поиск неисправностей в символике iOS руководство.

Добавление операторов регистрации в ваше приложение

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

// // MyAppViewController.m // MyApp // // #import "MyAppViewController.h" #import "EmbeddedAgent.h" @implementation MyAppViewController - (void) dealloc {[super dealloc]; } - (void) didReceiveMemoryWarning {// Оператор журнала уровня предупреждения EALogWarn (@ "Предупреждение о получении памяти"); // Освобождает представление, если оно не имеет суперпредставления. [super didReceiveMemoryWarning]; // Освобождаем любые кэшированные данные, изображения и т. Д., Которые не используются. } #pragma mark - View lifecycle // Реализация viewDidLoad для дополнительной настройки после загрузки представления, как правило, из кончика. - (void) viewDidLoad {// Список тегов можно добавить в операторы журнала для дополнительных // критериев поиска в веб-приложении. EALogInfoWithTags ([NSArray arrayWithObject: @ "MyTag"], @ "Представление загружается"); [super viewDidLoad]; } - (void) viewDidUnload {[super viewDidUnload ===== Заголовок 2-го уровня =====]; // Освободить все сохраненные подпредставления основного представления. // например, self.myOutlet = nil; } - (BOOL) shouldAutorotateToInterfaceOrientation: (UIInterfaceOrientation) interfaceOrientation {// Все макросы журнала допускают замены стандартного строкового формата // найдены в NSLog и stringWithFormat EALogDebug (@ "Просят, чтобы представление поворачивалось в ориентацию интерфейса% d", interfaceOrientation); // Возвращаем YES для поддерживаемых ориентаций return (interfaceOrientation == UIInterfaceOrientationPortrait); } @конец

Добавление синхронизированных событий в ваше приложение

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

- (void) executeMyTransaction {NSString * eventID = [EmbeddedAgent startTimedEvent: @ "Transaction"]; // Выполнение некоторой бизнес-логики для завершения транзакции //… // [EmbeddedAgent endTimedEvent: eventID]; }

Временные события могут быть очищены перед отправкой в ​​службу с помощью clearTimedEvent: метод или очистить все события с помощью clearTimedEventsOlderThanTimeInterval: метод.

- (void) executeMyTransaction {BOOL успешно = НЕТ; NSString * eventID = [EmbeddedAgent startTimedEvent: @ "Транзакция"]; // Выполнение некоторой бизнес-логики для завершения транзакции //… // if (success) [EmbeddedAgent endTimedEvent: eventID]; еще [EmbeddedAgent clearTimedEvent: eventID]; }

… ИЛИ ЖЕ …

- (void) clearAllTimedEvents {[EmbeddedAgent clearTimedEventsOlderThanTimeInterval: 0]; }

Добавление общих событий в ваше приложение

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

- (void) handleMyEvent {[EmbeddedAgent sendGenericEvent: @ "myEventName"]; // Выполнить некоторую бизнес-логику для обработки события //… //}

Использование групп конфигурации в вашем приложении

Группы конфигурации позволяют установить набор пар значений ключа через основной веб-интерфейс, которые затем загружаются агентом при первоначальном запуске, а затем с частотой, устанавливаемой параметром «частота обновления конфигурации» в файле EmbeddedAgentSettings.plist. Элементы конфигурации должны запрашиваться по имени группы и имени ключа. Может быть задано значение по умолчанию для использования в случае, если группа конфигурации не содержит элемент с запрошенным именем ключа. Если значение по умолчанию не указано, а ключ не существует в группе, возвращается значение nil. Группы конфигурации могут быть назначены агентам на основе версии приложения, версии ОС и платформы.

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

(void) myMethod {NSString * serverURLString = [EmbeddedAgent configurationStringForKey: @ группа «URL-адрес сервера»: @ «Информация о сервере» defaultValue: @ »http://myserver.abc.com/restapi»]; // Используем serverURLString для выполнения дополнительной работы ... //… //}

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

Имя Описание EmbeddedAgentAppConfigurationGroupDidInsert Была добавлена ​​группа конфигурации. Имя группы включается в объект уведомления userInfo с ключом: EmbeddedAgentAppConfigurationGroupNameKey. EmbeddedAgentAppConfigurationGroupDidUpdate Группа конфигурации была обновлена. Имя группы включается в объект уведомления userInfo с ключом: EmbeddedAgentAppConfigurationGroupNameKey. EmbeddedAgentAppConfigurationGroupDidDelete Группа конфигурации была удалена. Имя группы включается в объект уведомления userInfo с ключом: EmbeddedAgentAppConfigurationGroupNameKey. EmbeddedAgentAppConfigurationGroupNameKey Группа конфигурации была изменена, добавлена, обновлена ​​или удалена. (void) updateViewFromConfigurationChange: (NSNotification *) уведомление {NSDictionary * userInfo = [уведомление userInfo]; NSString * groupName = [[userInfo valueForKey: EmbeddedAgentAppConfigurationGroupNameKey]]; // // Обновляем представление на основе groupName // ...} (void) viewDidLoad {[[NSNotificationCenter defaultCenter] addObserver: self selector: @selector (updateViewFromConfigurationChange :) name: EmbeddedAgentAppConfigurationGroupDidUpdate объект: nil]; [super viewDidLoad]; }

Отправка кэшированных данных

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

[EmbeddedAgent sendCachedData];

Цель встроенного агента - предоставить ценную возможность управления вашему приложению, не мешая приложению, которым оно управляет. Хотя нет ничего бесплатного, мы постарались ограничить количество ресурсов, которые мы потребляем во время выполнения. Три ключевых момента были измерены, и результаты перечислены ниже.

Метрика Описание Задержка измерения при запуске Время, которое требуется агенту для запуска и возврата управления обратно в основной поток. Все остальные операции выполняются в фоновых потоках. Средняя задержка в секундах: iPhone 3g - 0,052, iPhone 4 - 0,017, iPad 2 - 0,026 Память Объем дополнительной памяти, которую агент использует в устойчивом состоянии. Сетевой трафик 116 КБ Хотя конкретный объем сетевого трафика зависит от того, как вы используете службу, большинство пакетов, отправляемых в службу, составляют менее 2 КБ. Размер файла библиотеки менее 2 КБ Чистое увеличение размера изображения вашего приложения в результате включения встроенного агента. 1.3MB

2,4

2,4

2,3

2,0

Похожие

Комментарии