Struct actix_treblle::Treblle

source · [−]

pub struct Treblle { /* private fields */ }

Implementations

source

impl Treblle

source

pub fn new(project_id: String, api_key: String) -> Treblle

Create the middleware and wrap your application with it.

HttpServer::new(|| {
    App::new()
        .wrap(actix_treblle::Treblle::new("project_id".to_string(), "api_key".to_string()))
        .route("/hello", web::get().to(|| async { "Hello World!" }))
})
.bind(("127.0.0.1", 8080))?
.run()
.await

source

pub fn debug(self) -> Treblle

Turn on the debug mode

WARNING: Turning this option ON can slow down your requests by 10 fold sometimes because we are waiting for the response from Treblle.com.

HttpServer::new(|| {
    App::new()
        .wrap(
            actix_treblle::Treblle::new("project_id".to_string(), "api_key".to_string())
               .debug()
        )
        .route("/hello", web::get().to(|| async { "Hello World!" }))
})
.bind(("127.0.0.1", 8080))?
.run()
.await

source

pub fn clear_masking_fields(self) -> Treblle

If you don’t wish to have default masking fields, or simply want to remove the default ones use this method when wrapping your application with this middleware.

HttpServer::new(|| {
    App::new()
        .wrap(
            actix_treblle::Treblle::new("project_id".to_string(), "api_key".to_string())
               .clear_masking_fields()
        )
        .route("/hello", web::get().to(|| async { "Hello World!" }))
})
.bind(("127.0.0.1", 8080))?
.run()
.await

source

pub fn add_masking_fields(self, fields: Vec<String>) -> Treblle

Set masking fields that will be masked before the request leaves your application

Default masking fields:

“password”
“pwd”
“secret”
“password_confirmation”
“passwordConfirmation”
“cc”
“card_number”
“cardNumber”
“ccv”
“ssn”
“credit_score”
“creditScore”

HttpServer::new(|| {
    App::new()
        .wrap(
            actix_treblle::Treblle::new("project_id".to_string(), "api_key".to_string())
               .add_masking_fields(vec![
                   "password".to_string(),
                   "ssl_key".to_string(),
                   "cookie".to_string(),
                   "csrf".to_string(),
               ])
        )
        .route("/hello", web::get().to(|| async { "Hello World!" }))
})
.bind(("127.0.0.1", 8080))?
.run()
.await

source

pub fn add_ignored_routes(self, routes: Vec<String>) -> Treblle

Add routes that will be ignored for logging

Add a vector of route matching patterns, same as you would define them in your application.

HttpServer::new(|| {
    App::new()
        .wrap(
            actix_treblle::Treblle::new("project_id".to_string(), "api_key".to_string())
               .add_ignored_routes(vec![
                   "/users/{user_id}".to_string(),
                   "/users/{user_id}/change-password".to_string(),
               ])
        )
        .route("/hello", web::get().to(|| async { "Hello World!" }))
})
.bind(("127.0.0.1", 8080))?
.run()
.await