[SCB-2897] add accesslog and requestlog for WebSocket

Author: yhs0092

common/common-access-log/src/main/java/org/apache/servicecomb/common/accessLog/ws/WebSocketAccessLogConfig.java

@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.servicecomb.common.accessLog.ws;
+
+import com.netflix.config.DynamicPropertyFactory;
+
+public class WebSocketAccessLogConfig {
+  private static final String BASE = "servicecomb.accesslog.ws.";
+
+  private static final String SERVER_BASE = BASE + "server.";
+
+  private static final String CLIENT_BASE = BASE + "client.";
+
+  private static final String SERVER_LOG_ENABLED = SERVER_BASE + "enabled";
+
+  private static final String CLIENT_LOG_ENABLED = CLIENT_BASE + "enabled";
+
+  private boolean serverLogEnabled;
+
+  private boolean clientLogEnabled;
+
+  public static final WebSocketAccessLogConfig INSTANCE = new WebSocketAccessLogConfig();
+
+  private WebSocketAccessLogConfig() {
+    clientLogEnabled = DynamicPropertyFactory
+        .getInstance().getBooleanProperty(CLIENT_LOG_ENABLED, false).get();
+    serverLogEnabled = DynamicPropertyFactory
+        .getInstance().getBooleanProperty(SERVER_LOG_ENABLED, false).get();
+  }
+
+  public boolean isServerLogEnabled() {
+    return serverLogEnabled;
+  }
+
+  public boolean isClientLogEnabled() {
+    return clientLogEnabled;
+  }
+}

common/common-access-log/src/main/java/org/apache/servicecomb/common/accessLog/ws/WebSocketAccessLogGenerator.java

@@ -0,0 +1,87 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.servicecomb.common.accessLog.ws;
+
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.Locale;
+import java.util.TimeZone;
+
+import org.apache.servicecomb.core.event.WebSocketActionEvent;
+
+/**
+ * Similar to {@link org.apache.servicecomb.common.accessLog.core.AccessLogGenerator},
+ * this is an access log generator for WebSocket protocol.
+ */
+public class WebSocketAccessLogGenerator {
+
+  public static final String DEFAULT_DATETIME_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
+
+  public static final Locale DEFAULT_LOCALE = Locale.US;
+
+  public static final TimeZone TIME_ZONE = TimeZone.getDefault();
+
+  private final ThreadLocal<SimpleDateFormat> datetimeFormatHolder = new ThreadLocal<>();
+
+  public String generateServerLog(WebSocketActionEvent actionEvent) {
+    return generateLog(actionEvent);
+  }
+
+  public String generateClientLog(WebSocketActionEvent actionEvent) {
+    return generateLog(actionEvent);
+  }
+
+  private String generateLog(WebSocketActionEvent actionEvent) {
+    return actionEvent.getInvocationType()
+        + "|"
+        + actionEvent.getOperationMeta().getMicroserviceQualifiedName()
+        + "|"
+        + formatTimestampToDateTimeStr(actionEvent.getActionStartTimestamp())
+        + "|"
+        + actionEvent.getTraceId()
+        + "|"
+        + actionEvent.getConnectionId()
+        + "|"
+        + actionEvent.getActionType()
+        + "|"
+        + (actionEvent.getActionStartTimestamp() - actionEvent.getScheduleStartTimestamp())
+        + "|"
+        + actionEvent.getActionTimeCostMillis()
+        + "|"
+        + actionEvent.getHandleThreadName()
+        + "|"
+        + actionEvent.getDataSize();
+  }
+
+  private String formatTimestampToDateTimeStr(long timestamp) {
+    return getDatetimeFormat()
+        .format(new Date(timestamp));
+  }
+
+  private SimpleDateFormat getDatetimeFormat() {
+    SimpleDateFormat dateFormat = datetimeFormatHolder.get();
+    if (null == dateFormat) {
+      dateFormat = new SimpleDateFormat(DEFAULT_DATETIME_PATTERN, DEFAULT_LOCALE);
+      dateFormat.setTimeZone(TIME_ZONE);
+
+      datetimeFormatHolder.set(dateFormat);
+    }
+
+    return dateFormat;
+  }
+}

common/common-access-log/src/main/java/org/apache/servicecomb/common/accessLog/ws/WebSocketAccessLogInitializer.java

@@ -0,0 +1,80 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.servicecomb.common.accessLog.ws;
+
+import org.apache.servicecomb.common.accessLog.AccessLogConfig;
+import org.apache.servicecomb.common.accessLog.AccessLogInitializer;
+import org.apache.servicecomb.core.event.WebSocketActionEvent;
+import org.apache.servicecomb.swagger.invocation.InvocationType;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.google.common.eventbus.AllowConcurrentEvents;
+import com.google.common.eventbus.EventBus;
+import com.google.common.eventbus.Subscribe;
+
+public class WebSocketAccessLogInitializer implements AccessLogInitializer {
+  private static final Logger ACCESS_LOG_LOGGER = LoggerFactory.getLogger("ws.accesslog");
+
+  private static final Logger REQUEST_LOG_LOGGER = LoggerFactory.getLogger("ws.requestlog");
+
+  private WebSocketAccessLogGenerator accessLogGenerator;
+
+  private boolean clientLogEnabled;
+
+  private boolean serverLogEnabled;
+
+  @Override
+  public void init(EventBus eventBus, AccessLogConfig accessLogConfig) {
+    WebSocketAccessLogConfig config = WebSocketAccessLogConfig.INSTANCE;
+    clientLogEnabled = config.isClientLogEnabled();
+    serverLogEnabled = config.isServerLogEnabled();
+    if (clientLogEnabled || serverLogEnabled) {
+      accessLogGenerator = new WebSocketAccessLogGenerator();
+      eventBus.register(this);
+    }
+  }
+
+  @Subscribe
+  @AllowConcurrentEvents
+  public void onRequestReceived(WebSocketActionEvent actionEvent) {
+    if (actionEvent == null) {
+      return;
+    }
+    InvocationType invocationType = actionEvent.getInvocationType();
+    if (invocationType == null) {
+      return;
+    }
+
+    switch (invocationType) {
+      case CONSUMER:
+        if (clientLogEnabled) {
+          REQUEST_LOG_LOGGER.info(accessLogGenerator.generateClientLog(actionEvent));
+        }
+        break;
+      case PRODUCER: {
+        if (serverLogEnabled) {
+          ACCESS_LOG_LOGGER.info(accessLogGenerator.generateServerLog(actionEvent));
+        }
+        break;
+      }
+      default:
+        throw new IllegalStateException("unexpected websocket invocation type: " + invocationType);
+    }
+  }
+}

common/common-access-log/src/main/resources/META-INF/services/org.apache.servicecomb.common.accessLog.AccessLogInitializer

@@ -17,3 +17,4 @@
 
 org.apache.servicecomb.common.accessLog.client.ClientDefaultInitializer
 org.apache.servicecomb.common.accessLog.server.ServerDefaultInitializer
+org.apache.servicecomb.common.accessLog.ws.WebSocketAccessLogInitializer