Page History

One of the benefits of using CardioLog Analytics on-premise is a complete ownership of your own data, on your own servers, which allows you to control both privacy and security. This also means that redundancy for the CardioLog server is the customer's responsibility to maintain. This article contains several recommedations recommendations for optimal operation.

Contents

• How to Configure NLB for Usage Data Collection
• How to Install the CardioLog Data Collection Web Applications on a WFE
• How to Configure CardioLog in the Event of a SharePoint Farm Failover

Anchor
configure nlb configure nlb

...

High Availability and Network Load Balancing for Usage Data Collection

Data collection is handled by the EventCollector and CardioLogAgent web applications. Multiple instances of these web applications can work in parallel. Each instance will simultaneously write its own usage data directly into the CardioLog database.
For portals with 5 10 million events or more per month, we highly recommend using network load balancing (NLB) for usage data collection. Data collection is still handled by the EventCollector and CardioLogAgent web applications, but multiple instances of these web applications can work in parallel. Each instance will simultaneously write its own data into the CardioLog database.The architecture for  

By default the CardioLogAgent web application is hosted on the SharePoint WFEs and the EventCollector web application is hosted on the CardioLog application server. In case the CardioLog application server is not available, usage data will be lost. To eliminate the dependency on the CardioLog application server (given the CardioLog database is hosted on a separate server) we highly recommend configuring High Availability (HA) for usage data collection.  

The architecture for HA and NLB should be as follows:

1. Main Application server hosting a full the CardioLog installation.At least one additional web front end (WFE) that hosts the Analytics application.
2. Database server hosting the CardioLog database.
3. Two or more web servers that host the Usage Data Collection components (EventCollector and CardioLogAgent web applications).
   Note: You can use the existing SharePoint WFEs or dedicated servers to host

...

1. the Usage Data Collection components. By default, when deploying the CardioLog Analytics SharePoint feature for usage tracking, the CardioLogAgent web application is automatically installed on your SharePoint WFEs under each SharePoint web application _layouts folder. You can install the EventCollector web application in the same location assuming the SharePoint WFEs have sufficient resources to handle the additional web requests.
2. SharePoint WFEs hosting the CardioLog Analytics JavaScript tracking code. By default, when deploying the CardioLog Analytics SharePoint feature for usage tracking, the JavaScript tracking code is hosted in the CardioLogAgent web application which is automatically installed on your SharePoint WFEs under each SharePoint web application _layouts folder. 

Image Added

CardioLog Analytics On-Premise High Availability Architecture - with usage data collection components installed on dedicated web servers

Anchor
install data collection install data collection

How to Install the CardioLog Analytics Usage Data Collection

...

Components on a

...

Dedicated Web Server

Anchor
system_reqs system_reqs

System Requirements

Inspect the following table to assure that your dedicated web server meets the minimum hardware and software requirements:

1. Verify that your system meets the software and hardware requirements.
2. Install the Required Web Server (IIS) Role Services on your web server.
3. Deploy the CardioLog Analytics SharePoint feature for usage tracking, or add the tracking code to a common page component of your choice (for example - master pages, page toolbars, Web Parts, headers or footers).
4. Create a new EventCollector web application on your WFEweb server. For the new web application, create :
   • Create a dedicated application pool
   . Set
   • with ASP.NET version
   to 2
   • 4.0 and
   grant
   • Integrated managed pipeline mode.
   • The application pool should run with a local administrator account. 
   • Grant the application pool account the "db_owner" role on the CardioLog database.
    Set
   •  
   • Set the web application authentication method to Anonymous access (disable Windows Authentication). 
   • Grant Full Control permissions for the IIS_IUSRS group on the EventCollector folder
5. Copy the files from the CardioLog server [CardioLog Installation Directory]\EventCollector to the new directory.
6. Copy the files from the CardioLog server [CardioLog Installation Directory]\Setup Files\SLPS to the new directory under \EventCollector\bin folder.
7. Execute the following command on your web server: Slps.Runtime.Configuration /Install (execute it from this location - \EventCollector\bin)
8. Contact us to receive the required licenses for the web server (product edition and engagement package) and apply it using the License Admin tool (execute it from this location - \EventCollector\bin\Microsoft.Licensing.LicAdmin.exe).
9. Create a new CardioLogAgent web application on the WFEweb server. For the new web application, create :
   • Create a dedicated application pool
   and set ASP
   • with ASP.NET version to
   2
   • 4.0 and Integrated managed pipeline mode.
   • The application pool should run with a local administrator account.
   • Set the web application authentication method
   of the web application to
   • to Windows Authentication (disable Anonymous access).
   • Grant Full Control permissions for the IIS_IUSRS group on the CardioLogAgent folder

10. Copy the files from the CardioLog server [CardioLog Installation Directory]\CardioLogAgent to the new directory.
    

    Note: When deploying the CardioLog Analytics SharePoint feature for usage tracking, there is no need to create a new CardioLogAgent web application.

11. Edit the following keys in

    the

    the CardioLogAgent\web.config

    file

     file, located in

    the

    the <appSettings>

    section

     section and enter the NLB FQDN

    -

    , where [domain name] is the NLB FQDN for the web applications.

    Info
    icon false
    <add key="EventCollectorPath" value="http[s]://[domain name]/EventCollector/monitor.aspx" /> <add key="CardioLogAgentRoot" value="http[s]://[domain name]"/>

Where [domain name] is the NLB FQDN for the web applications.

1. 
   Note: When the EventCollector and CardioLogAgent web applications are installed on your SharePoint WFEs under each SharePoint web

...

1. application _layouts folder, edit the following keys in

...

1. the CardioLogAgent\web.config

...

1.  file, located in

...

1. the <appSettings>

...

1.  section, where [domain name] is the SharePoint web application FQDN.

   Info
   icon false
   <add key="EventCollectorPath" value="http[s]://[domain name]/_layouts/EventCollector/monitor.aspx" /> <add key="CardioLogAgentRoot" value="/_layouts"/

...

Where [domain name] is the SharePoint web application FQDN.

1. >

2. Edit the following

   keys

   URLs in the Java Script tracking code

   .

...

1. :

...

1. Info
   icon false
   http[s]://[domain name]/CardioLogAgent/

...

1. getCAData.aspx?

...

1. r='+

...

1. Math.random()

...

1. ;

...

1. http[s]://[domain name]/CardioLogAgent/ca.aspx?

...

1. u='+

...

1. document.location.href;

...

1. http[s]://[domain name]/CardioLogAgent/AgentEmbed.aspx?env=[SharePoint version]

...

1. '

...

1. ;

   
   [domain name] - the NLB FQDN for the web application.
   [SharePoint version] - MOSS2007, SP2010, SP2013, SP2016 or SPOnline
   
   If the CardioLog Analytics SharePoint feature for usage tracking

...

By default, the Java Script tracking code is embedded within a common Java Script file on your SharePoint WFEs -

...

1. is deployed, edit the URLs in the following location:
   C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\

...

1. 14\TEMPLATE\LAYOUTS\

...

1. CardioLogAgent\

...

1. CardioLogAgent.js

...

The code is located at the end of the file, between these comments: //Intlock tracking code start, and //Intlock tracking code end

...

1. If the Java Script tracking code is embedded within a common page component on your SharePoint WFEs, edit the URLs in there.

     

2. In the CardioLog database, edit the URL column in the tab_management table by executing the following SQL script:
   
   Use CardioLog
   GO
   
   update tab_management set url = replace (url, '[Old URL]', '[New URL]')
   where name = 'EventCollector'
   
   [Old URL] - http[s]://CardioLog-machine-name:port
   [New URL] - http[s]://[domain name]

Disaster Recovery for the CardioLog Analytics Application

An Active-Active DR configuration for the entire CardioLog solution, including the reporting user interface, is not supported.

An Active-Passive DR configuration for the entire CardioLog solution is available at an additional cost (the dormant server requires a production license).

Anchor
configure failover configure failover

...

Configuring CardioLog Analytics on a SharePoint DR Farm

...

Assuming

...

the SharePoint backup farm has

...

identical content to the live farm (identical content URLs and SharePoint IDs) and CardioLog is importing the tree structure directly from the SharePoint database (supported on SharePoint 2013 or lower), follow this procedure to prepare for a SharePoint farm failover:
 

1. Install the CardioLog Analytics Tracking Agent Feature on the backup farm as detailed here
2. Verify that the CardioLog user account has read permissions to the SharePoint databases and a TEMPLATE folder on the backup farm.
3. In case of a failover,

• Go to Administration > System Configuration > SharePoint Tree Adaptor > click on your SharePoint farm
• In the SharePoint Tree Adaptor dialog, fill out the following fields for the backup farm:
  -      Database Server - The SharePoint database instance name.
  -      SharePoint Configuration Database Name - The SharePoint configuration database name. eg,. "SharePoint_Config"
  -      Authentication Authentication - Database authentication type (Windows Integrated or SQL Authentication).
  -      SharePoint TEMPLATE Directory - This is the full path for the SharePoint TEMPLATE directory. eg,. "\\<sharepoint server name>\C$\Program Files\Common Files\Microsoft Shared\Web Server Extensions\XX\TEMPLATE\" (Where XX XX is 12 for  for MOSS 2007; 14 for  for SharePoint 2010; 15 for SharePoint 2013)
• Click Click Apply, and then click Save.
  
  
  SharePoint Adaptor System Configuration Preference Window

In versions lower than 2.0.8.0,

...

http://[server name]:[port]/: 'http://cardiolog/server name:port/'
[SharePoint version]: MOSS2007, SP2010 or SP2013

...

Verify that the CardioLog user account has read permissions to the SharePoint databases and the TEMPLATE folder on the backup farm.

...

           
           [SharePoint web application root URL] - A '*' separated list of the monitored SharePoint web applications in the farm
           [SharePoint TEMPLATE path] - Edit the SharePoint TEMPLATE folder path: 
           \\SharePoint WFE server name\C$\Program Files\Common Files\Microsoft Shared\Web Server Extensions\XX\TEMPLATE\ (Where XX is 12 for MOSS 2007; 14 for SharePoint 2010; 15 for SharePoint 2013)

...