Skip to content

Expose EMF TCP and UDP ports, and others, in the service #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 12, 2024
Merged

Expose EMF TCP and UDP ports, and others, in the service #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6e48f4
Prepare getContainerPorts for being extracted to a common file
lucabrunox Jun 6, 2024
35fb863
Move getContainerPorts to a common ports file
lucabrunox Jun 6, 2024
6dfb875
Create service ports based on container ports
lucabrunox Jun 6, 2024
27d6e24
Support both EMF TCP and UDP ports
lucabrunox Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apis/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions apis/v1alpha2/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

171 changes: 1 addition & 170 deletions internal/manifests/collector/container.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,11 @@
package collector

import (
"errors"
"fmt"
"regexp"
"sort"
"strconv"
"strings"

"go.uber.org/zap"

"github.com/go-logr/logr"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/util/validation"

"github.com/aws/amazon-cloudwatch-agent-operator/apis/v1alpha1"
"github.com/aws/amazon-cloudwatch-agent-operator/internal/config"
Expand All @@ -34,14 +27,7 @@ func Container(cfg config.Config, logger logr.Logger, agent v1alpha1.AmazonCloud
image = cfg.CollectorImage()
}

ports := getContainerPorts(logger, agent.Spec.Config)
for _, p := range agent.Spec.Ports {
ports[p.Name] = corev1.ContainerPort{
Name: p.Name,
ContainerPort: p.Port,
Protocol: p.Protocol,
}
}
ports := getContainerPorts(logger, agent.Spec.Config, agent.Spec.Ports)

var volumeMounts []corev1.VolumeMount
argsMap := agent.Spec.Args
Expand Down Expand Up @@ -125,140 +111,6 @@ func getVolumeMounts(os string) corev1.VolumeMount {
return volumeMount
}

func getContainerPorts(logger logr.Logger, cfg string) map[string]corev1.ContainerPort {
ports := map[string]corev1.ContainerPort{}
var servicePorts []corev1.ServicePort
config, err := adapters.ConfigStructFromJSONString(cfg)
if err != nil {
logger.Error(err, "error parsing cw agent config")
servicePorts = PortMapToServicePortList(AppSignalsPortToServicePortMap)
} else {
servicePorts = getServicePortsFromCWAgentConfig(logger, config)
}

for _, p := range servicePorts {
truncName := naming.Truncate(p.Name, maxPortLen)
if p.Name != truncName {
logger.Info("truncating container port name",
zap.String("port.name.prev", p.Name), zap.String("port.name.new", truncName))
}
nameErrs := validation.IsValidPortName(truncName)
numErrs := validation.IsValidPortNum(int(p.Port))
if len(nameErrs) > 0 || len(numErrs) > 0 {
logger.Info("dropping invalid container port", zap.String("port.name", truncName), zap.Int32("port.num", p.Port),
zap.Strings("port.name.errs", nameErrs), zap.Strings("num.errs", numErrs))
continue
}
ports[truncName] = corev1.ContainerPort{
Name: truncName,
ContainerPort: p.Port,
Protocol: p.Protocol,
}
}
return ports
}

func getServicePortsFromCWAgentConfig(logger logr.Logger, config *adapters.CwaConfig) []corev1.ServicePort {
servicePortsMap := getAppSignalsServicePortsMap()
getMetricsReceiversServicePorts(logger, config, servicePortsMap)
getLogsReceiversServicePorts(logger, config, servicePortsMap)
getTracesReceiversServicePorts(logger, config, servicePortsMap)
return PortMapToServicePortList(servicePortsMap)
}

func getMetricsReceiversServicePorts(logger logr.Logger, config *adapters.CwaConfig, servicePortsMap map[int32]corev1.ServicePort) {
if config.Metrics == nil || config.Metrics.MetricsCollected == nil {
return
}
//StatD - https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-custom-metrics-statsd.html
if config.Metrics.MetricsCollected.StatsD != nil {
getReceiverServicePort(logger, config.Metrics.MetricsCollected.StatsD.ServiceAddress, StatsD, corev1.ProtocolUDP, servicePortsMap)
}
//CollectD - https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-custom-metrics-collectd.html
if config.Metrics.MetricsCollected.CollectD != nil {
getReceiverServicePort(logger, config.Metrics.MetricsCollected.CollectD.ServiceAddress, CollectD, corev1.ProtocolUDP, servicePortsMap)
}
}

func getReceiverServicePort(logger logr.Logger, serviceAddress string, receiverName string, protocol corev1.Protocol, servicePortsMap map[int32]corev1.ServicePort) {
if serviceAddress != "" {
port, err := portFromEndpoint(serviceAddress)
if err != nil {
logger.Error(err, "error parsing port from endpoint for receiver", zap.String("endpoint", serviceAddress), zap.String("receiver", receiverName))
} else {
if _, ok := servicePortsMap[port]; ok {
logger.Info("Duplicate port has been configured in Agent Config for port", zap.Int32("port", port))
} else {
sp := corev1.ServicePort{
Name: CWA + receiverName,
Port: port,
Protocol: protocol,
}
servicePortsMap[port] = sp
}
}
} else {
if _, ok := servicePortsMap[receiverDefaultPortsMap[receiverName]]; ok {
logger.Info("Duplicate port has been configured in Agent Config for port", zap.Int32("port", receiverDefaultPortsMap[receiverName]))
} else {
sp := corev1.ServicePort{
Name: receiverName,
Port: receiverDefaultPortsMap[receiverName],
Protocol: protocol,
}
servicePortsMap[receiverDefaultPortsMap[receiverName]] = sp
}
}
}

func getLogsReceiversServicePorts(logger logr.Logger, config *adapters.CwaConfig, servicePortsMap map[int32]corev1.ServicePort) {
//EMF - https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Generation_CloudWatch_Agent.html
if config.Logs != nil && config.Logs.LogMetricsCollected != nil && config.Logs.LogMetricsCollected.EMF != nil {
if _, ok := servicePortsMap[receiverDefaultPortsMap[EMF]]; ok {
logger.Info("Duplicate port has been configured in Agent Config for port", zap.Int32("port", receiverDefaultPortsMap[EMF]))
} else {
sp := corev1.ServicePort{
Name: EMF,
Port: receiverDefaultPortsMap[EMF],
}
servicePortsMap[receiverDefaultPortsMap[EMF]] = sp
}
}
}

func getTracesReceiversServicePorts(logger logr.Logger, config *adapters.CwaConfig, servicePortsMap map[int32]corev1.ServicePort) []corev1.ServicePort {
var tracesPorts []corev1.ServicePort

if config.Traces == nil || config.Traces.TracesCollected == nil {
return tracesPorts
}
//Traces - https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html#CloudWatch-Agent-Configuration-File-Tracessection
//OTLP
if config.Traces.TracesCollected.OTLP != nil {
//GRPC
getReceiverServicePort(logger, config.Traces.TracesCollected.OTLP.GRPCEndpoint, OtlpGrpc, corev1.ProtocolTCP, servicePortsMap)
//HTTP
getReceiverServicePort(logger, config.Traces.TracesCollected.OTLP.HTTPEndpoint, OtlpHttp, corev1.ProtocolTCP, servicePortsMap)

}
//Xray
if config.Traces.TracesCollected.XRay != nil {
getReceiverServicePort(logger, config.Traces.TracesCollected.XRay.BindAddress, XrayTraces, corev1.ProtocolUDP, servicePortsMap)
if config.Traces.TracesCollected.XRay.TCPProxy != nil {
getReceiverServicePort(logger, config.Traces.TracesCollected.XRay.TCPProxy.BindAddress, XrayProxy, corev1.ProtocolTCP, servicePortsMap)
}
}
return tracesPorts
}

func getAppSignalsServicePortsMap() map[int32]corev1.ServicePort {
servicePortMap := make(map[int32]corev1.ServicePort)
for k, v := range AppSignalsPortToServicePortMap {
servicePortMap[k] = v
}
return servicePortMap
}

func portMapToContainerPortList(portMap map[string]corev1.ContainerPort) []corev1.ContainerPort {
ports := make([]corev1.ContainerPort, 0, len(portMap))
for _, p := range portMap {
Expand All @@ -269,24 +121,3 @@ func portMapToContainerPortList(portMap map[string]corev1.ContainerPort) []corev
})
return ports
}

func portFromEndpoint(endpoint string) (int32, error) {
var err error
var port int64

r := regexp.MustCompile(":[0-9]+")

if r.MatchString(endpoint) {
port, err = strconv.ParseInt(strings.Replace(r.FindString(endpoint), ":", "", -1), 10, 32)

if err != nil {
return 0, err
}
}

if port == 0 {
return 0, errors.New("port should not be empty")
}

return int32(port), err
}
Loading
Loading