官網解析:
在生產環境中使用 Sentinel
監控
Sentinel 會記錄資源訪問的秒級數據(若沒有訪問則不進行記錄)並保存在本地日誌中,具體格式請見 秒級監控日誌文檔。Sentinel 控制檯可以通過 Sentinel 客戶端預留的 HTTP API 從秒級監控日誌中拉取監控數據,並進行聚合。
目前 Sentinel 控制檯中監控數據聚合後直接存在內存中,未進行持久化,且僅保留最近 5 分鐘的監控數據。若需要監控數據持久化的功能,可以自行擴展實現 MetricsRepository 接口(0.2.0 版本),然後註冊成 Spring Bean 並在相應位置通過 @Qualifier 註解指定對應的 bean name 即可。MetricsRepository 接口定義了以下功能:
-
save 與 saveAll:存儲對應的監控數據
-
queryByAppAndResourceBetween:查詢某段時間內的某個應用的某個資源的監控數據
-
listResourcesOfApp:查詢某個應用下的所有資源
其中默認的監控數據類型爲 MetricEntity,包含應用名稱、時間戳、資源名稱、異常數、請求通過數、請求拒絕數、平均響應時間等信息。對於監控數據的存儲,用戶需要根據自己的存儲精度,來考慮如何存儲這些監控數據。部署多個控制檯實例時,通常需要仔細設計下監控拉取和寫入策略。
同時用戶可以自行進行擴展,適配 Grafana 等可視化平臺,以便將監控數據更好地進行可視化。
以上爲官方解析,現在我們來進行操作。
引入依賴
找到實時監控進行保存和查詢的類,具體目錄爲:/sentinel-dashboard/src/main/java/com/alibaba/csp/sentinel/dashboard/repository/metric/InMemoryMetricsRepository。
熟悉基本邏輯之後,我們開始寫將數據持久化到InfluxDB的操作。
引入依賴:
<dependency>
<groupId>org.influxdb</groupId>
<artifactId>influxdb-java</artifactId>
<version>2.15</version>
</dependency>
數據庫鏈接
需要在本地或者是測試環境搭建influxdb數據庫,具體見上一個博客。然後開始和數據庫建立鏈接
package com.alibaba.csp.sentinel.dashboard.repository.metric.InfluxDB;
import org.influxdb.InfluxDB;
import org.influxdb.InfluxDBFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.concurrent.TimeUnit;
@Configuration
public class InfluxDBConfig {
@Value("${spring.influx.url:''}")
private String influxDBUrl;
@Value("${spring.influx.user:''}")
private String userName;
@Value("${spring.influx.password:''}")
private String password;
@Value("${spring.influx.database:''}")
private String database;
@Bean
public InfluxDB influxDB(){
InfluxDB influxDB = InfluxDBFactory.connect(influxDBUrl, userName, password);
try {
/**
* 異步插入:
* enableBatch這裏第一個是point的個數,第二個是時間,單位毫秒
* point的個數和時間是聯合使用的,如果滿100條或者2000毫秒
* 滿足任何一個條件就會發送一次寫的請求。
*/
influxDB.setDatabase(database)
.enableBatch(100,2000, TimeUnit.MILLISECONDS);
} catch (Exception e) {
e.printStackTrace();
} finally {
influxDB.setRetentionPolicy("autogen");
}
influxDB.setLogLevel(InfluxDB.LogLevel.BASIC);
return influxDB;
}
}
建立實體類
package com.alibaba.csp.sentinel.dashboard.repository.metric.InfluxDB;
import org.influxdb.annotation.Column;
import org.influxdb.annotation.Measurement;
import java.time.Instant;
@Measurement(name = "sentinelInfo")
public class InfluxDBMetricEntity {
@Column(name = "time")
private Instant time;
@Column(name = "gmtCreate")
private Long gmtCreate;
@Column(name = "gmtModified")
private Long gmtModified;
/**
* 監控信息的時間戳
*/
@Column(name = "app", tag = true)
private String app;
@Column(name = "resource", tag = true)
private String resource;
@Column(name = "timestamp")
private Long timestamp;
@Column(name = "passQps")
private Long passQps;//通過qps
@Column(name = "successQps")
private Long successQps;//成功qps
@Column(name = "blockQps")
private Long blockQps;//限流qps
@Column(name = "exceptionQps")
private Long exceptionQps;//異常qps
/**
* 所有successQps的rt的和
*/
@Column(name = "rt")
private double rt;
/**
* 本次聚合的總條數
*/
@Column(name = "count")
private int count;
@Column(name = "resourceCode")
private int resourceCode;
public static InfluxDBMetricEntity copyOf(InfluxDBMetricEntity oldEntity) {
InfluxDBMetricEntity entity = new InfluxDBMetricEntity();
entity.setApp(oldEntity.getApp());
entity.setGmtCreate(oldEntity.getGmtCreate());
entity.setGmtModified(oldEntity.getGmtModified());
entity.setTimestamp(oldEntity.getTimestamp());
entity.setResource(oldEntity.getResource());
entity.setPassQps(oldEntity.getPassQps());
entity.setBlockQps(oldEntity.getBlockQps());
entity.setSuccessQps(oldEntity.getSuccessQps());
entity.setExceptionQps(oldEntity.getExceptionQps());
entity.setRt(oldEntity.getRt());
entity.setCount(oldEntity.getCount());
entity.setResource(oldEntity.getResource());
return entity;
}
public synchronized void addPassQps(Long passQps) {
this.passQps += passQps;
}
public synchronized void addBlockQps(Long blockQps) {
this.blockQps += blockQps;
}
public synchronized void addExceptionQps(Long exceptionQps) {
this.exceptionQps += exceptionQps;
}
public synchronized void addCount(int count) {
this.count += count;
}
public synchronized void addRtAndSuccessQps(double avgRt, Long successQps) {
this.rt += avgRt * successQps;
this.successQps += successQps;
}
/**
* {@link #rt} = {@code avgRt * successQps}
*
* @param avgRt average rt of {@code successQps}
* @param successQps
*/
public synchronized void setRtAndSuccessQps(double avgRt, Long successQps) {
this.rt = avgRt * successQps;
this.successQps = successQps;
}
public Long getGmtCreate() {
return gmtCreate;
}
public void setGmtCreate(Long gmtCreate) {
this.gmtCreate = gmtCreate;
}
public Long getGmtModified() {
return gmtModified;
}
public void setGmtModified(Long gmtModified) {
this.gmtModified = gmtModified;
}
public Long getTimestamp() {
return timestamp;
}
public void setTimestamp(Long timestamp) {
this.timestamp = timestamp;
}
public String getResource() {
return resource;
}
public void setResource(String resource) {
this.resource = resource;
this.resourceCode = resource.hashCode();
}
public Long getPassQps() {
return passQps;
}
public void setPassQps(Long passQps) {
this.passQps = passQps;
}
public Long getBlockQps() {
return blockQps;
}
public void setBlockQps(Long blockQps) {
this.blockQps = blockQps;
}
public Long getExceptionQps() {
return exceptionQps;
}
public void setExceptionQps(Long exceptionQps) {
this.exceptionQps = exceptionQps;
}
public double getRt() {
return rt;
}
public void setRt(double rt) {
this.rt = rt;
}
public int getCount() {
return count;
}
public void setCount(int count) {
this.count = count;
}
public int getResourceCode() {
return resourceCode;
}
public Long getSuccessQps() {
return successQps;
}
public void setSuccessQps(Long successQps) {
this.successQps = successQps;
}
public Instant getTime() {
return time;
}
public void setTime(Instant time) {
this.time = time;
}
public String getApp() {
return app;
}
public void setApp(String app) {
this.app = app;
}
@Override
public String toString() {
return "InfluxdbMetricEntity{" +
", gmtCreate=" + gmtCreate +
", gmtModified=" + gmtModified +
", timestamp=" + timestamp +
", resource='" + resource + '\'' +
", passQps=" + passQps +
", blockQps=" + blockQps +
", successQps=" + successQps +
", exceptionQps=" + exceptionQps +
", rt=" + rt +
", count=" + count +
", resourceCode=" + resourceCode +
'}';
}
}
持久化代碼
直接將InMemoryMetricsRepository複製一份,更改名字爲InfluxDBMetricsRepository,然後將保存和查詢內存的代碼更改爲數據庫即可。
package com.alibaba.csp.sentinel.dashboard.repository.metric.InfluxDB;
import com.alibaba.csp.sentinel.dashboard.datasource.entity.MetricEntity;
import com.alibaba.csp.sentinel.dashboard.repository.metric.MetricsRepository;
import com.alibaba.csp.sentinel.util.StringUtil;
import com.alibaba.nacos.client.naming.utils.CollectionUtils;
import org.influxdb.InfluxDB;
import org.influxdb.dto.BatchPoints;
import org.influxdb.dto.Point;
import org.influxdb.dto.Query;
import org.influxdb.dto.QueryResult;
import org.influxdb.impl.InfluxDBResultMapper;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.*;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
@Component("influxDBMetricsRepository")
public class InfluxDBMetricsRepository implements MetricsRepository<MetricEntity> {
@Autowired
public InfluxDB influxDB;
@Override
public synchronized void save(MetricEntity metric) {
#這裏我直接建立2張表,因爲後期做圖表用的grafana,需要用這2張表sentinelInfo和sentinel_app
try {
Point point = Point
.measurement("sentinelInfo")
.time(System.currentTimeMillis(), TimeUnit.MILLISECONDS)
.tag("app",metric.getApp())//tag 數據走索引
.tag("resource",metric.getResource())//tag 數據走索引
.addField("gmtCreate", metric.getGmtCreate().getTime())
.addField("gmtModified", metric.getGmtModified().getTime())
.addField("timestamp", metric.getTimestamp().getTime())
.addField("passQps", metric.getPassQps())
.addField("successQps", metric.getSuccessQps())
.addField("blockQps", metric.getBlockQps())
.addField("exceptionQps", metric.getExceptionQps())
.addField("rt", metric.getRt())
.addField("count", metric.getCount())
.addField("resourceCode", metric.getResourceCode())
.build();
influxDB.write(point);
//在grafana中查詢app列表中,設置成tag不能使用distinct
Point point1=Point.measurement("sentinel_app")
.time(System.currentTimeMillis(), TimeUnit.MILLISECONDS)
.addField("app",metric.getApp())
.addField("resource",metric.getResource()).build();
influxDB.write(point1);
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public synchronized void saveAll(Iterable<MetricEntity> metrics) {
if (metrics == null) {
return;
}
BatchPoints batchPoints = BatchPoints.builder()
.tag("async", "true")
.consistency(InfluxDB.ConsistencyLevel.ALL)
.build();
BatchPoints batchPoint1s = BatchPoints.builder()
.tag("async", "true")
.consistency(InfluxDB.ConsistencyLevel.ALL)
.build();
metrics.forEach(metric->{
Point point = Point
.measurement("sentinelInfo")
.time(System.currentTimeMillis(), TimeUnit.MILLISECONDS)
.tag("app",metric.getApp())//tag 數據走索引
.tag("resource",metric.getResource())//tag 數據走索引
.addField("gmtCreate", metric.getGmtCreate().getTime())
.addField("gmtModified", metric.getGmtModified().getTime())
.addField("timestamp", metric.getTimestamp().getTime())
.addField("passQps", metric.getPassQps())
.addField("successQps", metric.getSuccessQps())
.addField("blockQps", metric.getBlockQps())
.addField("exceptionQps", metric.getExceptionQps())
.addField("rt", metric.getRt())
.addField("count", metric.getCount())
.addField("resourceCode", metric.getResourceCode())
.build();
batchPoints.point(point);
//在grafana中查詢app列表中,設置成tag不能使用distinct
Point point1=Point.measurement("sentinel_app")
.time(System.currentTimeMillis(), TimeUnit.MILLISECONDS)
.addField("app",metric.getApp())
.addField("resource",metric.getResource()).build();
batchPoints.point(point1);
});
influxDB.write(batchPoints);
influxDB.write(batchPoint1s);
}
@Override
public synchronized List<MetricEntity> queryByAppAndResourceBetween(String app, String resource, long startTime, long endTime) {
List<MetricEntity> results = new ArrayList<>();
if (StringUtil.isBlank(app)) {
return results;
}
String command = "SELECT * FROM sentinelInfo WHERE app='"+app+"' AND resource = '"+resource+"' AND gmtCreate>"+startTime+" AND gmtCreate<"+endTime;
Query query = new Query(command);
QueryResult queryResult = influxDB.query(query);
InfluxDBResultMapper resultMapper = new InfluxDBResultMapper(); // thread-safe - can be reused
List<InfluxDBMetricEntity> influxResults = resultMapper.toPOJO(queryResult, InfluxDBMetricEntity.class);
try {
influxResults.forEach(entity->{
MetricEntity metric = new MetricEntity();
BeanUtils.copyProperties(entity,metric);
metric.setTimestamp(new Date(entity.getTimestamp()));
metric.setGmtCreate(new Date(entity.getGmtCreate()));
metric.setGmtModified(new Date(entity.getGmtModified()));
results.add(metric);
});
} catch (Exception e) {
e.printStackTrace();
}
return results;
}
@Override
public synchronized List<String> listResourcesOfApp(String app) {
List<String> results = new ArrayList<>();
if (StringUtil.isBlank(app)) {
return results;
}
//最近一分鐘的指標(實時數據)
final long minTimeMs = System.currentTimeMillis() - 1000 * 60;
String command = "SELECT * FROM sentinelInfo WHERE app='"+app+"' AND gmtCreate>"+minTimeMs;
Query query = new Query(command);
QueryResult queryResult = influxDB.query(query);
InfluxDBResultMapper resultMapper = new InfluxDBResultMapper(); // thread-safe - can be reused
List<InfluxDBMetricEntity> influxResults = resultMapper.toPOJO(queryResult, InfluxDBMetricEntity.class);
try {
if (CollectionUtils.isEmpty(influxResults)) {
return results;
}
Map<String, InfluxDBMetricEntity> resourceCount = new HashMap<>(32);
for (InfluxDBMetricEntity metricEntity : influxResults) {
String resource = metricEntity.getResource();
if (resourceCount.containsKey(resource)) {
InfluxDBMetricEntity oldEntity = resourceCount.get(resource);
oldEntity.addPassQps(metricEntity.getPassQps());
oldEntity.addRtAndSuccessQps(metricEntity.getRt(), metricEntity.getSuccessQps());
oldEntity.addBlockQps(metricEntity.getBlockQps());
oldEntity.addExceptionQps(metricEntity.getExceptionQps());
oldEntity.addCount(1);
} else {
resourceCount.put(resource, InfluxDBMetricEntity.copyOf(metricEntity));
}
}
//排序
results = resourceCount.entrySet()
.stream()
.sorted((o1, o2) -> {
InfluxDBMetricEntity e1 = o1.getValue();
InfluxDBMetricEntity e2 = o2.getValue();
int t = e2.getBlockQps().compareTo(e1.getBlockQps());
if (t != 0) {
return t;
}
return e2.getPassQps().compareTo(e1.getPassQps());
})
.map(Map.Entry::getKey)
.collect(Collectors.toList());
} catch (Exception e) {
e.printStackTrace();
}
return results;
}
}
還需要在配置文件中加入influxDB的用戶名和密碼等信息
spring.influx.url=http://127.0.0.1:8086
spring.influx.user=admin
spring.influx.password=admin
spring.influx.database=sentinel_log
要註冊成 Spring Bean 並在相應位置通過 @Qualifier 註解指定對應的 bean name 。所以還需要修改2個注入的bean name
修改注入的具體baen name
以上就是全部的過程,當然了,我們可以對進行根據實際的需要進行再優化。