Skip to content

Commit a1b3464

Browse files
author
awstools
committed
feat(client-cloudwatch-logs): We are pleased to announce limit increases to our grok processor logs transformation feature. Now you can define 20 Grok patterns in their configurations, with an expanded total pattern matching limit of 512 characters.
1 parent cb11bbf commit a1b3464

File tree

3 files changed

+18
-13
lines changed

3 files changed

+18
-13
lines changed

clients/client-cloudwatch-logs/src/commands/FilterLogEventsCommand.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,7 @@ export interface FilterLogEventsCommandOutput extends FilterLogEventsResponse, _
5151
* <p>Partially full or empty pages
5252
* don't necessarily mean that pagination is finished. If the results include a <code>nextToken</code>, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent
5353
* <code>FilterLogEvents</code> operation. If the results don't include a <code>nextToken</code>, then pagination is finished. </p>
54-
* <note>
55-
* <p>If you set <code>startFromHead</code> to <code>true</code> and you don’t include <code>endTime</code> in your request, you can end up in a situation where the pagination doesn't terminate.
56-
* This can happen when the new log events are being added to the target log streams
57-
* faster than they are being read. This situation is a good use case for the CloudWatch Logs <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html">Live Tail</a> feature.</p>
58-
* </note>
54+
* <p>Specifying the <code>limit</code> parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior.</p>
5955
* <p>The returned log events are sorted by event timestamp, the timestamp when the event was ingested
6056
* by CloudWatch Logs, and the ID of the <code>PutLogEvents</code> request.</p>
6157
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and

clients/client-cloudwatch-logs/src/models/models_0.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4867,15 +4867,15 @@ export interface Grok {
48674867

48684868
/**
48694869
* <p>The grok pattern to match against the log event. For a list of
4870-
* supported grok patterns, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#Grok-Patterns">Supported grok patterns</a>.</p>
4870+
* supported grok patterns, see <a href="https://docs.aws.amazon.com/mazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#Grok-Patterns">Supported grok patterns</a>.</p>
48714871
* @public
48724872
*/
48734873
match: string | undefined;
48744874
}
48754875

48764876
/**
48774877
* <p>This processor takes a list of objects that contain key fields, and converts them into a map of target keys.</p>
4878-
* <p>For more information about this processor including examples, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-listToMap">
4878+
* <p>For more information about this processor including examples, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-listToMap">
48794879
* listToMap</a> in the <i>CloudWatch Logs User Guide</i>.</p>
48804880
* @public
48814881
*/

codegen/sdk-codegen/aws-models/cloudwatch-logs.json

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2226,7 +2226,7 @@
22262226
"traits": {
22272227
"smithy.api#length": {
22282228
"min": 1,
2229-
"max": 1
2229+
"max": 2
22302230
}
22312231
}
22322232
},
@@ -4458,7 +4458,7 @@
44584458
}
44594459
],
44604460
"traits": {
4461-
"smithy.api#documentation": "<p>Lists log events from the specified log group. You can list all the log events or filter the results\n using one or more of the following:</p>\n <ul>\n <li>\n <p>A filter pattern</p>\n </li>\n <li>\n <p>A time range</p>\n </li>\n <li>\n <p>The log stream name, or a log stream name prefix that matches mutltiple log streams</p>\n </li>\n </ul>\n <p>You must have the <code>logs:FilterLogEvents</code> permission to perform this operation.</p>\n <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.\n You must include one of these two parameters, but you can't include both.\n </p>\n <p>\n <code>FilterLogEvents</code> is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. \n For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.</p>\n <p>Partially full or empty pages\n don't necessarily mean that pagination is finished. If the results include a <code>nextToken</code>, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent\n <code>FilterLogEvents</code> operation. If the results don't include a <code>nextToken</code>, then pagination is finished. </p>\n <note>\n <p>If you set <code>startFromHead</code> to <code>true</code> and you don’t include <code>endTime</code> in your request, you can end up in a situation where the pagination doesn't terminate. \n This can happen when the new log events are being added to the target log streams\n faster than they are being read. This situation is a good use case for the CloudWatch Logs <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html\">Live Tail</a> feature.</p>\n </note>\n <p>The returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the <code>PutLogEvents</code> request.</p>\n <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html\">CloudWatch cross-account observability</a>.</p>\n <note>\n <p>If you are using <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html\">log transformation</a>, the <code>FilterLogEvents</code> operation returns only the original versions of log events, before they \n were transformed. To view the transformed versions, you must use a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html\">CloudWatch Logs query.</a>\n </p>\n </note>",
4461+
"smithy.api#documentation": "<p>Lists log events from the specified log group. You can list all the log events or filter the results\n using one or more of the following:</p>\n <ul>\n <li>\n <p>A filter pattern</p>\n </li>\n <li>\n <p>A time range</p>\n </li>\n <li>\n <p>The log stream name, or a log stream name prefix that matches mutltiple log streams</p>\n </li>\n </ul>\n <p>You must have the <code>logs:FilterLogEvents</code> permission to perform this operation.</p>\n <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.\n You must include one of these two parameters, but you can't include both.\n </p>\n <p>\n <code>FilterLogEvents</code> is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. \n For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.</p>\n <p>Partially full or empty pages\n don't necessarily mean that pagination is finished. If the results include a <code>nextToken</code>, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent\n <code>FilterLogEvents</code> operation. If the results don't include a <code>nextToken</code>, then pagination is finished. </p>\n <p>Specifying the <code>limit</code> parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior.</p>\n <p>The returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the <code>PutLogEvents</code> request.</p>\n <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html\">CloudWatch cross-account observability</a>.</p>\n <note>\n <p>If you are using <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html\">log transformation</a>, the <code>FilterLogEvents</code> operation returns only the original versions of log events, before they \n were transformed. To view the transformed versions, you must use a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html\">CloudWatch Logs query.</a>\n </p>\n </note>",
44624462
"smithy.api#paginated": {
44634463
"inputToken": "nextToken",
44644464
"outputToken": "nextToken",
@@ -5564,7 +5564,7 @@
55645564
"match": {
55655565
"target": "com.amazonaws.cloudwatchlogs#GrokMatch",
55665566
"traits": {
5567-
"smithy.api#documentation": "<p>The grok pattern to match against the log event. For a list of \n supported grok patterns, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#Grok-Patterns\">Supported grok patterns</a>.</p>",
5567+
"smithy.api#documentation": "<p>The grok pattern to match against the log event. For a list of \n supported grok patterns, see <a href=\"https://docs.aws.amazon.com/mazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#Grok-Patterns\">Supported grok patterns</a>.</p>",
55685568
"smithy.api#required": {}
55695569
}
55705570
}
@@ -5578,7 +5578,7 @@
55785578
"traits": {
55795579
"smithy.api#length": {
55805580
"min": 1,
5581-
"max": 128
5581+
"max": 512
55825582
}
55835583
}
55845584
},
@@ -6400,7 +6400,7 @@
64006400
}
64016401
},
64026402
"traits": {
6403-
"smithy.api#documentation": "<p>This processor takes a list of objects that contain key fields, and converts them into a map of target keys.</p>\n <p>For more information about this processor including examples, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-listToMap\">\n listToMap</a> in the <i>CloudWatch Logs User Guide</i>.</p>"
6403+
"smithy.api#documentation": "<p>This processor takes a list of objects that contain key fields, and converts them into a map of target keys.</p>\n <p>For more information about this processor including examples, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-listToMap\">\n listToMap</a> in the <i>CloudWatch Logs User Guide</i>.</p>"
64046404
}
64056405
},
64066406
"com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent": {
@@ -11352,6 +11352,15 @@
1135211352
"smithy.api#documentation": "<p>Use this processor to split a field into an array of strings using a delimiting character.</p>\n <p>For more information about this processor including examples, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-splitString\">\n splitString</a> in the <i>CloudWatch Logs User Guide</i>.</p>"
1135311353
}
1135411354
},
11355+
"com.amazonaws.cloudwatchlogs#SplitStringDelimiter": {
11356+
"type": "string",
11357+
"traits": {
11358+
"smithy.api#length": {
11359+
"min": 1,
11360+
"max": 128
11361+
}
11362+
}
11363+
},
1135511364
"com.amazonaws.cloudwatchlogs#SplitStringEntries": {
1135611365
"type": "list",
1135711366
"member": {
@@ -11375,7 +11384,7 @@
1137511384
}
1137611385
},
1137711386
"delimiter": {
11378-
"target": "com.amazonaws.cloudwatchlogs#Delimiter",
11387+
"target": "com.amazonaws.cloudwatchlogs#SplitStringDelimiter",
1137911388
"traits": {
1138011389
"smithy.api#documentation": "<p>The separator characters to split the string entry on.</p>",
1138111390
"smithy.api#required": {}

0 commit comments

Comments
 (0)