RANGER-3905: Ranger metrics on audit throughput for each of the Ranger Service plugins

agents-audit/core/pom.xml

@@ -47,6 +47,15 @@
             <artifactId>jackson-databind</artifactId>
             <version>${fasterxml.jackson.databind.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.jaxrs</groupId>
+            <artifactId>jackson-jaxrs-json-provider</artifactId>
+            <version>${fasterxml.jackson.databind.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.code.gson</groupId>
+            <artifactId>gson</artifactId>
+        </dependency>
         <dependency>
             <groupId>commons-collections</groupId>
             <artifactId>commons-collections</artifactId>
@@ -88,6 +97,11 @@
             <artifactId>ranger-plugins-cred</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.core</groupId>
+            <artifactId>jersey-client</artifactId>
+            <version>${jersey-client.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>

agents-audit/core/src/main/java/org/apache/ranger/audit/client/AbstractRangerAuditMetricRESTClient.java

@@ -0,0 +1,48 @@
+/*
+ * 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.ranger.audit.client;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import org.apache.hadoop.conf.Configuration;
+import org.apache.ranger.audit.model.RangerAuditMetrics;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public abstract class AbstractRangerAuditMetricRESTClient {
+    private static final Logger LOG = LoggerFactory.getLogger(AbstractRangerAuditMetricRESTClient.class);
+    public               Gson   gson;
+
+    public void init(String url, String sslConfigFileName, Configuration config) {
+        Gson gson = null;
+
+        try {
+            gson = new GsonBuilder().setDateFormat("yyyyMMdd-HH:mm:ss.SSS-Z").create();
+        } catch (Throwable excp) {
+            LOG.error("AbstractRangerAdminClient: failed to create GsonBuilder object", excp);
+        }
+
+        this.gson = gson;
+    }
+
+    public RangerAuditMetrics createAuditMetrics(RangerAuditMetrics request) throws Exception {
+        return null;
+    }
+}

agents-audit/core/src/main/java/org/apache/ranger/audit/client/RESTResponse.java

@@ -0,0 +1,208 @@
+/**
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.ranger.audit.client;
+
+import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import org.apache.ranger.audit.utils.JsonUtils;
+import org.apache.ranger.audit.utils.StringUtil;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.ws.rs.core.Response;
+
+import java.util.List;
+
+@JsonAutoDetect(getterVisibility = Visibility.NONE, setterVisibility = Visibility.NONE, fieldVisibility = Visibility.ANY)
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class RESTResponse implements java.io.Serializable {
+    /**
+     * values for statusCode
+     */
+    public static final int STATUS_SUCCESS         = 0;
+    public static final int STATUS_ERROR           = 1;
+    public static final int STATUS_VALIDATION      = 2;
+    public static final int STATUS_WARN            = 3;
+    public static final int STATUS_INFO            = 4;
+    public static final int STATUS_PARTIAL_SUCCESS = 5;
+    public static final int ResponseStatus_MAX     = 5;
+    private static final Logger LOG = LoggerFactory.getLogger(RESTResponse.class);
+    private int           httpStatusCode;
+    private int           statusCode;
+    private String        msgDesc;
+    private List<Message> messageList;
+
+    public static RESTResponse fromClientResponse(Response response) {
+        RESTResponse ret = null;
+
+        String jsonString = response == null ? null : response.readEntity(String.class);
+        int    httpStatus = response == null ? 0 : response.getStatus();
+
+        if (!StringUtil.isEmpty(jsonString)) {
+            ret = RESTResponse.fromJson(jsonString);
+        }
+
+        if (ret == null) {
+            ret = new RESTResponse();
+        }
+
+        ret.setHttpStatusCode(httpStatus);
+
+        return ret;
+    }
+
+    public static RESTResponse fromJson(String jsonString) {
+        try {
+            return JsonUtils.jsonToObj(jsonString, RESTResponse.class);
+        } catch (Exception e) {
+            LOG.debug("fromJson({}) failed", jsonString, e);
+        }
+
+        return null;
+    }
+
+    public int getHttpStatusCode() {
+        return httpStatusCode;
+    }
+
+    public void setHttpStatusCode(int httpStatusCode) {
+        this.httpStatusCode = httpStatusCode;
+    }
+
+    public int getStatusCode() {
+        return statusCode;
+    }
+
+    public void setStatusCode(int statusCode) {
+        this.statusCode = statusCode;
+    }
+
+    public String getMsgDesc() {
+        return msgDesc;
+    }
+
+    public void setMsgDesc(String msgDesc) {
+        this.msgDesc = msgDesc;
+    }
+
+    public List<Message> getMessageList() {
+        return messageList;
+    }
+
+    public void setMessageList(List<Message> messageList) {
+        this.messageList = messageList;
+    }
+
+    public String getMessage() {
+        return StringUtil.isEmpty(msgDesc) ? ("HTTP " + httpStatusCode) : msgDesc;
+    }
+
+    public String toJson() {
+        try {
+            return JsonUtils.objToJson(this);
+        } catch (Exception e) {
+            LOG.debug("toJson() failed", e);
+        }
+
+        return "";
+    }
+
+    @Override
+    public String toString() {
+        return toJson();
+    }
+
+    @JsonAutoDetect(getterVisibility = Visibility.NONE, setterVisibility = Visibility.NONE, fieldVisibility = Visibility.ANY)
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class Message implements java.io.Serializable {
+        private String name;
+        private String rbKey;
+        private String message;
+        private Long   objectId;
+        private String fieldName;
+
+        public static RESTResponse fromJson(String jsonString) {
+            try {
+                return JsonUtils.jsonToObj(jsonString, RESTResponse.class);
+            } catch (Exception e) {
+                LOG.debug("fromJson('{}') failed", jsonString, e);
+            }
+
+            return null;
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        public void setName(String name) {
+            this.name = name;
+        }
+
+        public String getRbKey() {
+            return rbKey;
+        }
+
+        public void setRbKey(String rbKey) {
+            this.rbKey = rbKey;
+        }
+
+        public String getMessage() {
+            return message;
+        }
+
+        public void setMessage(String message) {
+            this.message = message;
+        }
+
+        public Long getObjectId() {
+            return objectId;
+        }
+
+        public void setObjectId(Long objectId) {
+            this.objectId = objectId;
+        }
+
+        public String getFieldName() {
+            return fieldName;
+        }
+
+        public void setFieldName(String fieldName) {
+            this.fieldName = fieldName;
+        }
+
+        public String toJson() {
+            try {
+                return JsonUtils.objToJson(this);
+            } catch (Exception e) {
+                LOG.debug("toJson() failed", e);
+            }
+
+            return "";
+        }
+
+        @Override
+        public String toString() {
+            return toJson();
+        }
+    }
+}