f missing docs

src/tags.rs

@@ -63,6 +63,10 @@ pub fn parse_user_agent(agent: &str) -> (WootheeResult<'_>, &str, &str) {
     (wresult, metrics_os, metrics_browser)
 }
 
+/// Tags are a set of meta information passed along with sentry errors and metrics.
+///
+/// Not all tags are distributed out. `tags` are searchable and may cause cardinality issues.
+/// `extra` are not searchable, but may not be sent to [crate::metrics::Metrics].
 #[derive(Clone, Debug)]
 pub struct Tags {
     pub tags: HashMap<String, String>,

src/web/dockerflow.rs

@@ -1,11 +1,18 @@
+//! Mozilla Ops dockerflow endpoints.
+//!
+//! These are common endpoints that are used for process management. These include
+//! * `__heartbeat__` - return process status
+//! * `__lbheartbeat__` - used for load balancer availability
+//! * `__version__` - return the current process version (and github commit)
+
 use std::collections::HashMap;
 
 use actix_web::{web, HttpRequest, HttpResponse};
 use serde_json::Value;
 
 use crate::error::HandlerError;
 
-// Known DockerFlow commands for Ops callbacks
+/// Well Known DockerFlow commands for Ops callbacks
 pub const DOCKER_FLOW_ENDPOINTS: [&str; 4] = [
     "/__heartbeat__",
     "/__lbheartbeat__",

src/web/middleware/mod.rs

@@ -1,4 +1,3 @@
+//! Actix middleware wrappers
 // pub mod db;
-pub mod sentry;
-
-// # Web Middleware
+pub mod sentry;

src/web/middleware/sentry.rs

@@ -1,3 +1,7 @@
+//! Wrapper for sentry error reporting
+//!
+//! This sends [crate::error::HandlerError] events to Sentry
+
 use std::task::Context;
 use std::{
     cell::{RefCell, RefMut},
@@ -74,6 +78,10 @@ pub fn queue_report(mut ext: RefMut<'_, Extensions>, err: &Error) {
     }
 }
 
+/// Report an error with [crate::tags::Tags] and [Event] directly to sentry
+///
+/// And [Event] can be derived using
+/// `sentry::event_from_error(err:Error)`
 pub fn report(tags: &Tags, mut event: Event<'static>) {
     let tags = tags.clone();
     event.tags = tags.clone().tag_tree();

src/web/user_agent.rs

@@ -1,10 +1,13 @@
+//! Simple UserAgent parser/stripper
+
 use std::fmt;
 
 use woothee::{
     parser::{Parser, WootheeResult},
     woothee::VALUE_UNKNOWN,
 };
 
+/// ADM required browser format form
 #[allow(dead_code)]
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
 pub enum FormFactor {
@@ -21,6 +24,7 @@ impl fmt::Display for FormFactor {
     }
 }
 
+/// Simplified Operating System Family
 #[allow(dead_code)]
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
 pub enum OsFamily {
@@ -69,6 +73,7 @@ pub fn strip_ua(ua: &str) -> String {
     )
 }
 
+/// Convert a UserAgent header into a simplified ([OsFamily], [FormFactor])
 pub fn get_device_info(ua: &str) -> (OsFamily, FormFactor) {
     let wresult = Parser::new().parse(ua).unwrap_or_default();