This is an automated email from the ASF dual-hosted git repository. wusheng pushed a commit to branch polish-doc in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit ef528079cb2b300fdb0644d17b6616de88f58a39 Author: Wu Sheng <[email protected]> AuthorDate: Tue Dec 6 20:34:58 2022 +0800 add `Spring MicroMeter Observations Analysis` --- docs/en/changes/changes.md | 5 ++ docs/en/setup/backend/micrometer-observations.md | 40 +++++++++++++++ docs/en/setup/backend/spring-sleuth-setup.md | 63 ------------------------ docs/menu.yml | 4 +- 4 files changed, 47 insertions(+), 65 deletions(-) diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md index 3e4c16ad61..6137a54bd1 100644 --- a/docs/en/changes/changes.md +++ b/docs/en/changes/changes.md @@ -8,6 +8,7 @@ * Adds Micrometer as a new component.(ID=141) * Refactor session cache in MetricsPersistentWorker. * Cache enhancement - don't read new metrics from database in minute dimensionality. + ``` // When // (1) the time bucket of the server's latest stability status is provided @@ -21,6 +22,7 @@ // for the specific minute of booted successfully, the metrics are expected to load from database when // it doesn't exist in the cache. ``` + * Remove the offset of metric session timeout according to worker creation sequence. * Correct `MetricsExtension` annotations declarations in manual entities. * Support component IDs' priority in process relation metrics. @@ -30,4 +32,7 @@ #### Documentation +* Remove Spring Sleuth docs, and add `Spring MicroMeter Observations Analysis` with the latest Java agent side + enhancement. + All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/160?closed=1) diff --git a/docs/en/setup/backend/micrometer-observations.md b/docs/en/setup/backend/micrometer-observations.md new file mode 100644 index 0000000000..9ca0726abf --- /dev/null +++ b/docs/en/setup/backend/micrometer-observations.md @@ -0,0 +1,40 @@ +# MicroMeter Observations setup + +Micrometer Observation is part of the Micrometer project and contains the Observation API. +SkyWalking integrates its MicroMeter 1.10 APIs so that it can send metrics to the Skywalking [Meter System](./../../concepts-and-designs/meter.md). + +Follow Java agent [Observations docs](https://skywalking.apache.org/docs/skywalking-java/next/en/setup/service-agent/java-agent/application-toolkit-micrometer-1.10/) to set up agent in the Spring first. + +## Set up backend receiver + +1. Make sure to enable meter receiver in `application.yml`. +```yaml +receiver-meter: + selector: ${SW_RECEIVER_METER:default} + default: +``` + +2. Configure the meter config file. It already has the [spring sleuth meter config](../../../../oap-server/server-starter/src/main/resources/meter-analyzer-config/spring-sleuth.yaml). + If you have a customized meter at the agent side, please configure the meter using the steps set out in the [meter document](backend-meter.md#meters-configure). + +3. Enable Spring sleuth config in `application.yml`. +```yaml +agent-analyzer: + selector: ${SW_AGENT_ANALYZER:default} + default: + meterAnalyzerActiveFiles: ${SW_METER_ANALYZER_ACTIVE_FILES:spring-sleuth} +``` + +## Dashboard configuration + +SkyWalking provides the Spring Sleuth dashboard by default under the general service instance, which contains the metrics provided by Spring Sleuth by default. +Once you have added customized metrics in the application and configuration the meter config file in the backend. Please following +the [customized dashboard documentation](../../ui/README.md#metrics) to add the metrics in the dashboard. + +## Supported meter + +Three types of information are supported: Application, System, and JVM. + +1. Application: HTTP request count and duration, JDBC max/idle/active connection count, and Tomcat session active/reject count. +1. System: CPU system/process usage, OS system load, and OS process file count. +1. JVM: GC pause count and duration, memory max/used/committed size, thread peak/live/daemon count, and classes loaded/unloaded count. diff --git a/docs/en/setup/backend/spring-sleuth-setup.md b/docs/en/setup/backend/spring-sleuth-setup.md deleted file mode 100644 index 10f2d9e57d..0000000000 --- a/docs/en/setup/backend/spring-sleuth-setup.md +++ /dev/null @@ -1,63 +0,0 @@ -# Spring sleuth setup -Spring Sleuth provides Spring Boot auto-configuration for distributed tracing. Skywalking integrates its micrometer so that it can send metrics to the Skywalking [Meter System](./../../concepts-and-designs/meter.md). - -## Set up agent - -1. Add micrometer and Skywalking meter registry dependency into the project's `pom.xml` file. You can find more details at [Toolkit micrometer](https://github.com/apache/skywalking-java/blob/20fb8c81b3da76ba6628d34c12d23d3d45c973ef/docs/en/setup/service-agent/java-agent/Application-toolkit-micrometer.md). -```xml -<dependency> - <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-actuator</artifactId> -</dependency> -<dependency> - <groupId>org.apache.skywalking</groupId> - <artifactId>apm-toolkit-micrometer-registry</artifactId> - <version>${skywalking.version}</version> -</dependency> -``` - -2. Create Skywalking meter registry in spring bean management. -```java -@Bean -SkywalkingMeterRegistry skywalkingMeterRegistry() { - // Add rate configs If you need, otherwise using none args construct - SkywalkingConfig config = new SkywalkingConfig(Arrays.asList("")); - return new SkywalkingMeterRegistry(config); -} -``` - -## Set up backend receiver - -1. Make sure to enable meter receiver in `application.yml`. -```yaml -receiver-meter: - selector: ${SW_RECEIVER_METER:default} - default: -``` - -2. Configure the meter config file. It already has the [spring sleuth meter config](../../../../oap-server/server-starter/src/main/resources/meter-analyzer-config/spring-sleuth.yaml). -If you have a customized meter at the agent side, please configure the meter using the steps set out in the [meter document](backend-meter.md#meters-configure). - -3. Enable Spring sleuth config in `application.yml`. -```yaml -agent-analyzer: - selector: ${SW_AGENT_ANALYZER:default} - default: - meterAnalyzerActiveFiles: ${SW_METER_ANALYZER_ACTIVE_FILES:spring-sleuth} -``` - -## Dashboard configuration - - - -SkyWalking provides the Spring Sleuth dashboard by default under the general service instance, which contains the metrics provided by Spring Sleuth by default. -Once you have added customized metrics in the application and configuration the meter config file in the backend. Please following -the [customized dashboard documentation](../../ui/README.md#metrics) to add the metrics in the dashboard. - -## Supported meter - -Three types of information are supported: Application, System, and JVM. - -1. Application: HTTP request count and duration, JDBC max/idle/active connection count, and Tomcat session active/reject count. -1. System: CPU system/process usage, OS system load, and OS process file count. -1. JVM: GC pause count and duration, memory max/used/committed size, thread peak/live/daemon count, and classes loaded/unloaded count. diff --git a/docs/menu.yml b/docs/menu.yml index cb6a856ebc..eda1bf216e 100644 --- a/docs/menu.yml +++ b/docs/menu.yml @@ -125,8 +125,8 @@ catalog: path: "/en/setup/backend/telegraf-receiver" - name: "Apdex Threshold" path: "/en/setup/backend/apdex-threshold" - - name: "Spring Sleuth Metrics Analysis" - path: "/en/setup/backend/spring-sleuth-setup" + - name: "Spring MicroMeter Observations Analysis" + path: "/en/setup/backend/micrometer-observations" - name: "Alerting" path: "/en/setup/backend/backend-alarm" - name: "Logging"
