This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new 4b7ec0bab5 Polish doc (#10114)
4b7ec0bab5 is described below
commit 4b7ec0bab5aa88849296662eab2a91bbe241a9a6
Author: 吴晟 Wu Sheng <[email protected]>
AuthorDate: Tue Dec 6 21:59:33 2022 +0800
Polish doc (#10114)
---
docs/en/changes/changes.md | 6 +++
docs/en/setup/backend/backend-meter.md | 8 +--
docs/en/setup/backend/micrometer-observations.md | 40 ++++++++++++++
docs/en/setup/backend/spring-sleuth-setup.md | 63 ----------------------
docs/menu.yml | 4 +-
.../{spring-sleuth.yaml => spring-micrometer.yaml} | 0
test/e2e-v2/cases/kafka/meter/docker-compose.yml | 2 +-
test/e2e-v2/cases/meter/docker-compose.yml | 2 +-
.../satellite/native-protocols/docker-compose.yml | 2 +-
9 files changed, 55 insertions(+), 72 deletions(-)
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index 6de767411f..0bf4669869 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,14 +22,19 @@
// 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.
* Remove abandon logic in MergableBufferedData, which caused unexpected
no-update.
* Fix miss set `LastUpdateTimestamp` that caused the metrics session to expire.
+* Rename MAL rule `spring-sleuth.yaml` to `spring-micrometer.yaml`.
#### UI
#### 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/backend-meter.md
b/docs/en/setup/backend/backend-meter.md
index dee81764e7..59fc51e961 100644
--- a/docs/en/setup/backend/backend-meter.md
+++ b/docs/en/setup/backend/backend-meter.md
@@ -29,7 +29,7 @@ The receiver adds labels with `key = service` and `key =
instance` to the collec
and values from service and service instance name defined in SkyWalking Agent,
for identification of the metric data.
-A typical manual meter API set is [Spring Sleuth APIs](spring-sleuth-setup.md)
+A typical manual meter API set is [Spring MicroMeter Observations
APIs](micrometer-observations.md)
### OpenTelemetry Exporter
@@ -73,10 +73,10 @@ All available meter analysis scripts could be found
[here](../../../../oap-serve
|satellite| Metrics of SkyWalking Satellite self-observability(so11y)|
meter-analyzer-config/satellite.yaml| SkyWalking Satellite --meter
format-->SkyWalking OAP Server|
|threadpool| Metrics of Thread Pool | meter-analyzer-config/threadpool.yaml |
Thread Pool --meter format--> SkyWalking OAP Server |
|datasource| Metrics of DataSource metrics |
meter-analyzer-config/datasource.yaml | Datasource --meter format--> SkyWalking
OAP Server |
-|spring-sleuth| Metrics of Spring Sleuth Application |
meter-analyzer-config/spring-sleuth.yaml | Sprign Sleuth Application --meter
format--> SkyWalking OAP Server |
+|spring-micrometer| Metrics of Spring Sleuth Application |
meter-analyzer-config/spring-micrometer.yaml | Sprign Sleuth Application
--meter format--> SkyWalking OAP Server |
-An example can be found
[here](../../../../oap-server/server-starter/src/main/resources/meter-analyzer-config/spring-sleuth.yaml).
-If you're using Spring Sleuth, see [Spring Sleuth
Setup](spring-sleuth-setup.md).
+An example can be found
[here](../../../../oap-server/server-starter/src/main/resources/meter-analyzer-config/spring-micrometer.yaml).
+If you're using Spring MicroMeter Observations, see [Spring MicroMeter
Observations APIs](micrometer-observations.md).
### Meters configuration
diff --git a/docs/en/setup/backend/micrometer-observations.md
b/docs/en/setup/backend/micrometer-observations.md
new file mode 100644
index 0000000000..69e4bf63db
--- /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-micrometer.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-micrometer}
+```
+
+## 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"
diff --git
a/oap-server/server-starter/src/main/resources/meter-analyzer-config/spring-sleuth.yaml
b/oap-server/server-starter/src/main/resources/meter-analyzer-config/spring-micrometer.yaml
similarity index 100%
rename from
oap-server/server-starter/src/main/resources/meter-analyzer-config/spring-sleuth.yaml
rename to
oap-server/server-starter/src/main/resources/meter-analyzer-config/spring-micrometer.yaml
diff --git a/test/e2e-v2/cases/kafka/meter/docker-compose.yml
b/test/e2e-v2/cases/kafka/meter/docker-compose.yml
index 8c28a3c910..4e989e9acd 100644
--- a/test/e2e-v2/cases/kafka/meter/docker-compose.yml
+++ b/test/e2e-v2/cases/kafka/meter/docker-compose.yml
@@ -80,7 +80,7 @@ services:
SW_KAFKA_FETCHER_SERVERS: broker-a:9092,broker-b:9092
SW_KAFKA_FETCHER_PARTITIONS: 2
SW_KAFKA_FETCHER_PARTITIONS_FACTOR: 1
- SW_METER_ANALYZER_ACTIVE_FILES: spring-sleuth
+ SW_METER_ANALYZER_ACTIVE_FILES: spring-micrometer
depends_on:
broker-a:
condition: service_healthy
diff --git a/test/e2e-v2/cases/meter/docker-compose.yml
b/test/e2e-v2/cases/meter/docker-compose.yml
index a537a9cb46..c2f919abdc 100644
--- a/test/e2e-v2/cases/meter/docker-compose.yml
+++ b/test/e2e-v2/cases/meter/docker-compose.yml
@@ -18,7 +18,7 @@ version: '2.1'
services:
oap:
environment:
- SW_METER_ANALYZER_ACTIVE_FILES: spring-sleuth,batch-meter
+ SW_METER_ANALYZER_ACTIVE_FILES: spring-micrometer,batch-meter
#virtual cache test case
SW_SLOW_CACHE_SLOW_WRITE_THRESHOLD: default:-1
SW_SLOW_CACHE_SLOW_READ_THRESHOLD: default:-1
diff --git a/test/e2e-v2/cases/satellite/native-protocols/docker-compose.yml
b/test/e2e-v2/cases/satellite/native-protocols/docker-compose.yml
index 6b2306ae80..64156fce7c 100644
--- a/test/e2e-v2/cases/satellite/native-protocols/docker-compose.yml
+++ b/test/e2e-v2/cases/satellite/native-protocols/docker-compose.yml
@@ -45,7 +45,7 @@ services:
environment:
SW_LOG_LAL_FILES: test
SW_CLUSTER: etcd
- SW_METER_ANALYZER_ACTIVE_FILES: spring-sleuth
+ SW_METER_ANALYZER_ACTIVE_FILES: spring-micrometer
SW_CONFIGURATION: etcd
volumes:
- ./lal.yaml:/skywalking/config/lal/test.yaml
