summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--src/DotNetOpenAuth/Configuration/DotNetOpenAuth.xsd4
-rw-r--r--src/DotNetOpenAuth/Configuration/ReportingElement.cs70
-rw-r--r--src/DotNetOpenAuth/Reporting.cs54
3 files changed, 100 insertions, 28 deletions
diff --git a/src/DotNetOpenAuth/Configuration/DotNetOpenAuth.xsd b/src/DotNetOpenAuth/Configuration/DotNetOpenAuth.xsd
index 873ae0e..f27e50e 100644
--- a/src/DotNetOpenAuth/Configuration/DotNetOpenAuth.xsd
+++ b/src/DotNetOpenAuth/Configuration/DotNetOpenAuth.xsd
@@ -316,6 +316,10 @@
<xs:element name="reporting">
<xs:complexType>
<xs:attribute name="enabled" type="xs:boolean" />
+ <xs:attribute name="minimumReportingInterval" type="xs:string" />
+ <xs:attribute name="minimumFlushInterval" type="xs:string" />
+ <xs:attribute name="includeFeatureUsage" type="xs:boolean" default="true" />
+ <xs:attribute name="includeEventStatistics" type="xs:boolean" default="true" />
</xs:complexType>
</xs:element>
</xs:choice>
diff --git a/src/DotNetOpenAuth/Configuration/ReportingElement.cs b/src/DotNetOpenAuth/Configuration/ReportingElement.cs
index b771698..27a6880 100644
--- a/src/DotNetOpenAuth/Configuration/ReportingElement.cs
+++ b/src/DotNetOpenAuth/Configuration/ReportingElement.cs
@@ -21,6 +21,35 @@ namespace DotNetOpenAuth.Configuration {
private const string EnabledAttributeName = "enabled";
/// <summary>
+ /// The name of the @minimumReportingInterval attribute.
+ /// </summary>
+ private const string MinimumReportingIntervalAttributeName = "minimumReportingInterval";
+
+ /// <summary>
+ /// The name of the @minimumFlushInterval attribute.
+ /// </summary>
+ private const string MinimumFlushIntervalAttributeName = "minimumFlushInterval";
+
+ /// <summary>
+ /// The name of the @includeFeatureUsage attribute.
+ /// </summary>
+ private const string IncludeFeatureUsageAttributeName = "includeFeatureUsage";
+
+ /// <summary>
+ /// The name of the @includeEventStatistics attribute.
+ /// </summary>
+ private const string IncludeEventStatisticsAttributeName = "includeEventStatistics";
+
+ /// <summary>
+ /// The default value for the @minimumFlushInterval attribute.
+ /// </summary>
+#if DEBUG
+ private const string MinimumFlushIntervalDefault = "0";
+#else
+ private const string MinimumFlushIntervalDefault = "0:15";
+#endif
+
+ /// <summary>
/// Initializes a new instance of the <see cref="ReportingElement"/> class.
/// </summary>
internal ReportingElement() {
@@ -35,5 +64,46 @@ namespace DotNetOpenAuth.Configuration {
get { return (bool)this[EnabledAttributeName]; }
set { this[EnabledAttributeName] = value; }
}
+
+ /// <summary>
+ /// Gets or sets the maximum frequency that reports will be published.
+ /// </summary>
+ [ConfigurationProperty(MinimumReportingIntervalAttributeName, DefaultValue = "1")] // 1 day default
+ internal TimeSpan MinimumReportingInterval {
+ get { return (TimeSpan)this[MinimumReportingIntervalAttributeName]; }
+ set { this[MinimumReportingIntervalAttributeName] = value; }
+ }
+
+ /// <summary>
+ /// Gets or sets the maximum frequency the set can be flushed to disk.
+ /// </summary>
+ [ConfigurationProperty(MinimumFlushIntervalAttributeName, DefaultValue = MinimumFlushIntervalDefault)]
+ internal TimeSpan MinimumFlushInterval {
+ get { return (TimeSpan)this[MinimumFlushIntervalAttributeName]; }
+ set { this[MinimumFlushIntervalAttributeName] = value; }
+ }
+
+ /// <summary>
+ /// Gets or sets a value indicating whether to include a list of library features used in the report.
+ /// </summary>
+ /// <value><c>true</c> to include a report of features used; otherwise, <c>false</c>.</value>
+ [ConfigurationProperty(IncludeFeatureUsageAttributeName, DefaultValue = true)]
+ internal bool IncludeFeatureUsage {
+ get { return (bool)this[IncludeFeatureUsageAttributeName]; }
+ set { this[IncludeFeatureUsageAttributeName] = value; }
+ }
+
+ /// <summary>
+ /// Gets or sets a value indicating whether to include statistics of certain events such as
+ /// authentication success and failure counting, and can include remote endpoint URIs.
+ /// </summary>
+ /// <value>
+ /// <c>true</c> to include event counters in the report; otherwise, <c>false</c>.
+ /// </value>
+ [ConfigurationProperty(IncludeEventStatisticsAttributeName, DefaultValue = true)]
+ internal bool IncludeEventStatistics {
+ get { return (bool)this[IncludeEventStatisticsAttributeName]; }
+ set { this[IncludeEventStatisticsAttributeName] = value; }
+ }
}
}
diff --git a/src/DotNetOpenAuth/Reporting.cs b/src/DotNetOpenAuth/Reporting.cs
index 3a67c80..212fe22 100644
--- a/src/DotNetOpenAuth/Reporting.cs
+++ b/src/DotNetOpenAuth/Reporting.cs
@@ -31,20 +31,6 @@ namespace DotNetOpenAuth {
/// </summary>
internal static class Reporting {
/// <summary>
- /// The maximum frequency that reports will be published.
- /// </summary>
- private static readonly TimeSpan minimumReportingInterval = TimeSpan.FromDays(1);
-
- /// <summary>
- /// The maximum frequency the set can be flushed to disk.
- /// </summary>
-#if DEBUG
- private static readonly TimeSpan minimumFlushInterval = TimeSpan.Zero;
-#else
- private static readonly TimeSpan minimumFlushInterval = TimeSpan.FromMinutes(15);
-#endif
-
- /// <summary>
/// The isolated storage to use for collecting data in between published reports.
/// </summary>
private static IsolatedStorageFile file;
@@ -137,6 +123,13 @@ namespace DotNetOpenAuth {
internal static bool Enabled { get; set; }
/// <summary>
+ /// Gets the configuration to use for reporting.
+ /// </summary>
+ private static ReportingElement Configuration {
+ get { return DotNetOpenAuthSection.Configuration.Reporting; }
+ }
+
+ /// <summary>
/// Records an event occurrence.
/// </summary>
/// <param name="eventName">Name of the event.</param>
@@ -144,14 +137,16 @@ namespace DotNetOpenAuth {
internal static void RecordEventOccurrence(string eventName, string category) {
Contract.Requires<ArgumentException>(!String.IsNullOrEmpty(eventName));
- PersistentCounter counter;
- lock (events) {
- if (!events.TryGetValue(eventName, out counter)) {
- events[eventName] = counter = new PersistentCounter(file, "event-" + SanitizeFileName(eventName) + ".txt");
+ if (Enabled && Configuration.IncludeEventStatistics) {
+ PersistentCounter counter;
+ lock (events) {
+ if (!events.TryGetValue(eventName, out counter)) {
+ events[eventName] = counter = new PersistentCounter(file, "event-" + SanitizeFileName(eventName) + ".txt");
+ }
}
- }
- counter.Increment(category);
+ counter.Increment(category);
+ }
}
/// <summary>
@@ -161,7 +156,10 @@ namespace DotNetOpenAuth {
/// <param name="category">The category within the event. Null and empty strings are allowed, but considered the same.</param>
internal static void RecordEventOccurrence(object eventNameByObjectType, string category) {
Contract.Requires<ArgumentNullException>(eventNameByObjectType != null);
- RecordEventOccurrence(eventNameByObjectType.GetType().Name, category);
+
+ if (Enabled && Configuration.IncludeEventStatistics) {
+ RecordEventOccurrence(eventNameByObjectType.GetType().Name, category);
+ }
}
/// <summary>
@@ -171,7 +169,7 @@ namespace DotNetOpenAuth {
internal static void RecordFeatureUse(string feature) {
Contract.Requires<ArgumentException>(!String.IsNullOrEmpty(feature));
- if (Enabled) {
+ if (Enabled && Configuration.IncludeFeatureUsage) {
observedFeatures.Add(feature);
Touch();
}
@@ -184,7 +182,7 @@ namespace DotNetOpenAuth {
internal static void RecordFeatureUse(object value) {
Contract.Requires<ArgumentNullException>(value != null);
- if (Enabled) {
+ if (Enabled && Configuration.IncludeFeatureUsage) {
observedFeatures.Add(value.GetType().Name);
Touch();
}
@@ -199,7 +197,7 @@ namespace DotNetOpenAuth {
internal static void RecordFeatureAndDependencyUse(object value, object dependency1, object dependency2) {
Contract.Requires<ArgumentNullException>(value != null);
- if (Enabled) {
+ if (Enabled && Configuration.IncludeFeatureUsage) {
StringBuilder builder = new StringBuilder();
builder.Append(value.GetType().Name);
builder.Append(" ");
@@ -223,7 +221,7 @@ namespace DotNetOpenAuth {
Contract.Requires<ArgumentNullException>(service != null);
Contract.Requires<ArgumentNullException>(tokenManager != null);
- if (Enabled) {
+ if (Enabled && Configuration.IncludeFeatureUsage) {
StringBuilder builder = new StringBuilder();
builder.Append(value.GetType().Name);
builder.Append(" ");
@@ -393,7 +391,7 @@ namespace DotNetOpenAuth {
private static void Touch() {
// Publish stats if it's time to do so.
lock (publishingConsiderationLock) {
- if (DateTime.Now - lastPublished > minimumReportingInterval) {
+ if (DateTime.Now - lastPublished > Configuration.MinimumReportingInterval) {
lastPublished = DateTime.Now;
SendStatsAsync();
}
@@ -612,7 +610,7 @@ namespace DotNetOpenAuth {
}
}
- if (this.dirty && DateTime.Now - this.lastFlushed > minimumFlushInterval) {
+ if (this.dirty && DateTime.Now - this.lastFlushed > Configuration.MinimumFlushInterval) {
this.Flush();
}
}
@@ -749,7 +747,7 @@ namespace DotNetOpenAuth {
this.counters.TryGetValue(category, out counter);
this.counters[category] = counter + 1;
this.dirty = true;
- if (this.dirty && DateTime.Now - this.lastFlushed > minimumFlushInterval) {
+ if (this.dirty && DateTime.Now - this.lastFlushed > Configuration.MinimumFlushInterval) {
this.Flush();
}
}
generated by cgit v1.1 at 2025-05-20 18:22:14 +0000