feat: metric for method not found

Author: prestwich

src/metrics.rs

@@ -33,6 +33,11 @@ pub(crate) const ROUTER_PARSE_ERRORS: &str = "ajj.router.parse_errors";
 pub(crate) const ROUTER_PARSE_ERRORS_HELP: &str =
     "Number of parse errors encountered by ajj router methods. This implies no response was sent.";
 
+/// Metric for counting method not found errors.
+pub(crate) const ROUTER_METHOD_NOT_FOUND: &str = "ajj.router.method_not_found";
+pub(crate) const ROUTER_METHOD_NOT_FOUND_HELP: &str =
+    "Number of times ajj router methods encountered a method not found error. This implies a response was sent.";
+
 static DESCRIBE: LazyLock<()> = LazyLock::new(|| {
     metrics::describe_counter!(ROUTER_CALLS, metrics::Unit::Count, ROUTER_CALLS_HELP);
     metrics::describe_counter!(ROUTER_ERRORS, metrics::Unit::Count, ROUTER_ERRORS_HELP);
@@ -56,6 +61,11 @@ static DESCRIBE: LazyLock<()> = LazyLock::new(|| {
         metrics::Unit::Count,
         ROUTER_PARSE_ERRORS_HELP
     );
+    metrics::describe_counter!(
+        ROUTER_METHOD_NOT_FOUND,
+        metrics::Unit::Count,
+        ROUTER_METHOD_NOT_FOUND_HELP
+    );
 });
 
 /// Get or register a counter for calls to a specific service and method.
@@ -168,3 +178,20 @@ pub(crate) fn record_parse_error(service_name: &'static str) {
     let counter = parse_errors(service_name);
     counter.increment(1);
 }
+
+/// Get or register a counter for method not found errors.
+pub(crate) fn method_not_found_errors(service_name: &'static str, method: &str) -> Counter {
+    let _ = &DESCRIBE;
+    metrics::counter!(ROUTER_METHOD_NOT_FOUND, "service" => service_name.to_string(), "method" => method.to_string())
+}
+
+/// Record a method not found error.
+pub(crate) fn record_method_not_found(
+    response_sent: bool,
+    service_name: &'static str,
+    method: &str,
+) {
+    let counter = method_not_found_errors(service_name, method);
+    counter.increment(1);
+    record_output(response_sent, service_name, method);
+}

src/routes/ctx.rs

@@ -464,8 +464,18 @@ impl HandlerArgs {
         self.req.id_owned()
     }
 
+    /// Get the method of the JSON-RPC request.
+    pub fn method(&self) -> &str {
+        self.req.method()
+    }
+
     /// Get the OpenTelemetry span name for this handler invocation.
     pub fn otel_span_name(&self) -> String {
         format!("{}/{}", self.ctx.service_name(), self.req.method())
     }
+
+    /// Get the service name for this handler invocation.
+    pub const fn service_name(&self) -> &'static str {
+        self.ctx.service_name()
+    }
 }

src/routes/handler.rs

@@ -440,7 +440,7 @@ pub struct OutputResponsePayload {
     _sealed: (),
 }
 
-/// Takes nothing, returns ResponsePayload
+// Takes nothing, returns ResponsePayload
 impl<F, Fut, Payload, ErrData, S> Handler<(OutputResponsePayload,), S> for F
 where
     F: FnOnce() -> Fut + Clone + Send + Sync + 'static,
@@ -455,7 +455,7 @@ where
     }
 }
 
-/// Takes Ctx, returns ResponsePayload
+// Takes Ctx, returns ResponsePayload
 impl<F, Fut, Payload, ErrData, S> Handler<(OutputResponsePayload, HandlerCtx), S> for F
 where
     F: FnOnce(HandlerCtx) -> Fut + Clone + Send + Sync + 'static,
@@ -470,7 +470,7 @@ where
     }
 }
 
-/// Takes Params, returns ResponsePayload
+// Takes Params, returns ResponsePayload
 impl<F, Fut, Input, Payload, ErrData, S> Handler<(OutputResponsePayload, PhantomParams<Input>), S>
     for F
 where
@@ -487,7 +487,7 @@ where
     }
 }
 
-/// Takes Params<Params>, returns ResponsePayload
+// Takes Params<Params>, returns ResponsePayload
 impl<F, Fut, Input, Payload, ErrData, S> Handler<(OutputResponsePayload, Params<Input>), S> for F
 where
     F: FnOnce(Params<Input>) -> Fut + Clone + Send + Sync + 'static,
@@ -503,7 +503,7 @@ where
     }
 }
 
-/// Takes State, returns ResponsePayload
+// Takes State, returns ResponsePayload
 impl<F, Fut, Payload, ErrData, S> Handler<(OutputResponsePayload, PhantomState<S>), S> for F
 where
     F: FnOnce(S) -> Fut + Clone + Send + Sync + 'static,
@@ -519,7 +519,7 @@ where
     }
 }
 
-/// Takes State<State>, returns ResponsePayload
+// Takes State<State>, returns ResponsePayload
 impl<F, Fut, Payload, ErrData, S> Handler<(OutputResponsePayload, State<S>), S> for F
 where
     F: FnOnce(State<S>) -> Fut + Clone + Send + Sync + 'static,
@@ -535,7 +535,7 @@ where
     }
 }
 
-/// Takes Ctx, Params, returns ResponsePayload
+// Takes Ctx, Params, returns ResponsePayload
 impl<F, Fut, Input, Payload, ErrData, S>
     Handler<(OutputResponsePayload, HandlerCtx, PhantomParams<Input>), S> for F
 where
@@ -552,7 +552,7 @@ where
     }
 }
 
-/// Takes Ctx, Params<Params>, returns ResponsePayload
+// Takes Ctx, Params<Params>, returns ResponsePayload
 impl<F, Fut, Input, Payload, ErrData, S>
     Handler<(OutputResponsePayload, HandlerCtx, Params<Input>), S> for F
 where
@@ -569,7 +569,7 @@ where
     }
 }
 
-/// Takes Params, State, returns ResponsePayload
+// Takes Params, State, returns ResponsePayload
 impl<F, Fut, Input, Payload, ErrData, S> Handler<(OutputResponsePayload, Input, S), S> for F
 where
     F: FnOnce(Input, S) -> Fut + Clone + Send + Sync + 'static,
@@ -586,7 +586,7 @@ where
     }
 }
 
-/// Takes Ctx, State, returns ResponsePayload
+// Takes Ctx, State, returns ResponsePayload
 impl<F, Fut, Payload, ErrData, S> Handler<(OutputResponsePayload, HandlerCtx, PhantomState<S>), S>
     for F
 where
@@ -603,7 +603,7 @@ where
     }
 }
 
-/// Takes Ctx, State<State>, returns ResponsePayload
+// Takes Ctx, State<State>, returns ResponsePayload
 impl<F, Fut, Payload, ErrData, S> Handler<(OutputResponsePayload, HandlerCtx, State<S>), S> for F
 where
     F: FnOnce(HandlerCtx, State<S>) -> Fut + Clone + Send + Sync + 'static,
@@ -619,7 +619,7 @@ where
     }
 }
 
-/// Takes Ctx, Params, State, returns ResponsePayload
+// Takes Ctx, Params, State, returns ResponsePayload
 impl<F, Fut, Input, Payload, ErrData, S> Handler<(OutputResponsePayload, HandlerCtx, Input, S), S>
     for F
 where
@@ -637,7 +637,7 @@ where
     }
 }
 
-/// Takes nothing, returns Result
+// Takes nothing, returns Result
 impl<F, Fut, Payload, ErrData, S> Handler<(OutputResult,), S> for F
 where
     F: FnOnce() -> Fut + Clone + Send + Sync + 'static,

src/routes/mod.rs

@@ -52,8 +52,12 @@ impl Route {
     pub(crate) fn default_fallback() -> Self {
         Self::new(tower::service_fn(|args: HandlerArgs| async {
             let id = args.id_owned();
+            crate::metrics::record_method_not_found(
+                id.is_some(),
+                args.service_name(),
+                args.method(),
+            );
             drop(args); // no longer needed
-
             Ok(Response::maybe_method_not_found(id.as_deref()))
         }))
     }

src/types/resp/payload.rs

@@ -8,9 +8,8 @@ const INTERNAL_ERROR: Cow<'_, str> = Cow::Borrowed("Internal error");
 
 /// A JSON-RPC 2.0 response payload.
 ///
-/// This enum covers both the success and error cases of a JSON-RPC 2.0
-/// response. It is used to represent the `result` and `error` fields of a
-/// response object.
+/// This is a thin wrapper around a [`Result`] type containing either
+/// the successful payload or an error payload.
 #[derive(Clone, Debug, PartialEq, Eq)]
 #[repr(transparent)]
 pub struct ResponsePayload<Payload, ErrData>(pub Result<Payload, ErrorPayload<ErrData>>);