858585c6-6e27-4bca-a3b8-78d6d978f737

Committed 25 Mar 2025 06:43PM UTC coverage: 86.88% (+0.02%) from 86.865%

Build # 858585c6-6e27-4bca-a3b8-78d6d978f737

Build Type

push

circleci

Committed by

web-flow

Commit Message

[Utils] Add a batch policy utility (#12430)

Coverage Stats

53 of 56 new or added lines in 1 file covered. (94.64%)

227 existing lines in 12 files now uncovered.

63251 of 72803 relevant lines covered (86.88%)

0.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.84

/localstack-core/localstack/runtime/analytics.py

import logging
import os

from localstack import config
from localstack.runtime import hooks
from localstack.utils.analytics import log

LOG = logging.getLogger(__name__)

TRACKED_ENV_VAR = [
    "ALLOW_NONSTANDARD_REGIONS",
    "BEDROCK_PREWARM",
    "CLOUDFRONT_LAMBDA_EDGE",
    "CONTAINER_RUNTIME",
    "DEBUG",
    "DEFAULT_REGION",  # Not functional; deprecated in 0.12.7, removed in 3.0.0
    "DEFAULT_BEDROCK_MODEL",
    "DISABLE_CORS_CHECK",
    "DISABLE_CORS_HEADERS",
    "DMS_SERVERLESS_DEPROVISIONING_DELAY",
    "DMS_SERVERLESS_STATUS_CHANGE_WAITING_TIME",
    "DNS_ADDRESS",
    "DYNAMODB_ERROR_PROBABILITY",
    "DYNAMODB_IN_MEMORY",
    "DYNAMODB_REMOVE_EXPIRED_ITEMS",
    "EAGER_SERVICE_LOADING",
    "EC2_VM_MANAGER",
    "ECS_TASK_EXECUTOR",
    "EDGE_PORT",
    "ENABLE_REPLICATOR",
    "ENFORCE_IAM",
    "ES_CUSTOM_BACKEND",  # deprecated in 0.14.0, removed in 3.0.0
    "ES_MULTI_CLUSTER",  # deprecated in 0.14.0, removed in 3.0.0
    "ES_ENDPOINT_STRATEGY",  # deprecated in 0.14.0, removed in 3.0.0
    "EVENT_RULE_ENGINE",
    "IAM_SOFT_MODE",
    "KINESIS_PROVIDER",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "KINESIS_ERROR_PROBABILITY",
    "KMS_PROVIDER",  # defunct since 1.4.0
    "LAMBDA_DEBUG_MODE",
    "LAMBDA_DOWNLOAD_AWS_LAYERS",
    "LAMBDA_EXECUTOR",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "LAMBDA_STAY_OPEN_MODE",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "LAMBDA_REMOTE_DOCKER",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "LAMBDA_CODE_EXTRACT_TIME",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "LAMBDA_CONTAINER_REGISTRY",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "LAMBDA_FALLBACK_URL",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "LAMBDA_FORWARD_URL",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "LAMBDA_XRAY_INIT",  # Not functional; deprecated in 2.0.0, removed in 3.0.0
    "LAMBDA_PREBUILD_IMAGES",
    "LAMBDA_RUNTIME_EXECUTOR",
    "LAMBDA_RUNTIME_ENVIRONMENT_TIMEOUT",
    "LEGACY_EDGE_PROXY",  # Not functional; deprecated in 1.0.0, removed in 2.0.0
    "LS_LOG",
    "MOCK_UNIMPLEMENTED",  # Not functional; deprecated in 1.3.0, removed in 3.0.0
    "OPENSEARCH_ENDPOINT_STRATEGY",
    "PERSISTENCE",
    "PERSISTENCE_SINGLE_FILE",
    "PERSIST_ALL",  # defunct since 2.3.2
    "PORT_WEB_UI",
    "RDS_MYSQL_DOCKER",
    "REQUIRE_PRO",
    "SERVICES",
    "STRICT_SERVICE_LOADING",
    "SKIP_INFRA_DOWNLOADS",
    "SQS_ENDPOINT_STRATEGY",
    "USE_SINGLE_REGION",  # Not functional; deprecated in 0.12.7, removed in 3.0.0
    "USE_SSL",
]

PRESENCE_ENV_VAR = [
    "DATA_DIR",
    "EDGE_FORWARD_URL",  # Not functional; deprecated in 1.4.0, removed in 3.0.0
    "GATEWAY_LISTEN",
    "HOSTNAME",
    "HOSTNAME_EXTERNAL",
    "HOSTNAME_FROM_LAMBDA",
    "HOST_TMP_FOLDER",  # Not functional; deprecated in 1.0.0, removed in 2.0.0
    "INIT_SCRIPTS_PATH",  # Not functional; deprecated in 1.1.0, removed in 2.0.0
    "LAMBDA_DEBUG_MODE_CONFIG_PATH",
    "LEGACY_DIRECTORIES",  # Not functional; deprecated in 1.1.0, removed in 2.0.0
    "LEGACY_INIT_DIR",  # Not functional; deprecated in 1.1.0, removed in 2.0.0
    "LOCALSTACK_HOST",
    "LOCALSTACK_HOSTNAME",
    "OUTBOUND_HTTP_PROXY",
    "OUTBOUND_HTTPS_PROXY",
    "S3_DIR",
    "TMPDIR",
]


@hooks.on_infra_start()
def _publish_config_as_analytics_event():
    env_vars = list(TRACKED_ENV_VAR)

    for key, value in os.environ.items():
        if key.startswith("PROVIDER_OVERRIDE_"):
            env_vars.append(key)
        elif key.startswith("SYNCHRONOUS_") and key.endswith("_EVENTS"):
            # these config variables have been removed with 3.0.0
            env_vars.append(key)

    env_vars = {key: os.getenv(key) for key in env_vars}
    present_env_vars = {env_var: 1 for env_var in PRESENCE_ENV_VAR if os.getenv(env_var)}

    log.event("config", env_vars=env_vars, set_vars=present_env_vars)


class LocalstackContainerInfo:
    def get_image_variant(self) -> str:
        for f in os.listdir("/usr/lib/localstack"):
            if f.startswith(".") and f.endswith("-version"):
                return f[1:-8]
        return "unknown"

    def has_docker_socket(self) -> bool:
        return os.path.exists("/run/docker.sock")

    def to_dict(self):
        return {
            "variant": self.get_image_variant(),
            "has_docker_socket": self.has_docker_socket(),
        }


@hooks.on_infra_start()
def _publish_container_info():
    if not config.is_in_docker:
        return

    try:
        log.event("container_info", payload=LocalstackContainerInfo().to_dict())
    except Exception as e:
        if config.DEBUG_ANALYTICS:
            LOG.debug("error gathering container information: %s", e)

1	import logging	1✔
2	import os	1✔
3
4	from localstack import config	1✔
5	from localstack.runtime import hooks	1✔
6	from localstack.utils.analytics import log	1✔
7
8	LOG = logging.getLogger(__name__)	1✔
9
10	TRACKED_ENV_VAR = [	1✔
11	"ALLOW_NONSTANDARD_REGIONS",
12	"BEDROCK_PREWARM",
13	"CLOUDFRONT_LAMBDA_EDGE",
14	"CONTAINER_RUNTIME",
15	"DEBUG",
16	"DEFAULT_REGION", # Not functional; deprecated in 0.12.7, removed in 3.0.0
17	"DEFAULT_BEDROCK_MODEL",
18	"DISABLE_CORS_CHECK",
19	"DISABLE_CORS_HEADERS",
20	"DMS_SERVERLESS_DEPROVISIONING_DELAY",
21	"DMS_SERVERLESS_STATUS_CHANGE_WAITING_TIME",
22	"DNS_ADDRESS",
23	"DYNAMODB_ERROR_PROBABILITY",
24	"DYNAMODB_IN_MEMORY",
25	"DYNAMODB_REMOVE_EXPIRED_ITEMS",
26	"EAGER_SERVICE_LOADING",
27	"EC2_VM_MANAGER",
28	"ECS_TASK_EXECUTOR",
29	"EDGE_PORT",
30	"ENABLE_REPLICATOR",
31	"ENFORCE_IAM",
32	"ES_CUSTOM_BACKEND", # deprecated in 0.14.0, removed in 3.0.0
33	"ES_MULTI_CLUSTER", # deprecated in 0.14.0, removed in 3.0.0
34	"ES_ENDPOINT_STRATEGY", # deprecated in 0.14.0, removed in 3.0.0
35	"EVENT_RULE_ENGINE",
36	"IAM_SOFT_MODE",
37	"KINESIS_PROVIDER", # Not functional; deprecated in 2.0.0, removed in 3.0.0
38	"KINESIS_ERROR_PROBABILITY",
39	"KMS_PROVIDER", # defunct since 1.4.0
40	"LAMBDA_DEBUG_MODE",
41	"LAMBDA_DOWNLOAD_AWS_LAYERS",
42	"LAMBDA_EXECUTOR", # Not functional; deprecated in 2.0.0, removed in 3.0.0
43	"LAMBDA_STAY_OPEN_MODE", # Not functional; deprecated in 2.0.0, removed in 3.0.0
44	"LAMBDA_REMOTE_DOCKER", # Not functional; deprecated in 2.0.0, removed in 3.0.0
45	"LAMBDA_CODE_EXTRACT_TIME", # Not functional; deprecated in 2.0.0, removed in 3.0.0
46	"LAMBDA_CONTAINER_REGISTRY", # Not functional; deprecated in 2.0.0, removed in 3.0.0
47	"LAMBDA_FALLBACK_URL", # Not functional; deprecated in 2.0.0, removed in 3.0.0
48	"LAMBDA_FORWARD_URL", # Not functional; deprecated in 2.0.0, removed in 3.0.0
49	"LAMBDA_XRAY_INIT", # Not functional; deprecated in 2.0.0, removed in 3.0.0
50	"LAMBDA_PREBUILD_IMAGES",
51	"LAMBDA_RUNTIME_EXECUTOR",
52	"LAMBDA_RUNTIME_ENVIRONMENT_TIMEOUT",
53	"LEGACY_EDGE_PROXY", # Not functional; deprecated in 1.0.0, removed in 2.0.0
54	"LS_LOG",
55	"MOCK_UNIMPLEMENTED", # Not functional; deprecated in 1.3.0, removed in 3.0.0
56	"OPENSEARCH_ENDPOINT_STRATEGY",
57	"PERSISTENCE",
58	"PERSISTENCE_SINGLE_FILE",
59	"PERSIST_ALL", # defunct since 2.3.2
60	"PORT_WEB_UI",
61	"RDS_MYSQL_DOCKER",
62	"REQUIRE_PRO",
63	"SERVICES",
64	"STRICT_SERVICE_LOADING",
65	"SKIP_INFRA_DOWNLOADS",
66	"SQS_ENDPOINT_STRATEGY",
67	"USE_SINGLE_REGION", # Not functional; deprecated in 0.12.7, removed in 3.0.0
68	"USE_SSL",
69	]
70
71	PRESENCE_ENV_VAR = [	1✔
72	"DATA_DIR",
73	"EDGE_FORWARD_URL", # Not functional; deprecated in 1.4.0, removed in 3.0.0
74	"GATEWAY_LISTEN",
75	"HOSTNAME",
76	"HOSTNAME_EXTERNAL",
77	"HOSTNAME_FROM_LAMBDA",
78	"HOST_TMP_FOLDER", # Not functional; deprecated in 1.0.0, removed in 2.0.0
79	"INIT_SCRIPTS_PATH", # Not functional; deprecated in 1.1.0, removed in 2.0.0
80	"LAMBDA_DEBUG_MODE_CONFIG_PATH",
81	"LEGACY_DIRECTORIES", # Not functional; deprecated in 1.1.0, removed in 2.0.0
82	"LEGACY_INIT_DIR", # Not functional; deprecated in 1.1.0, removed in 2.0.0
83	"LOCALSTACK_HOST",
84	"LOCALSTACK_HOSTNAME",
85	"OUTBOUND_HTTP_PROXY",
86	"OUTBOUND_HTTPS_PROXY",
87	"S3_DIR",
88	"TMPDIR",
89	]
90
91
92	@hooks.on_infra_start()	1✔
93	def _publish_config_as_analytics_event():	1✔
94	env_vars = list(TRACKED_ENV_VAR)	1✔
95
96	for key, value in os.environ.items():	1✔
97	if key.startswith("PROVIDER_OVERRIDE_"):	1✔
98	env_vars.append(key)	1✔
99	elif key.startswith("SYNCHRONOUS_") and key.endswith("_EVENTS"):	1✔
100	# these config variables have been removed with 3.0.0
UNCOV 101	env_vars.append(key)	×
102
103	env_vars = {key: os.getenv(key) for key in env_vars}	1✔
104	present_env_vars = {env_var: 1 for env_var in PRESENCE_ENV_VAR if os.getenv(env_var)}	1✔
105
106	log.event("config", env_vars=env_vars, set_vars=present_env_vars)	1✔
107
108
109	class LocalstackContainerInfo:	1✔
110	def get_image_variant(self) -> str:	1✔
111	for f in os.listdir("/usr/lib/localstack"):	1✔
112	if f.startswith(".") and f.endswith("-version"):	1✔
113	return f[1:-8]	1✔
UNCOV 114	return "unknown"	×
115
116	def has_docker_socket(self) -> bool:	1✔
117	return os.path.exists("/run/docker.sock")	1✔
118
119	def to_dict(self):	1✔
120	return {	1✔
121	"variant": self.get_image_variant(),
122	"has_docker_socket": self.has_docker_socket(),
123	}
124
125
126	@hooks.on_infra_start()	1✔
127	def _publish_container_info():	1✔
128	if not config.is_in_docker:	1✔
129	return	1✔
130
131	try:	1✔
132	log.event("container_info", payload=LocalstackContainerInfo().to_dict())	1✔
133	except Exception as e:	×
134	if config.DEBUG_ANALYTICS:	×
UNCOV 135	LOG.debug("error gathering container information: %s", e)	×

localstack / localstack / 858585c6-6e27-4bca-a3b8-78d6d978f737

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous