1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
from __future__ import annotations
import logging
from datetime import datetime
from typing import Any, Final, Optional, TypedDict
from botocore.client import BaseClient
from botocore.exceptions import ClientError
from moto.logs.models import LogEvent, LogsBackend, logs_backends
from moto.stepfunctions.parser.api import (
HistoryEventType,
LoggingConfiguration,
LogLevel,
LongArn,
)
from moto.stepfunctions.parser.asl.utils.encoding import to_json_str
from moto.utilities.arns import (
parse_arn,
)
LOG = logging.getLogger(__name__)
ExecutionEventLogDetails = dict
# The following event type sets are compiled according to AWS's
# log level definitions: https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html
_ERROR_LOG_EVENT_TYPES: Final[set[HistoryEventType]] = {
HistoryEventType.ExecutionAborted,
HistoryEventType.ExecutionFailed,
HistoryEventType.ExecutionTimedOut,
HistoryEventType.FailStateEntered,
HistoryEventType.LambdaFunctionFailed,
HistoryEventType.LambdaFunctionScheduleFailed,
HistoryEventType.LambdaFunctionStartFailed,
HistoryEventType.LambdaFunctionTimedOut,
HistoryEventType.MapStateAborted,
HistoryEventType.MapStateFailed,
HistoryEventType.MapIterationAborted,
HistoryEventType.MapIterationFailed,
HistoryEventType.MapRunAborted,
HistoryEventType.MapRunFailed,
HistoryEventType.ParallelStateAborted,
HistoryEventType.ParallelStateFailed,
HistoryEventType.TaskFailed,
HistoryEventType.TaskStartFailed,
HistoryEventType.TaskStateAborted,
HistoryEventType.TaskSubmitFailed,
HistoryEventType.TaskTimedOut,
HistoryEventType.WaitStateAborted,
}
_FATAL_LOG_EVENT_TYPES: Final[set[HistoryEventType]] = {
HistoryEventType.ExecutionAborted,
HistoryEventType.ExecutionFailed,
HistoryEventType.ExecutionTimedOut,
}
# The LogStreamName used when creating the empty Log Stream when validating the logging configuration.
VALIDATION_LOG_STREAM_NAME: Final[str] = (
"log_stream_created_by_aws_to_validate_log_delivery_subscriptions"
)
def is_logging_enabled_for(
log_level: LogLevel, history_event_type: HistoryEventType
) -> bool:
# Checks whether the history event type is in the context of a give LogLevel.
if log_level == LogLevel.ALL:
return True
elif log_level == LogLevel.OFF:
return False
elif log_level == LogLevel.ERROR:
return history_event_type in _ERROR_LOG_EVENT_TYPES
elif log_level == LogLevel.FATAL:
return history_event_type in _FATAL_LOG_EVENT_TYPES
else:
LOG.error("Unknown LogLevel '%s'", log_level)
class CloudWatchLoggingConfiguration:
state_machine_arn: Final[LongArn]
log_level: Final[LogLevel]
log_account_id: Final[str]
log_region: Final[str]
log_group_name: Final[str]
log_stream_name: Final[str]
include_execution_data: Final[bool]
def __init__(
self,
state_machine_arn: LongArn,
log_account_id: str,
log_region: str,
log_group_name: str,
log_level: LogLevel,
include_execution_data: bool,
):
self.state_machine_arn = state_machine_arn
self.log_level = log_level
self.log_group_name = log_group_name
self.log_account_id = log_account_id
self.log_region = log_region
# TODO: AWS appears to append a date and a serial number to the log
# stream name: more investigations are needed in this area.
self.log_stream_name = f"states/{state_machine_arn}"
self.include_execution_data = include_execution_data
@staticmethod
def extract_log_arn_parts_from(
logging_configuration: LoggingConfiguration,
) -> Optional[tuple[str, str, str]]:
# Returns a tuple with: account_id, region, and log group name if the logging configuration
# specifies a valid cloud watch log group arn, none otherwise.
destinations = logging_configuration.get("destinations")
if (
not destinations or len(destinations) > 1
): # Only one destination can be defined.
return None
log_group = destinations[0].get("cloudWatchLogsLogGroup")
if not log_group:
return None
log_group_arn = log_group.get("logGroupArn")
if not log_group_arn:
return None
try:
arn_data = parse_arn(log_group_arn)
except IndexError:
return None
log_region = arn_data.region
if log_region is None:
return None
log_account_id = arn_data.account
if log_account_id is None:
return None
log_resource = arn_data.resource_id
if log_resource is None:
return None
log_resource_parts = log_resource.split("log-group:")
if not log_resource_parts:
return None
log_group_name = log_resource_parts[-1].split(":")[0]
return log_account_id, log_region, log_group_name
@staticmethod
def from_logging_configuration(
state_machine_arn: LongArn,
logging_configuration: LoggingConfiguration,
) -> Optional[CloudWatchLoggingConfiguration]:
log_level = logging_configuration.get("level", LogLevel.OFF)
if log_level == LogLevel.OFF:
return None
log_arn_parts = CloudWatchLoggingConfiguration.extract_log_arn_parts_from(
logging_configuration=logging_configuration
)
if not log_arn_parts:
return None
log_account_id, log_region, log_group_name = log_arn_parts
include_execution_data = logging_configuration["includeExecutionData"]
return CloudWatchLoggingConfiguration(
state_machine_arn=state_machine_arn,
log_account_id=log_account_id,
log_region=log_region,
log_group_name=log_group_name,
log_level=log_level,
include_execution_data=include_execution_data,
)
def validate(self) -> None:
pass
class HistoryLog(TypedDict):
id: str
previous_event_id: str
event_timestamp: datetime
type: HistoryEventType
execution_arn: LongArn
details: Optional[ExecutionEventLogDetails]
class CloudWatchLoggingSession:
execution_arn: Final[LongArn]
configuration: Final[CloudWatchLoggingConfiguration]
_logs_client: Final[BaseClient]
_is_log_stream_available: bool
def __init__(
self, execution_arn: LongArn, configuration: CloudWatchLoggingConfiguration
):
self.execution_arn = execution_arn
self.configuration = configuration
self._logs_client: LogsBackend = logs_backends[
self.configuration.log_account_id
][self.configuration.log_region]
def log_level_filter(self, history_event_type: HistoryEventType) -> bool:
# Checks whether the history event type should be logged in this session.
return is_logging_enabled_for(
log_level=self.configuration.log_level,
history_event_type=history_event_type,
)
def publish_history_log(self, history_log: HistoryLog) -> None:
timestamp_value = int(history_log["event_timestamp"].timestamp() * 1000)
message = to_json_str(history_log)
log_events = [LogEvent(ingestion_time=timestamp_value, log_event=history_log)]
LOG.debug(
"New CloudWatch Log for execution '%s' with message: '%s'",
self.execution_arn,
message,
)
self._publish_history_log_or_setup(log_events=log_events)
def _publish_history_log_or_setup(self, log_events: list[Any]):
# Attempts to put the events into the given log group and stream, and attempts to create the stream if
# this does not already exist.
is_events_put = self._put_events(log_events=log_events)
if is_events_put:
return
is_setup = self._setup()
if not is_setup:
LOG.debug(
"CloudWatch Log was not published due to setup errors encountered "
"while creating the LogStream for execution '%s'.",
self.execution_arn,
)
return
self._put_events(log_events=log_events)
def _put_events(self, log_events: list[Any]) -> bool:
# Puts the events to the targe log group and stream, and returns false if the LogGroup or LogStream could
# not be found, true otherwise.
try:
self._logs_client.put_log_events(
log_group_name=self.configuration.log_group_name,
log_stream_name=self.configuration.log_stream_name,
log_events=log_events,
)
except ClientError as error:
error_code = error.response["Error"]["Code"]
if error_code == "ResourceNotFoundException":
return False
except Exception as ignored:
LOG.warning(
"State Machine execution log event could not be published due to an error: '%s'",
ignored,
)
return True
def _setup(self) -> bool:
# Create the log stream if one does not exist already.
# TODO: enhance the verification logic to match AWS's logic to ensure IAM features work as expected.
# https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html#cloudwatch-iam-policy
try:
self._logs_client.create_log_stream(
log_group_name=self.configuration.log_group_name,
log_stream_name=self.configuration.log_stream_name,
)
except ClientError as error:
error_code = error.response["Error"]["Code"]
if error_code != "ResourceAlreadyExistsException":
LOG.error(
"Could not create execution log stream for execution '%s' due to %s",
self.execution_arn,
error,
)
return False
return True
|