com.amazonaws.athena.connectors.cloudwatch.metrics.tables.MetricsTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of athena-cloudwatch-metrics Show documentation
There is a newer version: 2024.46.1
Show newest version
/*-
 * #%L
 * athena-cloudwatch-metrics
 * %%
 * Copyright (C) 2019 Amazon Web Services
 * %%
 * Licensed 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.
 * #L%
 */
package com.amazonaws.athena.connectors.cloudwatch.metrics.tables;

import com.amazonaws.athena.connector.lambda.data.FieldBuilder;
import com.amazonaws.athena.connector.lambda.data.SchemaBuilder;
import org.apache.arrow.vector.types.Types;
import org.apache.arrow.vector.types.pojo.Schema;

import java.util.Collections;
import java.util.Set;

/**
 * Defines the metadata associated with our static metrics table.
 * 
 * This table contains the available metrics as uniquely defined by a triple of namespace, set, name.
 * More specifically, this table contains the following columns.
 * * **namespace** - A VARCHAR containing the namespace.
 * * **metric_name** - A VARCHAR containing the metric name.
 * * **dimensions** - A LIST of STRUCTS comprised of dim_name (VARCHAR) and dim_value (VARCHAR).
 * * **statistic** - A List of VARCH statistics (e.g. p90, AVERAGE, etc..) avialable for the metric.
 */
public class MetricsTable
        extends Table
{
    private final Schema schema;
    private final String name;

    public MetricsTable()
    {
        schema = new SchemaBuilder().newBuilder()
                .addStringField(NAMESPACE_FIELD)
                .addStringField(METRIC_NAME_FIELD)
                .addField(FieldBuilder.newBuilder(DIMENSIONS_FIELD, Types.MinorType.LIST.getType())
                        .addField(FieldBuilder.newBuilder(DIMENSIONS_FIELD, Types.MinorType.STRUCT.getType())
                                .addStringField(DIMENSION_NAME_FIELD)
                                .addStringField(DIMENSION_VALUE_FIELD)
                                .build())
                        .build())
                .addStringField(DIMENSION_NAME_FIELD)
                .addStringField(DIMENSION_VALUE_FIELD)
                .addListField(STATISTIC_FIELD, Types.MinorType.VARCHAR.getType())
                .addMetadata(NAMESPACE_FIELD, "Metric namespace")
                .addMetadata(METRIC_NAME_FIELD, "Metric name")
                .addMetadata(STATISTIC_FIELD, "List of statistics available for this metric (e.g. Maximum, Minimum, Average, Sample Count)")
                .addMetadata(DIMENSIONS_FIELD, "Array of Dimensions for the given metric.")
                .addMetadata(DIMENSION_NAME_FIELD, "Shortcut field that flattens dimension to allow easier filtering for metrics that contain the dimension name. This field is left blank unless used in the where clause.")
                .addMetadata(DIMENSION_VALUE_FIELD, "Shortcut field that flattens  dimension to allow easier filtering for metrics that contain the dimension value. This field is left blank unless used in the where clause.")
                .build();

        name = "metrics";
    }

    @Override
    public String getName()
    {
        return name;
    }

    @Override
    public Schema getSchema()
    {
        return schema;
    }

    @Override
    public Set getPartitionColumns()
    {
        return Collections.emptySet();
    }
}