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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
//! A simple pattern-based encoder.
//!
//! Requires the `pattern_encoder` feature.
//!
//! The pattern syntax is similar to Rust's string formatting syntax. It
//! consists of raw text interspersed with format arguments. The grammar is:
//!
//! ```not_rust
//! format_string := <text> [ format <text> ] *
//! format := '{' formatter [ ':' format_spec ] '}'
//! formatter := [ name ] [ '(' argument ')' ] *
//! name := identifier
//! argument := format_string
//!
//! format_spec := [ [ fill ] align ] [ min_width ] [ '.' max_width ]
//! fill := character
//! align := '<' | '>'
//! min_width := number
//! max_width := number
//! ```
//!
//! # Special characters
//!
//! The `{`, `}`, `(`, `)`, and `\` characters are part of the pattern syntax;
//! they must be escaped to appear in output. Like with Rust's string
//! formatting syntax, type the character twice to escape it. That is, `{{`
//! will be rendered as `{` in output and `))` will be rendered as `)`.
//!
//! In addition, these characters may also be escaped by prefixing them with a
//! `\` character. That is, `\{` will be rendered as `{`.
//!
//! # Formatters
//!
//! A formatter inserts a dynamic portion of text into the pattern. It may be
//! text derived from a log event or from some other context like the current
//! time. Formatters may be passed arguments consisting of parenthesized format
//! strings.
//!
//! The following formatters are currently supported. Unless otherwise stated,
//! a formatter does not accept any argument.
//!
//! * `d`, `date` - The current time. By default, the ISO 8601 format is used.
//! A custom format may be provided in the syntax accepted by `chrono`.
//! The timezone defaults to local, but can be specified explicitly by
//! passing a second argument of `utc` for UTC or `local` for local time.
//! * `{d}` - `2016-03-20T14:22:20.644420340-08:00`
//! * `{d(%Y-%m-%d %H:%M:%S)}` - `2016-03-20 14:22:20`
//! * `{d(%Y-%m-%d %H:%M:%S %Z)(utc)}` - `2016-03-20 22:22:20 UTC`
//! * `f`, `file` - The source file that the log message came from, or `???` if
//! not provided.
//! * `h`, `highlight` - Styles its argument according to the log level. The
//! style is intense red for errors, red for warnings, blue for info, and
//! the default style for all other levels.
//! * `{h(the level is {l})}` -
//! <code style="color: red; font-weight: bold">the level is ERROR</code>
//! * `D`, `debug` - Outputs its arguments ONLY in debug build.
//! * `R`, `release` - Outputs its arguments ONLY in release build.
//! * `l`, `level` - The log level.
//! * `L`, `line` - The line that the log message came from, or `???` if not
//! provided.
//! * `m`, `message` - The log message.
//! * `M`, `module` - The module that the log message came from, or `???` if not
//! provided.
//! * `P`, `pid` - The current process id.
//! * `i`, `tid` - The current system-wide unique thread ID.
//! * `n` - A platform-specific newline.
//! * `t`, `target` - The target of the log message.
//! * `T`, `thread` - The name of the current thread.
//! * `I`, `thread_id` - The pthread ID of the current thread.
//! * `X`, `mdc` - A value from the [MDC][MDC]. The first argument specifies
//! the key, and the second argument specifies the default value if the
//! key is not present in the MDC. The second argument is optional, and
//! defaults to the empty string.
//! * `{X(user_id)}` - `123e4567-e89b-12d3-a456-426655440000`
//! * `{X(nonexistent_key)(no mapping)}` - `no mapping`
//! * An "unnamed" formatter simply formats its argument, applying the format
//! specification.
//! * `{({l} {m})}` - `INFO hello`
//!
//! # Format Specification
//!
//! The format specification determines how the output of a formatter is
//! adjusted before being returned.
//!
//! ## Fill/Alignment
//!
//! The fill and alignment values are used in conjunction with a minimum width
//! value (see below) to control the behavior when a formatter's output is less
//! than the minimum. While the default behavior is to pad the output to the
//! right with space characters (i.e. left align it), the fill value specifies
//! the character used, and the alignment value is one of:
//!
//! * `<` - Left align by appending the fill character to the formatter output
//! * `>` - Right align by prepending the fill character to the formatter
//! output.
//!
//! ## Width
//!
//! By default, the full contents of a formatter's output will be inserted into
//! the pattern output, but both the minimum and maximum lengths can be
//! configured. Any output over the maximum length will be truncated, and
//! output under the minimum length will be padded (see above).
//!
//! # Examples
//!
//! The default pattern is `{d} {l} {t} - {m}{n}` which produces output like
//! `2016-03-20T22:22:20.644420340+00:00 INFO module::path - this is a log
//! message`.
//!
//! The pattern `{m:>10.15}` will right-align the log message to a minimum of
//! 10 bytes, filling in with space characters, and truncate output after 15
//! bytes. The message `hello` will therefore be displayed as
//! <code> hello</code>, while the message `hello there, world!` will be
//! displayed as `hello there, wo`.
//!
//! The pattern `{({l} {m}):15.15}` will output the log level and message
//! limited to exactly 15 bytes, padding with space characters on the right if
//! necessary. The message `hello` and log level `INFO` will be displayed as
//! <code>INFO hello </code>, while the message `hello, world!` and log
//! level `DEBUG` will be truncated to `DEBUG hello, wo`.
//!
//! [MDC]: https://crates.io/crates/log-mdc
use chrono::{Local, Utc};
use derivative::Derivative;
use log::{Level, Record};
use std::{default::Default, io, process, thread};
use crate::encode::{
self,
pattern::parser::{Alignment, Parameters, Parser, Piece},
Color, Encode, Style, NEWLINE,
};
#[cfg(feature = "config_parsing")]
use crate::config::{Deserialize, Deserializers};
mod parser;
thread_local!(
/// Thread-locally cached thread ID.
static TID: usize = thread_id::get()
);
/// The pattern encoder's configuration.
#[cfg(feature = "config_parsing")]
#[derive(Clone, Eq, PartialEq, Hash, Debug, Default, serde::Deserialize)]
#[serde(deny_unknown_fields)]
pub struct PatternEncoderConfig {
pattern: Option<String>,
}
fn is_char_boundary(b: u8) -> bool {
b as i8 >= -0x40
}
fn char_starts(buf: &[u8]) -> usize {
buf.iter().filter(|&&b| is_char_boundary(b)).count()
}
struct MaxWidthWriter<'a> {
remaining: usize,
w: &'a mut dyn encode::Write,
}
impl<'a> io::Write for MaxWidthWriter<'a> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let mut remaining = self.remaining;
let mut end = buf.len();
for (idx, _) in buf
.iter()
.enumerate()
.filter(|&(_, &b)| is_char_boundary(b))
{
if remaining == 0 {
end = idx;
break;
}
remaining -= 1;
}
// we don't want to report EOF, so just act as a sink past this point
if end == 0 {
return Ok(buf.len());
}
let buf = &buf[..end];
match self.w.write(buf) {
Ok(len) => {
if len == end {
self.remaining = remaining;
} else {
self.remaining -= char_starts(&buf[..len]);
}
Ok(len)
}
Err(e) => Err(e),
}
}
fn flush(&mut self) -> io::Result<()> {
self.w.flush()
}
}
impl<'a> encode::Write for MaxWidthWriter<'a> {
fn set_style(&mut self, style: &Style) -> io::Result<()> {
self.w.set_style(style)
}
}
struct LeftAlignWriter<W> {
to_fill: usize,
fill: char,
w: W,
}
impl<W: encode::Write> LeftAlignWriter<W> {
fn finish(mut self) -> io::Result<()> {
for _ in 0..self.to_fill {
write!(self.w, "{}", self.fill)?;
}
Ok(())
}
}
impl<W: encode::Write> io::Write for LeftAlignWriter<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
match self.w.write(buf) {
Ok(len) => {
self.to_fill = self.to_fill.saturating_sub(char_starts(&buf[..len]));
Ok(len)
}
Err(e) => Err(e),
}
}
fn flush(&mut self) -> io::Result<()> {
self.w.flush()
}
}
impl<W: encode::Write> encode::Write for LeftAlignWriter<W> {
fn set_style(&mut self, style: &Style) -> io::Result<()> {
self.w.set_style(style)
}
}
enum BufferedOutput {
Data(Vec<u8>),
Style(Style),
}
struct RightAlignWriter<W> {
to_fill: usize,
fill: char,
w: W,
buf: Vec<BufferedOutput>,
}
impl<W: encode::Write> RightAlignWriter<W> {
fn finish(mut self) -> io::Result<()> {
for _ in 0..self.to_fill {
write!(self.w, "{}", self.fill)?;
}
for out in self.buf {
match out {
BufferedOutput::Data(ref buf) => self.w.write_all(buf)?,
BufferedOutput::Style(ref style) => self.w.set_style(style)?,
}
}
Ok(())
}
}
impl<W: encode::Write> io::Write for RightAlignWriter<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.to_fill = self.to_fill.saturating_sub(char_starts(buf));
let mut pushed = false;
if let Some(&mut BufferedOutput::Data(ref mut data)) = self.buf.last_mut() {
data.extend_from_slice(buf);
pushed = true;
};
if !pushed {
self.buf.push(BufferedOutput::Data(buf.to_owned()));
}
Ok(buf.len())
}
fn flush(&mut self) -> io::Result<()> {
Ok(())
}
}
impl<W: encode::Write> encode::Write for RightAlignWriter<W> {
fn set_style(&mut self, style: &Style) -> io::Result<()> {
self.buf.push(BufferedOutput::Style(style.clone()));
Ok(())
}
}
#[derive(Clone, Eq, PartialEq, Hash, Debug)]
enum Chunk {
Text(String),
Formatted {
chunk: FormattedChunk,
params: Parameters,
},
Error(String),
}
impl Chunk {
fn encode(&self, w: &mut dyn encode::Write, record: &Record) -> io::Result<()> {
match *self {
Chunk::Text(ref s) => w.write_all(s.as_bytes()),
Chunk::Formatted {
ref chunk,
ref params,
} => match (params.min_width, params.max_width, params.align) {
(None, None, _) => chunk.encode(w, record),
(None, Some(max_width), _) => {
let mut w = MaxWidthWriter {
remaining: max_width,
w,
};
chunk.encode(&mut w, record)
}
(Some(min_width), None, Alignment::Left) => {
let mut w = LeftAlignWriter {
to_fill: min_width,
fill: params.fill,
w,
};
chunk.encode(&mut w, record)?;
w.finish()
}
(Some(min_width), None, Alignment::Right) => {
let mut w = RightAlignWriter {
to_fill: min_width,
fill: params.fill,
w,
buf: vec![],
};
chunk.encode(&mut w, record)?;
w.finish()
}
(Some(min_width), Some(max_width), Alignment::Left) => {
let mut w = LeftAlignWriter {
to_fill: min_width,
fill: params.fill,
w: MaxWidthWriter {
remaining: max_width,
w,
},
};
chunk.encode(&mut w, record)?;
w.finish()
}
(Some(min_width), Some(max_width), Alignment::Right) => {
let mut w = RightAlignWriter {
to_fill: min_width,
fill: params.fill,
w: MaxWidthWriter {
remaining: max_width,
w,
},
buf: vec![],
};
chunk.encode(&mut w, record)?;
w.finish()
}
},
Chunk::Error(ref s) => write!(w, "{{ERROR: {}}}", s),
}
}
}
impl<'a> From<Piece<'a>> for Chunk {
fn from(piece: Piece<'a>) -> Chunk {
match piece {
Piece::Text(text) => Chunk::Text(text.to_owned()),
Piece::Argument {
mut formatter,
parameters,
} => match formatter.name {
"d" | "date" => {
if formatter.args.len() > 2 {
return Chunk::Error("expected at most two arguments".to_owned());
}
let format = match formatter.args.first() {
Some(arg) => {
let mut format = String::new();
for piece in arg {
match *piece {
Piece::Text(text) => format.push_str(text),
Piece::Argument { .. } => {
format.push_str("{ERROR: unexpected formatter}");
}
Piece::Error(ref err) => {
format.push_str("{ERROR: ");
format.push_str(err);
format.push('}');
}
}
}
format
}
None => "%+".to_owned(),
};
let timezone = match formatter.args.get(1) {
Some(arg) => {
if let Some(arg) = arg.first() {
match *arg {
Piece::Text("utc") => Timezone::Utc,
Piece::Text("local") => Timezone::Local,
Piece::Text(z) => {
return Chunk::Error(format!("invalid timezone `{}`", z));
}
_ => return Chunk::Error("invalid timezone".to_owned()),
}
} else {
return Chunk::Error("invalid timezone".to_owned());
}
}
None => Timezone::Local,
};
Chunk::Formatted {
chunk: FormattedChunk::Time(format, timezone),
params: parameters,
}
}
"h" | "highlight" => {
if formatter.args.len() != 1 {
return Chunk::Error("expected exactly one argument".to_owned());
}
let chunks = formatter
.args
.pop()
.unwrap()
.into_iter()
.map(From::from)
.collect();
Chunk::Formatted {
chunk: FormattedChunk::Highlight(chunks),
params: parameters,
}
}
"D" | "debug" => {
if formatter.args.len() != 1 {
return Chunk::Error("expected exactly one argument".to_owned());
}
let chunks = formatter
.args
.pop()
.unwrap()
.into_iter()
.map(From::from)
.collect();
Chunk::Formatted {
chunk: FormattedChunk::Debug(chunks),
params: parameters,
}
}
"R" | "release" => {
if formatter.args.len() != 1 {
return Chunk::Error("expected exactly one argument".to_owned());
}
let chunks = formatter
.args
.pop()
.unwrap()
.into_iter()
.map(From::from)
.collect();
Chunk::Formatted {
chunk: FormattedChunk::Release(chunks),
params: parameters,
}
}
"l" | "level" => no_args(&formatter.args, parameters, FormattedChunk::Level),
"m" | "message" => no_args(&formatter.args, parameters, FormattedChunk::Message),
"M" | "module" => no_args(&formatter.args, parameters, FormattedChunk::Module),
"n" => no_args(&formatter.args, parameters, FormattedChunk::Newline),
"f" | "file" => no_args(&formatter.args, parameters, FormattedChunk::File),
"L" | "line" => no_args(&formatter.args, parameters, FormattedChunk::Line),
"T" | "thread" => no_args(&formatter.args, parameters, FormattedChunk::Thread),
"I" | "thread_id" => no_args(&formatter.args, parameters, FormattedChunk::ThreadId),
"P" | "pid" => no_args(&formatter.args, parameters, FormattedChunk::ProcessId),
"i" | "tid" => no_args(&formatter.args, parameters, FormattedChunk::SystemThreadId),
"t" | "target" => no_args(&formatter.args, parameters, FormattedChunk::Target),
"X" | "mdc" => {
if formatter.args.len() > 2 {
return Chunk::Error("expected at most two arguments".to_owned());
}
let key = match formatter.args.first() {
Some(arg) => {
if let Some(arg) = arg.first() {
match arg {
Piece::Text(key) => key.to_owned(),
Piece::Error(ref e) => return Chunk::Error(e.clone()),
_ => return Chunk::Error("invalid MDC key".to_owned()),
}
} else {
return Chunk::Error("invalid MDC key".to_owned());
}
}
None => return Chunk::Error("missing MDC key".to_owned()),
};
let default = match formatter.args.get(1) {
Some(arg) => {
if let Some(arg) = arg.first() {
match arg {
Piece::Text(key) => key.to_owned(),
Piece::Error(ref e) => return Chunk::Error(e.clone()),
_ => return Chunk::Error("invalid MDC default".to_owned()),
}
} else {
return Chunk::Error("invalid MDC default".to_owned());
}
}
None => "",
};
Chunk::Formatted {
chunk: FormattedChunk::Mdc(key.into(), default.into()),
params: parameters,
}
}
"" => {
if formatter.args.len() != 1 {
return Chunk::Error("expected exactly one argument".to_owned());
}
let chunks = formatter
.args
.pop()
.unwrap()
.into_iter()
.map(From::from)
.collect();
Chunk::Formatted {
chunk: FormattedChunk::Align(chunks),
params: parameters,
}
}
name => Chunk::Error(format!("unknown formatter `{}`", name)),
},
Piece::Error(err) => Chunk::Error(err),
}
}
}
fn no_args(arg: &[Vec<Piece>], params: Parameters, chunk: FormattedChunk) -> Chunk {
if arg.is_empty() {
Chunk::Formatted { chunk, params }
} else {
Chunk::Error("unexpected arguments".to_owned())
}
}
#[derive(Clone, Eq, PartialEq, Hash, Debug)]
enum Timezone {
Utc,
Local,
}
#[derive(Clone, Eq, PartialEq, Hash, Debug)]
enum FormattedChunk {
Time(String, Timezone),
Level,
Message,
Module,
File,
Line,
Thread,
ThreadId,
ProcessId,
SystemThreadId,
Target,
Newline,
Align(Vec<Chunk>),
Highlight(Vec<Chunk>),
Debug(Vec<Chunk>),
Release(Vec<Chunk>),
Mdc(String, String),
}
impl FormattedChunk {
fn encode(&self, w: &mut dyn encode::Write, record: &Record) -> io::Result<()> {
match *self {
FormattedChunk::Time(ref fmt, Timezone::Utc) => write!(w, "{}", Utc::now().format(fmt)),
FormattedChunk::Time(ref fmt, Timezone::Local) => {
write!(w, "{}", Local::now().format(fmt))
}
FormattedChunk::Level => write!(w, "{}", record.level()),
FormattedChunk::Message => w.write_fmt(*record.args()),
FormattedChunk::Module => w.write_all(record.module_path().unwrap_or("???").as_bytes()),
FormattedChunk::File => w.write_all(record.file().unwrap_or("???").as_bytes()),
FormattedChunk::Line => match record.line() {
Some(line) => write!(w, "{}", line),
None => w.write_all(b"???"),
},
FormattedChunk::Thread => {
w.write_all(thread::current().name().unwrap_or("unnamed").as_bytes())
}
FormattedChunk::ThreadId => w.write_all(thread_id::get().to_string().as_bytes()),
FormattedChunk::ProcessId => w.write_all(process::id().to_string().as_bytes()),
FormattedChunk::SystemThreadId => {
TID.with(|tid| w.write_all(tid.to_string().as_bytes()))
}
FormattedChunk::Target => w.write_all(record.target().as_bytes()),
FormattedChunk::Newline => w.write_all(NEWLINE.as_bytes()),
FormattedChunk::Align(ref chunks) => {
for chunk in chunks {
chunk.encode(w, record)?;
}
Ok(())
}
FormattedChunk::Highlight(ref chunks) => {
match record.level() {
Level::Error => {
w.set_style(Style::new().text(Color::Red).intense(true))?;
}
Level::Warn => w.set_style(Style::new().text(Color::Yellow))?,
Level::Info => w.set_style(Style::new().text(Color::Green))?,
Level::Trace => w.set_style(Style::new().text(Color::Cyan))?,
_ => {}
}
for chunk in chunks {
chunk.encode(w, record)?;
}
match record.level() {
Level::Error | Level::Warn | Level::Info | Level::Trace => {
w.set_style(&Style::new())?
}
_ => {}
}
Ok(())
}
FormattedChunk::Debug(ref chunks) => {
if cfg!(debug_assertions) {
for chunk in chunks {
chunk.encode(w, record)?;
}
}
Ok(())
}
FormattedChunk::Release(ref chunks) => {
if !cfg!(debug_assertions) {
for chunk in chunks {
chunk.encode(w, record)?;
}
}
Ok(())
}
FormattedChunk::Mdc(ref key, ref default) => {
log_mdc::get(key, |v| write!(w, "{}", v.unwrap_or(default)))
}
}
}
}
/// An `Encode`r configured via a format string.
#[derive(Derivative)]
#[derivative(Debug)]
#[derive(Clone, Eq, PartialEq, Hash)]
pub struct PatternEncoder {
#[derivative(Debug = "ignore")]
chunks: Vec<Chunk>,
pattern: String,
}
/// Returns a `PatternEncoder` using the default pattern of `{d} {l} {t} - {m}{n}`.
impl Default for PatternEncoder {
fn default() -> PatternEncoder {
PatternEncoder::new("{d} {l} {t} - {m}{n}")
}
}
impl Encode for PatternEncoder {
fn encode(&self, w: &mut dyn encode::Write, record: &Record) -> anyhow::Result<()> {
for chunk in &self.chunks {
chunk.encode(w, record)?;
}
Ok(())
}
}
impl PatternEncoder {
/// Creates a `PatternEncoder` from a pattern string.
///
/// The pattern string syntax is documented in the `pattern` module.
pub fn new(pattern: &str) -> PatternEncoder {
PatternEncoder {
chunks: Parser::new(pattern).map(From::from).collect(),
pattern: pattern.to_owned(),
}
}
}
/// A deserializer for the `PatternEncoder`.
///
/// # Configuration
///
/// ```yaml
/// kind: pattern
///
/// # The pattern to follow when formatting logs. Defaults to
/// # "{d} {l} {t} - {m}{n}".
/// pattern: "{d} {l} {t} - {m}{n}"
/// ```
#[cfg(feature = "config_parsing")]
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub struct PatternEncoderDeserializer;
#[cfg(feature = "config_parsing")]
impl Deserialize for PatternEncoderDeserializer {
type Trait = dyn Encode;
type Config = PatternEncoderConfig;
fn deserialize(
&self,
config: PatternEncoderConfig,
_: &Deserializers,
) -> anyhow::Result<Box<dyn Encode>> {
let encoder = match config.pattern {
Some(pattern) => PatternEncoder::new(&pattern),
None => PatternEncoder::default(),
};
Ok(Box::new(encoder))
}
}
#[cfg(test)]
mod tests {
#[cfg(feature = "simple_writer")]
use log::{Level, Record};
#[cfg(feature = "simple_writer")]
use std::process;
#[cfg(feature = "simple_writer")]
use std::thread;
use super::{Chunk, PatternEncoder};
#[cfg(feature = "simple_writer")]
use crate::encode::writer::simple::SimpleWriter;
#[cfg(feature = "simple_writer")]
use crate::encode::Encode;
fn error_free(encoder: &PatternEncoder) -> bool {
encoder.chunks.iter().all(|c| match *c {
Chunk::Error(_) => false,
_ => true,
})
}
#[test]
fn invalid_formatter() {
assert!(!error_free(&PatternEncoder::new("{x}")));
}
#[test]
fn unclosed_delimiter() {
assert!(!error_free(&PatternEncoder::new("{d(%Y-%m-%d)")));
}
#[test]
#[cfg(feature = "simple_writer")]
fn log() {
let pw = PatternEncoder::new("{l} {m} at {M} in {f}:{L}");
let mut buf = vec![];
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder()
.level(Level::Debug)
.args(format_args!("the message"))
.module_path(Some("path"))
.file(Some("file"))
.line(Some(132))
.build(),
)
.unwrap();
assert_eq!(buf, &b"DEBUG the message at path in file:132"[..]);
}
#[test]
#[cfg(feature = "simple_writer")]
fn unnamed_thread() {
thread::spawn(|| {
let pw = PatternEncoder::new("{T}");
let mut buf = vec![];
pw.encode(&mut SimpleWriter(&mut buf), &Record::builder().build())
.unwrap();
assert_eq!(buf, b"unnamed");
})
.join()
.unwrap();
}
#[test]
#[cfg(feature = "simple_writer")]
fn named_thread() {
thread::Builder::new()
.name("foobar".to_string())
.spawn(|| {
let pw = PatternEncoder::new("{T}");
let mut buf = vec![];
pw.encode(&mut SimpleWriter(&mut buf), &Record::builder().build())
.unwrap();
assert_eq!(buf, b"foobar");
})
.unwrap()
.join()
.unwrap();
}
#[test]
#[cfg(feature = "simple_writer")]
fn thread_id_field() {
thread::spawn(|| {
let pw = PatternEncoder::new("{I}");
let mut buf = vec![];
pw.encode(&mut SimpleWriter(&mut buf), &Record::builder().build())
.unwrap();
assert_eq!(buf, thread_id::get().to_string().as_bytes());
})
.join()
.unwrap();
}
#[test]
#[cfg(feature = "simple_writer")]
fn process_id() {
let pw = PatternEncoder::new("{P}");
let mut buf = vec![];
pw.encode(&mut SimpleWriter(&mut buf), &Record::builder().build())
.unwrap();
assert_eq!(buf, process::id().to_string().as_bytes());
}
#[test]
#[cfg(feature = "simple_writer")]
fn system_thread_id() {
let pw = PatternEncoder::new("{i}");
let mut buf = vec![];
pw.encode(&mut SimpleWriter(&mut buf), &Record::builder().build())
.unwrap();
assert_eq!(buf, thread_id::get().to_string().as_bytes());
}
#[test]
#[cfg(feature = "simple_writer")]
fn default_okay() {
assert!(error_free(&PatternEncoder::default()));
}
#[test]
#[cfg(feature = "simple_writer")]
fn left_align() {
let pw = PatternEncoder::new("{m:~<5.6}");
let mut buf = vec![];
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder().args(format_args!("foo")).build(),
)
.unwrap();
assert_eq!(buf, b"foo~~");
buf.clear();
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder().args(format_args!("foobar!")).build(),
)
.unwrap();
assert_eq!(buf, b"foobar");
}
#[test]
#[cfg(feature = "simple_writer")]
fn right_align() {
let pw = PatternEncoder::new("{m:~>5.6}");
let mut buf = vec![];
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder().args(format_args!("foo")).build(),
)
.unwrap();
assert_eq!(buf, b"~~foo");
buf.clear();
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder().args(format_args!("foobar!")).build(),
)
.unwrap();
assert_eq!(buf, b"foobar");
}
#[test]
#[cfg(feature = "simple_writer")]
fn left_align_formatter() {
let pw = PatternEncoder::new("{({l} {m}):15}");
let mut buf = vec![];
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder()
.level(Level::Info)
.args(format_args!("foobar!"))
.build(),
)
.unwrap();
assert_eq!(buf, b"INFO foobar! ");
}
#[test]
#[cfg(feature = "simple_writer")]
fn right_align_formatter() {
let pw = PatternEncoder::new("{({l} {m}):>15}");
let mut buf = vec![];
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder()
.level(Level::Info)
.args(format_args!("foobar!"))
.build(),
)
.unwrap();
assert_eq!(buf, b" INFO foobar!");
}
#[test]
fn custom_date_format() {
assert!(error_free(&PatternEncoder::new(
"{d(%Y-%m-%d %H:%M:%S)} {m}{n}"
)));
}
#[test]
fn timezones() {
assert!(error_free(&PatternEncoder::new("{d(%+)(utc)}")));
assert!(error_free(&PatternEncoder::new("{d(%+)(local)}")));
assert!(!error_free(&PatternEncoder::new("{d(%+)(foo)}")));
}
#[test]
fn unescaped_parens() {
assert!(!error_free(&PatternEncoder::new("(hi)")));
}
#[test]
#[cfg(feature = "simple_writer")]
fn escaped_chars() {
let pw = PatternEncoder::new("{{{m}(())}}");
let mut buf = vec![];
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder().args(format_args!("foobar!")).build(),
)
.unwrap();
assert_eq!(buf, b"{foobar!()}");
}
#[test]
#[cfg(feature = "simple_writer")]
fn quote_braces_with_backslash() {
let pw = PatternEncoder::new(r"\{\({l}\)\}\\");
let mut buf = vec![];
pw.encode(
&mut SimpleWriter(&mut buf),
&Record::builder().level(Level::Info).build(),
)
.unwrap();
assert_eq!(buf, br"{(INFO)}\");
}
#[test]
#[cfg(feature = "simple_writer")]
fn mdc() {
let pw = PatternEncoder::new("{X(user_id)}");
log_mdc::insert("user_id", "mdc value");
let mut buf = vec![];
pw.encode(&mut SimpleWriter(&mut buf), &Record::builder().build())
.unwrap();
assert_eq!(buf, b"mdc value");
}
#[test]
#[cfg(feature = "simple_writer")]
fn mdc_missing_default() {
let pw = PatternEncoder::new("{X(user_id)}");
let mut buf = vec![];
pw.encode(&mut SimpleWriter(&mut buf), &Record::builder().build())
.unwrap();
assert_eq!(buf, b"");
}
#[test]
#[cfg(feature = "simple_writer")]
fn mdc_missing_custom() {
let pw = PatternEncoder::new("{X(user_id)(missing value)}");
let mut buf = vec![];
pw.encode(&mut SimpleWriter(&mut buf), &Record::builder().build())
.unwrap();
assert_eq!(buf, b"missing value");
}
#[test]
#[cfg(feature = "simple_writer")]
fn debug_release() {
let debug_pat = "{D({l})}";
let release_pat = "{R({l})}";
let debug_encoder = PatternEncoder::new(debug_pat);
let release_encoder = PatternEncoder::new(release_pat);
let mut debug_buf = vec![];
let mut release_buf = vec![];
debug_encoder
.encode(
&mut SimpleWriter(&mut debug_buf),
&Record::builder().level(Level::Info).build(),
)
.unwrap();
release_encoder
.encode(
&mut SimpleWriter(&mut release_buf),
&Record::builder().level(Level::Info).build(),
)
.unwrap();
if cfg!(debug_assertions) {
assert_eq!(debug_buf, b"INFO");
assert!(release_buf.is_empty());
} else {
assert_eq!(release_buf, b"INFO");
assert!(debug_buf.is_empty());
}
}
}