You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2021/04/16 15:46:13 UTC

[skywalking] branch master updated: Polish the doc of log feature (#6772)

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 f0ee75c  Polish the doc of log feature (#6772)
f0ee75c is described below

commit f0ee75c021d9f0062850695b9ab3345625714473
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Fri Apr 16 23:45:49 2021 +0800

    Polish the doc of log feature (#6772)
---
 docs/en/setup/backend/backend-fetcher.md |  5 +++--
 docs/en/setup/backend/log-analyzer.md    | 18 +++++++++++++++++-
 docs/menu.yml                            |  4 ++--
 3 files changed, 22 insertions(+), 5 deletions(-)

diff --git a/docs/en/setup/backend/backend-fetcher.md b/docs/en/setup/backend/backend-fetcher.md
index cce8c2b..22fb08d 100644
--- a/docs/en/setup/backend/backend-fetcher.md
+++ b/docs/en/setup/backend/backend-fetcher.md
@@ -91,10 +91,11 @@ kafka-fetcher:
     bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092}
 ```
 
-`skywalking-segments`, `skywalking-metrics`, `skywalking-profile`, `skywalking-managements` and `skywalking-meters` topics are required by `kafka-fetcher`.
+`skywalking-segments`, `skywalking-metrics`, `skywalking-profile`, `skywalking-managements`, `skywalking-meters`
+and `skywalking-logs` topics are required by `kafka-fetcher`.
 If they do not exist, Kafka Fetcher will create them in default. Also, you can create them by yourself before the OAP server started.
 
-When using the OAP server automatical creation mechanism, you could modify the number of partitions and replications of the topics through the following configurations:
+When using the OAP server automatic creation mechanism, you could modify the number of partitions and replications of the topics through the following configurations:
 
 ```yaml
 kafka-fetcher:
diff --git a/docs/en/setup/backend/log-analyzer.md b/docs/en/setup/backend/log-analyzer.md
index 4a08301..4f1c88c 100644
--- a/docs/en/setup/backend/log-analyzer.md
+++ b/docs/en/setup/backend/log-analyzer.md
@@ -1,6 +1,22 @@
+# Log Collecting And Analysis
+
+## Collecting
+There are various ways to collect logs from application.
+
+### Java agent's toolkits
+Java agent provides toolkit for 
+[log4j](../service-agent/java-agent/Application-toolkit-log4j-1.x.md),
+[log4j2](../service-agent/java-agent/Application-toolkit-log4j-2.x.md), 
+[logback](../service-agent/java-agent/Application-toolkit-logback-1.x.md) 
+to report logs through gRPC with automatic injected trace context.
+
+[SkyWalking Satellite sidecar](https://github.com/apache/skywalking-satellite) is a recommended proxy/side to
+forward logs including to use Kafka MQ to transport logs. When use this, need to open [kafka-fetcher](backend-fetcher.md#kafka-fetcher).
+
+
 ## Log Analyzer
 
-Log analyzer supports native log data. OAP could use Log Analysis Language to
+Log analyzer of OAP server supports native log data. OAP could use Log Analysis Language to
 structurize log content through parse, extract, and save logs. 
 Also the analyzer leverages Meter Analysis Language Engine for further metrics calculation.
 
diff --git a/docs/menu.yml b/docs/menu.yml
index 4df194b..56616fe 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -127,7 +127,7 @@ catalog:
             path: "/en/setup/backend/dynamic-config"
           - name: "Uninstrumented Gateways"
             path: "/en/setup/backend/uninstrumented-gateways"
-          - name: "Apdex threshold"
+          - name: "Apdex Threshold"
             path: "/en/setup/backend/apdex-threshold"
           - name: "Service Grouping"
             path: "/en/setup/backend/service-auto-grouping"
@@ -139,7 +139,7 @@ catalog:
             path: "/en/setup/backend/backend-meter"
           - name: "Spring Sleuth Metrics Analysis"
             path: "/en/setup/backend/spring-sleuth-setup"
-          - name: "Log Analyzer"
+          - name: "Log Collecting And Analysis"
             path: "/en/setup/backend/log-analyzer"
           - name: "Infrastructure Monitoring"
             path: "/en/setup/backend/backend-infrastructure-monitoring"