Developer's Guide - Agent Configuration
In This Topic
The Loupe Agent offers a range of configuration options to tune its behavior. Most are designed to have good default values and not require any modification for your use, but a few minimum values need to be set to get the most out of Loupe.
Loupe defines an AgentConfiguration type to expose the strongly-typed properties for different configuration areas, each with multiple sub-properties for the actual settings:
- Publisher: for top-level configuration of your application's metadata. You will need to set some options on this type.
- Server: controls how information is sent to a Loupe server (and which server).
- SessionFile: controls how local Loupe data files are stored and managed.
- NetworkViewer: enables or disables the real-time TCP/IP log stream for local and remote viewing.
- Listener: controls what the Loupe agent automatically records as your application runs.
- Performance: controls Windows performance counter collection.
Configuring through files, environment variables, and others
.NET Core has a new model for building configuration via Microsoft.Extensions.Configuration. If you're developing an ASP.NET Core application you’ll already have references to the required assemblies, but for a regular console application or service you’ll need to add package references for Microsoft.Extensions.Configuration.Json and Microsoft.Extensions.Configuration.Binder.
For details on how to take advantage of the configuration builder to manage your Loupe Agent settings see Developer's Guide - Agent Configuration through Configuration Builder
Configuring through code
You can perform all agent configuration tasks in code with no configuration file being required. This is particularly useful if you want to ship your application as a single file or ensure that end users can't modify the agent configuration.
To see how to configure the agent through code without requiring a configuration file, see Developer's Guide - Agent Configuration through Code.
Common Scenarios
Loupe has an extensive set of configuration options. For a quick overview of some common configurations and purposes, see
Developer's Guide - Agent Configuration Common Scenarios.
See Also