Developer's Guide - Agent Configuration Common Scenarios

In This Topic

The Loupe Agent has extensive configuration options to tune nearly all aspects of its behavior. Wherever possible, sensible defaults have been chosen to minimize the amount of configuration that's necessary in normal operation. That said, there are a few common configurations that occur in typical Loupe deployments.

Items To Set Every Time

Virtually every application should configure the following properties:

Property	Content
Publisher.ProductName	A common name for the product that multiple applications are a part of. For example, "Microsoft Office"
Publisher.ApplicationName	The short name for a specific application within a product. For Example, "Outlook"
Publisher.ApplicationVersion	The version number for this specific build of the application. Loupe has several features that aggregate information by version number so updating this using semantic versioning or some other versioning scheme is important.
Publisher.ApplicationType	Optional. Specify the type of application to hint to Loupe how to treat it when searching for multiple users and other behaviors.

The examples below use these placeholder values that you need to replace:

Replace "Your Loupe Service Name" with the name of your Loupe Cloud-hosted Service. If you don't have one yet, sign up for a free trial service.
Replace "Your Product" and "Your Application" with friendly values for your application. A good analogy for Product is "Office" and Application is "Word", "Excel", and "PowerPoint".

Server Parameters

If you are using a Loupe Server you will need to configure the following additional properties:

Property	Content
Server.UseGibraltarService	If sending information to a Loupe server, specify this as true or false to indicate whether you are sending to Loupe Cloud-Hosted (true) or to a Loupe Self-Hosted (false) server.
Server.Customer	If using Loupe Cloud-Hosted this is your unique service name.
Server.Server	If using Loupe Self-Hosted this is the DNS name of your server.
Server.AutoSendSessions	True to enable background automatic sending of session data to the server as soon as the session files are closed.

Send Data to Loupe Cloud-Hosted

Properties File
XML File

XML File

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
    <entry key="Publisher.ProductName">Your Product</entry>
    <entry key="Publisher.ApplicationName">Your Application</entry>
    <entry key="Publisher.ApplicationVersion">1.0.0</entry>
    <entry key="Server.UseGibraltarService">true</entry>
    <entry key="Server.CustomerName">Your Loupe Service Name</entry>
    <entry key="Server.AutoSendSessions">true</entry>
    <entry key="Server.SendAllApplications">true</entry>
    <entry key="Server.PurgeSentSessions">false</entry>
    <entry key="NetworkViewer.AllowRemoteClients=true">false</entry>
</properties>

This configuration indicates session data should be sent to a Loupe Service account (hosted on our SaaS platform). You'll need to enter the name you gave your Loupe Service when you set it up (this is not your email address or user name - it's the name of the subscription you created).

AutoSendSessions, SendAllApplications, and PurgeSentSessions work together to request that:

Sessions data should be sent automatically in the background as the application runs (AutoSendSessions = true)
For any application in the same product as the running application. (SendAllApplications = true)
Once session data is confirmed by the server it will still be left locally. (PurgeSentSessions = false)

Assuming this is a server application, Live Sessions is enabled for remote clients which will relay through the server.

Send Data to A Loupe Self-Hosted Server

Properties File
XML File

XML File

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
    <entry key="Publisher.ProductName">Your Product</entry>
    <entry key="Publisher.ApplicationName">Your Application</entry>
    <entry key="Publisher.ApplicationVersion">1.0.0</entry>
    <entry key="Server.Server">server.dns.name</entry>
    <entry key="Server.UseSsl">true</entry>
    <entry key="Server.AutoSendSessions">true</entry>
    <entry key="Server.SendAllApplications">true</entry>
    <entry key="Server.PurgeSentSessions">false</entry>
    <entry key="NetworkViewer.AllowRemoteClients">true</entry>
</properties>

This configuration indicates session data should be sent to the server "server.dns.name" (you'd need to substitute the real DNS name of your server) using SSL.

AutoSendSessions, SendAllApplications, and PurgeSentSessions work together to request that:

Sessions data should be sent automatically in the background as the application runs (AutoSendSessions = true)
For any application in the same product as the running application. (SendAllApplications = true)
Once session data is confirmed by the server it will still be left locally. (PurgeSentSessions = false)

Assuming this is a server application, Live Sessions is enabled for remote clients which will relay through the server.

Sending to an Enterprise Edition Server

This configuration indicates session data should be sent to the repository "uniqueRepoistoryName" hosted on the cluster "cluster.dns.name" (you'd need to substitute the real DNS name of your cluster) using SSL.

AutoSendSessions, SendAllApplications, and PurgeSentSessions work together to request that:

Sessions data should be sent automatically in the background as the application runs (AutoSendSessions = true)
For any application in the same product as the running application. (SendAllApplications = true)
Once session data is confirmed by the server it will still be left locally. (PurgeSentSessions = false)

Assuming this is a server application, Live Sessions is enabled for remote clients which will relay through the server.

Specifying an Environment and Promotion Level

These values are useful for categorizing sessions on the server and within Loupe Desktop. Environment is typically used to describe the compute environment or location where the application is being run. Promotion Level is useful when you have strongly separated QA, Certification, Test, or Production areas. These values can also be configured on the server if necessary.

Properties File
XML File

XML File

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
    <entry key="Publisher.ProductName">Your Product</entry>
    <entry key="Publisher.ApplicationName">Your Application</entry>
    <entry key="Publisher.ApplicationVersion">1.0.0</entry>
    <entry key="Publisher.EnvironmentName">Azure</entry>
    <entry key="Publisher.PromotionLevelName">Production</entry>
                    </properties>

In this scenario the environment has been set to Azure and the promotion level to Production.

Reference

Reference - Session Categorization

Send Feedback