Skip to content

S
spdlog
Commit 8c538fba authored by Gabi Melman's avatar Gabi Melman
Browse files
Options

Create gh-pages branch via GitHub

parent ba3c94af
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 846 additions and 398 deletions
index.html
View file @ 8c538fba
This diff is collapsed.
params.json
View file @ 8c538fba
{"name":"Spdlog","tagline":"Super fast C++ logging library.","body":"# spdlog\r\n\r\nVery fast, header only, C++ logging library.\r\n\r\n\r\n## Install\r\nJust copy the files to your build tree and use a C++11 compiler\r\n\r\n\r\n## Tested on:\r\n* gcc 4.8.1 and above\r\n* clang 3.5\r\n* visual studio 2013\r\n\r\n##Features\r\n* Very low overhead\r\n* Stream like, easy to use interface\r\n* Logging levels\r\n* Rotating log files\r\n* Daily log files\r\n* Async logging\r\n* Thread safety\r\n* Custom formatting\r\n\r\n\r\n## Performance\r\nThe library is very fast. \r\nHere are some benchmarks (Ubuntu, Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz)\r\n```\r\n*******************************************************************************\r\nSingle thread, 250,000 iterations, flush every 1000 lines\r\n*******************************************************************************\r\nrotating_st...\t817,860 lines/sec\r\ndaily_st...\t\t827,820 lines /sec\r\n\r\n*******************************************************************************\r\n4 threads sharing same logger, 250,000 iterations, flush every 1000 lines\r\n*******************************************************************************\r\nrotating_mt...\t1,476,013 lines/sec\r\ndaily_mt...\t\t1,477,619 lines/sec\r\n```\r\n\r\n## Usage Example\r\n```\r\n#include <iostream>\r\n#include \"spdlog/spdlog.h\"\r\n\r\nint main(int, char* [])\r\n{\r\n namespace spd = spdlog;\r\n\r\n try\r\n {\r\n std::string filename = \"spdlog_example\";\r\n auto console = spd::stderr_logger_mt(\"console\");\r\n console->info(\"Welcome to spdlog!\") ;\r\n console->info() << \"Creating file \" << filename << \"..\";\r\n\r\n auto file_logger = spd::rotating_logger_mt(\"file_logger\", filename, 1024 * 1024 * 5, 3);\r\n file_logger->info(\"Log file message number\", 1);\r\n\r\n for (int i = 0; i < 100; ++i)\r\n {\r\n auto square = i*i;\r\n file_logger->info() << i << '*' << i << '=' << square << \" (\" << \"0x\" << std::hex << square << \")\";\r\n }\r\n\r\n // Change log level to all loggers to warning and above\r\n spd::set_level(spd::level::WARN);\r\n console->info(\"This should not be displayed\");\r\n console->warn(\"This should!\");\r\n spd::set_level(spd::level::INFO);\r\n\r\n // Change format pattern to all loggers\r\n spd::set_pattern(\" **** %Y-%m-%d %H:%M:%S.%e %l **** %v\");\r\n spd::get(\"console\")->info(\"This is another message with different format\");\r\n }\r\n catch (const spd::spdlog_ex& ex)\r\n {\r\n std::cout << \"Log failed: \" << ex.what() << std::endl;\r\n }\r\n return 0;\r\n}\r\n```","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
{"name":"Spdlog","tagline":"Super fast C++ logging library.","body":"# spdlog\r\n\r\nVery fast, header only, C++ logging library.\r\n\r\n## Install\r\nJust copy the files to your build tree and use a C++11 compiler\r\n\r\n## Tested on:\r\n* gcc 4.8.1 and above\r\n* clang 3.5 (Linux and OSX)\r\n* visual studio 2013\r\n* mingw with g++ 4.9.x\r\n\r\n##Features\r\n* Very fast - performance is the primary goal (see [benchmarks](#benchmarks) below).\r\n* Headers only.\r\n* No dependencies - just copy and use.\r\n* Cross platform - Linux / Windows on 32/64 bits.\r\n* **new!** Feature rich [call style](#usage-example) using the excellent [cppformat](http://cppformat.github.io/) library.\r\n* ostream call style is supported too.\r\n* Extremely fast asynchronous mode (optional) - using lockfree queues and other tricks to reach millions of calls/sec.\r\n* [Custom](https://github.com/gabime/spdlog/wiki/Custom-formatting) formatting.\r\n* Multi/Single threaded loggers.\r\n* Various log targets:\r\n * Rotating log files.\r\n * Daily log files.\r\n * Console logging.\r\n * Linux syslog.\r\n * Easily extendable with custom log targets (just implement a single function in the [sink](include/spdlog/sinks/sink.h) interface).\r\n* Severity based filtering - threshold levels can be modified in runtime as well as in compile time.\r\n\r\n\r\n\r\n## Benchmarks\r\n\r\nBelow are some [benchmarks](bench) comparing popular log libraries under Ubuntu 64 bit, Intel i7-4770 CPU @ 3.40GHz \r\n\r\n#### Synchronous mode\r\nTime needed to log 1,000,000 lines in synchronous mode (in seconds, the best of 3 runs):\r\n\r\n|threads|boost log|glog |easylogging |spdlog|\r\n|-------|:-------:|:-----:|----------:|------:|\r\n|1| 4.169s |1.066s |0.975s |0.302s|\r\n|10| 16.029 |3.032s |2.857s |0.968s|\r\n|100| 15.008 |1.139s |4.512s |0.497s|\r\n\r\n\r\n#### Asynchronous mode \r\nTime needed to log 1,000,000 lines in asynchronous mode, i.e. the time it takes to put them in the async queue (in seconds, the best of 3 runs):\r\n\r\n|threads|g2log <sup>async logger</sup> |spdlog <sup>async mode</sup>|\r\n|:-------|:-----:|-------------------------:|\r\n|1| 1.850s |0.216s |\r\n|10| 0.943s |0.173s|\r\n|100| 0.959s |0.202s|\r\n\r\n\r\n\r\n\r\n## Usage Example\r\n```c++\r\n#include <iostream>\r\n#include \"spdlog/spdlog.h\"\r\n\r\nint main(int, char* [])\r\n{\r\n namespace spd = spdlog;\r\n try\r\n {\r\n //Create console, multithreaded logger\r\n auto console = spd::stdout_logger_mt(\"console\");\r\n console->info(\"Welcome to spdlog!\") ;\r\n console->info(\"An info message example {}..\", 1);\r\n console->info() << \"Streams are supported too \" << 1;\r\n\t\r\n //Formatting examples\r\n console->info(\"Easy padding in numbers like {:08d}\", 12);\r\n console->info(\"Support for int: {0:d}; hex: {0:x}; oct: {0:o}; bin: {0:b}\", 42);\r\n console->info(\"Support for floats {:03.2f}\", 1.23456);\r\n console->info(\"Positional args are {1} {0}..\", \"too\", \"supported\");\r\n\r\n console->info(\"{:<30}\", \"left aligned\");\r\n console->info(\"{:>30}\", \"right aligned\");\r\n console->info(\"{:^30}\", \"centered\");\r\n \r\n //\r\n // Runtime log levels\r\n //\r\n spd::set_level(spd::level::info); //Set global log level to info\r\n console->debug(\"This message shold not be displayed!\");\r\n console->set_level(spd::level::debug); // Set specific logger's log level\r\n console->debug(\"Now it should..\");\r\n \r\n //\r\n // Create a file rotating logger with 5mb size max and 3 rotated files\r\n //\r\n auto file_logger = spd::rotating_logger_mt(\"file_logger\", \"logs/mylogfile\", 1048576 * 5, 3);\r\n for(int i = 0; i < 10; ++i)\r\n\t\t file_logger->info(\"{} * {} equals {:>10}\", i, i, i*i);\r\n\r\n //\r\n // Create a daily logger - a new file is created every day on 2:30am\r\n //\r\n auto daily_logger = spd::daily_logger_mt(\"daily_logger\", \"logs/daily\", 2, 30);\r\n \r\n // \r\n // Customize msg format for all messages\r\n //\r\n spd::set_pattern(\"*** [%H:%M:%S %z] [thread %t] %v ***\");\r\n file_logger->info(\"This is another message with custom format\");\r\n\r\n spd::get(\"console\")->info(\"loggers can be retrieved from a global registry using the spdlog::get(logger_name) function\");\r\n\r\n //\r\n // Compile time debug or trace macros.\r\n // Enabled #ifdef SPDLOG_DEBUG_ON or #ifdef SPDLOG_TRACE_ON\r\n //\r\n SPDLOG_TRACE(console, \"Enabled only #ifdef SPDLOG_TRACE_ON..{} ,{}\", 1, 3.23);\r\n SPDLOG_DEBUG(console, \"Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}\", 1, 3.23);\r\n \r\n //\r\n // Asynchronous logging is very fast..\r\n // Just call spdlog::set_async_mode(q_size) and all created loggers from now on will be asynchronous..\r\n //\r\n size_t q_size = 1048576; //queue size must be power of 2\r\n spdlog::set_async_mode(q_size);\r\n auto async_file= spd::daily_logger_st(\"async_file_logger\", \"logs/async_log.txt\");\r\n async_file->info() << \"This is async log..\" << \"Should be very fast!\";\r\n \r\n // \r\n // syslog example. linux only..\r\n //\r\n #ifdef __linux__\r\n std::string ident = \"spdlog-example\";\r\n auto syslog_logger = spd::syslog_logger(\"syslog\", ident, LOG_PID);\r\n syslog_logger->warn(\"This is warning that will end up in syslog. This is Linux only!\"); \r\n #endif\r\n }\r\n catch (const spd::spdlog_ex& ex)\r\n {\r\n std::cout << \"Log failed: \" << ex.what() << std::endl;\r\n }\r\n}\r\n\r\n\r\n// Example of user defined class with operator<<\r\nclass some_class {};\r\nstd::ostream& operator<<(std::ostream& os, const some_class& c) { return os << \"some_class\"; }\r\n\r\nvoid custom_class_example()\r\n{\r\n some_class c;\r\n spdlog::get(\"console\")->info(\"custom class with operator<<: {}..\", c);\r\n spdlog::get(\"console\")->info() << \"custom class with operator<<: \" << c << \"..\";\r\n}\r\n```\r\n\r\n## Tweaking\r\nspdlog can be tweaked to improve performance even more.\r\n\r\nEdit [this](include/spdlog/tweakme.h) file to disable at compile time unneeded features.\r\n\r\n\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
stylesheets/github-light.css 0 → 100644
View file @ 8c538fba
/*
Copyright 2014 GitHub Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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.
*/
.pl-c /* comment */ {
color: #969896;
}
.pl-c1 /* constant, markup.raw, meta.diff.header, meta.module-reference, meta.property-name, support, support.constant, support.variable, variable.other.constant */,
.pl-s .pl-v /* string variable */ {
color: #0086b3;
}
.pl-e /* entity */,
.pl-en /* entity.name */ {
color: #795da3;
}
.pl-s .pl-s1 /* string source */,
.pl-smi /* storage.modifier.import, storage.modifier.package, storage.type.java, variable.other, variable.parameter.function */ {
color: #333;
}
.pl-ent /* entity.name.tag */ {
color: #63a35c;
}
.pl-k /* keyword, storage, storage.type */ {
color: #a71d5d;
}
.pl-pds /* punctuation.definition.string, string.regexp.character-class */,
.pl-s /* string */,
.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
.pl-sr /* string.regexp */,
.pl-sr .pl-cce /* string.regexp constant.character.escape */,
.pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */,
.pl-sr .pl-sre /* string.regexp source.ruby.embedded */ {
color: #183691;
}
.pl-v /* variable */ {
color: #ed6a43;
}
.pl-id /* invalid.deprecated */ {
color: #b52a1d;
}
.pl-ii /* invalid.illegal */ {
background-color: #b52a1d;
color: #f8f8f8;
}
.pl-sr .pl-cce /* string.regexp constant.character.escape */ {
color: #63a35c;
font-weight: bold;
}
.pl-ml /* markup.list */ {
color: #693a17;
}
.pl-mh /* markup.heading */,
.pl-mh .pl-en /* markup.heading entity.name */,
.pl-ms /* meta.separator */ {
color: #1d3e81;
font-weight: bold;
}
.pl-mq /* markup.quote */ {
color: #008080;
}
.pl-mi /* markup.italic */ {
color: #333;
font-style: italic;
}
.pl-mb /* markup.bold */ {
color: #333;
font-weight: bold;
}
.pl-md /* markup.deleted, meta.diff.header.from-file */ {
background-color: #ffecec;
color: #bd2c00;
}
.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
background-color: #eaffea;
color: #55a532;
}
.pl-mdr /* meta.diff.range */ {
color: #795da3;
font-weight: bold;
}
.pl-mo /* meta.output */ {
color: #1d3e81;
}
stylesheets/normalize.css
View file @ 8c538fba
This diff is collapsed.
stylesheets/stylesheet.css 0 → 100644
View file @ 8c538fba
* {
box-sizing: border-box; }
body {
padding: 0;
margin: 0;
font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
font-size: 16px;
line-height: 1.5;
color: #606c71; }
a {
color: #1e6bb8;
text-decoration: none; }
a:hover {
text-decoration: underline; }
.btn {
display: inline-block;
margin-bottom: 1rem;
color: rgba(255, 255, 255, 0.7);
background-color: rgba(255, 255, 255, 0.08);
border-color: rgba(255, 255, 255, 0.2);
border-style: solid;
border-width: 1px;
border-radius: 0.3rem;
transition: color 0.2s, background-color 0.2s, border-color 0.2s; }
.btn + .btn {
margin-left: 1rem; }
.btn:hover {
color: rgba(255, 255, 255, 0.8);
text-decoration: none;
background-color: rgba(255, 255, 255, 0.2);
border-color: rgba(255, 255, 255, 0.3); }
@media screen and (min-width: 64em) {
.btn {
padding: 0.75rem 1rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.btn {
padding: 0.6rem 0.9rem;
font-size: 0.9rem; } }
@media screen and (max-width: 42em) {
.btn {
display: block;
width: 100%;
padding: 0.75rem;
font-size: 0.9rem; }
.btn + .btn {
margin-top: 1rem;
margin-left: 0; } }
.page-header {
color: #fff;
text-align: center;
background-color: #159957;
background-image: linear-gradient(120deg, #155799, #159957); }
@media screen and (min-width: 64em) {
.page-header {
padding: 5rem 6rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.page-header {
padding: 3rem 4rem; } }
@media screen and (max-width: 42em) {
.page-header {
padding: 2rem 1rem; } }
.project-name {
margin-top: 0;
margin-bottom: 0.1rem; }
@media screen and (min-width: 64em) {
.project-name {
font-size: 3.25rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.project-name {
font-size: 2.25rem; } }
@media screen and (max-width: 42em) {
.project-name {
font-size: 1.75rem; } }
.project-tagline {
margin-bottom: 2rem;
font-weight: normal;
opacity: 0.7; }
@media screen and (min-width: 64em) {
.project-tagline {
font-size: 1.25rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.project-tagline {
font-size: 1.15rem; } }
@media screen and (max-width: 42em) {
.project-tagline {
font-size: 1rem; } }
.main-content :first-child {
margin-top: 0; }
.main-content img {
max-width: 100%; }
.main-content h1, .main-content h2, .main-content h3, .main-content h4, .main-content h5, .main-content h6 {
margin-top: 2rem;
margin-bottom: 1rem;
font-weight: normal;
color: #159957; }
.main-content p {
margin-bottom: 1em; }
.main-content code {
padding: 2px 4px;
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 0.9rem;
color: #383e41;
background-color: #f3f6fa;
border-radius: 0.3rem; }
.main-content pre {
padding: 0.8rem;
margin-top: 0;
margin-bottom: 1rem;
font: 1rem Consolas, "Liberation Mono", Menlo, Courier, monospace;
color: #567482;
word-wrap: normal;
background-color: #f3f6fa;
border: solid 1px #dce6f0;
border-radius: 0.3rem; }
.main-content pre > code {
padding: 0;
margin: 0;
font-size: 0.9rem;
color: #567482;
word-break: normal;
white-space: pre;
background: transparent;
border: 0; }
.main-content .highlight {
margin-bottom: 1rem; }
.main-content .highlight pre {
margin-bottom: 0;
word-break: normal; }
.main-content .highlight pre, .main-content pre {
padding: 0.8rem;
overflow: auto;
font-size: 0.9rem;
line-height: 1.45;
border-radius: 0.3rem; }
.main-content pre code, .main-content pre tt {
display: inline;
max-width: initial;
padding: 0;
margin: 0;
overflow: initial;
line-height: inherit;
word-wrap: normal;
background-color: transparent;
border: 0; }
.main-content pre code:before, .main-content pre code:after, .main-content pre tt:before, .main-content pre tt:after {
content: normal; }
.main-content ul, .main-content ol {
margin-top: 0; }
.main-content blockquote {
padding: 0 1rem;
margin-left: 0;
color: #819198;
border-left: 0.3rem solid #dce6f0; }
.main-content blockquote > :first-child {
margin-top: 0; }
.main-content blockquote > :last-child {
margin-bottom: 0; }
.main-content table {
display: block;
width: 100%;
overflow: auto;
word-break: normal;
word-break: keep-all; }
.main-content table th {
font-weight: bold; }
.main-content table th, .main-content table td {
padding: 0.5rem 1rem;
border: 1px solid #e9ebec; }
.main-content dl {
padding: 0; }
.main-content dl dt {
padding: 0;
margin-top: 1rem;
font-size: 1rem;
font-weight: bold; }
.main-content dl dd {
padding: 0;
margin-bottom: 1rem; }
.main-content hr {
height: 2px;
padding: 0;
margin: 1rem 0;
background-color: #eff0f1;
border: 0; }
@media screen and (min-width: 64em) {
.main-content {
max-width: 64rem;
padding: 2rem 6rem;
margin: 0 auto;
font-size: 1.1rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.main-content {
padding: 2rem 4rem;
font-size: 1.1rem; } }
@media screen and (max-width: 42em) {
.main-content {
padding: 2rem 1rem;
font-size: 1rem; } }
.site-footer {
padding-top: 2rem;
margin-top: 2rem;
border-top: solid 1px #eff0f1; }
.site-footer-owner {
display: block;
font-weight: bold; }
.site-footer-credits {
color: #819198; }
@media screen and (min-width: 64em) {
.site-footer {
font-size: 1rem; } }
@media screen and (min-width: 42em) and (max-width: 64em) {
.site-footer {
font-size: 1rem; } }
@media screen and (max-width: 42em) {
.site-footer {
font-size: 0.9rem; } }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment