feat: Convert some of the validation storage errors into metrics (#810)

* feat: Convert some of the validation storage errors into metrics

Closes #795

* f fmt, clippy

* f remove unused function, added hawk invalid_port

Co-authored-by: Donovan Preston <[email protected]>
Co-authored-by: Rachel Tublitz <[email protected]>

src/error.rs

@@ -57,6 +57,7 @@ pub const RETRY_AFTER: u8 = 10;
 pub struct ApiError {
     inner: Context<ApiErrorKind>,
     status: StatusCode,
+    metric_label: Option<String>,
 }
 
 /// Top-level ErrorKind.
@@ -130,8 +131,8 @@ impl ApiError {
                 _ => (),
             },
             _ => (),
-        }
-        true
+        };
+        self.metric_label.is_none()
     }
 
     pub fn on_response(&self, state: &ServerState) {
@@ -148,6 +149,7 @@ impl ApiError {
                     ref location,
                     name,
                     ref _tags,
+                    ref _metric_label,
                 ) => {
                     match description.as_ref() {
                         "over-quota" => return WeaveError::OverQuota,
@@ -162,7 +164,12 @@ impl ApiError {
                     }
                     WeaveError::UnknownError
                 }
-                ValidationErrorKind::FromValidationErrors(ref _err, ref location, ref _tags) => {
+                ValidationErrorKind::FromValidationErrors(
+                    ref _err,
+                    ref location,
+                    ref _tags,
+                    _metric_label,
+                ) => {
                     if *location == RequestErrorLocation::Body {
                         WeaveError::InvalidWbo
                     } else {
@@ -225,7 +232,11 @@ impl From<Context<ApiErrorKind>> for ApiError {
             ApiErrorKind::Validation(error) => error.status,
         };
 
-        Self { inner, status }
+        Self {
+            inner,
+            status,
+            metric_label: None,
+        }
     }
 }
 
@@ -338,3 +349,9 @@ macro_rules! from_error {
 from_error!(DbError, ApiError, ApiErrorKind::Db);
 from_error!(HawkError, ApiError, ApiErrorKind::Hawk);
 from_error!(ValidationError, ApiError, ApiErrorKind::Validation);
+
+macro_rules! label {
+    ($string:expr) => {
+        Some($string.to_string())
+    };
+}

src/web/auth.rs

@@ -175,6 +175,7 @@ impl HawkPayload {
                     RequestErrorLocation::Header,
                     None,
                     tags,
+                    label!("request.validate.hawk.invalid_port"),
                 )
             })?
         } else if ci.scheme() == "https" {

src/web/error.rs

@@ -90,13 +90,20 @@ impl ValidationError {
 #[derive(Debug, Fail)]
 pub enum ValidationErrorKind {
     #[fail(display = "{}", _0)]
-    FromDetails(String, RequestErrorLocation, Option<String>, Option<Tags>),
+    FromDetails(
+        String,
+        RequestErrorLocation,
+        Option<String>,
+        Option<Tags>,
+        Option<String>,
+    ),
 
     #[fail(display = "{}", _0)]
     FromValidationErrors(
         #[cause] validator::ValidationErrors,
         RequestErrorLocation,
         Option<Tags>,
+        Option<String>,
     ),
 }
 
@@ -119,18 +126,27 @@ impl From<Context<ValidationErrorKind>> for ValidationError {
     fn from(inner: Context<ValidationErrorKind>) -> Self {
         debug!("Validation Error: {:?}", inner.get_context());
         let status = match inner.get_context() {
-            ValidationErrorKind::FromDetails(ref _description, ref location, Some(ref name), _)
-                if *location == RequestErrorLocation::Header =>
-            {
+            ValidationErrorKind::FromDetails(
+                ref _description,
+                ref location,
+                Some(ref name),
+                _,
+                _,
+            ) if *location == RequestErrorLocation::Header => {
                 match name.to_ascii_lowercase().as_str() {
                     "accept" => StatusCode::NOT_ACCEPTABLE,
                     "content-type" => StatusCode::UNSUPPORTED_MEDIA_TYPE,
                     _ => StatusCode::BAD_REQUEST,
                 }
             }
-            ValidationErrorKind::FromDetails(ref _description, ref location, Some(ref name), _)
-                if *location == RequestErrorLocation::Path
-                    && ["bso", "collection"].contains(&name.as_ref()) =>
+            ValidationErrorKind::FromDetails(
+                ref _description,
+                ref location,
+                Some(ref name),
+                _,
+                _,
+            ) if *location == RequestErrorLocation::Path
+                && ["bso", "collection"].contains(&name.as_ref()) =>
             {
                 StatusCode::NOT_FOUND
             }
@@ -185,7 +201,13 @@ impl Serialize for ValidationErrorKind {
         let mut seq = serializer.serialize_seq(None)?;
 
         match *self {
-            ValidationErrorKind::FromDetails(ref description, ref location, ref name, ref tags) => {
+            ValidationErrorKind::FromDetails(
+                ref description,
+                ref location,
+                ref name,
+                ref tags,
+                ref _metric_label,
+            ) => {
                 seq.serialize_element(&SerializedValidationError {
                     description,
                     location,
@@ -195,7 +217,12 @@ impl Serialize for ValidationErrorKind {
                 })?;
             }
 
-            ValidationErrorKind::FromValidationErrors(ref errors, ref location, ref tags) => {
+            ValidationErrorKind::FromValidationErrors(
+                ref errors,
+                ref location,
+                ref tags,
+                ref _metric_label,
+            ) => {
                 for (field, field_errors) in errors.clone().field_errors().iter() {
                     for field_error in field_errors.iter() {
                         seq.serialize_element(&SerializedValidationError {