1 /*
2  * Copyright 2010-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  *  http://aws.amazon.com/apache2.0
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 package com.amazonaws.metrics;
16
17 /**
18  * A service provider interface that can be used to implement an AWS SDK
19  * general purpose metric collector.
20  */
21 public abstract class ServiceMetricCollector {
22     public static interface Factory {
23         /**
24          * Returns an instance of the collector; or null if if failed to create
25          * one.
26          */
27         public ServiceMetricCollector getServiceMetricCollector();
28     }
29     /**
30      * Collects metrics on the number of bytes written or read and the respective
31      * duration.
32      */
33     public abstract void collectByteThroughput(ByteThroughputProvider provider);
34     /**
35      * Collects metrics for non-request specific latencies.
36      */
37     public abstract void collectLatency(ServiceLatencyProvider provider);
38
39     public boolean isEnabled() { return true; }
40     /** A convenient instance of a no-op service metric collector. */
41     public static final ServiceMetricCollector NONE = new ServiceMetricCollector() {
42         @Override public void collectByteThroughput(ByteThroughputProvider provider) {}
43         @Override public void collectLatency(ServiceLatencyProvider provider) {}
44         @Override public boolean isEnabled() { return false; }
45     };
46 }
47