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 2019/04/16 05:43:42 UTC
[incubator-skywalking] branch envoy-access-log updated: Provide ALS
receiver document.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch envoy-access-log
in repository https://gitbox.apache.org/repos/asf/incubator-skywalking.git
The following commit(s) were added to refs/heads/envoy-access-log by this push:
new 61fe241 Provide ALS receiver document.
61fe241 is described below
commit 61fe24191be382a85ea497c2545dc4725cd5d438
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Tue Apr 16 13:43:26 2019 +0800
Provide ALS receiver document.
---
docs/en/setup/README.md | 4 +++-
docs/en/setup/backend/backend-receivers.md | 4 +++-
docs/en/setup/envoy/als_setting.md | 17 +++++++++++++++++
.../envoy/{README.md => metrics_service_setting.md} | 0
.../receiver/envoy/EnvoyMetricReceiverConfig.java | 4 ++--
5 files changed, 25 insertions(+), 4 deletions(-)
diff --git a/docs/en/setup/README.md b/docs/en/setup/README.md
index 3d21c0c..8cee143 100644
--- a/docs/en/setup/README.md
+++ b/docs/en/setup/README.md
@@ -21,10 +21,12 @@ You could go to their project repositories to find out the releases and how to u
## Service Mesh
- Istio
- [SkyWalking on Istio](istio/README.md). Introduce how to use Istio Mixer bypass Adapter to work with SkyWalking.
+ - Envoy
+ - Use [ALS(access log service)](https://www.envoyproxy.io/docs/envoy/latest/api-v2/service/accesslog/v2/als.proto) to observe service mesh, without Mixer. Follow [document](envoy/als_setting.md) to open it.
## Proxy
- [Envoy Proxy](https://www.envoyproxy.io/)
- - [Sending metrics to Skywalking from Envoy](envoy/README.md). How to send metrics from Envoy to SkyWalking using [Metrics service](https://www.envoyproxy.io/docs/envoy/latest/api-v2/config/metrics/v2/metrics_service.proto.html).
+ - [Sending metrics to Skywalking from Envoy](envoy/metrics_service_setting.md). How to send metrics from Envoy to SkyWalking using [Metrics service](https://www.envoyproxy.io/docs/envoy/latest/api-v2/config/metrics/v2/metrics_service.proto.html).
## Setup backend
Follow [backend and UI setup document](backend/backend-ui-setup.md) to understand and config the backend for different
diff --git a/docs/en/setup/backend/backend-receivers.md b/docs/en/setup/backend/backend-receivers.md
index 3c5ea57..7e0ee3d 100644
--- a/docs/en/setup/backend/backend-receivers.md
+++ b/docs/en/setup/backend/backend-receivers.md
@@ -10,12 +10,14 @@ We have following receivers, and `default` implementors are provided in our Apac
1. **service-mesh**. gRPC services accept data from inbound mesh probes.
1. **receiver-jvm**. gRPC services accept JVM metric data.
1. **istio-telemetry**. Istio telemetry is from Istio official bypass adaptor, this receiver match its gRPC services.
-1. **envoy-metric**. Envoy `metrics_service` supported by this receiver. OAL script support all GAUGE type metrics.
+1. **envoy-metric**. Envoy `metrics_service` and `ALS(access log service)` supported by this receiver. OAL script support all GAUGE type metrics.
1. **receiver_zipkin**. See [details](#zipkin-receiver).
1. **receiver_jaeger**. See [details](#jaeger-receiver).
The sample settings of these receivers should be already in default `application.yml`, and also list here
```yaml
+receiver-sharing-server:
+ default:
receiver-register:
default:
receiver-trace:
diff --git a/docs/en/setup/envoy/als_setting.md b/docs/en/setup/envoy/als_setting.md
new file mode 100644
index 0000000..b57b608
--- /dev/null
+++ b/docs/en/setup/envoy/als_setting.md
@@ -0,0 +1,17 @@
+# Observe service mesh through ALS
+Envoy [ALS(access log service)](https://www.envoyproxy.io/docs/envoy/latest/api-v2/service/accesslog/v2/als.proto) provides
+fully logs about RPC routed, including HTTP and TCP.
+
+You need three steps to open ALS.
+1. Right now, Istio pilot hasn't supported to open ALS, so you have to change pilot codes.
+1. Open SkyWalking [envoy receiver](../backend/backend-receivers.md).
+1. Active ALS k8s-mesh analysis
+```yaml
+envoy-metric:
+ default:
+ alsHTTPAnalysis:
+ - k8s-mesh
+```
+
+Notice, only use this when using envoy under Istio controlled.
+Otherwise, you need to implement your own `ALSHTTPAnalysis` and register it to receiver.
\ No newline at end of file
diff --git a/docs/en/setup/envoy/README.md b/docs/en/setup/envoy/metrics_service_setting.md
similarity index 100%
rename from docs/en/setup/envoy/README.md
rename to docs/en/setup/envoy/metrics_service_setting.md
diff --git a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/EnvoyMetricReceiverConfig.java b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/EnvoyMetricReceiverConfig.java
index d1ec648..616fbf6 100644
--- a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/EnvoyMetricReceiverConfig.java
+++ b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/EnvoyMetricReceiverConfig.java
@@ -18,7 +18,7 @@
package org.apache.skywalking.oap.server.receiver.envoy;
-import java.util.List;
+import java.util.*;
import lombok.Getter;
import org.apache.skywalking.oap.server.library.module.ModuleConfig;
@@ -27,5 +27,5 @@ import org.apache.skywalking.oap.server.library.module.ModuleConfig;
*/
@Getter
public class EnvoyMetricReceiverConfig extends ModuleConfig {
- private List<String> alsHTTPAnalysis;
+ private List<String> alsHTTPAnalysis = new ArrayList<>();
}