nautilus_common/python/logging.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
// -------------------------------------------------------------------------------------------------
// Copyright (C) 2015-2024 Nautech Systems Pty Ltd. All rights reserved.
// https://nautechsystems.io
//
// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
// You may not use this file except in compliance with the License.
// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// -------------------------------------------------------------------------------------------------
use std::collections::HashMap;
use log::LevelFilter;
use nautilus_core::uuid::UUID4;
use nautilus_model::identifiers::TraderId;
use pyo3::prelude::*;
use ustr::Ustr;
use crate::{
enums::{LogColor, LogLevel},
logging::{
self, headers,
logger::{self, LogGuard, LoggerConfig},
logging_set_bypass, map_log_level_to_filter, parse_level_filter_str,
writer::FileWriterConfig,
},
};
#[pymethods]
impl LoggerConfig {
#[staticmethod]
#[pyo3(name = "from_spec")]
pub fn py_from_spec(spec: String) -> Self {
LoggerConfig::from_spec(&spec)
}
}
#[pymethods]
impl FileWriterConfig {
#[new]
pub fn py_new(
directory: Option<String>,
file_name: Option<String>,
file_format: Option<String>,
) -> Self {
Self::new(directory, file_name, file_format)
}
}
/// Initialize tracing.
///
/// Tracing is meant to be used to trace/debug async Rust code. It can be
/// configured to filter modules and write up to a specific level only using
/// by passing a configuration using the `RUST_LOG` environment variable.
///
/// # Safety
///
/// Should only be called once during an applications run, ideally at the
/// beginning of the run.
#[pyfunction()]
#[pyo3(name = "init_tracing")]
pub fn py_init_tracing() {
logging::init_tracing();
}
/// Initialize logging.
///
/// Logging should be used for Python and sync Rust logic which is most of
/// the components in the main `nautilus_trader` package.
/// Logging can be configured to filter components and write up to a specific level only
/// by passing a configuration using the `NAUTILUS_LOG` environment variable.
///
/// # Safety
///
/// Should only be called once during an applications run, ideally at the
/// beginning of the run.
#[pyfunction]
#[pyo3(name = "init_logging")]
#[allow(clippy::too_many_arguments)]
pub fn py_init_logging(
trader_id: TraderId,
instance_id: UUID4,
level_stdout: LogLevel,
level_file: Option<LogLevel>,
component_levels: Option<HashMap<String, String>>,
directory: Option<String>,
file_name: Option<String>,
file_format: Option<String>,
is_colored: Option<bool>,
is_bypassed: Option<bool>,
print_config: Option<bool>,
) -> LogGuard {
let level_file = level_file
.map(map_log_level_to_filter)
.unwrap_or(LevelFilter::Off);
let config = LoggerConfig::new(
map_log_level_to_filter(level_stdout),
level_file,
parse_component_levels(component_levels),
is_colored.unwrap_or(true),
print_config.unwrap_or(false),
);
let file_config = FileWriterConfig::new(directory, file_name, file_format);
if is_bypassed.unwrap_or(false) {
logging_set_bypass();
}
logging::init_logging(trader_id, instance_id, config, file_config)
}
fn parse_component_levels(
original_map: Option<HashMap<String, String>>,
) -> HashMap<Ustr, LevelFilter> {
match original_map {
Some(map) => {
let mut new_map = HashMap::new();
for (key, value) in map {
let ustr_key = Ustr::from(&key);
let value = parse_level_filter_str(&value);
new_map.insert(ustr_key, value);
}
new_map
}
None => HashMap::new(),
}
}
/// Create a new log event.
#[pyfunction]
#[pyo3(name = "logger_log")]
pub fn py_logger_log(level: LogLevel, color: LogColor, component: String, message: String) {
logger::log(level, color, Ustr::from(&component), message.as_str());
}
/// Logs the standard Nautilus system header.
#[pyfunction]
#[pyo3(name = "log_header")]
pub fn py_log_header(trader_id: TraderId, machine_id: &str, instance_id: UUID4, component: &str) {
headers::log_header(trader_id, machine_id, instance_id, Ustr::from(component));
}
/// Logs system information.
#[pyfunction]
#[pyo3(name = "log_sysinfo")]
pub fn py_log_sysinfo(component: &str) {
headers::log_sysinfo(Ustr::from(component))
}