software.amazon.awssdk.metrics.MetricCategory Maven / Gradle / Ivy
/*
* Copyright 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://aws.amazon.com/apache2.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 software.amazon.awssdk.metrics;
import software.amazon.awssdk.annotations.SdkPublicApi;
/**
* A enum class representing the different types of metric categories in the SDK.
*
* A metric can be tagged with multiple categories. Clients can enable/disable metric collection
* at a {@link MetricCategory} level.
*/
@SdkPublicApi
public enum MetricCategory {
/**
* Metrics collected by the core SDK are classified under this category.
*/
CORE("Core"),
/**
* Metrics collected at the http client level are classified under this category.
*/
HTTP_CLIENT("HttpClient"),
/**
* Metrics specified by the customer should be classified under this category.
*/
CUSTOM("Custom"),
/**
* This is an umbrella category (provided for convenience) that records metrics belonging to every category
* defined in this enum. Clients who wish to collect lot of SDK metrics data should use this.
*
* Note: Enabling this option along with {@link MetricLevel#TRACE} is verbose and can be expensive based on the platform
* the metrics are uploaded to. Please make sure you need all this data before using this category.
*/
ALL("All");
private final String value;
MetricCategory(String value) {
this.value = value;
}
public String getValue() {
return value;
}
/**
* Create a {@link MetricCategory} from the given String value. This method is case insensitive.
*
* @param value the value to create the {@link MetricCategory} from
* @return A {@link MetricCategory} if the given {@link #value} matches one of the enum values.
* Otherwise throws {@link IllegalArgumentException}
*/
public static MetricCategory fromString(String value) {
for (MetricCategory mc : MetricCategory.values()) {
if (mc.value.equalsIgnoreCase(value)) {
return mc;
}
}
throw new IllegalArgumentException("MetricCategory cannot be created from value: " + value);
}
}