feat: upload source maps to Datadog during MFE deploy #3
Conversation
This file contains 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
adamstankiewicz
force-pushed
the
ags/datadog-sourcemaps
branch
2 times, most recently
from
3e2f22e
to
b407224
Compare
adamstankiewicz
commented
Jun 6, 2024
tubular/scripts/frontend_utils.py
Outdated
| def _upload_js_sourcemaps(self, app_path): | ||
| """ Upload JavaScript sourcemaps to Datadog. """ | ||
| app_config = self.get_app_config() | ||
| api_key = app_config.get('DATADOG_API_KEY') |
There was a problem hiding this comment.
[inform/context]
# Can't upload source maps without ``DATADOG_API_KEY``, which must be set as an environment variable
# before executing the Datadog CLI. The Datadog documentation suggests using a dedicated Datadog API key:
# https://docs.datadoghq.com/real_user_monitoring/guide/upload-javascript-source-maps/
It looks like DATADOG_API_KEY exists in edx-internal as an ansible secret (e.g., here), but I'm not too sure whether this is accessible by the frontend configs used in frontend_utils.py.
As is, I'm attempting to extract DATADOG_API_KEY from the MFE APP_CONFIG. Assumes DATADOG_API_KEY is defined under the common frontend config (e.g., here, shared across all MFEs.
adamstankiewicz
commented
Jun 6, 2024
Comment on lines
+25
to
+28
| @click.option( | ||
| '--common-config-file', | ||
| help='File from which common configuration variables are read.', | ||
| ) |
adamstankiewicz
force-pushed
the
ags/datadog-sourcemaps
branch
from
5ed5733
to
22b38e4
Compare
adamstankiewicz
force-pushed
the
ags/datadog-sourcemaps
branch
from
22b38e4
to
eb9e6ed
Compare
pwnage101
approved these changes
Jun 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related PR: https://github.com/edx/edx-internal/pull/10993
https://docs.datadoghq.com/real_user_monitoring/guide/upload-javascript-source-maps/
Without source maps uploaded to Datadog for MFEs, any reported JS errors are largely not actionable as engineers cannot discern which specific area of code caused the exception due to minified production JS code.
Example from Datadog docs:
Without source maps
JS error without any clues to to which code area/path triggered the error:
With source maps
Human-readable unminified source code of the exact line of JS code that triggered the error, including a direct link to source code on GitHub: