Jimoos-api-tracer

实现 Spring-boot mvc 的接口 request/response 的捕获利用。

反对版本 spring-boot 2.1.x, 其它版本暂未测试。

疾速上手

1. 初始化 数据库

CREATE TABLE `JM_API_TRACE`
(`id`          bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `request`     text COLLATE utf8mb4_unicode_ci COMMENT '申请',
    `response`    longtext COLLATE utf8mb4_unicode_ci COMMENT '返回值',
    `tenant_id`   varchar(128) COLLATE utf8mb4_unicode_ci  DEFAULT NULL COMMENT '租户 ID',
    `uri`         varchar(1024) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'path',
    `domain`      varchar(1023) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '域名',
    `method`      varchar(50) COLLATE utf8mb4_unicode_ci   DEFAULT NULL COMMENT 'http method,eg. POST',
    `path`        varchar(255) COLLATE utf8mb4_unicode_ci  DEFAULT NULL COMMENT '门路',
    `ip`          varchar(255) COLLATE utf8mb4_unicode_ci  DEFAULT NULL COMMENT '申请 IP',
    `user_agent`  varchar(255) COLLATE utf8mb4_unicode_ci  DEFAULT NULL COMMENT 'user-agent',
    `os_family`   varchar(50) COLLATE utf8mb4_unicode_ci   DEFAULT NULL COMMENT '零碎',
    `correlation` varchar(128) COLLATE utf8mb4_unicode_ci  DEFAULT NULL COMMENT 'correlation',
    `status`      varchar(50) COLLATE utf8mb4_unicode_ci   DEFAULT NULL COMMENT '返回状态',
    `duration`    int(11)                                  DEFAULT NULL COMMENT '申请工夫',
    `create_at`   bigint(20)                               DEFAULT NULL COMMENT '创立事件',
    PRIMARY KEY (`id`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8mb4
  COLLATE = utf8mb4_unicode_ci COMMENT ='api 接口的 request 和 response 跟踪';

2. 在接口模块 (监听端) 减少 依赖

<dependencies>
    <dependency>
        <groupId>cn.jimoos</groupId>
        <artifactId>jm-api-tracer</artifactId>
        <version>0.0.1</version>
    </dependency>
    <dependency>
        <groupId>org.zalando</groupId>
        <artifactId>logbook-spring-boot-starter</artifactId>
        <version>2.4.1</version>
    </dependency>
    <!-- ua 解析 -->
    <dependency>
        <groupId>com.github.ua-parser</groupId>
        <artifactId>uap-java</artifactId>
        <version>1.5.1</version>
    </dependency>
</dependencies>

当初启动 你的 spring-boot 利用，你的 表中 JM_API_TRACE 应该有 request/response 捕获了。

留神 在启动命令里 须减少 -Dlogbook.servlet.form-request=parameter,
解决 application/x-www-form-urlencoded 捕获 body 为空的问题。

idea 调试如下

启动 api-trace-manager web 服务

• 1 下载 manager jar
  ,Manager-Jar 下载地址
• 2 初始化 application.yml

spring:
  application:
  name: jimoos-api-tracer-manager
  datasource:
    url: jdbc:mysql://localhost:3306/jimoos?useUnicode=true&characterEncoding=utf-8
    username: root
    password: 123456
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
mybatis:
  mapper-locations: classpath*:mapper/**/*.xml
  type-aliases-package: cn.jimoos.model
server:
  port: 4000

• 3 启动 manager.jar

java  -Djava.security.egd=file:/dev/./urandom   -jar jm-api-tracer-manager-0.0.1.jar --spring.config.location=file:application.yml

配置数据库连贯，须要和 你的利用 数据库连贯统一。

• 4 关上利用 http://127.0.0.1:4000

输出明码 : 123456

即可查看预览

应用 Docker 镜像

docker run -d -p 4000:4000  -v /Users/keepcleargas/tmp/api-trace:/config --name jimoos-api-trace-manager -e TZ=Asia/Shanghai  --entrypoint '/bin/sh' keepcleargas/jm-api-tracer-manager -c 'java  -Djava.security.egd=file:/dev/./urandom   -jar /app.jar --spring.config.location=file:/config/application.yml'

留神 批改 config 的映射文件地址 到 application.yml 的 门路下。

其它

公布组件到 oss

 export GPG_TTY=$(tty) 
 mvn clean deploy -P release 

Docker 镜像构建

 #构建镜像
 docker build -t keepcleargas/jm-api-tracer-manager -f docker/Dockerfile .
 #推送镜像
 docker push keepcleargas/jm-api-tracer-manager

最初，欢送观看第四期 vlog 视频

https://www.bilibili.com/vide…

Demo 演示地址: http://150.158.189.200:4000/develop/traces

Demo 测试 Http 申请 http://150.158.189.200:4000/v1/pings?q=jimoos

开源版权申明

Lgpl-3.0