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

[skywalking] branch als/polish created (now a3ab8a33)

This is an automated email from the ASF dual-hosted git repository.

kezhenxu94 pushed a change to branch als/polish
in repository https://gitbox.apache.org/repos/asf/skywalking.git.


      at a3ab8a33 Polish ALS

This branch includes the following new commits:

     new a3ab8a33 Polish ALS

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[skywalking] 01/01: Polish ALS

Posted by ke...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

kezhenxu94 pushed a commit to branch als/polish
in repository https://gitbox.apache.org/repos/asf/skywalking.git

commit a3ab8a3341be53bfdbc0342984096129c2b160ab
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Sat Jan 16 21:19:54 2021 +0800

    Polish ALS
---
 .../src/main/resources/application.yml             |  1 +
 .../envoy-metrics-receiver-plugin/pom.xml          |  5 ++
 .../server/receiver/envoy/ALSCounterCollector.java | 65 ++++++++++++++++++++++
 .../envoy/AccessLogServiceGRPCHandler.java         | 25 +++++++--
 .../receiver/envoy/EnvoyMetricReceiverConfig.java  |  5 ++
 .../envoy/EnvoyMetricReceiverProvider.java         | 10 ++--
 6 files changed, 103 insertions(+), 8 deletions(-)

diff --git a/oap-server/server-bootstrap/src/main/resources/application.yml b/oap-server/server-bootstrap/src/main/resources/application.yml
index 7af29a4..2a52634 100755
--- a/oap-server/server-bootstrap/src/main/resources/application.yml
+++ b/oap-server/server-bootstrap/src/main/resources/application.yml
@@ -266,6 +266,7 @@ envoy-metric:
   selector: ${SW_ENVOY_METRIC:default}
   default:
     acceptMetricsService: ${SW_ENVOY_METRIC_SERVICE:true}
+    enableALS: ${SW_ENABLE_ENVOY_ALS:true}
     alsHTTPAnalysis: ${SW_ENVOY_METRIC_ALS_HTTP_ANALYSIS:""}
     # `k8sServiceNameRule` allows you to customize the service name in ALS via Kubernetes metadata,
     # the available variables are `pod`, `service`, f.e., you can use `${service.metadata.name}-${pod.metadata.labels.version}`
diff --git a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/pom.xml b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/pom.xml
index c1caf8b..c5f019f 100644
--- a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/pom.xml
+++ b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/pom.xml
@@ -71,5 +71,10 @@
             <groupId>com.google.flatbuffers</groupId>
             <artifactId>flatbuffers-java</artifactId>
         </dependency>
+
+        <dependency>
+            <groupId>io.prometheus</groupId>
+            <artifactId>simpleclient</artifactId>
+        </dependency>
     </dependencies>
 </project>
diff --git a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/ALSCounterCollector.java b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/ALSCounterCollector.java
new file mode 100644
index 0000000..736d19c
--- /dev/null
+++ b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/ALSCounterCollector.java
@@ -0,0 +1,65 @@
+package org.apache.skywalking.oap.server.receiver.envoy;
+
+import com.google.common.cache.Cache;
+import com.google.common.cache.CacheBuilder;
+import com.google.common.collect.Lists;
+import io.prometheus.client.Collector;
+import io.prometheus.client.CounterMetricFamily;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.atomic.AtomicInteger;
+import lombok.AccessLevel;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * ALSCounterCollector intend to expose metrics with limit size.
+ */
+@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
+@Slf4j
+public class ALSCounterCollector extends Collector {
+
+    private final String name;
+    private final String help;
+    private final String[] labelNames;
+    private final Cache<String, CounterSample> cache;
+
+    static ALSCounterCollector newInstance(final String name, final String help, final String... labelNames) {
+        return new ALSCounterCollector(name, help, labelNames, CacheBuilder.newBuilder()
+            .maximumSize(1000)
+            .build());
+    }
+
+    void inc(final String key, final int number, final String... labels) {
+        try {
+            cache.get(key, () -> new CounterSample(key, labels)).value.addAndGet(number);
+        } catch (final ExecutionException e) {
+            log.error("Get metric cache error", e);
+        }
+    }
+
+    @Override public List<MetricFamilySamples> collect() {
+        List<MetricFamilySamples> mfs = new ArrayList<>();
+        CounterMetricFamily labeledCounter = new CounterMetricFamily(name, help, Arrays.asList(labelNames));
+        cache.asMap().values().forEach(c -> {
+            if (labelNames.length != (1 + c.labels.length)) {
+                log.warn("Labels count is incorrect {}, {}", labelNames, c.labels);
+                return;
+            }
+            labeledCounter.addMetric(Lists.asList(c.key, c.labels), c.value.doubleValue());
+        });
+        mfs.add(labeledCounter);
+        return mfs;
+    }
+
+    @RequiredArgsConstructor
+    private static class CounterSample {
+        private final String key;
+
+        private final String[] labels;
+
+        private final AtomicInteger value = new AtomicInteger();
+    }
+}
diff --git a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/AccessLogServiceGRPCHandler.java b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/AccessLogServiceGRPCHandler.java
index 4d47072..2b5e60e 100644
--- a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/AccessLogServiceGRPCHandler.java
+++ b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/AccessLogServiceGRPCHandler.java
@@ -18,14 +18,17 @@
 
 package org.apache.skywalking.oap.server.receiver.envoy;
 
+import com.google.protobuf.TextFormat;
 import io.envoyproxy.envoy.data.accesslog.v3.HTTPAccessLogEntry;
 import io.envoyproxy.envoy.service.accesslog.v2.AccessLogServiceGrpc;
 import io.envoyproxy.envoy.service.accesslog.v3.StreamAccessLogsMessage;
 import io.envoyproxy.envoy.service.accesslog.v3.StreamAccessLogsResponse;
 import io.grpc.stub.StreamObserver;
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
 import java.util.ServiceLoader;
+import java.util.Set;
 import org.apache.skywalking.aop.server.receiver.mesh.TelemetryDataDispatcher;
 import org.apache.skywalking.apm.network.servicemesh.v3.ServiceMeshMetric;
 import org.apache.skywalking.oap.server.library.module.ModuleManager;
@@ -48,25 +51,34 @@ public class AccessLogServiceGRPCHandler extends AccessLogServiceGrpc.AccessLogS
     private final CounterMetrics counter;
     private final HistogramMetrics histogram;
     private final CounterMetrics sourceDispatcherCounter;
+    private final ALSCounterCollector alsCounterCollector;
 
     public AccessLogServiceGRPCHandler(ModuleManager manager,
                                        EnvoyMetricReceiverConfig config) throws ModuleStartException {
         ServiceLoader<ALSHTTPAnalysis> alshttpAnalyses = ServiceLoader.load(ALSHTTPAnalysis.class);
         envoyHTTPAnalysisList = new ArrayList<>();
+        if (config.getAlsHTTPAnalysis().isEmpty()) {
+            throw new ModuleStartException("There is no any ALS analysis here");
+        }
+        Set<String> names = new HashSet<>(3);
         for (String httpAnalysisName : config.getAlsHTTPAnalysis()) {
             for (ALSHTTPAnalysis httpAnalysis : alshttpAnalyses) {
+                names.add(httpAnalysis.name());
                 if (httpAnalysisName.equals(httpAnalysis.name())) {
                     httpAnalysis.init(manager, config);
                     envoyHTTPAnalysisList.add(httpAnalysis);
                 }
             }
         }
+        if (envoyHTTPAnalysisList.isEmpty()) {
+            throw new ModuleStartException("Analysis name must be one of " + names);
+        }
 
         LOGGER.debug("envoy HTTP analysis: " + envoyHTTPAnalysisList);
 
         MetricsCreator metricCreator = manager.find(TelemetryModule.NAME).provider().getService(MetricsCreator.class);
         counter = metricCreator.createCounter(
-            "envoy_als_in_count", "The count of envoy ALS metric received", MetricsTag.EMPTY_KEY,
+            "envoy_als_total_count", "The total count of envoy ALS metric received", MetricsTag.EMPTY_KEY,
             MetricsTag.EMPTY_VALUE
         );
         histogram = metricCreator.createHistogramMetric(
@@ -77,6 +89,11 @@ public class AccessLogServiceGRPCHandler extends AccessLogServiceGrpc.AccessLogS
             "envoy_als_source_dispatch_count", "The count of envoy ALS metric received", MetricsTag.EMPTY_KEY,
             MetricsTag.EMPTY_VALUE
         );
+        alsCounterCollector = ALSCounterCollector.newInstance(
+            "envoy_als_in_count", "The count of envoy ALS received, its labels indicate where/which envoy it's from",
+            "id", "cluster"
+        );
+        alsCounterCollector.register();
     }
 
     @Override
@@ -106,9 +123,8 @@ public class AccessLogServiceGRPCHandler extends AccessLogServiceGrpc.AccessLogS
 
                     if (LOGGER.isDebugEnabled()) {
                         LOGGER.debug(
-                            "Messaged is identified from Envoy[{}], role[{}] in [{}]. Received msg {}", identifier
-                                .getNode()
-                                .getId(), role, logCase, message);
+                            "Messaged is identified from Envoy[{}], role[{}] in [{}]. Received msg {}",
+                            identifier.getNode().getId(), role, logCase, TextFormat.shortDebugString(message));
                     }
 
                     switch (logCase) {
@@ -129,6 +145,7 @@ public class AccessLogServiceGRPCHandler extends AccessLogServiceGrpc.AccessLogS
                             }
 
                             sourceDispatcherCounter.inc(sourceResult.size());
+                            alsCounterCollector.inc(identifier.getNode().getId(), sourceResult.size(), identifier.getNode().getCluster());
                             sourceResult.forEach(TelemetryDataDispatcher::process);
                             break;
                     }
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 fb029fb..12f671d 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
@@ -24,6 +24,7 @@ import java.util.Collections;
 import java.util.List;
 import java.util.stream.Collectors;
 import lombok.Getter;
+import lombok.Setter;
 import org.apache.skywalking.oap.meter.analyzer.prometheus.rule.Rule;
 import org.apache.skywalking.oap.meter.analyzer.prometheus.rule.Rules;
 import org.apache.skywalking.oap.server.library.module.ModuleConfig;
@@ -31,7 +32,11 @@ import org.apache.skywalking.oap.server.library.module.ModuleStartException;
 
 public class EnvoyMetricReceiverConfig extends ModuleConfig {
     @Getter
+    @Setter
     private boolean acceptMetricsService = false;
+    @Getter
+    @Setter
+    private boolean enableALS = true;
     private String alsHTTPAnalysis;
     @Getter
     private String k8sServiceNameRule;
diff --git a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/EnvoyMetricReceiverProvider.java b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/EnvoyMetricReceiverProvider.java
index 1e3d8c0..c9f1e58 100644
--- a/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/EnvoyMetricReceiverProvider.java
+++ b/oap-server/server-receiver-plugin/envoy-metrics-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/envoy/EnvoyMetricReceiverProvider.java
@@ -31,7 +31,7 @@ import org.apache.skywalking.oap.server.receiver.sharing.server.SharingServerMod
 import org.apache.skywalking.oap.server.telemetry.TelemetryModule;
 
 public class EnvoyMetricReceiverProvider extends ModuleProvider {
-    private final EnvoyMetricReceiverConfig config;
+    protected final EnvoyMetricReceiverConfig config;
 
     protected String fieldMappingFile = "metadata-service-mapping.yaml";
 
@@ -73,9 +73,11 @@ public class EnvoyMetricReceiverProvider extends ModuleProvider {
             service.addHandler(handler);
             service.addHandler(new MetricServiceGRPCHandlerV3(handler));
         }
-        final AccessLogServiceGRPCHandler handler = new AccessLogServiceGRPCHandler(getManager(), config);
-        service.addHandler(handler);
-        service.addHandler(new AccessLogServiceGRPCHandlerV3(handler));
+        if (config.isEnableALS()) {
+            final AccessLogServiceGRPCHandler handler = new AccessLogServiceGRPCHandler(getManager(), config);
+            service.addHandler(handler);
+            service.addHandler(new AccessLogServiceGRPCHandlerV3(handler));
+        }
     }
 
     @Override