Background
Out of the box, PixieBrix automatically collects engagement and error telemetry for and makes it available in the Admin Console.
By default, error telemetry does not include detailed information about page, e.g., URL/origin for failed API calls. However, on an Enterprise plan you can turn on detailed telemetry (e.g., for debugging firewall/VPN problems).
Additionally, if you have existing logging infrastructure, on an Enterprise plan you can configure the PixieBrix browser extension to send telemetry to your own endpoint(s).
Extension Event Telemetry
PixieBrix automatically captures extension engagement telemetry so extension creators can measure business impact and identify onboarding problems.
Additionally, extension creators can send custom telemetry for us in business reports using the Send Telemetry brick in the PixieBrix Marketplace
For performance, event telemetry is batched POSTed to the collection endpoint.
In JSON Schema (in YAML for conciseness):
type: object
properties:
uid:
type: string
format: UUID
description: A random unique identifier for the browser profile
event:
type: string
description: The event name
examples:
- TriggerRun
- MenuItemClick
timestamp:
type: number
description: Unix timestamp (milliseconds since Unix epoch)
person:
type: object
properties:
email:
type: string
format: email
data:
type: object
additionalProperties: true
properties:
version:
type: string
description: The PixieBrix Browser Extension version number
examples:
- 1.7.0
versionName:
type: string
description: The PixieBrix Browser Extension full version name
examples:
- 1.7.0-beta.1
extensionId:
type: string
format: uuid
description: The UUID of the extension. Generated when the extension is installed
label:
type: string
description: The label/name of the extension
deploymentId:
type: string
format: UUID
description: 'The deployment UUID, if the extension is part of a deployment'
extensionPointId:
type: string
description: 'The extension point id registry id, or internal generated identifier'
blueprintId:
type: string
description: The mod registry id
blueprintVersion:
type: string
description: The mod semantic versionMod Error Telemetry
PixieBrix automatically captures mod error telemetry so mod creators can monitor the health of their mods and re-usable bricks.
In JSON Schema (in YAML for conciseness):
type: object
properties:
uuid:
type: string
format: UUID
description: A generated unique identifier for the error instance
message:
type: string
description: The error message/description
timestamp:
type: string
format: date-time
description: ISO date-time string
person:
type: object
properties:
email:
type: string
format: email
deployment:
type: string
format: UUID
description: 'The deployment UUID, if the extension is part of a deployment'
extension_uuid:
type: string
format: uuid
description: >-
The UUID of the custom extension. Generated when the extension is
installed
extension_label:
type: string
description: The label of the custom extension
user_agent:
type: string
description: The user agent of the browser
user_agent_extension_version:
type: string
description: The PixieBrix Browser Extension version number
examples:
- 1.7.0
is_application_error:
type: boolean
description: True if a application error (vs. a business error)
block:
type: object
properties:
id:
type: string
format: uuid
description: The block registry id
examples:
- '@pixiebrix/automation-anywhere/run-bot'
version:
type: string
description: The block semantic version
blueprint:
type: object
properties:
id:
type: string
format: uuid
description: The mod registry id
version:
type: string
description: The mod semantic version
service:
type: object
properties:
id:
type: string
format: uuid
description: The service registry id
version:
type: string
description: The service semantic version