java-logback.json 6.1 KB

123456
  1. {
  2. "html": "<div class=\"section\" id=\"installation\">\n<h2>Installation</h2>\n<p>Using Maven:</p>\n<div class=\"highlight-xml\"><div class=\"highlight\" style=\"background: #ffffff\"><pre style=\"line-height: 125%\"><span></span><span style=\"color: #2eb0f7\">&lt;dependency&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;groupId&gt;</span>io.sentry<span style=\"color: #2eb0f7\">&lt;/groupId&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;artifactId&gt;</span>sentry-logback<span style=\"color: #2eb0f7\">&lt;/artifactId&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;version&gt;</span>1.6.3<span style=\"color: #2eb0f7\">&lt;/version&gt;</span>\n<span style=\"color: #2eb0f7\">&lt;/dependency&gt;</span>\n</pre></div>\n</div>\n<p>Using Gradle:</p>\n<div class=\"highlight-groovy\"><div class=\"highlight\" style=\"background: #ffffff\"><pre style=\"line-height: 125%\"><span></span><span style=\"color: #111111\">compile</span> <span style=\"color: #e8535a\">&#39;io.sentry:sentry-logback:1.6.3&#39;</span>\n</pre></div>\n</div>\n<p>Using SBT:</p>\n<div class=\"highlight-scala\"><div class=\"highlight\" style=\"background: #ffffff\"><pre style=\"line-height: 125%\"><span></span><span style=\"color: #111111\">libraryDependencies</span> <span style=\"color: #4b4f5c\">+=</span> <span style=\"color: #e8535a\">&quot;io.sentry&quot;</span> <span style=\"color: #4b4f5c\">%</span> <span style=\"color: #e8535a\">&quot;sentry-logback&quot;</span> <span style=\"color: #4b4f5c\">%</span> <span style=\"color: #e8535a\">&quot;1.6.3&quot;</span>\n</pre></div>\n</div>\n<p>For other dependency managers see the <a class=\"reference external\" href=\"https://search.maven.org/#artifactdetails%7Cio.sentry%7Csentry-logback%7C1.6.3%7Cjar\">central Maven repository</a>.</p>\n</div>\n\n\n<div class=\"section\" id=\"usage\">\n<h2>Usage</h2>\n<p>The following example configures a <code class=\"docutils literal\"><span class=\"pre\">ConsoleAppender</span></code> that logs to standard out\nat the <code class=\"docutils literal\"><span class=\"pre\">INFO</span></code> level and a <code class=\"docutils literal\"><span class=\"pre\">SentryAppender</span></code> that logs to the Sentry server at\nthe <code class=\"docutils literal\"><span class=\"pre\">WARN</span></code> level. The <code class=\"docutils literal\"><span class=\"pre\">ConsoleAppender</span></code> is only provided as an example of\na non-Sentry appender that is set to a different logging threshold, like one you\nmay already have in your project.</p>\n<p>Example configuration using the <code class=\"docutils literal\"><span class=\"pre\">logback.xml</span></code> format:</p>\n<div class=\"highlight-xml\"><div class=\"highlight\" style=\"background: #ffffff\"><pre style=\"line-height: 125%\"><span></span><span style=\"color: #2eb0f7\">&lt;configuration&gt;</span>\n <span style=\"color: #34c08b; font-style: italic\">&lt;!-- Configure the Console appender --&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;appender</span> <span style=\"color: #a47ac6\">name=</span><span style=\"color: #e8535a\">&quot;Console&quot;</span> <span style=\"color: #a47ac6\">class=</span><span style=\"color: #e8535a\">&quot;ch.qos.logback.core.ConsoleAppender&quot;</span><span style=\"color: #2eb0f7\">&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;encoder&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;pattern&gt;</span>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n<span style=\"color: #2eb0f7\">&lt;/pattern&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;/encoder&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;/appender&gt;</span>\n\n <span style=\"color: #34c08b; font-style: italic\">&lt;!-- Configure the Sentry appender, overriding the logging threshold to the WARN level --&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;appender</span> <span style=\"color: #a47ac6\">name=</span><span style=\"color: #e8535a\">&quot;Sentry&quot;</span> <span style=\"color: #a47ac6\">class=</span><span style=\"color: #e8535a\">&quot;io.sentry.logback.SentryAppender&quot;</span><span style=\"color: #2eb0f7\">&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;filter</span> <span style=\"color: #a47ac6\">class=</span><span style=\"color: #e8535a\">&quot;ch.qos.logback.classic.filter.ThresholdFilter&quot;</span><span style=\"color: #2eb0f7\">&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;level&gt;</span>WARN<span style=\"color: #2eb0f7\">&lt;/level&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;/filter&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;/appender&gt;</span>\n\n <span style=\"color: #34c08b; font-style: italic\">&lt;!-- Enable the Console and Sentry appenders, Console is provided as an example</span>\n<span style=\"color: #34c08b; font-style: italic\"> of a non-Sentry logger that is set to a different logging threshold --&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;root</span> <span style=\"color: #a47ac6\">level=</span><span style=\"color: #e8535a\">&quot;INFO&quot;</span><span style=\"color: #2eb0f7\">&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;appender-ref</span> <span style=\"color: #a47ac6\">ref=</span><span style=\"color: #e8535a\">&quot;Console&quot;</span> <span style=\"color: #2eb0f7\">/&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;appender-ref</span> <span style=\"color: #a47ac6\">ref=</span><span style=\"color: #e8535a\">&quot;Sentry&quot;</span> <span style=\"color: #2eb0f7\">/&gt;</span>\n <span style=\"color: #2eb0f7\">&lt;/root&gt;</span>\n<span style=\"color: #2eb0f7\">&lt;/configuration&gt;</span>\n</pre></div>\n</div>\n<p>Next, <strong>you&#8217;ll need to configure your DSN</strong> (client key) and optionally other values such as\n<code class=\"docutils literal\"><span class=\"pre\">environment</span></code> and <code class=\"docutils literal\"><span class=\"pre\">release</span></code>. <a class=\"reference internal\" href=\"https://docs.getsentry.com/clients/java/config/#setting-the-dsn\"><span>See the configuration page</span></a> for ways you can do this.</p>\n</div>\n",
  3. "link": "https://docs.getsentry.com/clients/java/modules/logback/",
  4. "id": "java-logback",
  5. "name": "Logback"
  6. }