Add const and utils for aws container insight (#3211)

Add constants and utils functions for aws container insights
* define constants for all metrics
* define units for the metrics
* add utils functions to convert metrics to OpenTelemetry metrics

This PR is a part of our efforts to migrate the [code for aws container insights](https://github.com/aws-observability/aws-otel-collector/tree/container-insight-backup/internal) to upstream. More PRs will come along the way. 

**Link to tracking Issue:**
#2307

**Testing:** 
Unit tests

internal/aws/containerinsight/Makefile

@@ -0,0 +1 @@
+include ../../../Makefile.Common

internal/aws/containerinsight/const.go

@@ -0,0 +1,212 @@
+// Copyright 2020, OpenTelemetry Authors
+//
+// 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.
+package containerinsight
+
+import (
+	"strings"
+	"time"
+)
+
+//define metric names, attribute names, metric types, and units for both EKS and ECS Container Insights
+const (
+	GoPSUtilProcDirEnv = "HOST_PROC"
+
+	//We assume 50 micro-seconds is the minimal gap between two collected data sample to be valid to calculate delta
+	MinTimeDiff = 50 * time.Microsecond
+
+	//Attribute names
+	InstanceID              = "InstanceId"
+	InstanceType            = "InstanceType"
+	ClusterNameKey          = "ClusterName"
+	AutoScalingGroupNameKey = "AutoScalingGroupName"
+	NodeNameKey             = "NodeName"
+	Version                 = "Version"
+	DiskDev                 = "device"
+	EbsVolumeID             = "ebs_volume_id" //used by kubernetes cluster as persistent volume
+	HostEbsVolumeID         = "EBSVolumeId"   //used by host filesystem
+	FSType                  = "fstype"
+	MetricType              = "Type"
+	SourcesKey              = "Sources"
+	Timestamp               = "Timestamp"
+
+	//The following constants are used for metric name construction
+	CPUTotal                   = "cpu_usage_total"
+	CPUUser                    = "cpu_usage_user"
+	CPUSystem                  = "cpu_usage_system"
+	CPULimit                   = "cpu_limit"
+	CPUUtilization             = "cpu_utilization"
+	CPURequest                 = "cpu_request"
+	CPUReservedCapacity        = "cpu_reserved_capacity"
+	CPUUtilizationOverPodLimit = "cpu_utilization_over_pod_limit"
+
+	MemUsage                   = "memory_usage"
+	MemCache                   = "memory_cache"
+	MemRss                     = "memory_rss"
+	MemMaxusage                = "memory_max_usage"
+	MemSwap                    = "memory_swap"
+	MemFailcnt                 = "memory_failcnt"
+	MemMappedfile              = "memory_mapped_file"
+	MemWorkingset              = "memory_working_set"
+	MemPgfault                 = "memory_pgfault"
+	MemPgmajfault              = "memory_pgmajfault"
+	MemHierarchicalPgfault     = "memory_hierarchical_pgfault"
+	MemHierarchicalPgmajfault  = "memory_hierarchical_pgmajfault"
+	MemLimit                   = "memory_limit"
+	MemRequest                 = "memory_request"
+	MemUtilization             = "memory_utilization"
+	MemReservedCapacity        = "memory_reserved_capacity"
+	MemUtilizationOverPodLimit = "memory_utilization_over_pod_limit"
+
+	NetIfce       = "interface"
+	NetRxBytes    = "network_rx_bytes"
+	NetRxPackets  = "network_rx_packets"
+	NetRxDropped  = "network_rx_dropped"
+	NetRxErrors   = "network_rx_errors"
+	NetTxBytes    = "network_tx_bytes"
+	NetTxPackets  = "network_tx_packets"
+	NetTxDropped  = "network_tx_dropped"
+	NetTxErrors   = "network_tx_errors"
+	NetTotalBytes = "network_total_bytes"
+
+	FSUsage       = "filesystem_usage"
+	FSCapacity    = "filesystem_capacity"
+	FSAvailable   = "filesystem_available"
+	FSInodes      = "filesystem_inodes"
+	FSInodesfree  = "filesystem_inodes_free"
+	FSUtilization = "filesystem_utilization"
+
+	RunningPodCount       = "number_of_running_pods"
+	RunningContainerCount = "number_of_running_containers"
+	ContainerCount        = "number_of_containers"
+	NodeCount             = "node_count"
+	FailedNodeCount       = "failed_node_count"
+	ContainerRestartCount = "number_of_container_restarts"
+	RunningTaskCount      = "number_of_running_tasks"
+
+	DiskIOServiceBytesPrefix = "diskio_io_service_bytes_"
+	DiskIOServicedPrefix     = "diskio_io_serviced_"
+	DiskIOAsync              = "Async"
+	DiskIORead               = "Read"
+	DiskIOSync               = "Sync"
+	DiskIOWrite              = "Write"
+	DiskIOTotal              = "Total"
+
+	//Define the metric types
+	TypeCluster          = "Cluster"
+	TypeClusterService   = "ClusterService"
+	TypeClusterNamespace = "ClusterNamespace"
+	TypeService          = "Service"
+	TypeInstance         = "Instance" //mean EC2 Instance in ECS
+	TypeNode             = "Node"     //mean EC2 Instance in EKS
+	TypeInstanceFS       = "InstanceFS"
+	TypeNodeFS           = "NodeFS"
+	TypeInstanceNet      = "InstanceNet"
+	TypeNodeNet          = "NodeNet"
+	TypeInstanceDiskIO   = "InstanceDiskIO"
+	TypeNodeDiskIO       = "NodeDiskIO"
+	TypePod              = "Pod"
+	TypePodNet           = "PodNet"
+	TypeContainer        = "Container"
+	TypeContainerFS      = "ContainerFS"
+	TypeContainerDiskIO  = "ContainerDiskIO"
+
+	//unit
+	UnitBytes       = "Bytes"
+	UnitMegaBytes   = "Megabytes"
+	UnitNanoSecond  = "Nanoseconds"
+	UnitBytesPerSec = "Bytes/Second"
+	UnitCount       = "Count"
+	UnitCountPerSec = "Count/Second"
+	UnitVCPU        = "vCPU"
+	UnitPercent     = "Percent"
+)
+
+var metricToUnitMap map[string]string
+
+func init() {
+	metricToUnitMap = map[string]string{
+		//cpu metrics
+		//The following metrics are reported in unit of millicores, but cloudwatch doesn't support it
+		// CPUTotal
+		// CPUUser
+		// CPUSystem
+		// CPULimit
+		// CPURequest
+		CPUUtilization:             UnitPercent,
+		CPUReservedCapacity:        UnitPercent,
+		CPUUtilizationOverPodLimit: UnitPercent,
+
+		//memory metrics
+		MemUsage:                   UnitBytes,
+		MemCache:                   UnitBytes,
+		MemRss:                     UnitBytes,
+		MemMaxusage:                UnitBytes,
+		MemSwap:                    UnitBytes,
+		MemFailcnt:                 UnitCount,
+		MemMappedfile:              UnitBytes,
+		MemWorkingset:              UnitBytes,
+		MemRequest:                 UnitBytes,
+		MemLimit:                   UnitBytes,
+		MemUtilization:             UnitPercent,
+		MemReservedCapacity:        UnitPercent,
+		MemUtilizationOverPodLimit: UnitPercent,
+
+		MemPgfault:                UnitCountPerSec,
+		MemPgmajfault:             UnitCountPerSec,
+		MemHierarchicalPgfault:    UnitCountPerSec,
+		MemHierarchicalPgmajfault: UnitCountPerSec,
+
+		//disk io metrics
+		strings.ToLower(DiskIOServiceBytesPrefix + DiskIOAsync): UnitBytesPerSec,
+		strings.ToLower(DiskIOServiceBytesPrefix + DiskIORead):  UnitBytesPerSec,
+		strings.ToLower(DiskIOServiceBytesPrefix + DiskIOSync):  UnitBytesPerSec,
+		strings.ToLower(DiskIOServiceBytesPrefix + DiskIOWrite): UnitBytesPerSec,
+		strings.ToLower(DiskIOServiceBytesPrefix + DiskIOTotal): UnitBytesPerSec,
+		strings.ToLower(DiskIOServicedPrefix + DiskIOAsync):     UnitCountPerSec,
+		strings.ToLower(DiskIOServicedPrefix + DiskIORead):      UnitCountPerSec,
+		strings.ToLower(DiskIOServicedPrefix + DiskIOSync):      UnitCountPerSec,
+		strings.ToLower(DiskIOServicedPrefix + DiskIOWrite):     UnitCountPerSec,
+		strings.ToLower(DiskIOServicedPrefix + DiskIOTotal):     UnitCountPerSec,
+
+		//network metrics
+		NetRxBytes:    UnitBytesPerSec,
+		NetRxPackets:  UnitCountPerSec,
+		NetRxDropped:  UnitCountPerSec,
+		NetRxErrors:   UnitCountPerSec,
+		NetTxBytes:    UnitBytesPerSec,
+		NetTxPackets:  UnitCountPerSec,
+		NetTxDropped:  UnitCountPerSec,
+		NetTxErrors:   UnitCountPerSec,
+		NetTotalBytes: UnitBytesPerSec,
+
+		//filesystem metrics
+		FSUsage:       UnitBytes,
+		FSCapacity:    UnitBytes,
+		FSAvailable:   UnitBytes,
+		FSInodes:      UnitCount,
+		FSInodesfree:  UnitCount,
+		FSUtilization: UnitPercent,
+
+		//cluster metrics
+		NodeCount:       UnitCount,
+		FailedNodeCount: UnitCount,
+
+		//others
+		RunningPodCount:       UnitCount,
+		RunningContainerCount: UnitCount,
+		ContainerCount:        UnitCount,
+		ContainerRestartCount: UnitCount,
+		RunningTaskCount:      UnitCount,
+	}
+}

internal/aws/containerinsight/ecsconst.go

@@ -0,0 +1,20 @@
+// Copyright 2020, OpenTelemetry Authors
+//
+// 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.
+package containerinsight
+
+//define constants that are used for ECS Container Insights only
+const (
+	ContainerInstanceIDKey = "ContainerInstanceId"
+	ECS                    = "ecs"
+)

internal/aws/containerinsight/go.mod

@@ -0,0 +1,9 @@
+module github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/containerinsight
+
+go 1.15
+
+require (
+	github.com/stretchr/testify v1.7.0
+	go.opentelemetry.io/collector v0.25.0
+	go.uber.org/zap v1.16.0
+)