Reporting backend metrics

reports-scheduler/build.gradle

@@ -127,6 +127,9 @@ dependencies {
     compile "${group}:common-utils:${opendistroVersion}.2"
     compileOnly "${group}:opendistro-job-scheduler-spi:${opendistroVersion}.0"
     compile group: 'com.google.guava', name: 'guava', version: '15.0'
+    compile "org.json:json:20180813"
+    compile group: 'com.github.wnameless', name: 'json-flattener', version: '0.1.0'
+
     testImplementation(
             'org.assertj:assertj-core:3.16.1',
             'org.junit.jupiter:junit-jupiter-api:5.6.2'

reports-scheduler/gradle.properties

@@ -1,5 +1,5 @@
 #
-#   Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#   Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

reports-scheduler/src/main/java/com/amazon/opendistroforelasticsearch/reportsscheduler/metrics/BasicCounter.java

@@ -0,0 +1,55 @@
+/*
+ *   Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License").
+ *   You may not use this file except in compliance with the License.
+ *   A copy of the License is located at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file. This file 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 com.amazon.opendistroforelasticsearch.reportsscheduler.metrics;
+
+import java.util.concurrent.atomic.LongAdder;
+
+/**
+ * Counter to hold accumulative value over time.
+ */
+public class BasicCounter implements Counter<Long> {
+    private final LongAdder count = new LongAdder();
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void increment() {
+        count.increment();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void add(long n) {
+        count.add(n);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Long getValue() {
+        return count.longValue();
+    }
+
+    /** Reset the count value to zero*/
+    @Override
+    public void reset() {
+        count.reset();
+    }
+}

reports-scheduler/src/main/java/com/amazon/opendistroforelasticsearch/reportsscheduler/metrics/Counter.java

@@ -0,0 +1,34 @@
+/*
+ *   Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License").
+ *   You may not use this file except in compliance with the License.
+ *   A copy of the License is located at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file. This file 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 com.amazon.opendistroforelasticsearch.reportsscheduler.metrics;
+
+/**
+ * Defines a generic counter.
+ */
+public interface Counter<T> {
+
+    /** Increments the count value by 1 unit*/
+    void increment();
+
+    /** Increments the count value by n unit*/
+    void add(long n);
+
+    /** Retrieves the count value accumulated upto this call*/
+    T getValue();
+
+    /** Resets the count value to initial value when Counter is created*/
+    void reset();
+}

reports-scheduler/src/main/java/com/amazon/opendistroforelasticsearch/reportsscheduler/metrics/Metrics.java

@@ -0,0 +1,197 @@
+/*
+ * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file 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 com.amazon.opendistroforelasticsearch.reportsscheduler.metrics;
+
+import com.github.wnameless.json.unflattener.JsonUnflattener;
+import org.json.JSONObject;
+
+/**
+ * Enum to hold all the metrics that need to be logged into _opendistro/_reports/l_ocal/stats API
+ */
+public enum Metrics {
+
+    REQUEST_TOTAL("request_total", new BasicCounter()),
+    REQUEST_INTERVAL_COUNT("request_count", new RollingCounter()),
+    REQUEST_SUCCESS("success_count", new RollingCounter()),
+    REQUEST_USER_ERROR("failed_request_count_user_error", new RollingCounter()),
+    REQUEST_SYSTEM_ERROR("failed_request_count_system_error", new RollingCounter()),
+
+    /**
+     * Exceptions from:
+     * @see com.amazon.opendistroforelasticsearch.reportsscheduler.action.PluginBaseAction
+     */
+    REPORT_EXCEPTIONS_ES_STATUS_EXCEPTION("exception.es_status", new RollingCounter()),
+    REPORT_EXCEPTIONS_ES_SECURITY_EXCEPTION("exception.es_security", new RollingCounter()),
+    REPORT_EXCEPTIONS_VERSION_CONFLICT_ENGINE_EXCEPTION("exception.version_conflict_engine", new RollingCounter()),
+    REPORT_EXCEPTIONS_INDEX_NOT_FOUND_EXCEPTION("exception.index_not_found", new RollingCounter()),
+    REPORT_EXCEPTIONS_INVALID_INDEX_NAME_EXCEPTION("exception.invalid_index_name", new RollingCounter()),
+    REPORT_EXCEPTIONS_ILLEGAL_ARGUMENT_EXCEPTION("exception.illegal_argument", new RollingCounter()),
+    REPORT_EXCEPTIONS_ILLEGAL_STATE_EXCEPTION("exception.illegal_state", new RollingCounter()),
+    REPORT_EXCEPTIONS_IO_EXCEPTION("exception.io", new RollingCounter()),
+    REPORT_EXCEPTIONS_INTERNAL_SERVER_ERROR("exception.internal_server_error", new RollingCounter()),
+
+    // ==== Per REST endpoint metrics ==== //
+
+    // POST _opendistro/_reports/definition
+    REPORT_DEFINITION_CREATE_TOTAL("report_definition.create.total", new BasicCounter()),
+    REPORT_DEFINITION_CREATE_INTERVAL_COUNT("report_definition.create.count", new RollingCounter()),
+    REPORT_DEFINITION_CREATE_USER_ERROR("report_definition.create.user_error", new RollingCounter()),
+    REPORT_DEFINITION_CREATE_SYSTEM_ERROR("report_definition.create.system_error", new RollingCounter()),
+
+
+    // PUT _opendistro/_reports/definition/{reportDefinitionId}
+    REPORT_DEFINITION_UPDATE_TOTAL("report_definition.update.total", new BasicCounter()),
+    REPORT_DEFINITION_UPDATE_INTERVAL_COUNT("report_definition.update.count", new RollingCounter()),
+    REPORT_DEFINITION_UPDATE_USER_ERROR_MISSING_REPORT_DEF_DETAILS(
+        "report_definition.update.user_error.missing_report_def_details", new RollingCounter()),
+    REPORT_DEFINITION_UPDATE_USER_ERROR_INVALID_REPORT_DEF_ID(
+        "report_definition.update.user_error.invalid_report_def_id", new RollingCounter()),
+    REPORT_DEFINITION_UPDATE_USER_ERROR_INVALID_REPORT_DEF(
+        "report_definition.update.user_error.invalid_report_definition", new RollingCounter()),
+    REPORT_DEFINITION_UPDATE_SYSTEM_ERROR("report_definition.update.system_error", new RollingCounter()),
+
+
+    // GET _opendistro/_reports/definition/{reportDefinitionId}
+    REPORT_DEFINITION_INFO_TOTAL("report_definition.info.total", new BasicCounter()),
+    REPORT_DEFINITION_INFO_INTERVAL_COUNT("report_definition.info.count", new RollingCounter()),
+    REPORT_DEFINITION_INFO_USER_ERROR_MISSING_REPORT_DEF_DETAILS(
+        "report_definition.info.user_error.missing_report_def_details", new RollingCounter()),
+    REPORT_DEFINITION_INFO_USER_ERROR_INVALID_REPORT_DEF_ID(
+        "report_definition.info.user_error.invalid_report_def_id", new RollingCounter()),
+    REPORT_DEFINITION_INFO_SYSTEM_ERROR("report_definition.info.system_error", new RollingCounter()),
+
+
+    // DELETE _opendistro/_reports/definition/{reportDefinitionId}
+    REPORT_DEFINITION_DELETE_TOTAL("report_definition.delete.total", new BasicCounter()),
+    REPORT_DEFINITION_DELETE_INTERVAL_COUNT("report_definition.delete.count", new RollingCounter()),
+    REPORT_DEFINITION_DELETE_USER_ERROR_MISSING_REPORT_DEF_DETAILS(
+        "report_definition.delete.user_error.missing_report_def_details", new RollingCounter()),
+    REPORT_DEFINITION_DELETE_USER_ERROR_INVALID_REPORT_DEF_ID(
+        "report_definition.delete.user_error.invalid_report_def_id", new RollingCounter()),
+    REPORT_DEFINITION_DELETE_SYSTEM_ERROR("report_definition.delete.system_error", new RollingCounter()),
+
+
+    // GET _opendistro/_reports/definitions/[?[fromIndex=0]&[maxItems=100]]
+    REPORT_DEFINITION_LIST_TOTAL("report_definition.list.total",new BasicCounter()),
+    REPORT_DEFINITION_LIST_INTERVAL_COUNT("report_definition.list.count", new RollingCounter()),
+    REPORT_DEFINITION_LIST_USER_ERROR_INVALID_FROM_INDEX(
+        "report_definition.list.user_error.invalid_from_index", new RollingCounter()),
+    REPORT_DEFINITION_LIST_SYSTEM_ERROR("report_definition.list.system_error", new RollingCounter()),
+
+
+    // POST _opendistro/_reports/instance/{reportInstanceId}
+    REPORT_INSTANCE_UPDATE_TOTAL("report_instance.update.total", new BasicCounter()),
+    REPORT_INSTANCE_UPDATE_INTERVAL_COUNT("report_instance.update.count", new RollingCounter()),
+    REPORT_INSTANCE_UPDATE_USER_ERROR_MISSING_REPORT_INSTANCE(
+        "report_instance.update.user_error.missing_report_instance", new RollingCounter()),
+    REPORT_INSTANCE_UPDATE_USER_ERROR_INVALID_STATUS(
+        "report_instance.update.user_error.invalid_status", new RollingCounter()),
+    REPORT_INSTANCE_UPDATE_USER_ERROR_INVALID_REPORT_ID(
+        "report_instance.update.user_error.invalid_report_id", new RollingCounter()),
+    REPORT_INSTANCE_UPDATE_SYSTEM_ERROR("report_instance.update.system_error", new RollingCounter()),
+
+
+    // GET _opendistro/_reports/instance/{reportInstanceId}
+    REPORT_INSTANCE_INFO_TOTAL("report_instance.info.total", new BasicCounter()),
+    REPORT_INSTANCE_INFO_INTERVAL_COUNT("report_instance.info.count", new RollingCounter()),
+    REPORT_INSTANCE_INFO_USER_ERROR_MISSING_REPORT_INSTANCE(
+        "report_instance.info.user_error.missing_report_instance",
+        new RollingCounter()
+    ),
+    REPORT_INSTANCE_INFO_USER_ERROR_INVALID_REPORT_ID(
+        "report_instance.info.user_error.invalid_report_id", new RollingCounter()),
+    REPORT_INSTANCE_INFO_SYSTEM_ERROR("report_instance.info.system_error", new RollingCounter()),
+
+
+    // GET _opendistro/_reports/instances
+    REPORT_INSTANCE_LIST_TOTAL("report_instance.list.total", new BasicCounter()),
+    REPORT_INSTANCE_LIST_INTERVAL_COUNT("report_instance.list.count", new RollingCounter()),
+    REPORT_INSTANCE_LIST_USER_ERROR_INVALID_FROM_INDEX(
+        "report_instance.list.user_error.invalid_from_index", new RollingCounter()),
+    REPORT_INSTANCE_LIST_SYSTEM_ERROR("report_instance.list.system_error", new RollingCounter()),
+
+
+    // PUT _opendistro/_reports/on_demand
+    REPORT_FROM_DEFINITION_TOTAL("on_demand.create.total", new BasicCounter()),
+    REPORT_FROM_DEFINITION_INTERVAL_COUNT("on_demand.create.count", new RollingCounter()),
+    REPORT_FROM_DEFINITION_USER_ERROR_INVALID_BEGIN_TIME(
+        "on_demand.create.user_error.invalid_begin_time", new RollingCounter()),
+    REPORT_FROM_DEFINITION_USER_ERROR_INVALID_END_TIME(
+        "on_demand.create.user_error.invalid_end_time", new RollingCounter()),
+    REPORT_FROM_DEFINITION_USER_ERROR_INVALID_STATUS(
+        "on_demand.create.user_error.invalid_status", new RollingCounter()),
+    REPORT_FROM_DEFINITION_SYSTEM_ERROR("on_demand.create.system_error", new RollingCounter()),
+
+
+    // POST _opendistro/_reports/on_demand/{reportDefinitionId}
+    REPORT_FROM_DEFINITION_ID_TOTAL("on_demand_from_definition.create.total", new BasicCounter()),
+    REPORT_FROM_DEFINITION_ID_INTERVAL_COUNT("on_demand_from_definition.create.count", new RollingCounter()),
+    REPORT_FROM_DEFINITION_ID_USER_ERROR_INVALID_REPORT_DEF_ID(
+        "on_demand_from_definition.create.user_error.invalid_report_def_id", new RollingCounter()),
+    REPORT_FROM_DEFINITION_ID_SYSTEM_ERROR("on_demand_from_definition.create.system_error", new RollingCounter()),
+
+
+    REPORT_SECURITY_PERMISSION_ERROR("es_security_permission_error",  new RollingCounter()),
+    REPORT_PERMISSION_USER_ERROR("permission_user_error",  new RollingCounter());
+
+    private final String name;
+    private final Counter<?> counter;
+
+    Metrics(String name, Counter<?> counter) {
+        this.name = name;
+        this.counter = counter;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public Counter<?> getCounter() {
+        return counter;
+    }
+
+    private static final Metrics[] values = values();
+
+    /**
+     * Converts the enum metric values to JSON string
+     */
+    public static String collectToJSON() {
+        JSONObject metricsJSONObject = new JSONObject();
+        for (Metrics metric: values) {
+            metricsJSONObject.put(metric.name, metric.counter.getValue());
+        }
+        return metricsJSONObject.toString();
+    }
+
+    /**
+     * Unflattens the JSON to nested JSON for easy readability and parsing
+     * The metric name is unflattened in the output JSON on the period '.' delimiter
+     *
+     * For ex:  { "a.b.c_d" : 2 } becomes
+     *{
+     *   "a" : {
+     *     "b" : {
+     *       "c_d" : 2
+     *     }
+     *   }
+     * }
+     */
+
+    public static String collectToFlattenedJSON() {
+        return JsonUnflattener.unflatten(collectToJSON());
+    }
+}