merge: 补齐 Redis+限流、埋点、Prometheus 监控缺失功能

This commit is contained in:
Zhou Weidong authored and trae-solo-agent committed 2026-10-21 06:32:07 +08:00
commit 4f3bb0090c
16 files changed
+404 -2

No files matched your search

+27
View File
@@ -145,7 +145,34 @@ services:
start_period: 40s
retries: 3
# ─────────── 监控 ───────────
prometheus:
image: prom/prometheus:latest
container_name: fruitshorts-prometheus
restart: unless-stopped
ports:
- "9090:9090"
volumes:
- ./prometheus.yml:/etc/prometheus/prometheus.yml:ro
- prometheus-data:/prometheus
command:
- "--config.file=/etc/prometheus/prometheus.yml"
grafana:
image: grafana/grafana:latest
container_name: fruitshorts-grafana
restart: unless-stopped
ports:
- "3000:3000"
volumes:
- grafana-data:/var/lib/grafana
environment:
- GF_SECURITY_ADMIN_USER=admin
- GF_SECURITY_ADMIN_PASSWORD=admin
volumes:
# 命名卷:跟着 compose 项目走,`docker compose down -v` 才会删
db-data:
redis-data:
prometheus-data:
grafana-data:
@@ -66,3 +66,15 @@ springdoc:
logging:
level:
com.fruitshorts: debug
management:
endpoints:
web:
exposure:
include: prometheus,health
endpoint:
health:
show-details: always
metrics:
tags:
application: ${spring.application.name}
@@ -4,6 +4,7 @@ package com.fruitshorts.app.controller;
import com.fruitshorts.app.vo.GoogleLoginReqVO;
import com.fruitshorts.common.pojo.Result;
import com.fruitshorts.framework.redis.RateLimit;
import com.fruitshorts.framework.security.SecurityUtils;
import com.fruitshorts.framework.web.WebUtils;
import com.fruitshorts.user.service.AppAuthService;
@@ -36,6 +37,7 @@ public class AppAuthController {
/** 发送验证码。频控在服务端,客户端不需要自己限流。 */
@Operation(summary = "发送验证码(频控在服务端)")
@RateLimit(limit = 20, windowSeconds = 60, key = "otp")
@PostMapping("/otp")
public Result<Void> sendOtp(@Valid @RequestBody OtpSendReqVO req, HttpServletRequest request) {
otpService.send(req, WebUtils.getClientIp(request));
@@ -50,6 +52,7 @@ public class AppAuthController {
}
@Operation(summary = "登录(验证码或密码)")
@RateLimit(limit = 10, windowSeconds = 60, key = "login")
@PostMapping("/login")
public Result<TokenRespVO> login(@Valid @RequestBody LoginReqVO req,
HttpServletRequest request) {
@@ -0,0 +1,35 @@
// Author: fruit.com.cn
package com.fruitshorts.app.controller;
import com.fruitshorts.app.service.AppEventService;
import com.fruitshorts.app.vo.AppEventReqVO;
import com.fruitshorts.common.pojo.Result;
import com.fruitshorts.framework.security.SecurityUtils;
import com.fruitshorts.framework.web.WebUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/** 客户端埋点上报。 */
@Tag(name = "埋点")
@RestController
@RequestMapping("/app")
@RequiredArgsConstructor
public class AppEventController {
private final AppEventService eventService;
@Operation(summary = "埋点事件批量上报")
@PostMapping("/events")
public Result<Void> report(@Valid @RequestBody AppEventReqVO req, HttpServletRequest request) {
eventService.save(req, SecurityUtils.getUserIdOrNull(), WebUtils.getClientIp(request));
return Result.ok();
}
}
@@ -0,0 +1,33 @@
// Author: fruit.com.cn
package com.fruitshorts.app.dal.entity;
import com.baomidou.mybatisplus.annotation.FieldStrategy;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import java.time.LocalDateTime;
/** 埋点事件落库记录,为后续分析/漏斗预留原始数据。 */
@Data
@TableName("app_event_log")
public class AppEventLog {
@TableId(type = IdType.ASSIGN_ID)
private Long id;
private String eventName;
private LocalDateTime eventTime;
private Long userId;
private String deviceId;
private String sessionId;
private String page;
private String properties;
private String clientIp;
private LocalDateTime createdAt;
@TableField(updateStrategy = FieldStrategy.NEVER)
private LocalDateTime updatedAt;
}
@@ -0,0 +1,10 @@
// Author: fruit.com.cn
package com.fruitshorts.app.dal.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.fruitshorts.app.dal.entity.AppEventLog;
/** 埋点事件 Mapper。 */
public interface AppEventLogMapper extends BaseMapper<AppEventLog> {
}
@@ -0,0 +1,40 @@
// Author: fruit.com.cn
package com.fruitshorts.app.service;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fruitshorts.app.dal.entity.AppEventLog;
import com.fruitshorts.app.dal.mapper.AppEventLogMapper;
import com.fruitshorts.app.vo.AppEventReqVO;
import lombok.RequiredArgsConstructor;
import lombok.SneakyThrows;
import org.springframework.stereotype.Service;
import java.time.LocalDateTime;
/** 埋点事件接收:批量落库,事件名与属性暂不校验、透传,口径后续与运营对齐。 */
@Service
@RequiredArgsConstructor
public class AppEventService {
private final AppEventLogMapper eventLogMapper;
private final ObjectMapper objectMapper;
@SneakyThrows
public void save(AppEventReqVO req, Long userId, String clientIp) {
for (AppEventReqVO.EventItem item : req.getEvents()) {
AppEventLog log = new AppEventLog();
log.setEventName(item.getEventName());
log.setEventTime(item.getEventTime() == null ? LocalDateTime.now() : item.getEventTime());
log.setUserId(userId);
log.setDeviceId(req.getDeviceId());
log.setSessionId(req.getSessionId());
log.setPage(item.getPage());
log.setProperties(item.getProperties() == null ? null
: objectMapper.writeValueAsString(item.getProperties()));
log.setClientIp(clientIp);
log.setCreatedAt(LocalDateTime.now());
eventLogMapper.insert(log);
}
}
}
@@ -0,0 +1,48 @@
// Author: fruit.com.cn
package com.fruitshorts.app.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.Size;
import lombok.Data;
import java.time.LocalDateTime;
import java.util.List;
import java.util.Map;
/** 埋点事件批量上报请求。 */
@Data
public class AppEventReqVO {
@Schema(description = "设备ID")
private String deviceId;
@Schema(description = "会话ID")
private String sessionId;
@Schema(description = "事件列表")
@NotEmpty(message = "事件列表不能为空")
@Size(max = 50, message = "单次最多上报 50 条事件")
@Valid
private List<EventItem> events;
@Data
public static class EventItem {
@Schema(description = "事件名,如 playback_start/playback_end/pay_success")
@NotBlank(message = "事件名不能为空")
private String eventName;
@Schema(description = "事件发生时间,缺省用服务端接收时间")
private LocalDateTime eventTime;
@Schema(description = "页面/场景标识")
private String page;
@Schema(description = "事件属性(key-value)")
private Map<String, Object> properties;
}
}
@@ -18,6 +18,10 @@ spring:
jackson:
date-format: yyyy-MM-dd HH:mm:ss
time-zone: Asia/Shanghai
data:
redis:
host: ${REDIS_HOST:127.0.0.1}
port: ${REDIS_PORT:6379}
mybatis-plus:
configuration:
@@ -93,3 +97,15 @@ fruitshorts:
logging:
level:
com.fruitshorts: info
management:
endpoints:
web:
exposure:
include: prometheus,health
endpoint:
health:
show-details: always
metrics:
tags:
application: ${spring.application.name}
+14
View File
@@ -66,5 +66,19 @@
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
<!-- 监控:暴露 actuator 指标供 Prometheus 抓取 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
</dependencies>
</project>
@@ -0,0 +1,25 @@
// Author: fruit.com.cn
package com.fruitshorts.framework.redis;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 接口级固定窗口限流。基于 Redis INCR,key 按客户端 IP 维度隔离。
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RateLimit {
/** 窗口内允许的最大请求次数。 */
int limit() default 10;
/** 窗口时长(秒)。 */
int windowSeconds() default 60;
/** 限流维度前缀,默认取方法名。 */
String key() default "";
}
@@ -0,0 +1,54 @@
// Author: fruit.com.cn
package com.fruitshorts.framework.redis;
import com.fruitshorts.common.exception.ErrorCode;
import com.fruitshorts.common.exception.ServiceException;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import java.time.Duration;
/**
* 固定窗口限流切面:每次命中注解先 INCR,超阈值即拒绝。
*/
@Aspect
@Component
@RequiredArgsConstructor
public class RateLimitAspect {
private final RedisService redisService;
@Before("@annotation(rateLimit)")
public void check(RateLimit rateLimit) {
long count = redisService.increment(
buildKey(rateLimit), Duration.ofSeconds(rateLimit.windowSeconds()));
if (count > rateLimit.limit()) {
throw new ServiceException(ErrorCode.TOO_MANY_REQUESTS, "请求过于频繁,请稍后再试");
}
}
private String buildKey(RateLimit rateLimit) {
String scope = rateLimit.key().isBlank() ? "default" : rateLimit.key();
return "rate:" + scope + ":" + clientIp();
}
private String clientIp() {
ServletRequestAttributes attrs =
(ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
if (attrs == null) {
return "unknown";
}
HttpServletRequest request = attrs.getRequest();
String forwarded = request.getHeader("X-Forwarded-For");
if (forwarded != null && !forwarded.isBlank()) {
return forwarded.split(",")[0].trim();
}
return request.getRemoteAddr();
}
}
@@ -0,0 +1,45 @@
// Author: fruit.com.cn
package com.fruitshorts.framework.redis;
import lombok.RequiredArgsConstructor;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;
import java.time.Duration;
/**
* Redis 字符串操作封装,供缓存与限流复用。
* 统一在这里兜底过期策略,业务侧不直接接触 RedisTemplate。
*/
@Component
@RequiredArgsConstructor
public class RedisService {
private final StringRedisTemplate redisTemplate;
public void set(String key, String value, Duration ttl) {
redisTemplate.opsForValue().set(key, value, ttl);
}
public String get(String key) {
return redisTemplate.opsForValue().get(key);
}
public void delete(String key) {
redisTemplate.delete(key);
}
/**
* 固定窗口计数:自增并保证首次写入时设置过期时间。
* 用于接口限流,返回当前窗口内的累计次数。
*/
public long increment(String key, Duration window) {
Long count = redisTemplate.opsForValue().increment(key);
long value = count == null ? 1 : count;
if (value == 1) {
redisTemplate.expire(key, window);
}
return value;
}
}
@@ -44,6 +44,8 @@ public class SecurityConfig {
/* 启动配置与公告:客户端登录前就要拿(POST /app/creator/apply 等仍要登录) */
"/app/config",
"/app/notices",
/* 埋点上报:游客浏览也要记录,匿名可访问 */
"/app/events",
/* 媒资:封面与视频用 <img>/<video> 直接访问,无法带请求头。
片源的防盗链由 fruitshorts.media.signature-required 控制。 */
"/files/**",
@@ -51,9 +53,10 @@ public class SecurityConfig {
"/swagger-ui/**",
"/swagger-ui.html",
"/v3/api-docs/**",
/* 健康检查:给容器编排与冒烟脚本用(本项目没引 actuator,见 HealthController 注释) */
/* 健康检查与监控:/actuator/health 给容器编排,/actuator/prometheus 给 Prometheus 抓取指标 */
"/healthz",
"/actuator/health"
"/actuator/health",
"/actuator/prometheus"
};
private final JwtAuthenticationFilter jwtAuthenticationFilter;
+16
View File
@@ -0,0 +1,16 @@
# Author: fruit.com.cn
# Prometheus 抓取配置:抓取后端双服务的 actuator 指标(服务名走 compose 网络)
global:
scrape_interval: 15s
evaluation_interval: 15s
scrape_configs:
- job_name: "fruitshorts-app-api"
metrics_path: "/actuator/prometheus"
static_configs:
- targets: ["app-api:8081"]
- job_name: "fruitshorts-admin-api"
metrics_path: "/actuator/prometheus"
static_configs:
- targets: ["admin-api:8080"]
+21
View File
@@ -933,3 +933,24 @@ COMMENT ON COLUMN sys_admin_user.must_change_password IS '1 = 首登强制改密
-- 默认 1(超管照旧看到),置 0 表示"不给超管显示"。
ALTER TABLE sys_menu ADD COLUMN IF NOT EXISTS super_admin_visible SMALLINT NOT NULL DEFAULT 1;
COMMENT ON COLUMN sys_menu.super_admin_visible IS '0 = 不给超管显示(角色专属菜单用;超管的菜单是全量兜底,不走 sys_role_menu)';
-- ============================================================
-- 十、C3 埋点事件落库(/app/events 匿名上报,供分析漏斗用)
-- ============================================================
CREATE TABLE IF NOT EXISTS app_event_log (
id BIGINT PRIMARY KEY,
event_name VARCHAR(64) NOT NULL,
event_time TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
user_id BIGINT,
device_id VARCHAR(64),
session_id VARCHAR(64),
page VARCHAR(128),
properties TEXT,
client_ip VARCHAR(64),
created_at TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE INDEX IF NOT EXISTS idx_app_event_log_time ON app_event_log (event_time DESC);
CREATE INDEX IF NOT EXISTS idx_app_event_log_user ON app_event_log (user_id);
CREATE INDEX IF NOT EXISTS idx_app_event_log_name_time ON app_event_log (event_name, event_time DESC);
COMMENT ON TABLE app_event_log IS '客户端埋点事件原始落库(匿名上报,供后续分析与漏斗)';