Skip to content

Commit f842465

Browse files
committed
Merge pull request #326 from sharwell/docs
Updated documentation for HttpCheckDetails Body and BodyMatches
2 parents 6d950df + 947f92d commit f842465

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

src/corelib/Providers/Rackspace/Objects/Monitoring/HttpCheckDetails.cs

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ protected HttpCheckDetails()
8888
/// <param name="url">The target URI.</param>
8989
/// <param name="authUser">The username of the user to authenticate over HTTP.</param>
9090
/// <param name="authPassword">The password of the user to authenticate over HTTP.</param>
91-
/// <param name="body">The regular expression to match against the body of the reply.</param>
92-
/// <param name="bodyMatches">A collection of named regular expressions to match against the body of the reply.</param>
91+
/// <param name="body">The regular expression to match against the body of the reply. For more information, see <see cref="Body"/>.</param>
92+
/// <param name="bodyMatches">A collection of named regular expressions to match against the body of the reply. For more information, see <see cref="BodyMatches"/>.</param>
9393
/// <param name="followRedirects"><see langword="true"/> to follow redirects; otherwise, <see langword="false"/>.</param>
9494
/// <param name="headers">A collection of additional HTTP headers which are sent with the request.</param>
9595
/// <param name="method">The HTTP method to use for the request.</param>
@@ -159,6 +159,10 @@ public string AuthUser
159159
/// <summary>
160160
/// Gets the regular expression to match against the body of the reply.
161161
/// </summary>
162+
/// <remarks>
163+
/// The data matched by this regular expression is provided by the
164+
/// <c>body_match</c> metric in the alarm criteria.
165+
/// </remarks>
162166
public string Body
163167
{
164168
get
@@ -171,6 +175,16 @@ public string Body
171175
/// Gets a collection of named regular expressions to match against the
172176
/// body of the reply.
173177
/// </summary>
178+
/// <remarks>
179+
/// When this property is specified, a metric will be available for each of
180+
/// the named regular expressions. The keys of this dictionary provide the
181+
/// names for each of the regular expressions and determine the names of
182+
/// alarm criteria metrics which provide the data matched by the expression.
183+
/// For example, if <see cref="BodyMatches"/> contains a key
184+
/// <c><em>helloworld</em></c>, the metric
185+
/// <c>body_match_<em>helloworld</em></c> provides the data in the body
186+
/// matched by the associated regular expression.
187+
/// </remarks>
174188
public ReadOnlyDictionary<string, string> BodyMatches
175189
{
176190
get

0 commit comments

Comments
 (0)