From 166a440df14bfdda07caf429aa28f2f333fb8157 Mon Sep 17 00:00:00 2001 From: guqing <38999863+guqing@users.noreply.github.com> Date: Tue, 28 Feb 2023 21:18:18 +0800 Subject: [PATCH] chore: disable the visit log writer (#3421) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit #### What type of PR is this? /kind cleanup /area core /milestone 2.3.x #### What this PR does / why we need it: 移除 VisitLogWriter 的使用,不再记录访问日志,后续由 httptrace 去暴露指标 #### Does this PR introduce a user-facing change? ```release-note None ``` --- .../extension/endpoint/TrackerEndpoint.java | 29 ------------------- .../run/halo/app/metrics/VisitLogWriter.java | 3 +- .../halo/app/metrics/VisitLogWriterTest.java | 3 ++ 3 files changed, 4 insertions(+), 31 deletions(-) diff --git a/src/main/java/run/halo/app/core/extension/endpoint/TrackerEndpoint.java b/src/main/java/run/halo/app/core/extension/endpoint/TrackerEndpoint.java index 46a3e0810..d86f4744e 100644 --- a/src/main/java/run/halo/app/core/extension/endpoint/TrackerEndpoint.java +++ b/src/main/java/run/halo/app/core/extension/endpoint/TrackerEndpoint.java @@ -20,10 +20,6 @@ import run.halo.app.event.post.DownvotedEvent; import run.halo.app.event.post.UpvotedEvent; import run.halo.app.event.post.VisitedEvent; import run.halo.app.extension.GroupVersion; -import run.halo.app.infra.utils.HaloUtils; -import run.halo.app.infra.utils.IpAddressUtils; -import run.halo.app.metrics.MeterUtils; -import run.halo.app.metrics.VisitLogWriter; /** * Metrics counter endpoint. @@ -36,7 +32,6 @@ import run.halo.app.metrics.VisitLogWriter; public class TrackerEndpoint implements CustomEndpoint { private final ApplicationEventPublisher eventPublisher; - private final VisitLogWriter visitLogWriter; @Override public RouterFunction endpoint() { @@ -94,9 +89,6 @@ public class TrackerEndpoint implements CustomEndpoint { .doOnNext(counterRequest -> { eventPublisher.publishEvent(new VisitedEvent(this, counterRequest.group(), counterRequest.name(), counterRequest.plural())); - - // async write visit log - writeVisitLog(request, counterRequest); }) .then(ServerResponse.ok().build()); } @@ -139,27 +131,6 @@ public class TrackerEndpoint implements CustomEndpoint { } } - private void writeVisitLog(ServerRequest request, CounterRequest counterRequest) { - String logMessage = logMessage(request, counterRequest); - visitLogWriter.log(logMessage); - } - - private String logMessage(ServerRequest request, CounterRequest counterRequest) { - String ipAddress = IpAddressUtils.getIpAddress(request); - String hostname = counterRequest.hostname(); - String screen = counterRequest.screen(); - String language = counterRequest.language(); - String referrer = counterRequest.referrer(); - String userAgent = HaloUtils.userAgentFrom(request); - String counterName = - MeterUtils.nameOf(counterRequest.group(), counterRequest.plural(), - counterRequest.name()); - return String.format( - "subject=[%s], ipAddress=[%s], hostname=[%s], screen=[%s], language=[%s], " - + "referrer=[%s], userAgent=[%s]", counterName, ipAddress, hostname, screen, - language, referrer, userAgent); - } - @Override public GroupVersion groupVersion() { return new GroupVersion("api.halo.run", "v1alpha1"); diff --git a/src/main/java/run/halo/app/metrics/VisitLogWriter.java b/src/main/java/run/halo/app/metrics/VisitLogWriter.java index eda0394eb..d7bde76b7 100644 --- a/src/main/java/run/halo/app/metrics/VisitLogWriter.java +++ b/src/main/java/run/halo/app/metrics/VisitLogWriter.java @@ -17,7 +17,6 @@ import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.exception.ExceptionUtils; import org.springframework.beans.factory.DisposableBean; import org.springframework.beans.factory.InitializingBean; -import org.springframework.stereotype.Component; import reactor.core.Disposable; import run.halo.app.infra.properties.HaloProperties; import run.halo.app.infra.utils.FileUtils; @@ -29,7 +28,7 @@ import run.halo.app.infra.utils.FileUtils; * @since 2.0.0 */ @Slf4j -@Component +@Deprecated public class VisitLogWriter implements InitializingBean, DisposableBean { private static final String LOG_FILE_NAME = "visits.log"; private static final String LOG_FILE_LOCATION = "logs"; diff --git a/src/test/java/run/halo/app/metrics/VisitLogWriterTest.java b/src/test/java/run/halo/app/metrics/VisitLogWriterTest.java index 550359d78..49cfcca7d 100644 --- a/src/test/java/run/halo/app/metrics/VisitLogWriterTest.java +++ b/src/test/java/run/halo/app/metrics/VisitLogWriterTest.java @@ -8,6 +8,7 @@ import java.nio.file.Files; import java.nio.file.Path; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.Mock; @@ -21,6 +22,8 @@ import run.halo.app.infra.properties.HaloProperties; * @author guqing * @since 2.0.0 */ +@Disabled +@Deprecated @ExtendWith(MockitoExtension.class) class VisitLogWriterTest {