|
382 | 382 | <label class="md-nav__title" for="toc">Table of contents</label> |
383 | 383 | <ul class="md-nav__list" data-md-scrollfix> |
384 | 384 |
|
| 385 | + <li class="md-nav__item"> |
| 386 | + <a href="#inengine-settings" title="InEngine Settings" class="md-nav__link"> |
| 387 | + InEngine Settings |
| 388 | + </a> |
| 389 | + |
| 390 | +</li> |
| 391 | + |
385 | 392 | <li class="md-nav__item"> |
386 | 393 | <a href="#top-level-settings" title="Top-level Settings" class="md-nav__link"> |
387 | 394 | Top-level Settings |
|
403 | 410 |
|
404 | 411 | </li> |
405 | 412 |
|
| 413 | + <li class="md-nav__item"> |
| 414 | + <a href="#logging-settings" title="Logging Settings" class="md-nav__link"> |
| 415 | + Logging Settings |
| 416 | + </a> |
| 417 | + |
| 418 | +</li> |
| 419 | + |
406 | 420 |
|
407 | 421 |
|
408 | 422 | </ul> |
|
412 | 426 | </li> |
413 | 427 |
|
414 | 428 |
|
| 429 | + |
| 430 | + |
| 431 | + |
| 432 | + |
| 433 | + |
| 434 | + <li class="md-nav__item"> |
| 435 | + <a href="../server/" title="Server" class="md-nav__link"> |
| 436 | + Server |
| 437 | + </a> |
| 438 | + </li> |
| 439 | + |
| 440 | + |
415 | 441 | </ul> |
416 | 442 | </nav> |
417 | 443 | </li> |
|
437 | 463 | <label class="md-nav__title" for="toc">Table of contents</label> |
438 | 464 | <ul class="md-nav__list" data-md-scrollfix> |
439 | 465 |
|
| 466 | + <li class="md-nav__item"> |
| 467 | + <a href="#inengine-settings" title="InEngine Settings" class="md-nav__link"> |
| 468 | + InEngine Settings |
| 469 | + </a> |
| 470 | + |
| 471 | +</li> |
| 472 | + |
440 | 473 | <li class="md-nav__item"> |
441 | 474 | <a href="#top-level-settings" title="Top-level Settings" class="md-nav__link"> |
442 | 475 | Top-level Settings |
|
458 | 491 |
|
459 | 492 | </li> |
460 | 493 |
|
| 494 | + <li class="md-nav__item"> |
| 495 | + <a href="#logging-settings" title="Logging Settings" class="md-nav__link"> |
| 496 | + Logging Settings |
| 497 | + </a> |
| 498 | + |
| 499 | +</li> |
| 500 | + |
461 | 501 |
|
462 | 502 |
|
463 | 503 | </ul> |
|
474 | 514 |
|
475 | 515 |
|
476 | 516 | <h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¶</a></h1> |
| 517 | +<h2 id="inengine-settings">InEngine Settings<a class="headerlink" href="#inengine-settings" title="Permanent link">¶</a></h2> |
477 | 518 | <p>Configuration is accomplished by modifying the appsettings.json file that comes with the InEngine.NET binary distribution. |
478 | 519 | The <strong>-c, --configuration</strong> argument can also be used to specify an alternate configuration file.</p> |
479 | 520 | <div class="codehilite"><pre><span></span><span class="p">{</span> |
@@ -611,6 +652,27 @@ <h2 id="queue-settings">Queue Settings<a class="headerlink" href="#queue-setting |
611 | 652 | </tr> |
612 | 653 | </tbody> |
613 | 654 | </table> |
| 655 | +<h2 id="logging-settings">Logging Settings<a class="headerlink" href="#logging-settings" title="Permanent link">¶</a></h2> |
| 656 | +<p>Any exceptions thrown by a command will be logged, provided NLog is configured to log exceptions. |
| 657 | +The <a href="https://github.com/NLog/NLog/wiki/Tutorial#configuration">NLog configuration</a> file needs to be setup with something like this: </p> |
| 658 | +<div class="codehilite"><pre><span></span><span class="cp"><?xml version="1.0" encoding="utf-8" ?></span> |
| 659 | +<span class="nt"><nlog</span> <span class="na">xmlns=</span><span class="s">"http://www.nlog-project.org/schemas/NLog.xsd"</span> |
| 660 | + <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span><span class="nt">></span> |
| 661 | + |
| 662 | + <span class="nt"><targets></span> |
| 663 | + <span class="nt"><target</span> <span class="na">name=</span><span class="s">"logfile"</span> <span class="na">xsi:type=</span><span class="s">"File"</span> <span class="na">fileName=</span><span class="s">"inengine.log"</span> <span class="nt">/></span> |
| 664 | + <span class="nt"></targets></span> |
| 665 | + |
| 666 | + <span class="nt"><rules></span> |
| 667 | + <span class="nt"><logger</span> <span class="na">name=</span><span class="s">"*"</span> <span class="na">minlevel=</span><span class="s">"Error"</span> <span class="na">writeTo=</span><span class="s">"logfile"</span> <span class="nt">/></span> |
| 668 | + <span class="nt"></rules></span> |
| 669 | +<span class="nt"></nlog></span> |
| 670 | +</pre></div> |
| 671 | + |
| 672 | + |
| 673 | +<p>InEngine.Core does not depend explicitly on NLog, but rather <a href="http://net-commons.github.io/common-logging/">Common.Logging</a>. |
| 674 | +This means that any logging framework that Common.Logging supports can be used. |
| 675 | +Configuring Common.Logging to use a different logging framework is out of the scope of this documentation.</p> |
614 | 676 |
|
615 | 677 |
|
616 | 678 |
|
@@ -644,6 +706,20 @@ <h2 id="queue-settings">Queue Settings<a class="headerlink" href="#queue-setting |
644 | 706 | </a> |
645 | 707 |
|
646 | 708 |
|
| 709 | + <a href="../server/" title="Server" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
| 710 | + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
| 711 | + <span class="md-flex__ellipsis"> |
| 712 | + <span class="md-footer-nav__direction"> |
| 713 | + Next |
| 714 | + </span> |
| 715 | + Server |
| 716 | + </span> |
| 717 | + </div> |
| 718 | + <div class="md-flex__cell md-flex__cell--shrink"> |
| 719 | + <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
| 720 | + </div> |
| 721 | + </a> |
| 722 | + |
647 | 723 | </nav> |
648 | 724 | </div> |
649 | 725 |
|
|
0 commit comments