Abstract base class for ShareUsageElement builders.
| ShareUsageBuilderBase (ILoggerFactory loggerFactory)
Constructor More...
| |
| ShareUsageBuilderBase (ILoggerFactory loggerFactory, ILogger logger) |
| string | ShareUsageUrl => ShareUsageUri.AbsoluteUri
The remote endpoint to send usage data to. More...
|
| ILoggerFactory | LoggerFactory [get]
The logger factory used by this builder More...
|
| ILogger | Logger [get]
The logger to be used by this builder More...
|
| int | RepeatEvidenceInterval = Constants.SHARE_USAGE_DEFAULT_REPEAT_EVIDENCE_INTERVAL [get]
Where a set of evidence values exactly matches a previously seen set of evidence values, it will not be shared if that situation occurs within this time interval. More...
|
| double | SharePercentage = Constants.SHARE_USAGE_DEFAULT_SHARE_PERCENTAGE [get]
The approximate proportion of events to share. More...
|
| int | MinimumEntriesPerMessage = Constants.SHARE_USAGE_DEFAULT_MIN_ENTRIES_PER_MESSAGE [get]
The minimum number of entries to be present in the XML PAyload before it is sent to the usage sharing endpoint. More...
|
| int | MaximumQueueSize [get]
Set the maximum number of entries to be stored in the queue to be sent. More...
|
| int | AddTimeout = Constants.SHARE_USAGE_DEFAULT_ADD_TIMEOUT [get]
The timeout in milliseconds to allow when attempting to add an item to the queue. More...
|
| int | TakeTimeout = Constants.SHARE_USAGE_DEFAULT_TAKE_TIMEOUT [get]
The timeout in milliseconds to allow when attempting to take an item from the queue in order to send to the remote service. More...
|
| Uri | ShareUsageUri = new Uri(Constants.SHARE_USAGE_DEFAULT_URL) [get]
The remote endpoint to send usage data to. More...
|
| string | AspSessionCookieName = Engines.Constants.DEFAULT_ASP_COOKIE_NAME [get]
The name of the cookie that contains the asp.net session id. More...
|
| List< string > | BlockedHttpHeaders = new List<string>() [get]
A list of HTTP headers that should not be shared. More...
|
| List< string > | IncludedQueryStringParameters = new List<string>() [get]
A list of query string parameters to be shared. More...
|
| List< KeyValuePair< string, string > > | IgnoreDataEvidenceFilter = new List<KeyValuePair<string, string>>() [get]
A collection of evidence keys and values which, if present, cause the event to be ignored for the purposes of usage sharing. More...
|
| bool | TrackSession [get]
Controls whether session tracking is enabled or disabled. More...
|
| bool | ShareAllEvidence = false [get]
If set to true then all evidence values will be shared. More...
|
| FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.ShareUsageBuilderBase | ( | ILoggerFactory | loggerFactory | ) |
Constructor
| FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.ShareUsageBuilderBase | ( | ILoggerFactory | loggerFactory, |
| ILogger | logger | ||
| ) |
| abstract T FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.Build | ( | ) |
Create the ShareUsageElement
Implemented in FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilder.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetAddTimeout | ( | int | milliseconds | ) |
Set the timeout in milliseconds to allow when attempting to add an item to the queue.
If this timeout is exceeded then usage sharing will be disabled.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetAspSessionCookieName | ( | string | cookieName | ) |
Set the name of the cookie that contains the asp.net session id.
This setting has no effect if TrackSession is false.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetBlockedHttpHeader | ( | string | blockedHeader | ) |
By default, all HTTP headers (excluding a few such as 'cookies') are shared.
Individual headers can be excluded from sharing by adding them to this list.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetBlockedHttpHeaders | ( | List< string > | blockedHeaders | ) |
By default, all HTTP headers (excluding a few such as 'cookies') are shared.
Individual headers can be excluded from sharing by adding them to this list.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetIgnoreFlowDataEvidenceFilter | ( | string | evidenceFilter | ) |
This setting can be used to stop the usage sharing element from sharing anything about specific requests.
For example, if you wanted to stop sharing any details from requests where the user-agent header was 'ABC', you would set this to "header.user-agent:ABC"
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetIncludedQueryStringParameter | ( | string | queryStringParameterName | ) |
By default query string and HTTP form parameters are not shared unless prefixed with '51D_'.
This setting allows you to share these parameters with 51Degrees if needed.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetIncludedQueryStringParameters | ( | List< string > | queryStringParameterNames | ) |
By default query string and HTTP form parameters are not shared unless prefixed with '51D_'.
This setting allows you to share these parameters with 51Degrees if needed.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetIncludedQueryStringParameters | ( | string | queryStringParameterNames | ) |
By default query string and HTTP form parameters are not shared unless prefixed with '51D_'.
This setting allows you to share these parameters with 51Degrees if needed.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetMaximumQueueSize | ( | int | size | ) |
Set the maximum number of entries to be stored in the queue to be sent.
This must be more than MinimumEntriesPerMessage.
By default, the value is calculated automatically based on the MinimumEntriesPerMessage setting.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetMinimumEntriesPerMessage | ( | int | minimumEntriesPerMessage | ) |
The usage element will group data into single requests before sending it.
This setting controls the minimum number of entries before data is sent. If you are sharing large amounts of data, increasing this value is recommended in order to reduce the overhead of sending HTTP messages. For example, the 51Degrees cloud service uses a value of 2500.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetRepeatEvidenceIntervalMinutes | ( | int | interval | ) |
If exactly the same evidence values are seen multiple times within this time limit then they will only be shared once.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetShareAllEvidence | ( | bool | shareAll | ) |
Configure the usage sharing element to share all evidence.
This will override all the other evidence filtering settings.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetShareAllQueryStringParameters | ( | bool | shareAll | ) |
Configure the usage sharing element to share all query string and HTTP form parameters.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetSharePercentage | ( | double | sharePercentage | ) |
Set the percentage of data that the ShareUsageElement should be sharing.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetShareUsageUrl | ( | string | shareUsageUrl | ) |
Set the URL to use when sharing usage data.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetShareUsageUrl | ( | Uri | shareUsageUrl | ) |
Set the URL to use when sharing usage data.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetTakeTimeout | ( | int | milliseconds | ) |
Set the timeout in milliseconds to allow when attempting to take an item from the queue in order to send to the remote service.
| ShareUsageBuilderBase<T> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SetTrackSession | ( | bool | track | ) |
If set to true, the configured session cookie will be used to identify user sessions.
This will help to differentiate duplicate values that should not be shared.
| string FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.ShareUsageUrl => ShareUsageUri.AbsoluteUri |
The remote endpoint to send usage data to.
| int FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.AddTimeout = Constants.SHARE_USAGE_DEFAULT_ADD_TIMEOUT |
The timeout in milliseconds to allow when attempting to add an item to the queue.
If this timeout is exceeded then usage sharing will be disabled.
| string FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.AspSessionCookieName = Engines.Constants.DEFAULT_ASP_COOKIE_NAME |
The name of the cookie that contains the asp.net session id.
This is used to help prevent the same usage data being shared multiple times.
| List<string> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.BlockedHttpHeaders = new List<string>() |
A list of HTTP headers that should not be shared.
| List<KeyValuePair<string, string> > FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.IgnoreDataEvidenceFilter = new List<KeyValuePair<string, string>>() |
A collection of evidence keys and values which, if present, cause the event to be ignored for the purposes of usage sharing.
| List<string> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.IncludedQueryStringParameters = new List<string>() |
A list of query string parameters to be shared.
| ILogger FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.Logger |
The logger to be used by this builder
| ILoggerFactory FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.LoggerFactory |
The logger factory used by this builder
| int FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.MaximumQueueSize |
Set the maximum number of entries to be stored in the queue to be sent.
This must be more than the minimum entries per message. By default, the value is calculated automatically based on the MinimumEntriesPerMessage setting.
| int FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.MinimumEntriesPerMessage = Constants.SHARE_USAGE_DEFAULT_MIN_ENTRIES_PER_MESSAGE |
The minimum number of entries to be present in the XML PAyload before it is sent to the usage sharing endpoint.
| int FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.RepeatEvidenceInterval = Constants.SHARE_USAGE_DEFAULT_REPEAT_EVIDENCE_INTERVAL |
Where a set of evidence values exactly matches a previously seen set of evidence values, it will not be shared if that situation occurs within this time interval.
(in minutes)
| bool FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.ShareAllEvidence = false |
If set to true then all evidence values will be shared.
| double FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.SharePercentage = Constants.SHARE_USAGE_DEFAULT_SHARE_PERCENTAGE |
The approximate proportion of events to share.
Specified as a floating point number from 0 to 1.
| Uri FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.ShareUsageUri = new Uri(Constants.SHARE_USAGE_DEFAULT_URL) |
The remote endpoint to send usage data to.
| int FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.TakeTimeout = Constants.SHARE_USAGE_DEFAULT_TAKE_TIMEOUT |
The timeout in milliseconds to allow when attempting to take an item from the queue in order to send to the remote service.
| bool FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.ShareUsageBuilderBase< T >.TrackSession |
Controls whether session tracking is enabled or disabled.
If enabled, requests from a single user session will only be shared once.
