search close

.Net Module Install

access_time Updated Jun 29, 2022

Requirements

  • .NET Framework 4.5 or higher.
  • Verify you have installed the Signal Sciences Windows Agent. This will ensure the appropriate folder structure is in place on your file system.
  • Download the latest .NET Module, or get it via Nuget

Install

  1. Download the latest Signal Sciences .Net module.

  2. Extract the contents of sigsci-module-dotnet-x.x.x.zip to your application’s bin directory.

  3. Add the following sections to your application’s web.config file:

    <configuration>
        ...
        <configSections>
            <section name="SignalSciencesModule" type="SignalSciences.ModuleConfiguration"/>
        </configSections>
    
        ...
        <system.webServer>
            <modules>
                <add name="SignalSciencesModule" type="SignalSciences.HttpModule"/>
            </modules>
        </system.webServer>
        ...
    
        <SignalSciencesModule agentEndPoint="127.0.0.1:737" />
        ...
    </configuration>

  4. Restart the web site service.

Note: Ensure the AgentEndPoint value is set to the same IP and port configured with the Signal Sciences agent’s rpc-address value. See the Windows agent installation documentation for additional information about Windows agent configuration options.

.NET module configuration

Option Default Description
agentEndPoint required, no default The TCP endpoint (host:port) that the Agent is listening on. host can be either a hostname or an IPv4 or IPv6 address.
filterHeaders optional, no default Comma-separated list of request and response headers that should not be sent to the Agent. Case insensitive. Regardless of configuration, it always includes Cookie, Set-Cookie, Authorization and X-Auth-Token.
agentRpcTimeoutMillis optional, default: 200 Maximum number of milliseconds allowed for each RPC call to the Agent.
agentConnectionPoolSize optional, default: 10 Number of connections that, once opened, will be retained in a pool.
maxPostSize optional, default: 100000 A request body above this size will not be sent to the Agent.
anomalySize optional, default: 524288 If the HTTP response is this size or larger, log it with the Agent.
anomalyDurationMillis optional, default: 1000 If the response took longer than this number of milliseconds, log it with the Agent.

Sample advanced .NET module configuration

<SignalSciencesModule
            agentEndPoint="127.0.0.1:737"
            filterHeaders="X-My-Private-Header, X-My-Other-Header"
            agentRpcTimeoutMillis="200"
            agentConnectionPoolSize="10"
            maxPostSize="100000"
            anomalySize="524288"
            anomalyDurationMillis="1000"
            />