Skip to end of metadata
Go to start of metadata

Configuration File

CodeSmith Insight can also be configured via a configuration file. The documentation below will help you configure your Insight Instance.

<codesmith.insight /> Section

The codesmith.insight section is a required section that is needed to enter the api key for submiting cases the Insight

Attribute Name

Required

Description

apiKey

Yes

The API key is required to send data to the insight service.

serverUrl

No

The URL to the insight service. The default is app.codesmithinsight.com

queuePath

No

A local path on the client where reports are queued before sending to insight.  If this path is null, Isolated Storage is used.

enableLogging

No

Set to true to enable internal logging for the insight client.

logPath

No

The local path where log files for internal logging are written.

Example

<settings /> Subsection

The settings section is used to override server settings.  Settings are adding with a key value pair. 

Attribute Name

Data TypeDefault Value

Description

UserNamespaces

Semicolon delimited string 

This allows you to declare specific namespaces you would like to log exceptions for.

EnableAddScreenShot

BooleanTrue

You can turn off Screenshot capturing when an error happens by setting this to True or False.

For a full list of configured server settings, please take a look at the Settings -> Data -> Configuration node inside of the Insight.

Example

<customFields /> Subsection

The customFields section is used to add custom fields to the insight reports.

Example

<tags /> Subsection

The tags sections is used to add custom tags to the insight reports.

Example

Configuration Attribute

InsightAttribute

The insight attribute is an assembly level attribute used to configure the api key and other various settings for the insight client.  This attribute can only appear once in an assembly.

Property Name 

Required 

Description

ApiKey 

Yes

The API key is required to send data to the insight service.

ServerUrl 

No

The URL to the insight service. The default is app.codesmithinsight.com

QueuePath 

No

A local path on the client where reports are queued before sending to insight.  If this path is null, Isolated Storage is used.

EnableLogging 

No

Set to true to enable internal logging for the insight client.

LogPath 

No

The local path where log files for internal logging are written. 

Example

InsightSettingAttribute

The settings attribute is used to override server settings.  Settings are in a name value pair. There can be multiple InsightSettings attributes in an assembly.

Example

Labels: