Skip to content

Commit fb6f49f

Browse files
author
Jonathan Woollett-Light
committed
feat: Instrumentation
Signed-off-by: Jonathan Woollett-Light <jcawl@amazon.co.uk>
1 parent 05f8294 commit fb6f49f

File tree

233 files changed

+2716
-1
lines changed

Some content is hidden

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

233 files changed

+2716
-1
lines changed

‎src/api_server/src/lib.rs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ pub struct ApiServer {
4343
}
4444

4545
impl ApiServer {
46+
#[tracing::instrument(
47+
level = "trace",
48+
skip(api_request_sender, vmm_response_receiver, to_vmm_fd)
49+
)]
4650
/// Constructor for `ApiServer`.
4751
///
4852
/// Returns the newly formed `ApiServer`.
@@ -59,6 +63,10 @@ impl ApiServer {
5963
}
6064
}
6165

66+
#[tracing::instrument(
67+
level = "trace",
68+
skip(self, server, process_time_reporter, seccomp_filter, api_payload_limit)
69+
)]
6270
/// Runs the Api Server.
6371
///
6472
/// # Arguments
@@ -128,6 +136,7 @@ impl ApiServer {
128136
}
129137
}
130138

139+
#[tracing::instrument(level = "trace", skip(self, request, request_processing_start_us))]
131140
/// Handles an API request received through the associated socket.
132141
pub fn handle_request(
133142
&mut self,
@@ -158,6 +167,7 @@ impl ApiServer {
158167
}
159168
}
160169

170+
#[tracing::instrument(level = "trace", skip(self, vmm_action, request_processing_start_us))]
161171
fn serve_vmm_action_request(
162172
&mut self,
163173
vmm_action: Box<VmmAction>,
@@ -199,13 +209,15 @@ impl ApiServer {
199209
response
200210
}
201211

212+
#[tracing::instrument(level = "trace", skip(status, body))]
202213
/// An HTTP response which also includes a body.
203214
pub(crate) fn json_response<T: Into<String> + Debug>(status: StatusCode, body: T) -> Response {
204215
let mut response = Response::new(Version::Http11, status);
205216
response.set_body(Body::new(body.into()));
206217
response
207218
}
208219

220+
#[tracing::instrument(level = "trace", skip(msg))]
209221
fn json_fault_message<T: AsRef<str> + serde::Serialize + Debug>(msg: T) -> String {
210222
json!({ "fault_message": msg }).to_string()
211223
}

‎src/api_server/src/parsed_request.rs

Lines changed: 21 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", skip(self, message))]
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", skip(self))]
5153
pub fn take_deprecation_message(&mut self) -> Option<String> {
5254
self.deprecation_message.take()
5355
}
@@ -61,6 +63,7 @@ pub(crate) struct ParsedRequest {
6163

6264
impl TryFrom<&Request> for ParsedRequest {
6365
type Error = Error;
66+
#[tracing::instrument(level = "trace", skip(request))]
6467
fn try_from(request: &Request) -> Result<Self, Self::Error> {
6568
let request_uri = request.uri().get_abs_path().to_string();
6669
log_received_api_request(describe(
@@ -121,21 +124,25 @@ impl TryFrom<&Request> for ParsedRequest {
121124
}
122125

123126
impl ParsedRequest {
127+
#[tracing::instrument(level = "trace", skip(action))]
124128
pub(crate) fn new(action: RequestAction) -> Self {
125129
Self {
126130
action,
127131
parsing_info: Default::default(),
128132
}
129133
}
130134

135+
#[tracing::instrument(level = "trace", skip(self))]
131136
pub(crate) fn into_parts(self) -> (RequestAction, ParsingInfo) {
132137
(self.action, self.parsing_info)
133138
}
134139

140+
#[tracing::instrument(level = "trace", skip(self))]
135141
pub(crate) fn parsing_info(&mut self) -> &mut ParsingInfo {
136142
&mut self.parsing_info
137143
}
138144

145+
#[tracing::instrument(level = "trace", skip(body_data))]
139146
pub(crate) fn success_response_with_data<T>(body_data: &T) -> Response
140147
where
141148
T: ?Sized + Serialize + Debug,
@@ -146,6 +153,7 @@ impl ParsedRequest {
146153
response
147154
}
148155

156+
#[tracing::instrument(level = "trace", skip(body_data))]
149157
pub(crate) fn success_response_with_mmds_value(body_data: &Value) -> Response {
150158
info!("The request was executed successfully. Status code: 200 OK.");
151159
let mut response = Response::new(Version::Http11, StatusCode::OK);
@@ -157,6 +165,7 @@ impl ParsedRequest {
157165
response
158166
}
159167

168+
#[tracing::instrument(level = "trace", skip(request_outcome))]
160169
pub(crate) fn convert_to_response(
161170
request_outcome: &std::result::Result<VmmData, VmmActionError>,
162171
) -> Response {
@@ -205,12 +214,14 @@ impl ParsedRequest {
205214
}
206215
}
207216

217+
#[tracing::instrument(level = "trace", skip(vmm_action))]
208218
/// Helper function to avoid boiler-plate code.
209219
pub(crate) fn new_sync(vmm_action: VmmAction) -> ParsedRequest {
210220
ParsedRequest::new(RequestAction::Sync(Box::new(vmm_action)))
211221
}
212222
}
213223

224+
#[tracing::instrument(level = "trace", skip(api_description))]
214225
/// Helper function for writing the received API requests to the log.
215226
///
216227
/// The `info` macro is used for logging.
@@ -219,6 +230,7 @@ fn log_received_api_request(api_description: String) {
219230
info!("The API server received a {}.", api_description);
220231
}
221232

233+
#[tracing::instrument(level = "trace", skip(method, path, body))]
222234
/// Helper function for metric-logging purposes on API requests.
223235
///
224236
/// # Arguments
@@ -246,6 +258,7 @@ fn describe(method: Method, path: &str, body: Option<&Body>) -> String {
246258
}
247259
}
248260

261+
#[tracing::instrument(level = "trace", skip(method, path, payload_value))]
249262
fn describe_with_body(method: Method, path: &str, payload_value: &Body) -> String {
250263
format!(
251264
"{:?} request on {:?} with body {:?}",
@@ -257,6 +270,7 @@ fn describe_with_body(method: Method, path: &str, payload_value: &Body) -> Strin
257270
)
258271
}
259272

273+
#[tracing::instrument(level = "trace", skip(method))]
260274
/// Generates a `GenericError` for each request method.
261275
pub(crate) fn method_to_error(method: Method) -> Result<ParsedRequest, Error> {
262276
match method {
@@ -296,6 +310,7 @@ pub(crate) enum Error {
296310

297311
// It's convenient to turn errors into HTTP responses directly.
298312
impl From<Error> for Response {
313+
#[tracing::instrument(level = "trace", skip(err))]
299314
fn from(err: Error) -> Self {
300315
let msg = ApiServer::json_fault_message(format!("{}", err));
301316
match err {
@@ -309,6 +324,7 @@ impl From<Error> for Response {
309324
}
310325

311326
// This function is supposed to do id validation for requests.
327+
#[tracing::instrument(level = "trace", skip(id))]
312328
pub(crate) fn checked_id(id: &str) -> Result<&str, Error> {
313329
// todo: are there any checks we want to do on id's?
314330
// not allow them to be empty strings maybe?
@@ -341,6 +357,7 @@ pub mod tests {
341357
use super::*;
342358

343359
impl PartialEq for ParsedRequest {
360+
#[tracing::instrument(level = "trace", skip(self, other))]
344361
fn eq(&self, other: &ParsedRequest) -> bool {
345362
if self.parsing_info.deprecation_message != other.parsing_info.deprecation_message {
346363
return false;
@@ -355,13 +372,15 @@ pub mod tests {
355372
}
356373
}
357374

375+
#[tracing::instrument(level = "trace", skip(req))]
358376
pub(crate) fn vmm_action_from_request(req: ParsedRequest) -> VmmAction {
359377
match req.action {
360378
RequestAction::Sync(vmm_action) => *vmm_action,
361379
_ => panic!("Invalid request"),
362380
}
363381
}
364382

383+
#[tracing::instrument(level = "trace", skip(req, msg))]
365384
pub(crate) fn depr_action_from_req(req: ParsedRequest, msg: Option<String>) -> VmmAction {
366385
let (action_req, mut parsing_info) = req.into_parts();
367386
match action_req {
@@ -375,6 +394,7 @@ pub mod tests {
375394
}
376395
}
377396

397+
#[tracing::instrument(level = "trace", skip(body, status_code))]
378398
fn http_response(body: &str, status_code: i32) -> String {
379399
let header = format!(
380400
"HTTP/1.1 {} \r\nServer: Firecracker API\r\nConnection: keep-alive\r\n",
@@ -394,6 +414,7 @@ pub mod tests {
394414
}
395415
}
396416

417+
#[tracing::instrument(level = "trace", skip(request_type, endpoint, body))]
397418
fn http_request(request_type: &str, endpoint: &str, body: Option<&str>) -> String {
398419
let req_no_body = format!(
399420
"{} {} 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", skip(body))]
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", skip(path_second_token))]
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", skip(body))]
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", skip(body, path_second_token))]
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", skip(body))]
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", skip(body))]
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", skip(body, id_from_path))]
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", skip(body, id_from_path))]
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", skip(body))]
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", skip())]
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))

‎src/api_server/src/request/logger.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", skip(body))]
1112
pub(crate) fn parse_put_logger(body: &Body) -> Result<ParsedRequest, Error> {
1213
METRICS.put_api_requests.logger_count.inc();
1314
let res = serde_json::from_slice::<LoggerConfig>(body.raw());

0 commit comments

Comments
 (0)