Telemetry Events

You are viewing documentation for a legacy Rasa product. If you want to get started building assistants with Rasa please check out our latest documentation here.

These are the events we anonymously track in order to improve our products. They are only tracked if telemetry is enabled.

note

We track events from both the backend and the frontend. Backend events look like Model Trained. Frontend events look like actions:share-bot:show.

Conversations screen

Message Annotated

backend Sent when a message is annotated (i.e. its intent made explicit by the user). Event properties:

• message_annotated_from (string): Indicates from where the message was annotated. See also: entity:annotation:corrected. Can be one of: "conversations", "annotate_new_data", "interactive_learning".

Message Received

backend Sent when a user event is received, that is, read from the event broker by the event service. Event properties:

• username (string): Anonymized username (using SHA256).
• channel (string): Channel from which the message was received.

Message Flagged

backend Sent when a user flags a conversation message.

Conversation Tagged

backend Sent when one or more tags are assigned to a conversation. Event properties:

• count (integer): Number of new tags assigned to the conversation.

Conversation Reviewed

backend Sent when a conversation is marked as reviewed.

Conversation Saved For Later

backend Sent when a conversation is saved for later.

Undo Conversation Reviewed

backend Sent when a conversation that was marked as reviewed no longer is.

Undo Conversation Saved For Later

backend Sent when a conversation that was saved for later no longer is.

Conversation Deleted

backend Sent when a conversation is deleted.

view:conversations:loaded

frontend Sent when the user enters the conversations view.

view:conversations:filters:apply

frontend Sent when the conversations filters are applied.

view:conversations:filters:reset

frontend Sent when the conversations filters are reset (cleared).

view:conversations:filters:apply:date

frontend Sent conversations are filtered by date.

entity:conversation:selected

frontend Sent when a conversation is selected from the conversations list.

entity:annotation:corrected

frontend Sent when a user message event is annotated (i.e. its intent corrected).

entity:slots:copied

frontend Sent when the user copies slots to the clipboard.

entity:story:copied

frontend Sent when the user copies a story to the clipboard.

entity:e2eStory:copied

frontend Sent when the user copies an end-to-end story to the clipboard.

entity:e2eStory:opened

frontend Sent when the user opens an end-to-end story tab.

entity:story:copied-to-il

frontend Sent when a conversation is copied from the conversations screen to the 'Talk to your bot' screen.

entity:event:selected

frontend Sent when an event is selected from a conversation.

entity:event:flagged

frontend Sent when a conversation event is flagged.

entity:event:unflagged

frontend Sent when a conversation event is unflagged.

actions:share-bot:show

frontend Sent when the user opens the Share your bot screen.

Interactive Learning screen

view:interactive:loaded

frontend Sent when the user enters the Interactive Learning / Talk to your Bot view.

Stories screen

Story Created

backend Sent when a user creates a new story. Event properties:

• story_created_from (string): Specifies from where the story was created from. Can be one of: "interactive", "stories".

view:stories:loaded

frontend Sent when the user enters the stories view.

NLU Inbox screen

Message Tagged

backend Sent when one or more tags are assigned to a message. Event properties:

• count (integer): Number of new tags assigned to the message.

view:suggestions:loaded

frontend Sent when the user enters the NLU Inbox screen.

NLU Training Data screen

view:regex-lookup:loaded

frontend Sent when the user enters the Regex / Lookup table view.

view:synonyms:loaded

frontend Sent when the user enters the synonyms view.

Responses screen

view:responses:loaded

frontend Sent when the user enters the responses view.

Config & Domain screens

view:config:loaded

frontend Sent when the user enters the config view.

view:domain:loaded

frontend Sent when the user enters the domain view.

Models screen & lifecycle

Model Trained

backend Sent when a Rasa model finishes training.

Model Training Failed

backend Sent when a Rasa model training fails Event properties:

• rasa_open_source (string): Rasa Open Source version.
• total_training_time (number): Total number of seconds it took to train.

Model Uploaded

backend Sent when a Rasa model is uploaded to Rasa X.

Model Promoted

backend Sent when a Rasa model is tagged as 'active'.

view:models:loaded

frontend Sent when the user enters the models view.

Integrated Version Control

Repository Created

backend Sent when a new Git repository is connected to Rasa X. Event properties:

• branch (string): Target branch for the repository.
• created_with_ui (string): When true, the repository was connected via the UI.

Git Changes Pushed

backend Sent when any changes are pushed to the remote Git repository. Event properties:

• branch (string): Name of the branch where the changes were pushed to.

Roles & Users screen (Enterprise only)

view:users:loaded

frontend Sent when the user enters the users view.

view:roles:loaded

frontend Sent when the user enters the roles view.

Miscellaneous

Local X Start

backend Event sent when Rasa X is started with LOCAL_MODE=true. In general, this corresponds to a pip installation.

Server X Start

backend Event sent when Rasa X is started with LOCAL_MODE=false. In general, this corresponds to a docker-compose or Kubernetes installation. Note: This event does not imply Rasa X is running on an actual server! Event properties:

• quick_install (boolean): When true, the one-line deployment script was used to deploy Rasa X.

End-to-End Test Created

backend Sent when a user saves a test. Event properties:

• e2e_test_created_from (string): Specifies from where the test was created from. Can be one of: "interactive", "stories".

Status

backend Event sent automatically every 1 hour. It provides information on the overall project/server status. Event properties:

• project (string): Anonymized project name (using SHA256).
• local_mode (boolean): Value for LOCAL_MODE.
• rasa_x (string): Rasa X version.
• rasa_open_source (string): Rasa Open Source version.
• num_intent_examples (integer): Number of NLU examples.
• num_entity_examples (integer): Number of entity examples.
• num_actions (integer): Number of actions defined in the domain.
• num_templates (integer): Number of templates defined in the domain.
• num_slots (integer): Number of slots defined in the domain.
• num_forms (integer): Number of forms defined in the domain.
• num_intents (integer): Number of intents defined in the domain.
• num_entities (integer): Number of entities defined in the domain.
• num_stories (integer): Number of stories available.
• num_conversations (integer): Total number of conversations in the Rasa X database.
• num_events (integer): Total number of events across all conversations.
• num_models (integer): Number of Rasa models.
• num_lookup_table_files (integer): Number of unique filenames containing lookup tables.
• num_lookup_table_entries (integer): Total number of lookup table entries combined.
• num_synonyms (integer): Total number of entity synonyms defined.
• num_regexes (integer): Total number of regexes defined.
• num_environments (integer): Number of Rasa environments (live or not).
• environment_names (array): Rasa environments names (anonymized).
• num_live_environments (integer): Number of live Rasa environments.
• uptime_seconds (number): Number of seconds elapsed since the Rasa X instance was started.
• num_tags (integer): Total number of tags defined.
• num_conversations_with_tags (integer): Total number of conversations with at least one tag assigned.
• num_nlu_inbox_messages_with_tags (integer): Total number of NLU inbox messages with at least one tag assigned.
• num_e2e_tests (integer): Total number of end-to-end tests.

Conversations Imported

backend Sent when events are saved that originate from a rasa export call. Event properties:

• process_id (string): Unique ID associated with the rasa export call (UUID4).

Feature Flag Updated

backend Sent when a feature flag is enabled or disabled. Event properties:

• name (string): Name of the feature.
• enabled (boolean): Whether the feature was enabled or disabled.

view:analytics:loaded

frontend Sent when the user enters the analytics view.

conversation:hints:enable

frontend Sent when the 'Show me' button in the conversations screen is pressed (under the lightbulb).

Intent Insights

Rasa Cross-Validation Result Requested

backend Sent when the user requests the Rasa Open Source cross-validation results.