You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-7Lines changed: 15 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -273,6 +273,21 @@ then following the log with:
273
273
274
274
tail -F ~/awstoolkit.log
275
275
276
+
### Telemetry
277
+
278
+
See [aws-toolkit-common/telemetry](https://github.com/aws/aws-toolkit-common/tree/main/telemetry#telemetry) for full details about defining telemetry metrics.
279
+
280
+
- You can define new metrics during development by adding items to
- Building the project will trigger the `generateClients` build task, which generates new symbols in `shared/telemetry/telemetry`, which you can import via:
283
+
```
284
+
import { telemetry } from '../../shared/telemetry/telemetry'
285
+
```
286
+
- The metrics defined in `vscodeTelemetry.json` should be upstreamed to [aws-toolkit-common](https://github.com/aws/aws-toolkit-common/blob/main/telemetry/definitions/commonDefinitions.json) after launch (at the latest).
287
+
- Metrics are dropped (not posted to the service) if the extension is running in [CI or other
- You can always _test_ telemetry via [assertTelemetry()](https://github.com/aws/aws-toolkit-vscode/blob/21ca0fca26d677f105caef81de2638b2e4796804/src/test/testUtil.ts#L164), regardless of the current environment.
290
+
276
291
### Service Endpoints
277
292
278
293
Endpoint overrides can be set per-service using the `aws.dev.endpoints` settings. This is a JSON object where each key is the service ID (case-insensitive) and each value is the endpoint. Refer to the SDK [API models](https://github.com/aws/aws-sdk-js/tree/master/apis) to find relevant service IDs.
@@ -285,13 +300,6 @@ Example:
285
300
}
286
301
```
287
302
288
-
### Telemetry and Automation
289
-
290
-
Metrics are only emitted if the extension is assumed to be ran from an actual user rather than automation scripts.
291
-
This condition is checked through an environment variable `AWS_TOOLKIT_AUTOMATION` which is set by test entry points.
292
-
If any truthy value is present, telemetry will be dropped if the current build is not a release version. Utility functions,
293
-
such as `assertTelemetry`, can be used to test specific telemetry emits even in automation.
294
-
295
303
### SAM/CFN ("goformation") JSON schema
296
304
297
305
See [docs/cfn-schema-support.md](./docs/cfn-schema-support.md) for how to fix
0 commit comments