Receive the latest in our newsletter. More
Receive the latest in our newsletter. Less
Something went horribly wrong with your application submission. Please try again later.

AFNetworking

AFNetworking

User Guide

Requirements

Mobile


iOS: Minimum SDK version: 9.0 or higher

App Configurations

Before deploying all the necessary components to enable the Codavel Performance Service, an App must be configured in Codavel’s private area. In case you have already configured your App, you may skip this section. Otherwise, please follow these steps:

1. Login into https://private.codavel.com/

a. If you do not have access, please contact your dedicated account manager, he will give you access to the console.


2. Add a new app

a. Go to home and click “NEW APP”

b. Fill in the fields, namely

1. Give the app a name (descriptive)

2. Add the package name (Android) and/or bundle identifier (iOS) of your app. If it doesn’t match with your app, the traffic will be discarded.

3. Choose the App Type CDN to use Codavel Performance Service.

4. Select the regions where you want the Bolina service enabled. If you require other regions, please contact your dedicated account manager.

5. Click in the button CREATE APP


c. Your new app will appear in the list of deployments with the creation status “Processing (Creating deployment…)”. This will take some time, you will receive an email notification when the deployment is ready to use.

3. The deployment is ready to use when the Creation status change to “Deployment ready” and the Bolina server URL is available

4. Click the app info button (?) to see the deployment id and the deployment secret


5. Take note of both deployment id and secret, you will need them later.

Integration

Integrate Mobile SDK

The integration can be achieved by following this instructions:

1. Install Bolina Interceptor into your project through  CocoaPods, a dependency manager for Objective-c and Swift.

a. Install CocoaPods, by running the following commands in a terminal:

sudo gem install cocoapods

pod setup

b. Then, you’ll need to create a file named ‘Podfile’ in the same directory as your Xcode project (.xcodeproj) file with the following content:

target "MyTargetName" do

     platform :ios, '9.0'

     use_frameworks!

    (...)
     pod 'BolinaInterceptor', :http=>'https://artifact.codavel.com:8081/artifactory/ios/BolinaInterceptor_<VERSION>.zip'
    (...)
end 

The most recent version, is available in the private area, inside instructions.

c. Install the dependencies in your project using the command:

pod install

d. To build your app with the dependencies, you need to open the generated Xcode workspace (.xcworkspace) instead of the project file:

open <YourProjectName>.xcworkspace

2. Make sure that, before performing any HTTP request (a good place would be the :didFinishLaunchingWithOptions: method in your AppDelegate), you import and start the interceptor:

a. Import Bolina headers:

#import <BolinaInterceptor/BolinaInterceptor.h>
#import <BolinaInterceptor/BolinaConfiguration.h>
#import <BolinaInterceptor/CdvlURLProtocol.h>

b. Initialize the Bolina Configuration and set the Bolina Configuration domain name:

BolinaConfiguration *config = [BolinaConfiguration initBolinaConfiguration];
[config setDomain:@"<BOLINA_SERVER_URL>"];


c. [optional] Configure your Origin:

[config addBolinaURLReplacement:@“<your.cdn.com>” url:@“ <your.origin.com>”];


With this configuration, all requests intercepted by Bolina that would originally be sent to <your.cdn.com>, will be sent to a Bolina Server, that then will fetch the resource from <your.origin.com>. In case the Bolina transfer fails, the requests will be sent to <your.cdn.com>, as before. You can add multiple entries to be replaced. Otherwise, without this configuration, Codavel Performance Service servers will perform the same request as your HTTP clients would, to your current CDN or Origin.

d. Start the Bolina interceptor:

[BolinaInterceptor startInterceptor:@"<APP_ID>" withSecret:@"<APP_SECRET>"];

e. Add the Bolina interceptor as a configuration of AFURLSessionManager and use that session manager to perform the HTTP requests:

NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
NSArray *protocols = [NSArray arrayWithObjects:[CdvlURLProtocol class], nil];
[configuration setProtocolClasses:protocols];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];

f. Make sure you stop the interceptor whenever you don’t need it:

[BolinaInterceptor stopInterceptor];

Other options to integrate:

  • In case you use AFNetwork’s default shared manager, we recommend creating a new Alamofire.SessionManager registered with Bolina as a Singleton, and use that instance to perform the HTTP requests. An example of how to create one is below:

BolinaAFNetworkingManager.h

#import <foundation/Foundation.h>

@interface BolinaAFNetworkingManager : AFHTTPSessionManager 

+ (id)sharedManager;

@end

BolinaAFNetworkingManager.m

@implementation BolinaAFNetworkingManager

+ (id)sharedManager {
    static BolinaAFNetworkingManager *sharedManager = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        sharedManager = [[self alloc] init];
    });
    return sharedManager;
}

- (id)init {
  NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
  [BolinaInterceptor registerBolina:configuration];
  
  return [super initWithSessionConfiguration:configuration];
}

@end

Then you are able to use this manager in your application using this call:

 BolinaAFNetworkingManager *sharedManager = [BolinaAFNetworkingManager sharedManager];
(...)

Configure Actions in App

Configure actions in App


Bolina SDK can collect the performance data between two points in your app code. This way you can easily compare the network performance of the app requests with and without bolina in a dashboard in your Bolina Performance Console. Bolina SDK provides a method to start the trace of an action, another one to stop the trace, and another one to add optional metadata.


1. When you want to mark the start of an action, add the following line to your code

String action_id = InterceptorSingleton.getInstance().startAction(“open app”, (bolina ? "BOLINA" : "HTTP"));

2. When you want to mark the stop of the same action, add the following line to your code:

InterceptorSingleton.getInstance().stopAction(action_id);

3. When you want to add metadata to the action, add the following lines to your code:

JSONObject metadata = new JSONObject();
metadata.put(“test”,”testing-metadata”);
metadata.put(“test_int”,123);
InterceptorSingleton.getInstance().addActionMetadata(action_id,metadata);

4. When you finish collecting data to the action, add the following line to your code:

InterceptorSingleton.getInstance().processAction(action_id);

Example:

Trace the time to start a video:

1. Call startAction when the user press the play button and give it a name, e.g. “video start”

2. Call stopAction when the video starts playing

3. Call processAction to save the action and send the action stats to your dashboard

Advanced Configurations

Advanced Configurations

Bolina SDK allows the configuration of some advanced settings for enabling some features, configuring security options and increasing the debug level. Please, before changing these settings make sure you know what you are doing. All the methods below are accessible via the BolinaConfiguration object that you need to pass to InterceptorSingleton.startInterceptor()


App settings


  • addBolinaURLReplacement(String originalURLRegex, String bolinaURL) – Adds a new rule to be executed at each HTTP request. If the URL matches the expression configured, then Bolina will replace the matched expression with the configured URL. In case of Bolina fallback, the original URL will be used


  • addFallbackURLReplacement(String bolinaURLRegex, String originalURL) – Adds a new rule to be executed in case of Bolina fallback or performing A/B testing. If the URL used by bolina matches the expression configured, then Bolina will replace the matched expression with the configured URL.

  • setConfigFolder(String configFolder) – Sets the path used by Bolina core to store cached info. Default: application specific cache directory on the filesystem.


A/B Testing setting


  • setUseABTestingPerSession(boolean useABTestingPerSession) – Enables or disables the ab testing per session. This flag changes the behavior of setABTestPercentage. When this flag is set to true, the ab test percentage is calculated per session, otherwise, it is calculated per request. Here we assume a session is a new app start. Default: false

  • setABTestPercentage(int abTestPercentage)  – Sets the percentage of requests or sessions using Bolina. Should be used with setUseABTestingPerSession to define if the ab testing is per session or per request. Default: 100 , meaning all requests or all sessions are using Bolina.

Verbose settings


  • setVerboseLevel(String verboseLevel) – Changes the verbose level of Bolina client. Accepted values: “critical”(less logs), “info”, “debug”, “trace”(more logs). Default: critical


Protocol settings


  • setBolinaHandlerPattern(Pattern bolinaHandlerPattern) – Sets the URLs to be handled via bolina. Any URL that match this pattern will use bolina, on the other hand, a URL that does not match this pattern will be transferred using regular HTTP. default: Pattern.compile(“.*”), meaning all requests are accelerated

  • setCertsEnabled(boolean enableCerts) – Enables/Disable the use of SSL certificates. Default: true.

  • setAllowSelfSignedCerts(boolean allowSelfSignedCerts) – Enables/Disable the use of self signed SSL certificates. We strongly recommend the use of this option only for testing purposes. Default: false.

  • setMaxMemoryAllowed(long maxMemoryAllowed) – Sets the maximum amount of memory used by bolina core. Default: 10MB

  • setZeroRtt(boolean enableZeroRtt) – Enables or disables the use of 0-RTT in Bolina. Default: enabled

  • setTimeToKeepAlive(int timeToKeepAlive) – Sets the maximum time that a connection will be kept alive, in milliseconds. Default: 120s

Insights settings


  • setMonitorPercentage(int monitorPercentage) – Sets the percentage of requests to be traced for detailed statistics in the insights dashboard. A value of 100 means all requests appear in the dashboard. Default: 100

Installation Guide

Infrastructure Overview

Deploy Server Components

User Insights

To get more information about your deployment and the users connected through Codavel Performance Service, we provide an analytics page inside your Codavel account, with data collected from both Servers and Client’s SDKs.

In order to access it, please follow these steps:

1. Login into https://private.codavel.com/

a. If you do not have access, please contact our sales team, they will give you access to the console.

2. Go to the Insights section of the menu.

Network

a. Network – Contains overall HTTP requests information, along with some more detailed and low level statistics.

User

b. User – Contains action information and user behaviour. Note: To view data in this dashboard you need to add action data via SDK. Please see the section Configure Action in App of the respective interceptor.

Debug

c. Debug – Contains detailed information about possible errors that may affect your user experience, that can be used to identify and fix any configuration or deployment issues.

Codavel Open Source Projects.
Want to see examples of open source apps already integrated with Codavel?

access projects
More Cloud Installation Guides