Liking cljdoc? Tell your friends :D
ClojureScript only.
dots.vscode.telemetry-sender
The telemetry sender is the contract between a telemetry logger and some telemetry service. Note that extensions must NOT call the methods of their sender directly as the logger provides extra guards and cleaning.
const sender: vscode.TelemetrySender = {...};
const logger = vscode.env.createTelemetryLogger(sender);
// GOOD - uses the logger
logger.logUsage('myEvent', { myData: 'myValue' });
// BAD - uses the sender directly: no data cleansing, ignores user settings, no echoing to the telemetry output channel etc
sender.logEvent('myEvent', { myData: 'myValue' });
The telemetry sender is the contract between a telemetry logger and some telemetry service. **Note** that extensions must NOT
call the methods of their sender directly as the logger provides extra guards and cleaning.
```js
const sender: vscode.TelemetrySender = {...};
const logger = vscode.env.createTelemetryLogger(sender);
// GOOD - uses the logger
logger.logUsage('myEvent', { myData: 'myValue' });
// BAD - uses the sender directly: no data cleansing, ignores user settings, no echoing to the telemetry output channel etc
sender.logEvent('myEvent', { myData: 'myValue' });
```flushcljs
(flush telemetry-sender)Optional flush function which will give this sender a chance to send any remaining events as its {@link TelemetryLogger } is being disposed
Returns: void | Thenable<void>
Optional flush function which will give this sender a chance to send any remaining events
as its {@link TelemetryLogger } is being disposed
**Returns:** `void | Thenable<void>`send-error-datacljs
(send-error-data telemetry-sender error)(send-error-data telemetry-sender error data)Function to send an error. Used within a {@link TelemetryLogger }
Parameters:
error:Error- The error being loggeddata:Record<string, any> | undefined- Any additional data to be collected with the exception
Returns: void
Function to send an error. Used within a {@link TelemetryLogger }
**Parameters:**
- `error`: `Error` - The error being logged
- `data`: `Record<string, any> | undefined` - Any additional data to be collected with the exception
**Returns:** `void`send-event-datacljs
(send-event-data telemetry-sender event-name)(send-event-data telemetry-sender event-name data)Function to send event data without a stacktrace. Used within a {@link TelemetryLogger }
Parameters:
event-name:string- The name of the event which you are loggingdata:Record<string, any> | undefined- A serializable key value pair that is being logged
Returns: void
Function to send event data without a stacktrace. Used within a {@link TelemetryLogger }
**Parameters:**
- `event-name`: `string` - The name of the event which you are logging
- `data`: `Record<string, any> | undefined` - A serializable key value pair that is being logged
**Returns:** `void`cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close