Skip to content

Commit 3b48ad6

Browse files
author
Jonathan Woollett-Light
committed
fix: tracing::instrument
Adds function instrumentation. Signed-off-by: Jonathan Woollett-Light <jcawl@amazon.co.uk>
1 parent 22a5b45 commit 3b48ad6

File tree

219 files changed

+2257
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

219 files changed

+2257
-3
lines changed

‎Cargo.lock

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/api_server/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ impl ApiServer {
6161
/// Constructor for `ApiServer`.
6262
///
6363
/// Returns the newly formed `ApiServer`.
64+
#[tracing::instrument(level = "trace", ret)]
6465
pub fn new(
6566
api_request_sender: mpsc::Sender<ApiRequest>,
6667
vmm_response_receiver: mpsc::Receiver<ApiResponse>,
@@ -145,6 +146,7 @@ impl ApiServer {
145146
/// let mut buf: [u8; 100] = [0; 100];
146147
/// assert!(sock.read(&mut buf[..]).unwrap() > 0);
147148
/// ```
149+
#[tracing::instrument(level = "trace", ret)]
148150
pub fn bind_and_run(
149151
&mut self,
150152
path: &PathBuf,
@@ -221,6 +223,7 @@ impl ApiServer {
221223
}
222224

223225
/// Handles an API request received through the associated socket.
226+
#[tracing::instrument(level = "trace", ret)]
224227
pub fn handle_request(
225228
&mut self,
226229
request: &Request,
@@ -250,6 +253,7 @@ impl ApiServer {
250253
}
251254
}
252255

256+
#[tracing::instrument(level = "trace", ret)]
253257
fn serve_vmm_action_request(
254258
&mut self,
255259
vmm_action: Box<VmmAction>,
@@ -292,12 +296,14 @@ impl ApiServer {
292296
}
293297

294298
/// An HTTP response which also includes a body.
299+
#[tracing::instrument(level = "trace", ret)]
295300
pub(crate) fn json_response<T: Into<String> + Debug>(status: StatusCode, body: T) -> Response {
296301
let mut response = Response::new(Version::Http11, status);
297302
response.set_body(Body::new(body.into()));
298303
response
299304
}
300305

306+
#[tracing::instrument(level = "trace", ret)]
301307
fn json_fault_message<T: AsRef<str> + serde::Serialize + Debug>(msg: T) -> String {
302308
json!({ "fault_message": msg }).to_string()
303309
}

‎src/api_server/src/parsed_request.rs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,15 @@ pub(crate) struct ParsingInfo {
4141
}
4242

4343
impl ParsingInfo {
44+
#[tracing::instrument(level = "trace", ret)]
4445
pub fn append_deprecation_message(&mut self, message: &str) {
4546
match self.deprecation_message.as_mut() {
4647
None => self.deprecation_message = Some(message.to_owned()),
4748
Some(s) => (*s).push_str(message),
4849
}
4950
}
5051

52+
#[tracing::instrument(level = "trace", ret)]
5153
pub fn take_deprecation_message(&mut self) -> Option<String> {
5254
self.deprecation_message.take()
5355
}
@@ -121,21 +123,25 @@ impl TryFrom<&Request> for ParsedRequest {
121123
}
122124

123125
impl ParsedRequest {
126+
#[tracing::instrument(level = "trace", ret)]
124127
pub(crate) fn new(action: RequestAction) -> Self {
125128
Self {
126129
action,
127130
parsing_info: Default::default(),
128131
}
129132
}
130133

134+
#[tracing::instrument(level = "trace", ret)]
131135
pub(crate) fn into_parts(self) -> (RequestAction, ParsingInfo) {
132136
(self.action, self.parsing_info)
133137
}
134138

139+
#[tracing::instrument(level = "trace")]
135140
pub(crate) fn parsing_info(&mut self) -> &mut ParsingInfo {
136141
&mut self.parsing_info
137142
}
138143

144+
#[tracing::instrument(level = "trace", ret)]
139145
pub(crate) fn success_response_with_data<T>(body_data: &T) -> Response
140146
where
141147
T: ?Sized + Serialize + Debug,
@@ -146,6 +152,7 @@ impl ParsedRequest {
146152
response
147153
}
148154

155+
#[tracing::instrument(level = "trace", ret)]
149156
pub(crate) fn success_response_with_mmds_value(body_data: &Value) -> Response {
150157
info!("The request was executed successfully. Status code: 200 OK.");
151158
let mut response = Response::new(Version::Http11, StatusCode::OK);
@@ -157,6 +164,7 @@ impl ParsedRequest {
157164
response
158165
}
159166

167+
#[tracing::instrument(level = "trace", ret)]
160168
pub(crate) fn convert_to_response(
161169
request_outcome: &std::result::Result<VmmData, VmmActionError>,
162170
) -> Response {
@@ -206,6 +214,7 @@ impl ParsedRequest {
206214
}
207215

208216
/// Helper function to avoid boiler-plate code.
217+
#[tracing::instrument(level = "trace", ret)]
209218
pub(crate) fn new_sync(vmm_action: VmmAction) -> ParsedRequest {
210219
ParsedRequest::new(RequestAction::Sync(Box::new(vmm_action)))
211220
}
@@ -215,6 +224,7 @@ impl ParsedRequest {
215224
///
216225
/// The `info` macro is used for logging.
217226
#[inline]
227+
#[tracing::instrument(level = "trace", ret)]
218228
fn log_received_api_request(api_description: String) {
219229
info!("The API server received a {}.", api_description);
220230
}
@@ -226,6 +236,7 @@ fn log_received_api_request(api_description: String) {
226236
/// * `method` - one of `GET`, `PATCH`, `PUT`
227237
/// * `path` - path of the API request
228238
/// * `body` - body of the API request
239+
#[tracing::instrument(level = "trace", ret)]
229240
fn describe(method: Method, path: &str, body: Option<&Body>) -> String {
230241
match (path, body) {
231242
("/mmds", Some(_)) | (_, None) => format!("{:?} request on {:?}", method, path),
@@ -246,6 +257,7 @@ fn describe_with_body(method: Method, path: &str, payload_value: &Body) -> Strin
246257
}
247258

248259
/// Generates a `GenericError` for each request method.
260+
#[tracing::instrument(level = "trace", ret)]
249261
pub(crate) fn method_to_error(method: Method) -> Result<ParsedRequest, Error> {
250262
match method {
251263
Method::Get => Err(Error::Generic(
@@ -284,6 +296,7 @@ pub(crate) enum Error {
284296

285297
// It's convenient to turn errors into HTTP responses directly.
286298
impl From<Error> for Response {
299+
#[tracing::instrument(level = "trace", ret)]
287300
fn from(err: Error) -> Self {
288301
let msg = ApiServer::json_fault_message(format!("{}", err));
289302
match err {
@@ -297,6 +310,7 @@ impl From<Error> for Response {
297310
}
298311

299312
// This function is supposed to do id validation for requests.
313+
#[tracing::instrument(level = "trace", ret)]
300314
pub(crate) fn checked_id(id: &str) -> Result<&str, Error> {
301315
// todo: are there any checks we want to do on id's?
302316
// not allow them to be empty strings maybe?
@@ -329,6 +343,7 @@ pub mod tests {
329343
use super::*;
330344

331345
impl PartialEq for ParsedRequest {
346+
#[tracing::instrument(level = "trace", ret)]
332347
fn eq(&self, other: &ParsedRequest) -> bool {
333348
if self.parsing_info.deprecation_message != other.parsing_info.deprecation_message {
334349
return false;
@@ -343,13 +358,15 @@ pub mod tests {
343358
}
344359
}
345360

361+
#[tracing::instrument(level = "trace", ret)]
346362
pub(crate) fn vmm_action_from_request(req: ParsedRequest) -> VmmAction {
347363
match req.action {
348364
RequestAction::Sync(vmm_action) => *vmm_action,
349365
_ => panic!("Invalid request"),
350366
}
351367
}
352368

369+
#[tracing::instrument(level = "trace", ret)]
353370
pub(crate) fn depr_action_from_req(req: ParsedRequest, msg: Option<String>) -> VmmAction {
354371
let (action_req, mut parsing_info) = req.into_parts();
355372
match action_req {
@@ -363,6 +380,7 @@ pub mod tests {
363380
}
364381
}
365382

383+
#[tracing::instrument(level = "trace", ret)]
366384
fn http_response(body: &str, status_code: i32) -> String {
367385
let header = format!(
368386
"HTTP/1.1 {} \r\nServer: Firecracker API\r\nConnection: keep-alive\r\n",
@@ -382,6 +400,7 @@ pub mod tests {
382400
}
383401
}
384402

403+
#[tracing::instrument(level = "trace", ret)]
385404
fn http_request(request_type: &str, endpoint: &str, body: Option<&str>) -> String {
386405
let req_no_body = format!(
387406
"{} {} HTTP/1.1\r\nContent-Type: application/json\r\n",

‎src/api_server/src/request/actions.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ struct ActionBody {
2828
action_type: ActionType,
2929
}
3030

31+
#[tracing::instrument(level = "trace", ret)]
3132
pub(crate) fn parse_put_actions(body: &Body) -> Result<ParsedRequest, Error> {
3233
METRICS.put_api_requests.actions_count.inc();
3334
let action_body = serde_json::from_slice::<ActionBody>(body.raw()).map_err(|err| {

‎src/api_server/src/request/balloon.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ use super::super::VmmAction;
1010
use crate::parsed_request::{Error, ParsedRequest};
1111
use crate::request::Body;
1212

13+
#[tracing::instrument(level = "trace", ret)]
1314
pub(crate) fn parse_get_balloon(path_second_token: Option<&str>) -> Result<ParsedRequest, Error> {
1415
match path_second_token {
1516
Some(stats_path) => match stats_path {
@@ -23,12 +24,14 @@ pub(crate) fn parse_get_balloon(path_second_token: Option<&str>) -> Result<Parse
2324
}
2425
}
2526

27+
#[tracing::instrument(level = "trace", ret)]
2628
pub(crate) fn parse_put_balloon(body: &Body) -> Result<ParsedRequest, Error> {
2729
Ok(ParsedRequest::new_sync(VmmAction::SetBalloonDevice(
2830
serde_json::from_slice::<BalloonDeviceConfig>(body.raw())?,
2931
)))
3032
}
3133

34+
#[tracing::instrument(level = "trace", ret)]
3235
pub(crate) fn parse_patch_balloon(
3336
body: &Body,
3437
path_second_token: Option<&str>,

‎src/api_server/src/request/boot_source.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ use super::super::VmmAction;
88
use crate::parsed_request::{Error, ParsedRequest};
99
use crate::request::Body;
1010

11+
#[tracing::instrument(level = "trace", ret)]
1112
pub(crate) fn parse_put_boot_source(body: &Body) -> Result<ParsedRequest, Error> {
1213
METRICS.put_api_requests.boot_source_count.inc();
1314
Ok(ParsedRequest::new_sync(VmmAction::ConfigureBootSource(

‎src/api_server/src/request/cpu_configuration.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ use super::super::VmmAction;
88
use crate::parsed_request::{Error, ParsedRequest};
99
use crate::request::Body;
1010

11+
#[tracing::instrument(level = "trace", ret)]
1112
pub(crate) fn parse_put_cpu_config(body: &Body) -> Result<ParsedRequest, Error> {
1213
METRICS.put_api_requests.cpu_cfg_count.inc();
1314

‎src/api_server/src/request/drive.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ use super::super::VmmAction;
88
use crate::parsed_request::{checked_id, Error, ParsedRequest};
99
use crate::request::{Body, StatusCode};
1010

11+
#[tracing::instrument(level = "trace", ret)]
1112
pub(crate) fn parse_put_drive(
1213
body: &Body,
1314
id_from_path: Option<&str>,
@@ -38,6 +39,7 @@ pub(crate) fn parse_put_drive(
3839
}
3940
}
4041

42+
#[tracing::instrument(level = "trace", ret)]
4143
pub(crate) fn parse_patch_drive(
4244
body: &Body,
4345
id_from_path: Option<&str>,

‎src/api_server/src/request/entropy.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ use vmm::vmm_config::entropy::EntropyDeviceConfig;
77
use crate::parsed_request::{Error, ParsedRequest};
88
use crate::request::Body;
99

10+
#[tracing::instrument(level = "trace", ret)]
1011
pub(crate) fn parse_put_entropy(body: &Body) -> Result<ParsedRequest, Error> {
1112
let cfg = serde_json::from_slice::<EntropyDeviceConfig>(body.raw())?;
1213
Ok(ParsedRequest::new_sync(VmmAction::SetEntropyDevice(cfg)))

‎src/api_server/src/request/instance_info.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ use vmm::rpc_interface::VmmAction;
66

77
use crate::parsed_request::{Error, ParsedRequest};
88

9+
#[tracing::instrument(level = "trace", ret)]
910
pub(crate) fn parse_get_instance_info() -> Result<ParsedRequest, Error> {
1011
METRICS.get_api_requests.instance_info_count.inc();
1112
Ok(ParsedRequest::new_sync(VmmAction::GetVmInstanceInfo))

0 commit comments

Comments
 (0)