feat(telemetry): introduce telemetry system for usage data collection#1109
Draft
davidberenstein1957 wants to merge 1 commit intomasterfrom
Draft
feat(telemetry): introduce telemetry system for usage data collection#1109davidberenstein1957 wants to merge 1 commit intomasterfrom
davidberenstein1957 wants to merge 1 commit intomasterfrom
Conversation
- Added a new telemetry module to collect and export usage data. - Implemented three telemetry tiers: Off, Internal, and Public. - Integrated OpenTelemetry for data export. - Created user prompts for telemetry consent on first run. - Updated documentation to explain telemetry features and configuration. This enhancement aims to improve CodeCarbon by gathering anonymous usage data while ensuring user privacy and consent.
| from codecarbon.external.logger import logger | ||
|
|
||
| # Environment variable name for telemetry setting | ||
| TELEMETRY_ENV_VAR = "CODECARBON_TELEMETRY" |
Collaborator
Author
There was a problem hiding this comment.
needs to be updated
| # Environment variable for OTEL endpoint | ||
| OTEL_ENDPOINT_ENV_VAR = "CODECARBON_OTEL_ENDPOINT" | ||
|
|
||
| # Default OTEL endpoint (can be configured by CodeCarbon team) |
Collaborator
Author
There was a problem hiding this comment.
needs to be updated
| hardware_tracked: list = field(default_factory=list) | ||
| measure_power_interval_secs: float = 15.0 | ||
|
|
||
| # ML Ecosystem (Tier 1: Internal) |
Collaborator
Author
There was a problem hiding this comment.
are these enough? perhaps we also want to add some traditional ML libraries like sklearn etc?
| container_runtime: str = "" | ||
| in_container: bool = False | ||
|
|
||
| # Emissions Data (Tier 2: Public only) |
Collaborator
Author
There was a problem hiding this comment.
I think it would be cool to see if people are interested in sharing this when prompted. We could use this to share approximation on measured carbon with codecarbon.
|
|
||
| return self | ||
|
|
||
| def collect_ml_ecosystem(self) -> "TelemetryCollector": |
Collaborator
Author
There was a problem hiding this comment.
perhaps this can be done a bit more efficiently.
Comment on lines
+14
to
+24
| try: | ||
| from opentelemetry import trace | ||
| from opentelemetry.sdk.trace import TracerProvider | ||
| from opentelemetry.sdk.trace.export import BatchSpanProcessor | ||
| from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter | ||
| from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter as OTLPSpanExporterHTTP | ||
|
|
||
| OTEL_AVAILABLE = True | ||
| except ImportError: | ||
| OTEL_AVAILABLE = False | ||
| logger.debug("OpenTelemetry not available, telemetry will not be exported") |
Collaborator
Author
There was a problem hiding this comment.
otel should be installed by default.
| self._tracer = None | ||
| self._initialized = False | ||
|
|
||
| if not OTEL_AVAILABLE: |
Collaborator
Author
There was a problem hiding this comment.
otel should be enabled by default
| if not self._config.is_enabled: | ||
| return False | ||
|
|
||
| try: |
Collaborator
Author
There was a problem hiding this comment.
enabled by default
| Returns: | ||
| TelemetryExporter instance or None if not available | ||
| """ | ||
| if not OTEL_AVAILABLE: |
Collaborator
Author
There was a problem hiding this comment.
enabled by default
Comment on lines
+18
to
+31
| try: | ||
| from rich.console import Console | ||
| from rich.prompt import Prompt | ||
|
|
||
| RICH_AVAILABLE = True | ||
| except ImportError: | ||
| RICH_AVAILABLE = False | ||
|
|
||
| try: | ||
| import questionary | ||
|
|
||
| QUESTIONARY_AVAILABLE = True | ||
| except ImportError: | ||
| QUESTIONARY_AVAILABLE = False |
Collaborator
Author
There was a problem hiding this comment.
remove this
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This enhancement aims to improve CodeCarbon by gathering anonymous usage data while ensuring user privacy and consent.
Description
Please explain the changes you made here.
Related Issue
Please link to the issue this PR resolves: [issue #1106]
Motivation and Context
Why is this change required? What problem does it solve?
How Has This Been Tested?
Please describe in detail how you tested your changes.
Screenshots (if appropriate):
Types of changes
What types of changes does your code introduce? Put an
xin all the boxes that apply:Checklist:
Go over all the following points, and put an
xin all the boxes that apply.