Skip to content
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.

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

feat(ecs): allow to specify log retention for aws log driver #2511

Merged
merged 1 commit into from
May 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 14 additions & 1 deletion packages/@aws-cdk/aws-ecs/lib/log-drivers/aws-log-driver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ export interface AwsLogDriverProps {
*/
readonly logGroup?: logs.ILogGroup;

/**
* The number of days log events are kept in CloudWatch Logs when the log
* group is automatically created by this construct.
*
* @default logs never expire
*/
readonly logRetentionDays?: logs.RetentionDays;

/**
* This option defines a multiline start pattern in Python strftime format.
*
Expand Down Expand Up @@ -57,8 +65,13 @@ export class AwsLogDriver extends LogDriver {

constructor(scope: cdk.Construct, id: string, private readonly props: AwsLogDriverProps) {
super(scope, id);

if (props.logGroup && props.logRetentionDays) {
throw new Error('Cannot specify both `logGroup` and `logRetentionDays`.');
}

this.logGroup = props.logGroup || new logs.LogGroup(this, 'LogGroup', {
retentionDays: 365,
retentionDays: props.logRetentionDays || Infinity,
});
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1027,9 +1027,6 @@
},
"TaskLoggingLogGroupC7E938D4": {
"Type": "AWS::Logs::LogGroup",
"Properties": {
"RetentionInDays": 365
},
"DeletionPolicy": "Retain"
},
"Rule4C995B7F": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -904,9 +904,6 @@
},
"FargateServiceLoggingLogGroup9B16742A": {
"Type": "AWS::Logs::LogGroup",
"Properties": {
"RetentionInDays": 365
},
"DeletionPolicy": "Retain"
},
"FargateServiceECC8084D": {
Expand Down
3 changes: 0 additions & 3 deletions packages/@aws-cdk/aws-ecs/test/fargate/integ.l3.expected.json
Original file line number Diff line number Diff line change
Expand Up @@ -585,9 +585,6 @@
},
"L3LoggingLogGroupBD1F02DD": {
"Type": "AWS::Logs::LogGroup",
"Properties": {
"RetentionInDays": 365
},
"DeletionPolicy": "Retain"
},
"L3Service616D5A93": {
Expand Down
83 changes: 83 additions & 0 deletions packages/@aws-cdk/aws-ecs/test/test.aws-log-driver.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
import { expect, haveResource } from '@aws-cdk/assert';
import logs = require('@aws-cdk/aws-logs');
import cdk = require('@aws-cdk/cdk');
import { Test } from 'nodeunit';
import ecs = require('../lib');

export = {
'create an aws log driver'(test: Test) {
// GIVEN
const stack = new cdk.Stack();

// WHEN
const driver = new ecs.AwsLogDriver(stack, 'Log', {
datetimeFormat: 'format',
logRetentionDays: logs.RetentionDays.OneMonth,
multilinePattern: 'pattern',
streamPrefix: 'hello'
});

// THEN
expect(stack).to(haveResource('AWS::Logs::LogGroup', {
RetentionInDays: logs.RetentionDays.OneMonth
}));

test.deepEqual(
stack.node.resolve(driver.renderLogDriver()),
{
logDriver: 'awslogs',
options: {
'awslogs-group': { Ref: 'LogLogGroup427F779C' },
'awslogs-stream-prefix': 'hello',
'awslogs-region': { Ref: 'AWS::Region' },
'awslogs-datetime-format': 'format',
'awslogs-multiline-pattern': 'pattern'
}
}
);

test.done();
},

'with a defined log group'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const logGroup = new logs.LogGroup(stack, 'LogGroup');

// WHEN
const driver = new ecs.AwsLogDriver(stack, 'Log', {
logGroup,
streamPrefix: 'hello'
});

// THEN
test.deepEqual(
stack.node.resolve(driver.renderLogDriver()),
{
logDriver: 'awslogs',
options: {
'awslogs-group': { Ref: 'LogGroupF5B46931' },
'awslogs-stream-prefix': 'hello',
'awslogs-region': { Ref: 'AWS::Region' }
}
}
);

test.done();
},

'throws when specifying log retention and log group'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const logGroup = new logs.LogGroup(stack, 'LogGroup');

// THEN
test.throws(() => new ecs.AwsLogDriver(stack, 'Log', {
logGroup,
logRetentionDays: logs.RetentionDays.FiveDays,
streamPrefix: 'hello'
}), /`logGroup`.*`logRetentionDays`/);

test.done();
}
};
Original file line number Diff line number Diff line change
Expand Up @@ -835,9 +835,6 @@
},
"TaskLoggingLogGroupC7E938D4": {
"Type": "AWS::Logs::LogGroup",
"Properties": {
"RetentionInDays": 365
},
"DeletionPolicy": "Retain"
},
"StateMachineRoleB840431D": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -457,9 +457,6 @@
},
"TaskLoggingLogGroupC7E938D4": {
"Type": "AWS::Logs::LogGroup",
"Properties": {
"RetentionInDays": 365
},
"DeletionPolicy": "Retain"
},
"FargateTaskSecurityGroup0BBB27CB": {
Expand Down