Chat Support
Loupe - Log - Monitor - Resolve
Loupe / Developer's Guide / For .NET Core / 6 / 8 / Agent Configuration / Developer's Guide - Server Configuration
Developer's Guide - Server Configuration

The Server section configures an agent to communicate with a Loupe Server.  With it you can both provide the information necessary to connect to the server and whether you want sessions to be sent automatically in the background (a capability unique to the Agent / Server connection).

Configuration Type Path
JSON File Loupe.Server
Environment Variable Prefix Loupe__Server
Option Description Default Value Required
Enabled True by default, disables server communication when false. true false
UseGibraltarService When true, specifies that the Loupe Cloud-Hosted Service should be used instead of a Self-hosted Loupe Server. false false
ApplicationKey A unique Application Key for the Loupe Repository you want to send data to.  When specified, the CustomerName and Repository fields are ignored. "" false
CustomerName The unique customer name when using the Loupe Cloud-hosted Service.  Only applies when UseGibraltarService is false. "" false
Server The full DNS name of the server where the Server is located. Only applies to a Self-hosted Loupe Server. "" false
UseSsl Indicates if the connection should be encrypted with SSL. Only applies to a Self-hosted Loupe Server. false false
Port An optional port number override for the server. Not required if the port is the traditional port (80 or 443). Only applies to a Self-hosted Loupe Server. 0 false
ApplicationBaseDirectory The virtual directory on the host for a Self-hosted Loupe Server. "" false
Repository The specific repository on the server to send the session to.  Only applies to a Self-hosted Loupe Server running Enterprise Edition. "" false
AutoSendSessions Indicates whether to automatically send session data to the server in the background. false false
AutoSendOnError Indicates whether to automatically send data to the server when error or critical messages are logged. true false
SendAllApplications Indicates whether to send data about all applications for this product to the server or just the current application. false false
PurgeSentSessions Indicates whether to remove sessions that have been sent from the local repository once confirmed by the server. false false

Examples

Loupe Cloud-Hosted Default Configuration

This uses the name of your Loupe Cloud-Hosted repository to identify where to route your data in the Loupe Cloud.  You can sign up for a Loupe Cloud account at the Loupe Customer Site.

appsettings.json
Copy Code
{
  "Loupe": {
    "Publisher": {
      "ProductName": "AspNetCore2.Sandbox",
      "ApplicationName": "Test",
      "ApplicationType": "AspNet",
      "ApplicationVersionNumber": "1.0.1"
    },
    "Server": {
      "UseGibraltarService": true,
      "CustomerName": "Your_Service_Name",
      "AutoSendSessions": true,
      "SendAllApplications": true
    }
  }
}

 

Environment Configuration
Copy Code
Loupe__Server__UseGibraltarService=True
Loupe__Server__CustomerName=Your_Service_Name
Loupe__Server__AutoSendSessions=True
Loupe__Server__SendAllApplications=True

Loupe Cloud-Hosted Application Key

If you want to use Loupe Monitor or have more control over how your data is received by the Loupe Cloud-Hosted Service, use an Application Key instead of your customer name.  Application Keys can route your data into an Application Environment and they can be blocked if you want to prevent transfer without re-deploying your application.

appsettings.json
Copy Code
{
  "Loupe": {
    "Publisher": {
      "ProductName": "AspNetCore2.Sandbox",
      "ApplicationName": "Test",
      "ApplicationType": "AspNet",
      "ApplicationVersionNumber": "1.0.1"
    },
    "Server": {
      "UseGibraltarService": true,
      "ApplicationKey": "Your_Application_Key",
      "AutoSendSessions": true,
      "SendAllApplications": true
    }
  }
}

 

Environment Configuration
Copy Code
Loupe__Server__UseGibraltarService=True
Loupe__Server__ApplicationKey=Your_Application_Key
Loupe__Server__AutoSendSessions=True
Loupe__Server__SendAllApplications=True

Loupe Self-Hosted Standard Edition

With Standard Edition there is only one repository so you only have to specify the connection information for the Server web API.  At a minimum that requires the Server, but you may also specify useSsl to enable SSL, a port number or even a path in some rare situations.

appsettings.json
Copy Code
{
  "Loupe": {
    "Publisher": {
      "ProductName": "AspNetCore2.Sandbox",
      "ApplicationName": "Test",
      "ApplicationType": "AspNet",
      "ApplicationVersionNumber": "1.0.1"
    },
    "Server": {
      "Server": "your.server.dns.name",
      "AutoSendSessions": true,
      "SendAllApplications": true
    }
  }
}

Loupe Self-Hosted Enterprise Edition

Loupe Enterprise Edition supports mutiple repositories so either a repository or an Application Key has to be specified so Loupe can route the data correctly.  You also need to provide connection information for the Server web API.  At a minimum that requires the Server value, but you may also specifyh useSsl to enable SSL.  In this example, the Repository is specified:

appsettings.json
Copy Code
{
  "Loupe": {
    "Publisher": {
      "ProductName": "AspNetCore2.Sandbox",
      "ApplicationName": "Test",
      "ApplicationType": "AspNet",
      "ApplicationVersionNumber": "1.0.1"
    },
    "Server": {
      "Server": "your.server.dns.name",
      "Repository": "Your_Repository_Name",
      "AutoSendSessions": true,
      "SendAllApplications": true
    }
  }
}
See Also