Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds logback-classic-1.2 instrumentation #618

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions instrumentation/logback-classic-1.2/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
jar {
manifest { attributes 'Implementation-Title': 'com.newrelic.instrumentation.logback-classic-1.2' }
}

dependencies {
implementation(project(":agent-bridge"))
implementation("ch.qos.logback:logback-classic:1.2.6")
}

verifyInstrumentation {
passesOnly("ch.qos.logback:logback-classic:[0.9.3,)")
excludeRegex '.*(alpha|groovyless).*'
excludeRegex 'ch.qos.logback:logback-classic:0.9.6'
}

site {
title 'Logback'
type 'Framework'
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package com.nr.agent.instrumentation.logbackclassic12;

import ch.qos.logback.classic.Level;
import com.newrelic.api.agent.NewRelic;
import com.newrelic.api.agent.weaver.MatchType;
import com.newrelic.api.agent.weaver.Weave;
import com.newrelic.api.agent.weaver.Weaver;
import org.slf4j.Marker;

@Weave(originalName = "ch.qos.logback.classic.Logger", type = MatchType.Interface)
public abstract class Logger_Instrumentation {

private void buildLoggingEventAndAppend(final String localFQCN, final Marker marker, final Level level, final String msg, final Object[] params,
final Throwable t) {
NewRelic.incrementCounter("Logging/lines");
NewRelic.incrementCounter("Logging/lines/" + level);
Weaver.callOriginal();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
package com.nr.agent.instrumentation.logbackclassic12;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import com.newrelic.agent.introspec.InstrumentationTestConfig;
import com.newrelic.agent.introspec.InstrumentationTestRunner;
import com.newrelic.agent.introspec.MetricsHelper;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.LoggerFactory;

@RunWith(InstrumentationTestRunner.class)
@InstrumentationTestConfig(includePrefixes = { "com.nr.agent.instrumentation.logbackclassic12" })
public class Logger_InstrumentationTest {

private static final String CAPTURED = "This log message should be captured";
private static final String NOT_CAPTURED = "This message should NOT be captured";

@Test
public void shouldIncrementEmittedLogsCountersIndependentlyIfLogLevelEnabled() {
// Given
final Logger logger = (Logger) LoggerFactory.getLogger(Logger_InstrumentationTest.class);
logger.setLevel(Level.INFO);

// When
logger.trace(NOT_CAPTURED);
logger.debug(NOT_CAPTURED);
logger.info(CAPTURED);
logger.info(CAPTURED);
logger.info(CAPTURED);
logger.warn(CAPTURED);
logger.warn(CAPTURED);
logger.warn(CAPTURED);
logger.warn(CAPTURED);
logger.error(CAPTURED);

// Then
Assert.assertEquals(8, MetricsHelper.getUnscopedMetricCount("Logging/lines"));
Assert.assertEquals(0, MetricsHelper.getUnscopedMetricCount("Logging/lines/TRACE"));
Assert.assertEquals(0, MetricsHelper.getUnscopedMetricCount("Logging/lines/DEBUG"));
Assert.assertEquals(3, MetricsHelper.getUnscopedMetricCount("Logging/lines/INFO"));
Assert.assertEquals(4, MetricsHelper.getUnscopedMetricCount("Logging/lines/WARN"));
Assert.assertEquals(1, MetricsHelper.getUnscopedMetricCount("Logging/lines/ERROR"));
}

@Test
public void shouldIncrementAllEmittedLogCountersIfLogLevelIsSetToTrace() {
// Given
final Logger logger = (Logger) LoggerFactory.getLogger(Logger_InstrumentationTest.class);
logger.setLevel(Level.TRACE);

// When
logger.trace(CAPTURED);
logger.debug(CAPTURED);
logger.info(CAPTURED);
logger.warn(CAPTURED);
logger.error(CAPTURED);

// Then
Assert.assertEquals(5, MetricsHelper.getUnscopedMetricCount("Logging/lines"));
Assert.assertEquals(1, MetricsHelper.getUnscopedMetricCount("Logging/lines/TRACE"));
Assert.assertEquals(1, MetricsHelper.getUnscopedMetricCount("Logging/lines/DEBUG"));
Assert.assertEquals(1, MetricsHelper.getUnscopedMetricCount("Logging/lines/INFO"));
Assert.assertEquals(1, MetricsHelper.getUnscopedMetricCount("Logging/lines/WARN"));
Assert.assertEquals(1, MetricsHelper.getUnscopedMetricCount("Logging/lines/ERROR"));
}
}
1 change: 1 addition & 0 deletions settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ include 'instrumentation:kafka-clients-heartbeat-2.1.0'
include 'instrumentation:kafka-clients-metrics-0.10.0.0'
include 'instrumentation:kafka-clients-metrics-2.0.0'
include 'instrumentation:kafka-clients-spans-0.11.0.0'
include 'instrumentation:logback-classic-1.2'
include 'instrumentation:mongodb-async-3.4'
include 'instrumentation:mongodb-async-3.6'
include 'instrumentation:mongodb-async-3.7'
Expand Down