网站首页 > 厂商资讯 > deepflow >

Skywalking上报请求参数有哪些方式？

随着互联网技术的飞速发展，分布式系统已经成为现代应用架构的重要组成部分。在这样的背景下，对系统性能的监控和问题定位显得尤为重要。Skywalking 是一款开源的APM（Application Performance Management）工具，可以帮助开发者全面监控和优化应用性能。本文将详细介绍 Skywalking 上报请求参数的方式，帮助开发者更好地利用这一工具。

一、Skywalking 简介

Skywalking 是一款开源的APM工具，可以监控和追踪应用性能，帮助开发者快速定位问题。它具有以下特点：

全链路追踪：可以追踪应用中的每个请求，从客户端到服务端，全面了解应用性能。
可视化：提供丰富的可视化界面，方便开发者查看和分析数据。
插件化：支持多种语言的插件，可以轻松集成到各种应用中。

二、Skywalking 上报请求参数的方式

Skywalking 上报请求参数的方式主要有以下几种：

1. 自定义埋点

开发者可以在代码中手动添加埋点，将请求参数上报到 Skywalking。这种方式比较灵活，但需要开发者具备一定的编程能力。

2. 拦截器

Skywalking 支持拦截器，可以拦截应用中的请求和响应，将请求参数上报到 Skywalking。这种方式无需修改代码，但可能对性能有一定影响。

3. 插件

Skywalking 支持多种语言的插件，可以方便地集成到各种应用中。开发者可以选择合适的插件，将请求参数上报到 Skywalking。

4. API 接口

Skywalking 提供了 API 接口，允许开发者通过编程方式上报请求参数。

以下是具体实现方式：

1. 自定义埋点

以 Java 代码为例，自定义埋点的方式如下：

import com.taobao.arthas.core.shaded.org.apache.commons.lang3.StringUtils;

import org.skywalking.apm.agent.core.boot.DefaultBootstrap;

import org.skywalking.apm.agent.core.context.ContextCarrier;

import org.skywalking.apm.agent.core.context.ContextManager;

import org.skywalking.apm.agent.core.context.trace.Span;

import org.skywalking.apm.agent.core.context.trace.SpanLayer;

import org.skywalking.apm.agent.core.context.trace.SpanOperation;

import org.skywalking.apm.agent.core.context.trace.TraceSegment;



public class CustomTrace {

    public static void main(String[] args) {

        DefaultBootstrap.start();

        ContextCarrier contextCarrier = new ContextCarrier();

        contextCarrier.setTraceSegmentId("1234567890");

        ContextManager.startSpan(new SpanOperation("custom-span") {

            @Override

            public void createSpan(Span span) {

                span.setLayer(SpanLayer.Web);

                span.setComponent("custom-component");

                span.setOperationName("custom-operation");

            }

        }, contextCarrier);

        ContextManager.createExitSpan(new SpanOperation("custom-span") {

            @Override

            public void createSpan(Span span) {

                span.setLayer(SpanLayer.Web);

                span.setComponent("custom-component");

                span.setOperationName("custom-operation");

            }

        }, contextCarrier);

        ContextManager.stopSpan();

        DefaultBootstrap.stop();

    }

}

2. 拦截器

以 Spring Boot 代码为例，拦截器的方式如下：

import org.springframework.stereotype.Component;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;



@Component

public class SkywalkingInterceptor implements HandlerInterceptor {

    @Override

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        // 获取请求参数

        String param1 = request.getParameter("param1");

        String param2 = request.getParameter("param2");

        // 上报请求参数到 Skywalking

        // ...

        return true;

    }



    @Override

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }



    @Override

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }

}

3. 插件

以 Spring Boot 代码为例，插件的方式如下：

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RestController;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.AfterAdvice;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.BeforeAdvice;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptContext;

import org.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;



@RestController

public class SkywalkingController {

    @Autowired

    private SkywalkingInterceptor skywalkingInterceptor;



    @GetMapping("/test")

    public String test(@BeforeAdvice() MethodInterceptContext context, @AfterAdvice() MethodInterceptResult result) {

        // 获取请求参数

        String param1 = context.getTraceSegmentRef().getStartSegment().getContext().getTraceSegmentId();

        String param2 = context.getTraceSegmentRef().getStartSegment().getContext().getOperationName();

        // 上报请求参数到 Skywalking

        // ...

        return "Hello, Skywalking!";

    }

}

4. API 接口

以 Java 代码为例，API 接口的方式如下：

import org.skywalking.apm.agent.core.logging.logger.Logger;

import org.skywalking.apm.agent.core.logging.logger.LoggerFactory;

import org.skywalking.apm.agent.core.remote.logging.LogData;



public class SkywalkingApi {

    private static final Logger logger = LoggerFactory.getLogger(SkywalkingApi.class);



    public static void reportLog(LogData logData) {

        try {

            // 调用 Skywalking API 接口上报日志

            // ...

        } catch (Exception e) {

            logger.error("Report log to Skywalking failed", e);

        }

    }

}

三、案例分析

以下是一个使用 Skywalking 上报请求参数的案例分析：

假设有一个 Spring Boot 应用，需要监控其性能。开发者可以选择以下方式上报请求参数：

自定义埋点：在代码中添加埋点，将请求参数上报到 Skywalking。
拦截器：添加拦截器，拦截请求和响应，将请求参数上报到 Skywalking。
插件：选择合适的插件，将请求参数上报到 Skywalking。

通过以上方式，开发者可以全面监控应用性能，及时发现和解决问题。

总结

Skywalking 提供了多种方式上报请求参数，开发者可以根据实际情况选择合适的方式。通过使用 Skywalking，开发者可以更好地监控和优化应用性能，提高开发效率。