Allow fine tunning of awslogs

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
This commit is contained in:
Nicolas De Loof 2020-08-11 15:48:12 +02:00
parent 5ed328d8df
commit d281f6cb3e
No known key found for this signature in database
GPG Key ID: 9858809D6F8F6E7E
5 changed files with 76 additions and 18 deletions

View File

@ -119,10 +119,7 @@ func (b Backend) Convert(project *types.Project) (*cloudformation.Template, erro
project.Secrets[i] = s project.Secrets[i] = s
} }
logGroup := fmt.Sprintf("/docker-compose/%s", project.Name) createLogGroup(project, template)
template.Resources["LogGroup"] = &logs.LogGroup{
LogGroupName: logGroup,
}
// Private DNS namespace will allow DNS name for the services to be <service>.<project>.local // Private DNS namespace will allow DNS name for the services to be <service>.<project>.local
createCloudMap(project, template) createCloudMap(project, template)
@ -190,7 +187,7 @@ func (b Backend) Convert(project *types.Project) (*cloudformation.Template, erro
dependsOn = append(dependsOn, serviceResourceName(dependency)) dependsOn = append(dependsOn, serviceResourceName(dependency))
} }
minPercent, maxPercent, err := b.computeRollingUpdateLimits(service) minPercent, maxPercent, err := computeRollingUpdateLimits(service)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@ -237,7 +234,19 @@ func (b Backend) Convert(project *types.Project) (*cloudformation.Template, erro
return template, nil return template, nil
} }
func (b Backend) computeRollingUpdateLimits(service types.ServiceConfig) (int, int, error) { func createLogGroup(project *types.Project, template *cloudformation.Template) {
retention := 0
if v, ok := project.Extensions[compose.ExtensionRetention]; ok {
retention = v.(int)
}
logGroup := fmt.Sprintf("/docker-compose/%s", project.Name)
template.Resources["LogGroup"] = &logs.LogGroup{
LogGroupName: logGroup,
RetentionInDays: retention,
}
}
func computeRollingUpdateLimits(service types.ServiceConfig) (int, int, error) {
maxPercent := 200 maxPercent := 200
minPercent := 100 minPercent := 100
if service.Deploy == nil || service.Deploy.UpdateConfig == nil { if service.Deploy == nil || service.Deploy.UpdateConfig == nil {

View File

@ -11,6 +11,7 @@ import (
"github.com/awslabs/goformation/v4/cloudformation/ecs" "github.com/awslabs/goformation/v4/cloudformation/ecs"
"github.com/awslabs/goformation/v4/cloudformation/elasticloadbalancingv2" "github.com/awslabs/goformation/v4/cloudformation/elasticloadbalancingv2"
"github.com/awslabs/goformation/v4/cloudformation/iam" "github.com/awslabs/goformation/v4/cloudformation/iam"
"github.com/awslabs/goformation/v4/cloudformation/logs"
"github.com/compose-spec/compose-go/cli" "github.com/compose-spec/compose-go/cli"
"github.com/compose-spec/compose-go/loader" "github.com/compose-spec/compose-go/loader"
"github.com/compose-spec/compose-go/types" "github.com/compose-spec/compose-go/types"
@ -26,6 +27,25 @@ func TestSimpleConvert(t *testing.T) {
golden.Assert(t, result, expected) golden.Assert(t, result, expected)
} }
func TestLogging(t *testing.T) {
template := convertYaml(t, "test", `
services:
foo:
image: hello_world
logging:
options:
awslogs-datetime-pattern: "FOO"
x-aws-logs_retention: 10
`)
def := template.Resources["FooTaskDefinition"].(*ecs.TaskDefinition)
logging := def.ContainerDefinitions[0].LogConfiguration
assert.Equal(t, logging.Options["awslogs-datetime-pattern"], "FOO")
logGroup := template.Resources["LogGroup"].(*logs.LogGroup)
assert.Equal(t, logGroup.RetentionInDays, 10)
}
func TestEnvFile(t *testing.T) { func TestEnvFile(t *testing.T) {
template := convertYaml(t, "test", ` template := convertYaml(t, "test", `
services: services:
@ -36,8 +56,15 @@ services:
`) `)
def := template.Resources["FooTaskDefinition"].(*ecs.TaskDefinition) def := template.Resources["FooTaskDefinition"].(*ecs.TaskDefinition)
env := def.ContainerDefinitions[0].Environment env := def.ContainerDefinitions[0].Environment
assert.Equal(t, env[0].Name, "FOO") var found bool
assert.Equal(t, env[0].Value, "BAR") for _, pair := range env {
if pair.Name == "FOO" {
assert.Equal(t, pair.Value, "BAR")
found = true
}
}
assert.Check(t, found, "environment variable FOO not set")
} }
func TestEnvFileAndEnv(t *testing.T) { func TestEnvFileAndEnv(t *testing.T) {

View File

@ -27,14 +27,16 @@ var compatibleComposeAttributes = []string{
"services.entrypoint", "services.entrypoint",
"services.environment", "services.environment",
"services.env_file", "services.env_file",
"service.image",
"services.init",
"services.healthcheck", "services.healthcheck",
"services.healthcheck.interval", "services.healthcheck.interval",
"services.healthcheck.retries", "services.healthcheck.retries",
"services.healthcheck.start_period", "services.healthcheck.start_period",
"services.healthcheck.test", "services.healthcheck.test",
"services.healthcheck.timeout", "services.healthcheck.timeout",
"services.image",
"services.init",
"services.logging",
"services.logging.options",
"services.networks", "services.networks",
"services.ports", "services.ports",
"services.ports.mode", "services.ports.mode",
@ -77,3 +79,9 @@ func (c *FargateCompatibilityChecker) CheckCapAdd(service *types.ServiceConfig)
} }
service.CapAdd = add service.CapAdd = add
} }
func (c *FargateCompatibilityChecker) CheckLoggingDriver(config *types.LoggingConfig) {
if config.Driver != "" && config.Driver != "awslogs" {
c.Unsupported("services.logging.driver %s is not supported", config.Driver)
}
}

View File

@ -44,14 +44,7 @@ func Convert(project *types.Project, service types.ServiceConfig) (*ecs.TaskDefi
fmt.Sprintf(" %s.local", project.Name), fmt.Sprintf(" %s.local", project.Name),
})) }))
logConfiguration := &ecs.TaskDefinition_LogConfiguration{ logConfiguration := getLogConfiguration(service, project)
LogDriver: ecsapi.LogDriverAwslogs,
Options: map[string]string{
"awslogs-region": cloudformation.Ref("AWS::Region"),
"awslogs-group": cloudformation.Ref("LogGroup"),
"awslogs-stream-prefix": project.Name,
},
}
var ( var (
containers []ecs.TaskDefinition_ContainerDefinition containers []ecs.TaskDefinition_ContainerDefinition
@ -222,6 +215,26 @@ func createEnvironment(project *types.Project, service types.ServiceConfig) ([]e
return pairs, nil return pairs, nil
} }
func getLogConfiguration(service types.ServiceConfig, project *types.Project) *ecs.TaskDefinition_LogConfiguration {
options := map[string]string{
"awslogs-region": cloudformation.Ref("AWS::Region"),
"awslogs-group": cloudformation.Ref("LogGroup"),
"awslogs-stream-prefix": project.Name,
}
if service.Logging != nil {
for k, v := range service.Logging.Options {
if strings.HasPrefix(k, "awslogs-") {
options[k] = v
}
}
}
logConfiguration := &ecs.TaskDefinition_LogConfiguration{
LogDriver: ecsapi.LogDriverAwslogs,
Options: options,
}
return logConfiguration
}
func toTags(labels types.Labels) []tags.Tag { func toTags(labels types.Labels) []tags.Tag {
t := []tags.Tag{} t := []tags.Tag{}
for n, v := range labels { for n, v := range labels {

View File

@ -9,4 +9,5 @@ const (
ExtensionKeys = "x-aws-keys" ExtensionKeys = "x-aws-keys"
ExtensionMinPercent = "x-aws-min_percent" ExtensionMinPercent = "x-aws-min_percent"
ExtensionMaxPercent = "x-aws-max_percent" ExtensionMaxPercent = "x-aws-max_percent"
ExtensionRetention = "x-aws-logs_retention"
) )