Customizing .NET APM Agent

You can customize the agent behaviour through .NET environment options.

Configurations

You can set following configurations in the .NET agent.

Option	Description	Type
LicenseKey	APM License Key of your account.	`string`
AppName	Name of your Go project/app.	`string`
Tracing	Flag to enable/disable distributed tracing.	`boolean`
Analytics	Flag to enable/disable app analytics.	`boolean`
CaptureBody	Flag to capture request body and response body in analytics.	`string`
LogLevel	Sets the logging level for the agent. This option is case-insensitive.	`string`
CaptureLogs	Flag to capture logs in .NET agent.	`boolean`
NotifyUrls (env: `ATATUS_SERVER_URL`)	URL of your on-premise Atatus server, `YOUR_ON_PREMISE_URL`. In `Web.config` use `Atatus:NotifyUrls`.	`string`

All above configurations will set your environment as follows.

export ATATUS_LICENSE_KEY="ATATUS_LICENSE_KEY"

export ATATUS_APP_NAME=".NET App"
export ATATUS_SERVER_URL="YOUR_ON_PREMISE_URL"

export ATATUS_TRACING="true"

export ATATUS_ANALYTICS="true"

export ATATUS_CAPTURE_BODY="all"

export ATATUS_LOG_LEVEL="debug"

export ATATUS_CAPTURE_LOGS="true"

Set analytics

App Analytics collects all requests individually with contextual data. In Web.config file:

<!-- Web.config /> -->
<add key="Atatus:AppName" value="YOUR_APP_NAME" />
<add key="Atatus:LicenseKey" value="YOUR_LICENSE_KEY" />
<add key="Atatus:NotifyUrls" value="YOUR_ON_PREMISE_URL" />
<add key="Atatus:Analytics" value="true" />

In appssettings.json file:

// appssettings.json
"Atatus": {
  "AppName": "YOUR_APP_NAME",
  "LicenseKey": "YOUR_LICENSE_KEY",
  "NotifyUrls": "YOUR_ON_PREMISE_URL",
  "Analytics": true
}

In Environment:

# Environment
export ATATUS_ANALYTICS="true"

Set Tracing

Tracing records every step a request takes for each endpoint. In Web.config file:

<!-- Web.config /> -->
<add key="Atatus:AppName" value="YOUR_APP_NAME" />
<add key="Atatus:LicenseKey" value="YOUR_LICENSE_KEY" />
<add key="Atatus:Tracing" value="true" />

In appssettings.json file:

// appssettings.json
"Atatus": {
  "AppName": "YOUR_APP_NAME",
  "LicenseKey": "YOUR_LICENSE_KEY",
  "Tracing": true
}

In Environment:

# Environment
export ATATUS_TRACING="true"

Set captureBody

By default Analytics don’t capture request and response body. If you want capture request body, you can enable below options in Atatus initialization. This option is only applicable to Analytics, not for APM. In Web.config file:

<!-- Web.config /> -->
<add key="Atatus:AppName" value="YOUR_APP_NAME" />
<add key="Atatus:LicenseKey" value="YOUR_LICENSE_KEY" />
<add key="Atatus:Analytics" value="true" />
<add key="Atatus:Tracing" value="true" />
<add key="Atatus:CaptureBody" value="all" />

In appssettings.json file:

// appssettings.json
"Atatus": {
  "AppName": "YOUR_APP_NAME",
  "LicenseKey": "YOUR_LICENSE_KEY",
  "Analytics": true,
  "Tracing": true,
  "CaptureBody": "all"
}

In Environment:

# Environment
export ATATUS_ANALYTICS="true"
export ATATUS_TRACING="true"
export ATATUS_CAPTURE_BODY="all"

Enable debug log level

In case if you are facing any issues with .NET APM (Example: no data is coming, crashing the server, etc), you can enable the debug log level and log path in env options then send the logs to success@atatus.com. The available log levels are Error, Warning, Information, Debug. In Web.config file:

<!-- Web.config /> -->
<add key="Atatus:AppName" value="YOUR_APP_NAME" />
<add key="Atatus:LicenseKey" value="YOUR_LICENSE_KEY" />
<add key="Atatus:LogLevel" value="Debug" />

In appssettings.json file:

// appssettings.json
"Atatus": {
  "AppName": "YOUR_APP_NAME",
  "LicenseKey": "YOUR_LICENSE_KEY",
  "LogLevel": "Debug"
}

In Environment:

# Environment
export ATATUS_LOG_LEVEL="Debug"

Set log directory

To write agent logs to a file, set ATATUS_LOG_DIRECTORY to the folder where the agent should create its log files. File logging also turns on when you set the ATATUS_LOG_LEVEL environment variable to Debug or Trace, so set the directory along with it to control where the files go. Set the directory and log level in your environment as follows:

$ export ATATUS_LOG_DIRECTORY="/var/log/atatus"
$ export ATATUS_LOG_LEVEL="Debug"

The agent creates one log file per process, named <process-name>_<process-id>_<number>.agent.log.

ATATUS_LOG_DIRECTORY is read only from environment variables. Setting it in Web.config or appsettings.json has no effect. Make sure the user running your application can write to this folder.

​Configurations

​Set analytics

​Set Tracing

​Set captureBody

​Enable debug log level

​Set log directory

Configurations

Set analytics

Set Tracing

Set captureBody

Enable debug log level

Set log directory