blob: f32626e81978343db76b496106e53ed32744a04a [file] [log] [blame]
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta http-equiv=x-ua-compatible content="ie=edge"><meta name=lang:clipboard.copy content="Copy to clipboard"><meta name=lang:clipboard.copied content="Copied to clipboard"><meta name=lang:search.language content=en><meta name=lang:search.pipeline.stopwords content=True><meta name=lang:search.pipeline.trimmer content=True><meta name=lang:search.result.none content="No matching documents"><meta name=lang:search.result.one content="1 matching document"><meta name=lang:search.result.other content="# matching documents"><meta name=lang:search.tokenizer content=[\s\-]+><link rel="shortcut icon" href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.0.4, mkdocs-material-4.4.2"><title>Logging - Eclipse Hawk</title><link rel=stylesheet href=../../assets/stylesheets/application.30686662.css><link rel=stylesheet href=../../assets/stylesheets/application-palette.a8b3c06d.css><meta name=theme-color content=#7e57c2><script src=../../assets/javascripts/modernizr.74668098.js></script><link href=https://fonts.gstatic.com rel=preconnect crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback"><style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style><link rel=stylesheet href=../../assets/fonts/material-icons.css><!-- FAVICON --><link rel=apple-touch-icon sizes=180x180 href=/img/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=/img/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=/img/favicon-16x16.png><link rel=manifest href=/img/site.webmanifest><link rel=mask-icon href=/img/safari-pinned-tab.svg color=#5bbad5><link rel="shortcut icon" href=/img/favicon.ico><meta name=msapplication-TileColor content=#b91d47><meta name=msapplication-config content=/img/browserconfig.xml><meta name=theme-color content=#ffffff></head> <body dir=ltr data-md-color-primary=deep-purple data-md-color-accent=deep-purple> <svg class=md-svg> <defs> </defs> </svg> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay data-md-component=overlay for=__drawer></label> <header class=md-header data-md-component=header> <nav class="md-header-nav md-grid"> <div class=md-flex> <div class="md-flex__cell md-flex__cell--shrink"> <a href=../.. title="Eclipse Hawk" class="md-header-nav__button md-logo"> <img src=../../img/hawk-logo-white.svg width=24 height=24> </a> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--menu md-header-nav__button" for=__drawer></label> </div> <div class="md-flex__cell md-flex__cell--stretch"> <div class="md-flex__ellipsis md-header-nav__title" data-md-component=title> <span class=md-header-nav__topic> Eclipse Hawk </span> <span class=md-header-nav__topic> Logging </span> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--search md-header-nav__button" for=__search></label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=query data-md-state=active> <label class="md-icon md-search__icon" for=__search></label> <button type=reset class="md-icon md-search__icon" data-md-component=reset tabindex=-1> &#xE5CD; </button> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=result> <div class=md-search-result__meta> Type to start searching </div> <ol class=md-search-result__list></ol> </div> </div> </div> </div> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <div class=md-header-nav__source> <a href=https://git.eclipse.org/c/hawk/hawk.git/ title="Go to repository" class=md-source data-md-source> <div class=md-source__repository> Git repository @ Eclipse </div> </a> </div> </div> </div> </nav> </header> <div class=md-container> <main class=md-main role=main> <div class="md-main__inner md-grid" data-md-component=container> <div class="md-sidebar md-sidebar--primary" data-md-component=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary" data-md-level=0> <label class="md-nav__title md-nav__title--site" for=__drawer> <a href=../.. title="Eclipse Hawk" class="md-nav__button md-logo"> <img src=../../img/hawk-logo-white.svg width=48 height=48> </a> Eclipse Hawk </label> <div class=md-nav__source> <a href=https://git.eclipse.org/c/hawk/hawk.git/ title="Go to repository" class=md-source data-md-source> <div class=md-source__repository> Git repository @ Eclipse </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../.. title=Home class=md-nav__link> Home </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-toggle md-nav__toggle" data-md-toggle=nav-2 type=checkbox id=nav-2> <label class=md-nav__link for=nav-2> Basic use </label> <nav class=md-nav data-md-component=collapsible data-md-level=1> <label class=md-nav__title for=nav-2> Basic use </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../basic-use/installation/ title=Installation class=md-nav__link> Installation </a> </li> <li class=md-nav__item> <a href=../../basic-use/core-concepts/ title="Core concepts" class=md-nav__link> Core concepts </a> </li> <li class=md-nav__item> <a href=../../basic-use/examples-xmi/ title="Examples (XMI)" class=md-nav__link> Examples (XMI) </a> </li> <li class=md-nav__item> <a href=../../basic-use/examples-modelio/ title="Examples (Modelio)" class=md-nav__link> Examples (Modelio) </a> </li> <li class=md-nav__item> <a href=../../basic-use/papyrus/ title="Papyrus UML support" class=md-nav__link> Papyrus UML support </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-toggle md-nav__toggle" data-md-toggle=nav-3 type=checkbox id=nav-3> <label class=md-nav__link for=nav-3> Advanced use </label> <nav class=md-nav data-md-component=collapsible data-md-level=1> <label class=md-nav__title for=nav-3> Advanced use </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../advanced-use/graph-as-emf/ title="Graph as EMF model" class=md-nav__link> Graph as EMF model </a> </li> <li class=md-nav__item> <a href=../../advanced-use/advanced-props/ title="Advanced properties" class=md-nav__link> Advanced properties </a> </li> <li class=md-nav__item> <a href=../../advanced-use/meta-queries/ title="Meta-level queries" class=md-nav__link> Meta-level queries </a> </li> <li class=md-nav__item> <a href=../../advanced-use/temporal-queries/ title="Temporal queries" class=md-nav__link> Temporal queries </a> </li> <li class=md-nav__item> <a href=../../advanced-use/oomph/ title="Oomph and Hawk" class=md-nav__link> Oomph and Hawk </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-toggle md-nav__toggle" data-md-toggle=nav-4 type=checkbox id=nav-4 checked> <label class=md-nav__link for=nav-4> Server </label> <nav class=md-nav data-md-component=collapsible data-md-level=1> <label class=md-nav__title for=nav-4> Server </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../architecture/ title=Architecture class=md-nav__link> Architecture </a> </li> <li class=md-nav__item> <a href=../api/ title="Thrift API" class=md-nav__link> Thrift API </a> </li> <li class=md-nav__item> <a href=../api-security/ title="Thrift API security" class=md-nav__link> Thrift API security </a> </li> <li class=md-nav__item> <a href=../deployment/ title=Deployment class=md-nav__link> Deployment </a> </li> <li class=md-nav__item> <a href=../cli/ title="Console client" class=md-nav__link> Console client </a> </li> <li class=md-nav__item> <a href=../eclipse/ title="Eclipse client" class=md-nav__link> Eclipse client </a> </li> <li class=md-nav__item> <a href=../file-config/ title="File-based configuration" class=md-nav__link> File-based configuration </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-toggle md-nav__toggle" data-md-toggle=toc type=checkbox id=__toc> <a href=./ title=Logging class="md-nav__link md-nav__link--active"> Logging </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-toggle md-nav__toggle" data-md-toggle=nav-5 type=checkbox id=nav-5> <label class=md-nav__link for=nav-5> Developers </label> <nav class=md-nav data-md-component=collapsible data-md-level=1> <label class=md-nav__title for=nav-5> Developers </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../developers/run-from-source/ title="Run GUI from source" class=md-nav__link> Run GUI from source </a> </li> <li class=md-nav__item> <a href=../../developers/server-from-source/ title="Run Server from source" class=md-nav__link> Run Server from source </a> </li> <li class=md-nav__item> <a href=../../developers/plain-maven/ title="Build with plain Maven" class=md-nav__link> Build with plain Maven </a> </li> <li class=md-nav__item> <a href=../../developers/website/ title="Work on the website" class=md-nav__link> Work on the website </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../additional-resources/ title="Additional resources" class=md-nav__link> Additional resources </a> </li> <li class=md-nav__item> <a href=https://www.eclipse.org/forums/index.php/f/442/ title=Forum class=md-nav__link> Forum </a> </li> <li class=md-nav__item> <a href=https://ci.eclipse.org/hawk/ title=Builds class=md-nav__link> Builds </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content> <article class="md-content__inner md-typeset"> <h1>Logging</h1> <p>Logging in Hawk is done through the <a href=https://logback.qos.ch/ >Logback</a> library. The specific <code>logback.xml</code> file is part of the <code>org.hawk.service.server.logback</code> plugin fragment. If you need to edit it, it is located in the <code>plugins/org.hawk.service.server.logback_&lt;HAWK RELEASE&gt;</code> folder from the main directory of the server.</p> <p>A typical configuration with Hawk logging at the DEBUG level, with time-based rolling and all messages going to the <code>hawk.log</code> file would look as follows:</p> <div class=codehilite><pre><span></span><span class=nt>&lt;configuration&gt;</span>
<span class=nt>&lt;appender</span> <span class=na>name=</span><span class=s>&quot;STDOUT&quot;</span> <span class=na>class=</span><span class=s>&quot;ch.qos.logback.core.ConsoleAppender&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;layout</span> <span class=na>class=</span><span class=s>&quot;ch.qos.logback.classic.PatternLayout&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;Pattern&gt;</span>
%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} -
%msg%n
<span class=nt>&lt;/Pattern&gt;</span>
<span class=nt>&lt;/layout&gt;</span>
<span class=nt>&lt;/appender&gt;</span>
<span class=nt>&lt;appender</span> <span class=na>name=</span><span class=s>&quot;FILE&quot;</span>
<span class=na>class=</span><span class=s>&quot;ch.qos.logback.core.rolling.RollingFileAppender&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;file&gt;</span>hawk.log<span class=nt>&lt;/file&gt;</span>
<span class=nt>&lt;encoder</span> <span class=na>class=</span><span class=s>&quot;ch.qos.logback.classic.encoder.PatternLayoutEncoder&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;Pattern&gt;</span>
%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
<span class=nt>&lt;/Pattern&gt;</span>
<span class=nt>&lt;/encoder&gt;</span>
<span class=nt>&lt;rollingPolicy</span> <span class=na>class=</span><span class=s>&quot;ch.qos.logback.core.rolling.TimeBasedRollingPolicy&quot;</span><span class=nt>&gt;</span>
<span class=c>&lt;!-- rollover daily --&gt;</span>
<span class=nt>&lt;fileNamePattern&gt;</span>mylog-%d{yyyy-MM-dd}.%i.txt<span class=nt>&lt;/fileNamePattern&gt;</span>
<span class=nt>&lt;maxHistory&gt;</span>60<span class=nt>&lt;/maxHistory&gt;</span>
<span class=nt>&lt;/rollingPolicy&gt;</span>
<span class=nt>&lt;/appender&gt;</span>
<span class=nt>&lt;logger</span> <span class=na>name=</span><span class=s>&quot;org.eclipse.jetty&quot;</span> <span class=na>level=</span><span class=s>&quot;warn&quot;</span> <span class=na>additivity=</span><span class=s>&quot;false&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;appender-ref</span> <span class=na>ref=</span><span class=s>&quot;STDOUT&quot;</span> <span class=nt>/&gt;</span>
<span class=nt>&lt;/logger&gt;</span>
<span class=nt>&lt;logger</span> <span class=na>name=</span><span class=s>&quot;ch.qos.logback&quot;</span> <span class=na>level=</span><span class=s>&quot;error&quot;</span> <span class=na>additivity=</span><span class=s>&quot;false&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;appender-ref</span> <span class=na>ref=</span><span class=s>&quot;STDOUT&quot;</span> <span class=nt>/&gt;</span>
<span class=nt>&lt;/logger&gt;</span>
<span class=nt>&lt;logger</span> <span class=na>name=</span><span class=s>&quot;org.apache.shiro&quot;</span> <span class=na>level=</span><span class=s>&quot;error&quot;</span> <span class=na>additivity=</span><span class=s>&quot;false&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;appender-ref</span> <span class=na>ref=</span><span class=s>&quot;STDOUT&quot;</span> <span class=nt>/&gt;</span>
<span class=nt>&lt;/logger&gt;</span>
<span class=c>&lt;!-- Change to &quot;error&quot; if Hawk produces too many messages for you --&gt;</span>
<span class=nt>&lt;logger</span> <span class=na>name=</span><span class=s>&quot;org.hawk&quot;</span> <span class=na>level=</span><span class=s>&quot;debug&quot;</span> <span class=na>additivity=</span><span class=s>&quot;false&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;appender-ref</span> <span class=na>ref=</span><span class=s>&quot;STDOUT&quot;</span> <span class=nt>/&gt;</span>
<span class=nt>&lt;appender-ref</span> <span class=na>ref=</span><span class=s>&quot;FILE&quot;</span> <span class=nt>/&gt;</span>
<span class=nt>&lt;/logger&gt;</span>
<span class=nt>&lt;root</span> <span class=na>level=</span><span class=s>&quot;debug&quot;</span><span class=nt>&gt;</span>
<span class=nt>&lt;appender-ref</span> <span class=na>ref=</span><span class=s>&quot;STDOUT&quot;</span> <span class=nt>/&gt;</span>
<span class=nt>&lt;/root&gt;</span>
<span class=nt>&lt;/configuration&gt;</span>
</pre></div> </article> </div> </div> </main> <footer class=md-footer> <div class=md-footer-nav> <nav class="md-footer-nav__inner md-grid"> <a href=../file-config/ title="File-based configuration" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel=prev> <div class="md-flex__cell md-flex__cell--shrink"> <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> </div> <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> <span class=md-flex__ellipsis> <span class=md-footer-nav__direction> Previous </span> File-based configuration </span> </div> </a> <a href=../../developers/run-from-source/ title="Run GUI from source" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel=next> <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> <span class=md-flex__ellipsis> <span class=md-footer-nav__direction> Next </span> Run GUI from source </span> </div> <div class="md-flex__cell md-flex__cell--shrink"> <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> </div> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright> powered by <a href=https://www.mkdocs.org>MkDocs</a> and <a href=https://squidfunk.github.io/mkdocs-material/ > Material for MkDocs</a> </div> </div> </div> </footer> </div> <script src=../../assets/javascripts/application.c648116f.js></script> <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script> </body> </html>