Skip to content

Add UsedFeature event and trackers #4003

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.

Sign up for GitHub

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

Merged
hawflau merged 6 commits into from
Jun 28, 2022
Merged

Add UsedFeature event and trackers #4003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
018019b
Add UsedFeature command and trackers
Leo10Gama Jun 24, 2022
0ba01c5
Remove LocalTest events
Leo10Gama Jun 24, 2022
65dd028
Prevent methods from failing if track_event fails
Leo10Gama Jun 27, 2022
07f9fd2
Reformat code to match current standard
Leo10Gama Jun 27, 2022
a851e09
Use correct string formatting
Leo10Gama Jun 27, 2022
b56adf6
Use proper LOG message
Leo10Gama Jun 27, 2022
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
2 changes: 2 additions & 0 deletions samcli/commands/build/build_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,8 @@ def run(self):

for f in self.get_resources_to_build().functions:
EventTracker.track_event("BuildFunctionRuntime", f.runtime)
if f.metadata and f.metadata.get("BuildMethod", "") == "esbuild":
EventTracker.track_event("UsedFeature", "ESBuild")

click.secho("\nBuild Succeeded", fg="green")

Expand Down
2 changes: 2 additions & 0 deletions samcli/commands/sync/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
)
from samcli.cli.cli_config_file import configuration_option, TomlProvider
from samcli.commands._utils.click_mutex import ClickMutex
from samcli.lib.telemetry.event import EventTracker
from samcli.lib.utils.colors import Colored
from samcli.lib.utils.version_checker import check_newer_version
from samcli.lib.bootstrap.bootstrap import manage_stack
Expand Down Expand Up @@ -260,6 +261,7 @@ def do_cli(

set_experimental(ExperimentalFlag.Accelerate)
update_experimental_context()
EventTracker.track_event("UsedFeature", "Accelerate")

with BuildContext(
resource_identifier=None,
Expand Down
10 changes: 8 additions & 2 deletions samcli/lib/telemetry/event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@
"""

from enum import Enum
import logging
from typing import List

from samcli.local.common.runtime_template import INIT_RUNTIMES


LOG = logging.getLogger(__name__)


class EventName(Enum):
"""Enum for the names of available events to track."""

Expand All @@ -23,7 +27,6 @@ class EventType:
EventName.USED_FEATURE: [
"ESBuild",
"Accelerate",
"LocalTest",
"CDK",
],
EventName.DEPLOY: [
Expand Down Expand Up @@ -110,7 +113,10 @@ def track_event(event_name: str, event_value: str):
EventTracker.track_event("UsedFeature", "FeatureY")
return some_value
"""
EventTracker._events.append(Event(event_name, event_value))
try:
EventTracker._events.append(Event(event_name, event_value))
except EventCreationError as e:
LOG.debug("Error occurred while trying to track an event: %s", e)

@staticmethod
def get_tracked_events() -> List[Event]:
Expand Down
2 changes: 2 additions & 0 deletions samcli/lib/telemetry/metric.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ def wrapped(*args, **kwargs):
try:
template_dict = ctx.template_dict
project_type = ProjectTypes.CDK.value if is_cdk_project(template_dict) else ProjectTypes.CFN.value
if project_type == ProjectTypes.CDK.value:
EventTracker.track_event("UsedFeature", "CDK")
metric_specific_attributes["projectType"] = project_type
except AttributeError:
LOG.debug("Template is not provided in context, skip adding project type metric")
Expand Down