mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-25 03:20:23 +01:00

History

PeterYinusa 273c1dedb7 Docs - segment metrics (#14435 ) * expand docs for metrics * link to docs * link to docs * remove obsolete docs * fix broken link		2022-04-19 16:15:41 +01:00
..
build	Restore `version` missing from certain build steps (#14344 )	2022-04-04 16:44:32 -02:30
highlights
lib
states
announcer.js
chromereload.js
create-static-server.js
empty.js
generate-lavamoat-policies.sh	Run main, flask and beta in sequence in generate-lavamoat-policies.sh (#14470 )	2022-04-19 11:13:47 -02:30
generate-migration.sh
gource-viz.sh
jest.config.js
metamaskbot-build-announce.js	Update metamaskbot-build-announce.js (#14320 )	2022-03-31 16:11:59 -10:00
missing-locale-strings.js
mock-3box.js
mock-segment.js
README.md	Docs - segment metrics (#14435 )	2022-04-19 16:15:41 +01:00
run-ganache.sh
sentry-publish.js
sentry-upload-artifacts.sh
shellcheck.sh
show-deps-install-scripts.js
source-map-explorer.sh
sourcemap-validator.js
static-server.js
stream-flat-map.js
verify-locale-strings.js

README.md

Development

Several files which are needed for developing on MetaMask.

Usually each file or directory contains information about its scope / usage.

Segment

Debugging with the Mock Segment API

To start the Mock Segment API:

Add/replace the SEGMENT_HOST and SEGMENT_WRITE_KEY variables in .metamaskrc
```
SEGMENT_HOST='http://localhost:9090'
SEGMENT_WRITE_KEY='FAKE'
```
Build the project to the ./dist/ folder with yarn dist
Run the Mock Segment API from the command line
```
node development/mock-segment.js
```

Events triggered whilst using the extension will be logged to the console of the Mock Segment API.

More information on the API and its usage can be found here.

Debugging in Segment

To debug in a production Segment environment:

Create a free account on Segment
Create a New Workspace
Add a Source (Node.js)
Copy the Write Key from the API Keys section under Settings

Add/replace the SEGMENT_HOST and SEGMENT_WRITE_KEY variables in .metamaskrc

SEGMENT_HOST='https://api.segment.io'
SEGMENT_WRITE_KEY='COPIED_WRITE_KEY'

Build the project to the ./dist/ folder with yarn dist

Events triggered whilst using the extension will be displayed in Segment's Debugger.

Debugging Segment requests in MetaMask

To opt in to MetaMetrics;

Unlock the extension
Open the Account menu
Click the Settings menu item
Click the Security & Privacy menu item
Toggle the Participate in MetaMetrics menu option to the ON position

You can inspect the requests in the Network tab of your browser's Developer Tools (background.html) by filtering for POST requests to /v1/batch. The full url will be http://localhost:9090/v1/batch or https://api.segment.io/v1/batch respectively.