amos-ionic-logging

<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>ionic-logging-viewer</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="../" class="navbar-brand">ionic-logging-viewer</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="hidden-xs menu"> <compodoc-menu mode="normal"></compodoc-menu> </div>  <div class="content component"> <div class="content-data"> <ol class="breadcrumb"> <li>Components</li> <li>LoggingViewerComponent</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="active"> <a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a> </li> <li > <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a> </li> <li > <a href="#templateData" role="tab" id="templateData-tab" data-toggle="tab" data-link="template">Template</a> </li> <li > <a href="#styleData" role="tab" id="styleData-tab" data-toggle="tab" data-link="style">Styles</a> </li> <li > <a href="#tree" role="tab" id="tree-tab" data-toggle="tab" data-link="dom-tree">DOM Tree</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="c-info"><p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/lib/logging-viewer/logging-viewer.component.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>Component for displaying the current logs.</p> <p>The component can be embedded in any web page using:</p> <p><ionic-logging-viewer></ionic-logging-viewer></p> </p> <p class="comment"> <h3>Implements</h3> </p> <p class="comment"> <code><a href="https://angular.io/api/core/OnInit" target="_blank" >OnInit</a></code> <code><a href="https://angular.io/api/core/OnDestroy" target="_blank" >OnDestroy</a></code> </p> <section> <h3>Metadata</h3> <table class="table table-sm table-hover"> <tbody> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>ionic-logging-viewer</code></td> </tr> <tr> <td class="col-md-3">styleUrls</td> <td class="col-md-9"><code>./logging-viewer.component.scss</code></td> </tr> <tr> <td class="col-md-3">templateUrl</td> <td class="col-md-9"><code>./logging-viewer.component.html</code></td> </tr> </tbody> </table> </section> <section> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Properties</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Public</span> <a href="#logMessagesForDisplay">logMessagesForDisplay</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Methods</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Public</span> <a href="#filterLogMessages">filterLogMessages</a> </li> <li> <span class="modifier">Public</span> <a href="#filterLogMessagesByLevel">filterLogMessagesByLevel</a> </li> <li> <span class="modifier">Public</span> <a href="#filterLogMessagesBySearch">filterLogMessagesBySearch</a> </li> <li> <span class="modifier">Public</span> <a href="#loadLogMessages">loadLogMessages</a> </li> <li> <span class="modifier">Public</span> <a href="#ngOnDestroy">ngOnDestroy</a> </li> <li> <span class="modifier">Public</span> <a href="#ngOnInit">ngOnInit</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Inputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#localStorageKeys">localStorageKeys</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section> <h3 id="constructor">Constructor</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>constructor(loggingService: LoggingService, loggingViewerFilterService: <a href="../injectables/LoggingViewerFilterService.html">LoggingViewerFilterService</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:36</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Creates a new instance of the component.</p> </div> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>loggingService</td> <td> <code>LoggingService</code> </td> <td> No </td> </tr> <tr> <td>loggingViewerFilterService</td> <td> <code><a href="../injectables/LoggingViewerFilterService.html" target="_self" >LoggingViewerFilterService</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="inputs">Inputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="localStorageKeys"></a> <b>localStorageKeys</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="26" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:26</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Comma-separated list of localStorageKeys. If set, the logs get loaded from localStorage instead of memory.</p> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="filterLogMessages"></a> <span class="name"> <b> <span class="modifier">Public</span> filterLogMessages </b> <a href="#filterLogMessages"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>filterLogMessages()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="96" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:96</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Filter the log messages.</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="filterLogMessagesByLevel"></a> <span class="name"> <b> <span class="modifier">Public</span> filterLogMessagesByLevel </b> <a href="#filterLogMessagesByLevel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>filterLogMessagesByLevel(message: LogMessage)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="108" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:108</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Check if the log message's level fulfills the level condition.</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>message</td> <td> <code>LogMessage</code> </td> <td> No </td> <td> <p>the log message to check</p> </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </div> <div class="io-description"> <p>true if check was successful</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="filterLogMessagesBySearch"></a> <span class="name"> <b> <span class="modifier">Public</span> filterLogMessagesBySearch </b> <a href="#filterLogMessagesBySearch"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>filterLogMessagesBySearch(message: LogMessage)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="124" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:124</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Check if the log message fulfills the search condition.</p> <p>The search value gets searched in:</p> <ul> <li>logger name</li> <li>method name</li> <li>message</li> </ul> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>message</td> <td> <code>LogMessage</code> </td> <td> No </td> <td> <p>the log message to check</p> </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </div> <div class="io-description"> <p>true if check was successful</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="loadLogMessages"></a> <span class="name"> <b> <span class="modifier">Public</span> loadLogMessages </b> <a href="#loadLogMessages"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>loadLogMessages()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="135" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:135</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Load the current log messages. For unit test purposes mainly.</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="ngOnDestroy"></a> <span class="name"> <b> <span class="modifier">Public</span> ngOnDestroy </b> <a href="#ngOnDestroy"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>ngOnDestroy()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="83" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:83</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Clean up.</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="ngOnInit"></a> <span class="name"> <b> <span class="modifier">Public</span> ngOnInit </b> <a href="#ngOnInit"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>ngOnInit()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="59" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:59</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Initialize the component.</p> <p>This is done by reading the filter data from <a href="LoggingViewerFilterService.html">LoggingViewerFilterService</a> and the log messages from <a href="../../../ionic-logging-service/typedoc/index.html">LoggingService</a>. If the localStorageKeys property is set, the messages are read from local storage.</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="inputs"> Properties </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="logMessagesForDisplay"></a> <span class="name"> <b> <span class="modifier">Public</span> logMessagesForDisplay</b> <a href="#logMessagesForDisplay"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>LogMessage[]</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">src/lib/logging-viewer/logging-viewer.component.ts:31</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Log messages which fulfill the filter condition.</p> </div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Component, OnDestroy, OnInit, Input } from "@angular/core"; import { Subscription } from "rxjs"; import { Logger, LoggingService, LogLevelConverter, LogMessage } from "ionic-logging-service"; import { LoggingViewerFilterService } from "../logging-viewer-filter.service"; /** * Component for displaying the current logs. * * The component can be embedded in any web page using: * * &lt;ionic-logging-viewer>&lt;/ionic-logging-viewer> */ @Component({ selector: "ionic-logging-viewer", templateUrl: "./logging-viewer.component.html", styleUrls: ["./logging-viewer.component.scss"] }) export class LoggingViewerComponent implements OnInit, OnDestroy { /** * Comma-separated list of localStorageKeys. If set, the logs get loaded from localStorage instead of memory. */ @Input() public localStorageKeys: string; /** * Log messages which fulfill the filter condition. */ public logMessagesForDisplay: LogMessage[]; private logger: Logger; private logMessages: LogMessage[]; private logMessagesChangedSubscription: Subscription; private filterChangedSubscription: Subscription; /** * Creates a new instance of the component. */ constructor( private loggingService: LoggingService, private loggingViewerFilterService: LoggingViewerFilterService) { this.logger = loggingService.getLogger("Ionic.Logging.Viewer.Component"); const methodName = "ctor"; this.logger.entry(methodName); this.logger.exit(methodName); } /** * Initialize the component. * * This is done by reading the filter data from [LoggingViewerFilterService](LoggingViewerFilterService.html) * and the log messages from [LoggingService](../../../ionic-logging-service/typedoc/index.html). * If the localStorageKeys property is set, the messages are read from local storage. */ public ngOnInit(): void { const methodName = "ngOnInit"; this.logger.entry(methodName); this.loadLogMessages(); this.filterLogMessages(); // subscribe to loggingService.logMessagesChanged event, to refresh, when new message is logged this.logMessagesChangedSubscription = this.loggingService.logMessagesChanged.subscribe(async () => { this.loadLogMessages(); this.filterLogMessages(); }); // subscribe to loggingViewerFilterService.filterChanged event, to refresh, when filter is modified this.filterChangedSubscription = this.loggingViewerFilterService.filterChanged.subscribe(() => { this.filterLogMessages(); }); this.logger.exit(methodName); } /** * Clean up. */ public ngOnDestroy(): void { const methodName = "ngOnDestroy"; this.logger.entry(methodName); this.logMessagesChangedSubscription.unsubscribe(); this.filterChangedSubscription.unsubscribe(); this.logger.exit(methodName); } /** * Filter the log messages. */ public filterLogMessages(): void { this.logMessagesForDisplay = this.logMessages.filter((message) => { return this.filterLogMessagesByLevel(message) && this.filterLogMessagesBySearch(message); }); } /** * Check if the log message's level fulfills the level condition. * * @param message the log message to check * @returns true if check was successful */ public filterLogMessagesByLevel(message: LogMessage): boolean { const levelValue = this.loggingViewerFilterService.level; return LogLevelConverter.levelFromString(message.level) >= LogLevelConverter.levelFromString(levelValue); } /** * Check if the log message fulfills the search condition. * * The search value gets searched in: * - logger name * - method name * - message * * @param message the log message to check * @returns true if check was successful */ public filterLogMessagesBySearch(message: LogMessage): boolean { const searchValue = new RegExp(this.loggingViewerFilterService.search, "i"); return message.logger.search(searchValue) >= 0 || message.methodName.search(searchValue) >= 0 || message.message.join("|").search(searchValue) >= 0; } /** * Load the current log messages. * For unit test purposes mainly. */ public loadLogMessages(): void { if (this.localStorageKeys) { this.logMessages = []; for (const localStorageKey of this.localStorageKeys.split(",")) { this.logMessages = this.logMessages.concat(this.loggingService.getLogMessagesFromLocalStorage(localStorageKey)); } this.logMessages = this.logMessages.sort((a, b) => a.timeStamp.getTime() - b.timeStamp.getTime()); } else { this.logMessages = this.loggingService.getLogMessages(); } } } </code></pre> </div> <div class="tab-pane fade " id="c-templateData"> <pre class="line-numbers"><code class="language-html"><ion-list> <ion-item *ngFor="let logMessage of logMessagesForDisplay"> <ion-label> <p>{{ logMessage.timeStamp | date:'dd.MM.yyyy HH:mm:ss' }} {{ logMessage.level }}</p> <p>{{ logMessage.logger }}</p> <p> {{ logMessage.methodName }} <span *ngFor="let messagePart of logMessage.message"> {{ messagePart }} </span> </p> </ion-label> </ion-item> </ion-list></code></pre> </div> <div class="tab-pane fade " id="c-styleData"> <p class="comment"> <code>./logging-viewer.component.scss</code> </p> <pre class="line-numbers"><code class="language-scss"></code></pre> </div> <div class="tab-pane fade " id="c-tree"> <div id="tree-container"></div> <div class="tree-legend"> <div class="title"> <b>Legend</b> </div> <div> <div class="color htmlelement"></div><span>Html element</span> </div> <div> <div class="color component"></div><span>Component</span> </div> <div> <div class="color directive"></div><span>Html element with directive</span> </div> </div> </div> </div> <script src="../js/libs/vis.min.js"></script> <script src="../js/libs/htmlparser.js"></script> <script src="../js/libs/deep-iterator.js"></script> <script> var COMPONENT_TEMPLATE = '<div><ion-list> <ion-item *ngFor="let logMessage of logMessagesForDisplay"> <ion-label> <p>{{ logMessage.timeStamp | date:\'dd.MM.yyyy HH:mm:ss\' }} {{ logMessage.level }}</p> <p>{{ logMessage.logger }}</p> <p> {{ logMessage.methodName }} <span *ngFor="let messagePart of logMessage.message"> {{ messagePart }} </span> </p> </ion-label> </ion-item></ion-list></div>' var COMPONENTS = [{'name': 'LoggingViewerComponent', 'selector': 'ionic-logging-viewer'},{'name': 'LoggingViewerLevelsComponent', 'selector': 'ionic-logging-viewer-levels'},{'name': 'LoggingViewerModalComponent', 'selector': 'ionic-logging-viewer-modal'},{'name': 'LoggingViewerSearchComponent', 'selector': 'ionic-logging-viewer-search'}]; var DIRECTIVES = []; var ACTUAL_COMPONENT = {'name': 'LoggingViewerComponent'}; </script> <script src="../js/tree.js"></script> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div>  </div> </div> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'component'; var COMPODOC_CURRENT_PAGE_URL = 'LoggingViewerComponent.html'; var MAX_SEARCH_RESULTS = 15; </script> <script src="../js/libs/custom-elements.min.js"></script> <script src="../js/libs/lit-html.js"></script>  <script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script> <script src="../js/menu-wc.js" defer></script> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/clipboard.min.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/search/search_index.js"></script> <script src="../js/lazy-load-graphs.js"></script> </body> </html>