update api-dependencies and check cloudwatch/logs enabled #9576

steffyP · 2023-11-07T18:08:25Z

Motivation

Previous PR #9494 enabled the loading of specific services only.
In this PR we update the API_DEPENDENCIES for community, and added checks for before calling non-required services.

Changes

Lambda
- prevent EventSourceListener to start if the event-source service is not loaded
- skip the start of LogHandler thread, if logs is not enabled
- skip building vpc-config if ec2 is not enabled
CloudWatch-Util
- added checks before calling service (logs + cloudwatch)
- the publish_lambda_metric is also used by lambda
Logs
- skip metric-filter if cloudwatch is disabled
updated API_DEPENDENCIES
- kinesis: removed dependency on dynamodb as it doesn't seem to be called
- lambda: removed cloudwatch + logs, added sts

Testing

Automated testing of this fix is hard, mainly because also for bootstrapped-test we cannot invoke the lambda.
As a manual check:

cat > index.py << EOL
import json
def handler(event, context):
    print(json.dumps(event))
    return event
EOL

zip function.zip index.py

awslocal lambda create-function \
    --function-name lambda-only-test \
    --runtime python3.9 \
    --zip-file fileb://function.zip \
    --handler index.handler \
    --role arn:aws:iam::000000000000:role/lambda-role

awslocal lambda create-event-source-mapping \
    --function-name lambda-only-test \
    --batch-size 1 \
    --starting-position "TRIM_HORIZON" \
    --event-source-arn "arn:aws:dynamodb:us-east-1:000000000000:table/MusicCollection/stream/2020-07-28T21:53:39.112" \
    --maximum-batching-window-in-seconds 1 \
    --maximum-retry-attempts 1

Before it would keep logging errors:

localstack  | 2023-11-08T11:58:16.004  INFO --- [   asgi_gw_0] l.aws.handlers.service     : Service 'dynamodbstreams' is not enabled. Please check your 'SERVICES' configuration variable.
localstack  | 2023-11-08T11:58:16.007 ERROR --- [functhread57] l.s.l.e.stream_event_sourc : Cannot describe target stream arn:aws:dynamodb:us-east-1:000000000000:table/MusicCollection/stream/2020-07-28T21:53:39.112 of event source mapping eb910335-cc95-4d52-957b-aa035ae57476: An error occurred (InternalFailure) when calling the DescribeStream operation: Service 'dynamodbstreams' is not enabled. Please check your 'SERVICES' configuration variable.

With this changes, we can add a mocked event-source-mapping without any errors, also invoke the lambda, logs and cloudwatch will not be enabled, and there are also no errors in the localstack logs.

steffyP · 2023-11-07T18:09:10Z

localstack/services/lambda_/event_source_listeners/event_source_listener.py

            )
            if self_managed_endpoints.get("KAFKA_BOOTSTRAP_SERVERS"):
                service_type = "kafka"
+        elif not is_api_enabled(service_type):


did not add the this logic to the start_listeners as the function will be removed for v3

steffyP · 2023-11-07T18:12:51Z

localstack/services/lambda_/invocation/logs.py

                )

    def start_subscriber(self) -> None:
+        if not is_api_enabled("logs"):


just preventing the thread start here. we can discuss if there are better approaches to handle this when logs are disabled.

github-actions · 2023-11-07T19:56:46Z

LocalStack Community integration with Pro

      2 files ±0       2 suites ±0 1h 25m 49s ⏱️ + 17m 38s
2 306 tests ±0 2 008 ✔️ ±0 298 💤 ±0 0 ❌ ±0
2 307 runs ±0 2 008 ✔️ ±0 299 💤 ±0 0 ❌ ±0

Results for commit 46c2cc9. ± Comparison against base commit 9dc7713.

♻️ This comment has been updated with latest results.

coveralls · 2023-11-08T12:46:48Z

coverage: 84.005%. remained the same
when pulling 46c2cc9 on strict_service_cw_logs
into 9dc7713 on master.

bentsku

LGTM! This is awesome! Also, great catch for sts. 🚀

bentsku · 2023-11-08T21:13:31Z

localstack/utils/bootstrap.py

    "es": ["opensearch"],
-    "lambda": ["logs", "cloudwatch", "s3", "sqs"],
-    "kinesis": ["dynamodb"],
+    "lambda": ["s3", "sqs", "sts"],


good catch! 👍

localstack/utils/bootstrap.py

joe4dev

This PR covers the basic Lambda scenarios 👍
It's gonna be tough to maintain these conditionals for many service combinations.

I tested the provided testing scenario with SERVICES=lambda and this PR fixes Lambda create-function, invoke, and (dummy) event source mapping (already create-function would fail without this PR) 👏👏👏 .

⚠️ I assume DLQs and success/failure destinations would fail with an exception in the event_manager.py 🤔 Would it provide some helpful logging output?

I guess one of the relevant scenarios for 3.0 is related to users who have set SERVICES since a long time before it got re-purposed. Obviously, any user code depending on other services within Lambda could fail somewhat implicitly but this likely falls under misconfiguration.

Out of the scope for this PR but I just wanted to comment on integrations to consider for ext:

X-Ray
and potentially ECR for pulling Lambda
IAM

joe4dev · 2023-11-13T11:40:31Z

localstack/services/lambda_/event_source_listeners/event_source_listener.py

            if self_managed_endpoints.get("KAFKA_BOOTSTRAP_SERVERS"):
                service_type = "kafka"
+        elif not is_api_enabled(service_type):
+            LOG.info(


Is info sufficient here or should this rather be a warning given the functionality just does not work and it might be a misconfiguration?
Maybe the question is how often is it a misconfiguration vs. intentional disabling 🤷

IMO info should be fine, because it's impossible to pass a valid/existing source-arn here (otherwise the service would be available).

steffyP · 2023-11-13T12:53:10Z

⚠️ I assume DLQs and success/failure destinations would fail with an exception in the event_manager.py 🤔 Would it provide some helpful logging output?

Generally for every access of a service that is disabled, we would throw a 501 error with the message Service '<service-name>' is not enabled. Please check your 'SERVICES' configuration variable.

I guess one of the relevant scenarios for 3.0 is related to users who have set SERVICES since a long time before it got re-purposed. Obviously, any user code depending on other services within Lambda could fail somewhat implicitly but this likely falls under misconfiguration.

Yes, they should run into issues quite fast though. We expect to get those kind of reports, for most customers removing the SERVICES will probably the most reasonable thing to do.
In general we will have more reactive approach for the usage of SERVICES as it's 1) impossible to test everything, and 2) we don't know yet how (or if) people will use it.

steffyP added the semver: patch Non-breaking changes which can be included in patch releases label Nov 7, 2023

steffyP commented Nov 7, 2023

View reviewed changes

steffyP marked this pull request as ready for review November 8, 2023 13:29

steffyP requested review from dfangl, dominikschubert, joe4dev and silv-io as code owners November 8, 2023 13:29

steffyP requested review from bentsku and removed request for silv-io November 8, 2023 13:29

bentsku approved these changes Nov 8, 2023

View reviewed changes

steffyP force-pushed the strict_service_cw_logs branch from 7dad74e to 9353f57 Compare November 9, 2023 10:11

steffyP added this to the 3.0 milestone Nov 13, 2023

steffyP added 8 commits November 13, 2023 10:07

prevent EventSourceListener start if the service is not enabled

75e82b7

skip start of log-subscriber if logs is disabled

1ead35a

skip cloudwatch/logs calls if service not enabled

9dd78c0

update API_DEPENDENCIES

8265986

fixup test_resolve_meta

ac5c043

fixup test assertion

9587d88

add sts dependency for lambda; skip vpc-config check if ec2 is disabled

387d11a

undo api-dependency change for dynamodbstreams

46c2cc9

steffyP force-pushed the strict_service_cw_logs branch from 9353f57 to 46c2cc9 Compare November 13, 2023 09:08

joe4dev approved these changes Nov 13, 2023

View reviewed changes

steffyP merged commit d4933e0 into master Nov 13, 2023

steffyP deleted the strict_service_cw_logs branch November 13, 2023 13:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

update api-dependencies and check cloudwatch/logs enabled #9576

update api-dependencies and check cloudwatch/logs enabled #9576

Uh oh!

steffyP commented Nov 7, 2023 •

edited

Loading

Uh oh!

steffyP Nov 7, 2023

Uh oh!

steffyP Nov 7, 2023

Uh oh!

github-actions bot commented Nov 7, 2023 •

edited

Loading

Uh oh!

coveralls commented Nov 8, 2023 •

edited

Loading

Uh oh!

bentsku left a comment

Uh oh!

bentsku Nov 8, 2023

Uh oh!

Uh oh!

joe4dev left a comment

Uh oh!

joe4dev Nov 13, 2023

Uh oh!

steffyP Nov 13, 2023

Uh oh!

steffyP commented Nov 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

update api-dependencies and check cloudwatch/logs enabled #9576

update api-dependencies and check cloudwatch/logs enabled #9576

Uh oh!

Conversation

steffyP commented Nov 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes

Testing

Uh oh!

steffyP Nov 7, 2023

Choose a reason for hiding this comment

Uh oh!

steffyP Nov 7, 2023

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

LocalStack Community integration with Pro

Uh oh!

coveralls commented Nov 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bentsku left a comment

Choose a reason for hiding this comment

Uh oh!

bentsku Nov 8, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joe4dev left a comment

Choose a reason for hiding this comment

Uh oh!

joe4dev Nov 13, 2023

Choose a reason for hiding this comment

Uh oh!

steffyP Nov 13, 2023

Choose a reason for hiding this comment

Uh oh!

steffyP commented Nov 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

steffyP commented Nov 7, 2023 •

edited

Loading

github-actions bot commented Nov 7, 2023 •

edited

Loading

coveralls commented Nov 8, 2023 •

edited

Loading