Commit 57b345dd authored by wuxingye's avatar wuxingye Committed by 吴晟
Browse files

add logstash logback plugin (#3365) 

* add logstash logback plugin

* add logstash logback plugin, set pom provided, refine logback doc

* refine logstash logback doc

* refine the comment

* remove the app_id that not related to SkyWalking

* remove tag @date for CI error: unknown tag: date

* add description for iLoggingEvent for ci warning: no description for @param
parent 95ceacfc

apm-application-toolkit/apm-toolkit-logback-1.x/pom.xml

+7 −0
Original line number Diff line number Diff line
@@ -29,6 +29,7 @@ 


    <properties>

        <logback-classic.version>1.2.3</logback-classic.version>

        <logstash.version>6.1</logstash.version>

    </properties>



    <dependencies>
@@ -38,5 +39,11 @@ 
            <version>${logback-classic.version}</version>

            <scope>provided</scope>

        </dependency>

        <dependency>

            <groupId>net.logstash.logback</groupId>

            <artifactId>logstash-logback-encoder</artifactId>

            <version>${logstash.version}</version>

            <scope>provided</scope>

        </dependency>

    </dependencies>

</project>

apm-application-toolkit/apm-toolkit-logback-1.x/src/main/java/org/apache/skywalking/apm/toolkit/log/logback/v1/x/LogbackPatternConverter.java

+1 −1
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ public class LogbackPatternConverter extends ClassicConverter { 
     * As default, return "TID: N/A" to the output message,

     * if sky-walking agent in active mode, return the real traceId in the recent Context, if existed.

     *

     * @param iLoggingEvent

     * @param iLoggingEvent the event

     * @return the traceId: N/A, empty String, or the real traceId.

     */

    @Override

apm-application-toolkit/apm-toolkit-logback-1.x/src/main/java/org/apache/skywalking/apm/toolkit/log/logback/v1/x/logstash/TraceIdJsonProvider.java

0 → 100644
+47 −0
Original line number Diff line number Diff line 
/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 *

 */



package org.apache.skywalking.apm.toolkit.log.logback.v1.x.logstash;



import ch.qos.logback.classic.spi.ILoggingEvent;

import com.fasterxml.jackson.core.JsonGenerator;

import java.io.IOException;

import java.util.Map;

import net.logstash.logback.composite.AbstractFieldJsonProvider;

import net.logstash.logback.composite.FieldNamesAware;

import net.logstash.logback.composite.JsonWritingUtils;

import net.logstash.logback.fieldnames.LogstashFieldNames;



/**

 * @author wuxingye

 */

public class TraceIdJsonProvider extends AbstractFieldJsonProvider<ILoggingEvent> implements FieldNamesAware<LogstashFieldNames> {



    public static final String TRACING_ID = "TID";



    @Override

    public void writeTo(JsonGenerator generator, ILoggingEvent event) throws IOException {

        Map<String, String> map = event.getLoggerContextVO().getPropertyMap();

        JsonWritingUtils.writeStringField(generator, getFieldName(), map.get(TRACING_ID));

    }



    @Override

    public void setFieldNames(LogstashFieldNames fieldNames) {

        setFieldName(TRACING_ID);

    }

}

apm-sniffer/apm-toolkit-activation/apm-toolkit-logback-1.x-activation/pom.xml

+13 −1
Original line number Diff line number Diff line
@@ -17,7 +17,8 @@ 
  ~

  -->



<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <parent>

        <artifactId>apm-toolkit-activation</artifactId>

        <groupId>org.apache.skywalking</groupId>
@@ -27,5 +28,16 @@ 


    <artifactId>apm-toolkit-logback-1.x-activation</artifactId>



    <properties>

        <logback-classic.version>1.2.3</logback-classic.version>

    </properties>



    <dependencies>

        <dependency>

            <groupId>ch.qos.logback</groupId>

            <artifactId>logback-classic</artifactId>

            <version>${logback-classic.version}</version>

            <scope>provided</scope>

        </dependency>

    </dependencies>

</project>

apm-sniffer/apm-toolkit-activation/apm-toolkit-logback-1.x-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/log/logback/v1/x/logstash/TcpSocketAppenderActivation.java

0 → 100644
+74 −0
Original line number Diff line number Diff line 
/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 *

 */





package org.apache.skywalking.apm.toolkit.activation.log.logback.v1.x.logstash;



import net.bytebuddy.description.method.MethodDescription;

import net.bytebuddy.matcher.ElementMatcher;

import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;

import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;

import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;

import org.apache.skywalking.apm.agent.core.plugin.match.ClassMatch;



import static net.bytebuddy.matcher.ElementMatchers.named;

import static org.apache.skywalking.apm.agent.core.plugin.bytebuddy.ArgumentTypeNameMatch.takesArgumentWithType;

import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;



/**

 * enhance the method prepareForDeferredProcessing of the logstash logback class "net.logstash.logback.appender.LogstashTcpSocketAppender".

 *

 * @author wuxingye

 */

public class TcpSocketAppenderActivation extends ClassInstanceMethodsEnhancePluginDefine {



    public static final String INTERCEPT_CLASS = "org.apache.skywalking.apm.toolkit.activation.log.logback.v1.x.logstash.TcpSocketAppenderInterceptor";

    public static final String ENHANCE_CLASS = "net.logstash.logback.appender.LogstashTcpSocketAppender";

    public static final String ENHANCE_METHOD = "prepareForDeferredProcessing";



    @Override

    protected ClassMatch enhanceClass() {

        return byName(ENHANCE_CLASS);

    }



    @Override

    public ConstructorInterceptPoint[] getConstructorsInterceptPoints() {

        return null;

    }



    @Override

    public InstanceMethodsInterceptPoint[] getInstanceMethodsInterceptPoints() {

        return new InstanceMethodsInterceptPoint[] {

            new InstanceMethodsInterceptPoint() {

                @Override

                public ElementMatcher<MethodDescription> getMethodsMatcher() {

                    return named(ENHANCE_METHOD).and(takesArgumentWithType(0, "ch.qos.logback.classic.spi.ILoggingEvent"));

                }



                @Override

                public String getMethodsInterceptor() {

                    return INTERCEPT_CLASS;

                }



                @Override public boolean isOverrideArgs() {

                    return false;

                }

            }

        };

    }

}