Versions Compared

Old Version 3

changes.mady.by.user Paul Berkowitz

Saved on

compared with

New Version Current

changes.mady.by.user Paul Berkowitz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Occasionally, changes in your system may affect CardioLog behavior. If you notice errors in data collection, it may be due to a failure in the tracking agent. The tracking agent can may fail due to various reasons, including network issues, database connection problems, and insufficient permissions. Issues can occur at each step of the data collection process, which we've broken down into these points:

  1. Downloading the Tracking Code - The JavaScript tracking code is added to a SharePoint common page component and is downloaded to the client browser with each page request.
  2. Personalizing Content (Optional) - Information about the visitor segments is downloaded to the client browser with each page request. The JavaScript code hides the content of the page, adds or modifies page elements and finally re-displays the page according to visitor segments.
  3. Tracking Usage Data - Data about user actions within website pages are sent to the CardioLogAgent web application via asynchronous JavaScript calls using AJAX.
  4. Storing Usage Data - The CardioLogAgent web application passes on the usage information via HTTP/S web requests, to the EventCollector web application, which writes the data into the CardioLog database.

For assistance in troubleshooting tracking agent errors, please open a new support ticket.

Contents

Anchor
test tracking agent
test tracking agent
How to Test the Tracking Agent

...

[Installation Folder] - by default, the CardioLogAgent folder is located in the CardioLog Installation folder. If the CardioLog Analytics SharePoint feature is installed, the CardioLogAgent folder should be located on all SharePoint WFEs under the SharePoint website "_layouts" folder. 

...

  • Delete the temporary files on your browser and browse to at least three (3) pages on your SharePoint website.
  • While on the SharePoint website page, click the "Agent Console" bookmark and wait for several seconds. Verify that you see the tracking agent console.
  • Click the "CardioLog" tab. The last line should read: "events: event sent. status: 0"

    console.jpg 
    The Tracking Agent Console CardioLog Tab
     

Anchor
possible faults
possible faults
Possible Faults

The tracking agent can fail due to various reasons, including network issues, database connection problems, and insufficient permissions. Issues can occur at each step of the data collection process.

For advanced troubleshooting, first determine if the tracking agent files have been successfully downloaded to the client browser. This can be done by using web debugging tools that log all HTTP(S) traffic. We recommend a program like Fiddler. If the tracking agent files have been successfully downloaded, check for server errors.

Anchor
troubleshooting usage data
troubleshooting usage data
Troubleshooting Usage Data Collection Issues

In order to troubleshoot issues with the tracking agent test event collection and follow the instructions below according to the outcome:relevant to you below: 

The 'Last Event #' in the tracking agent pop-up is 'None' or 'N/A', or an error message is displayed in the Agent Console CardioLog tab

  • Verify that Anonymous Authentication is enabled for the EventCollector web application in IIS Manager.
  • Verify that the EventCollector web application can be accessed from the SharePoint front-ends (WFEs), and that it is not blocked by a FW/Proxy in the organizationfirewall or proxy. This is done by browsing to http://[CardioLog server name:port]/EventCollector/monitor.aspx (edit the Input your CardioLog server name and port). The expected result is an XML response. View the ports which are used the ports used by CardioLog Analytics.
    In case If you have deployed the CardioLog Analytics SharePoint feature in order to track usage data, and the EventCollector web application cannot be accessed from the SharePoint front-ends (WFEs) due to security reasons, you can configure the CardioLogAgent web application to redirect to the CardioLog server by modifying the following key in the [SharePoint TEMPLATE folder]\CardioLogAgent\Web.config on all WFEs: <add key="CardioLogAgentRoot" value="http://[CardioLog server name:port]" />
    Note: This requires access from the client browser to the CardioLog application server. 
  • Verify that the CardioLog database is working and , that the CardioLog application pool user account can connect to it, and it the application pool user account is assigned a db_owner role.
  • Check for server errors in storing usage data.

The tracking agent pop-up does not show up at all, or the Agent Console shows up without any content

Delete the temporary files on your browser and test event collection again. If it was not helpful, do the following:

  • Stop and Start the CardioLogApplicationPool in using IIS Manager.
  • If you have added the tracking code automatically using the Configuration Wizard, verify you have repeated this step for all of the your SharePoint front-ends (WFEs) in your farm.
  • If you have deployed the "CardioLog Analytics " SharePoint Featurefeature, verify it is has been activated.
  • If you have added the tracking code yourself, verify that you have removed the opening and closing script <script> tags.
  • Verify that the CardioLogAgent web application can be accessed from your workstation, and it is not blocked by a FW/Proxy in the organizationfirewall or proxy. This is done by browsing to http://[CardioLog server name:port]/CardioLogAgentEventCollector/AgentEmbedmonitor.aspx (edit the Input your CardioLog server name and port). View the ports which are used  View the ports used by CardioLog Analytics.
  • Check for server errors in tracking usage data.
You get receive a login box
  • In If you are using Internet Explorer, click Tools > Internet Options > Security > Custom Level > User Authentication > Logon > select 'Choose Automatic logon with user name and password'.
  • Verify that the CardioLogAgent directory files have at least 'Read' permissions for assigned to all users, and for including the application pool account.
  • If you still get a login box, install the the CardioLog Analytics SharePoint Featurefeature. 
You get a JavaScript error on the page
  • Send the JavaScript error message
to 
Support
  • support..
  • Remove the tracking code from your SharePoint website.
 How?

You

get

receive a browser security message

-

  • This is likely because your SharePoint site runs on SSL
See how to configure


Anchor
troubleshooting content
troubleshooting content
Troubleshooting Content Personalization Issues

In order to troubleshoot issues with the tracking agent test content personalization and follow the instructions below according to the outcome:

...

Delete your browser temporary files and  and test content personalization again. If it was not helpful, do the following:
  • Stop and Start the CardioLogApplicationPool in IIS.
  • If you have added the tracking code automatically using the Configuration Wizard, verify you have repeated this step for all of the SharePoint front-ends (WFEs) in your farm.
  • If you have deployed the "the CardioLog Analytics " SharePoint Featurefeature, verify it is has been activated.
  • If you have added the tracking code yourself, verify that you have removed the opening and closing script <script> tags.
  • Verify that the CardioLogAgent web application can be accessed from your workstation, and it is not blocked by a FW/Proxy in the organizationfirewall or proxy. This is done by browsing to http://[CardioLog server name:port]/CardioLogAgentEventCollector/camonitor.aspx (edit the Input your CardioLog server name and port). View the ports which are used  View the ports used by CardioLog Analytics.
  • Check for server errors in personalizing content.
An error message is displayed in the Agent Console SharePoint Marketing Suite tab
  • Verify that the EventCollector web application can be accessed from the your SharePoint front-ends (WFEs), and that it is not blocked by a FW/Proxy in the organizationfirewall or proxy, by browsing to http://[CardioLog server name:port]/EventCollector/caCached.aspx (edit the Input your CardioLog server name and port). The expected result is a an XML response. To see which ports are used  View the ports used by CardioLog Analytics click here.
  • Verify that the CardioLog database is up and running, and the CardioLog application pool user account can account is assigned a db_owner role, and can connect to itthe database.
  • Check for server errors in personalizing content.
You get see a blank page for about 5 seconds and then the page is loaded loads with no content modifications, if any
The default timeout for loading the visitor segments information in order to personalize the page content is 5 seconds. In case of a connection error, do the following:
  • Configure the default timeout for content personalization in the JavaScript tracking code.
  • Verify the CardioLogAgent web application can be accessed from your workstation, and it is not blocked by a FW/Proxy in the organizationfirewall or proxy. This is done by browsing to http://[CardioLog server name:port]/CardioLogAgent/ca.aspx (edit the Input your CardioLog server name and port). View the ports which are used  View the ports used by CardioLog Analytics.
You get a JavaScript error on the page
  • Send the JavaScript error
message to Intlock Support
 How?

 

Anchor
view server error
view server error
How to View Server Error Messages

In order to configure detailed server errors for the tracking agent, edit the "KeywordForShowingErrors" key in the following files: [CardioLog Installation Folder]\CardioLogAgent\Web.config and  and [CardioLog Installation Folder]\EventCollector\Web.config:

...

Each customer must set his own unique value for "kfse". 
When using a valid "kfse" URL parameter, page caching and timeouts are ignored and one you can view the server error. In order to overcome avoid caching, modify the "kfse" parameter value with every call time so it contains the original value, for example, if "kfse" is "test", then use "test1", "test2", "testabc", etc. each time you browse to the page.

 

In order to turn on message logging to trace the tracking agent, add the "Message" switch to the "logType" key to the [CardioLog Installation Folder]\EventCollector\web.config file -

<add key="logType" value="Message,Warning,Error" />

...

Anchor
view server error tracking
view server error tracking
View Server Errors in Tracking Usage Data

To view the server error, browse the following page and add the "kfse" URL parameter (the . The "kfse" URL parameter value must correspond to the "KeywordForShowingErrors" keyword): 

Example error message: "Error caught in tunnel: Request timed out"
Solution: Verify that the EventCollector web application can be accessed from the SharePoint front-ends, and that it is has not been blocked by a FW/Proxy in the organizationfirewall or proxy. This is done by browsing to http://[CardioLog server name:port]/EventCollector/monitor.aspx (edit the Input your CardioLog server name and port). The expected result is an XML response. View the ports which are used  View the ports used by CardioLog Analytics. 
 

...

Anchor
view server error storing
view server error storing
View Server Errors in Storing Usage Data

To view the server error, browse to the following page and add the "kfse" URL parameter (the . The "kfse" URL parameter value must correspond to the "KeywordForShowingErrors" keyword): 

To view

...

a detailed log of the data collection process, open the [CardioLog Installation Folder]/CardioLogScheduleServices\Logs\EventCollector.log file.

 
Example error messages: "Error registering event", "Unrecognized event type"
Solution: Verify that the CardioLog database is up and running, the CardioLog application pool user account can connect to it, and it is account is assigned a db_owner role, and can connect to the database.
 
 

 View server errors in personalizing content

Anchor
view server error personalizing
view server error personalizing
View Server Errors in Personalizing Content

To view the server error, browse to the following pages and add the "kfse" URL parameter (the . The "kfse" URL parameter value must correspond to the "KeywordForShowingErrors" keyword).

Note: these files are cached by default, in order to overcome avoid caching and display the error message, modify the "kfse" parameter value with every call time so it contains the original value. For example, if "kfse" is "test", then use "test1", "test2", "testabc", etc. each time you browse to the page. 

Example error message: