BI Events/Analytics
Comet Onprem - BI Events¶
This document provides a comprehensive overview of all the BI events that are generated within the Comet application. By reviewing these events, you can gain a deeper understanding of how your team is using Comet and make more informed decisions about product usage.
Suported BI tools¶
- AWS CloudWatch
Common Properties¶
Most of the BI events has common properties populated.
| Column Name | Type | Description |
|---|---|---|
| id | character varying(512) | Unique ID for the BI Event |
| projectName | character varying(512) | Project Name |
| projectId | character varying(512) | Unique ID for the project |
| sdkVersion | character varying(512) | SDK Version used |
| teamName | character varying(512) | Name of the workspace |
| py_version | character varying(512) | Python Version used |
| event | character varying(512) | Name of the event |
| timestamp | timestamp without time zone | Timestamp of the event created |
| userId | character varying(512) | Unique User ID |
| experimentKey | character varying(512) | ID of the experiment |
| organizationId | character varying(512) | Unique ID of the company |
| organizationName | character varying(512) | Name of the company |
| backendVersion | character varying(512) | Deployed Comet Backend Version |
| licenseKey | character varying(512) | License Key used by the user |
add_experiment_to_project_be¶
Triggered¶
Experiment added to previously created project.
add_tag_to_experiment_be¶
Triggered¶
Tag added to the experiment via SDK or UI.
Additional features¶
| Column Name | Type | Description |
|---|---|---|
| tag | character varying(512) | name of the tag assigned |
add_team_member_be¶
Triggered¶
New users added to the workspace.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| addedUserName | character var (512) | userId of the new user |
| isAdmin | boolean | new user admin status |
chart_template_actions_be¶
Triggered¶
CRUD actions on the chart templates.
Structure¶
| Column Name | Type | Description |
|---|---|---|
| action | character var (512) | Action Type: new / update / delete |
delete_experiment_be¶
Triggered¶
Experiment deleted.
delete_project_details_be¶
Triggered¶
Any project detail deleted
delete_registry_model_be¶
Triggered¶
Registry model deleted.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| registryModelId | character varying(512) | ID of the deleteded registry model |
delete_report_be¶
Triggered¶
Report deleted.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| report_id | char var(512) | ID of the deleted report |
delete_tag_from_project_be¶
Triggered¶
Tag removed from project.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| tagName | char var(512) | Name of the removed tag |
delete_team_be¶
Triggered¶
Team deleted from Organization.
download_artifact_version_zip_be¶
Triggered¶
Artifact downloaded.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| artifactName | char var(512) | Name of the artifact |
| artifactVersionId | char var(512) | Version ID of the artifact |
download_asset_be¶
Triggered¶
An asset downloaded.
download_git_patch_be¶
Triggered¶
GIT Patch downloaded.
download_image_be¶
Triggered¶
Any image downloaded.
existing_logger_run_be¶
Triggered¶
Created an existing experiment.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| pipVersion | char var(512) | pip installer version |
file_name_for_experiment_be¶
Triggered¶
Changed the file name of the script/notebook.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| fileType | char var(512) | Type of the file: script / jupyter |
get_experiment_view_be¶
Triggered¶
Experiment viewed using Comet UI.
get_project_column_be¶
Triggered¶
Project viewed using Comet UI.
git_hub_start_be¶
Triggered¶
Initialization of github repo for the experimentation.
invite_to_team_be¶
Triggered¶
Invitation send to the new workspace member.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| sharedWithEmail | char var(512) | New user's email address |
list_project_reports_be¶
Triggered¶
Listing the reports of specific projects.
list_report_revisions_be¶
Triggered¶
Listing the revisions of any report.
manually_modify_metric_param_other_be¶
Triggered¶
Metric parameter modified using SDK or UI.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| metricValue | char var(512) | Metric parameter type: metrics / params / log_other |
| metricName | char var(512) | Name of the metric changed |
mpm_alerts_managment¶
Triggered¶
Any changes on Model Production Monitoring.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| modelId | char var(512) | Unique ID for the monitored model |
| operation | char var(512) | Operation ran: ADD_RULES / DELETE_RULE / DISMISS_NOTIFICATION |
new_experiment_be¶
Triggered¶
New experiment created/logged.
new_offline_experiment_be¶
Triggered¶
New experiment created/logged using an offline environment and synced when became online.
new_optimization_be¶
Triggered¶
New optimization created.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| optimizationId | char var(512) | Unique ID for the new optimization |
| optimizerVer | char var(512) | Optimizer version used to create optimiation |
| allowedOnPlan | char var(512) |
new_project_be¶
Triggered¶
New project created.
new_team_created_be¶
Triggered¶
New team created.
new_user_created_be¶
Triggered¶
New user created.
panel_template_create_be¶
Triggered¶
New panel template created by user.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| createdFrom | char var(512) | Unique ID of the parent template |
| duplicate | boolean | Is this template duplicated from another one |
| panelTemplateId | char var(512) | Unique ID of the created panel template |
| type | char var(512) | Type used creating the panel template: js / py |
panel_template_delete_be¶
Triggered¶
Panel template deleted by user.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| templateId | char var(512) | Unique ID of the deleted panel template |
panel_template_instance_create_be¶
Triggered¶
New instance of a panel template created.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| templateId | char var(512) | Unique ID of the panel template |
| type | char var(512) | Type used creating the panel template: js / py |
panel_template_instance_retrieve_be¶
Triggered¶
New instance of a panel template loaded.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| panelTemplateId | char var(512) | Unique ID of the panel template |
| instanceId | char var(512) | Unique ID of the instance |
| type | char var(512) | Type used creating the panel template: js / py |
panel_template_instance_update_be¶
Triggered¶
Instance of a panel template updated.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| panelTemplateId | char var(512) | Unique ID of the panel template |
| instanceId | char var(512) | Unique ID of the instance |
panel_template_update_be¶
Triggered¶
Panel template updated.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| panelTemplateId | char var(512) | Unique ID of the panel template |
| type | char var(512) | Type used updating the panel template: js / py |
panel_template_vote_be¶
Triggered¶
Panel template voted by a user.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| panelTemplateId | char var(512) | Unique ID of the panel template |
| voteType | char var(512) | Type of the vote: DOWNVOTE / UPVOTE |
project_segment_action_be¶
Triggered¶
Action on the project segments.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| segmentId | char var(512) | Unique ID of the segment |
| action | char var(512) | Type of the vote: upsert / delete |
remove_tag_from_experiment_be¶
project_segment_action_be¶
Triggered¶
Action on the project segments.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| tagName | char var(512) | Name of the tag |
remove_team_member_be¶
Triggered¶
User removed from a team.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| removedUserName | char var(512) | userId of the team member removed |
reproduce_get_be¶
Triggered¶
Reproduce feature used to get the repo.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| hasData | boolean | Has repo got any data? true / false |
reset_password_end_be¶
Triggered¶
User forgot password and completed the reset process.
reset_password_star_be¶
Triggered¶
User forgot password and started the reset process.
rest_api_call_be¶
Triggered¶
REST API call used.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| callName | char var(512) | Endpoint used by the REST API call |
restore_experiment_be¶
Triggered¶
Experiment restored.
save_chart_template_be¶
Triggered¶
A chart saved into a panel template.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| templateId | char var(512) | Unique ID of the template |
sdk_experiment_created¶
Triggered¶
Experiment created using SDK.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| _runId | char var(512) | Unique ID of the experiment run |
| apiKey | char var(512) | API key used on creating experiment |
sdk_experiment_creation_duration¶
Triggered¶
Experiment started and completed the creation via SDK.
Note
This event only used to asses the duration of the creation, not the actual experiment duration.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| err_msg | char var(512) | Duration of the experiment creation in seconds |
| _runId | char var(512) | Unique ID of the experiment run |
| apiKey | char var(512) | API key used on creating experiment |
sdk_experiment_creation_failed¶
Triggered¶
Experiment creation via SDK failed.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| err_msg | char var(512) | Context of the failure |
| _runId | char var(512) | Unique ID of the experiment run |
| apiKey | char var(512) | API key used on creating experiment |
sdk_git_patch_generation_failed¶
Triggered¶
GIT path generation failed for the SDK.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| err_msg | char var(512) | Context of the failure |
| _runId | char var(512) | Unique ID of the experiment run |
| apiKey | char var(512) | API key used on creating experiment |
sdk_on_exit_didnt_finish_upload_sdk¶
Triggered¶
SDK interrupted or failed while uploading.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| err_msg | char var(512) | Context of the failure with the messages and uploads count |
| _runId | char var(512) | Unique ID of the experiment run |
| apiKey | char var(512) | API key used on creating experiment |
update_artifact_state_be¶
Triggered¶
Updated artifact's state.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| artifactName | char var(512) | Name of the artifact |
| state | char var(512) | State of the artifact: CLOSED / ERROR |
| version | char var(512) | Version of the artifact |
| artifactVersionId | char var(512) | Unique ID of the specific version of artifact |
update_registry_model_be¶
Triggered¶
Updated registry model.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| registryModelId | character varying(512) | ID of the registry model |
| experimentModelId | character varying(512) | ID of the experiment used on model |
| version | char var(512) | Version of the registry model |
| isNew | boolean | Condition of the registy model whether is new: true / false |
update_team_member_be¶
Triggered¶
Change the username of a users in a workspace.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| updatedUserName | character varying(512) | new userId of the user |
update_team_plan_be¶
Triggered¶
Updated any information of a workspace
update_user_notification_be¶
Triggered¶
Change in notification settings.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| opt_in | boolean | Condition of the notification: true / false |
upload_asset_from_training_be¶
Triggered¶
Asset uploaded from training data.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| type | character varying(512) | Type of the asset |
| fileName | character varying(512) | File name of the asset |
upload_git_patch_be¶
Triggered¶
Git patch uploaded
upload_media_from_notes_be¶
Triggered¶
Media uploaded from Notes section.
upload_media_from_training_be¶
Triggered¶
Media uploaded from Notes training data.
upload_profile_pic_be¶
Triggered¶
Profile picture of a user uploaded.
upload_project_pic_be¶
Triggered¶
Profile picture of a project uploaded.
upsert_artifact_be¶
Triggered¶
Artifact upserted.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| artifactName | char var(512) | Name of the artifact |
| artifactVersionId | char var(512) | Unique ID of the specific version of artifact |
upsert_report_be¶
Triggered¶
Report upserted.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| reportName | char var(512) | Name of the report |
| reportId | char var(512) | Unique ID of the specific report |
user_created_experiment_from_be¶
Triggered¶
Experiment created. More information about the source used to creat experiments.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| _runId | char var(512) | Unique ID of the experiment run |
| source | char var(512) | Source used to create experiment |
user_email_verify_be¶
Triggered¶
User verified the email sent for user creation.
*** note This event contains Personally identifiable information (PII)
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| char var(512) | email of the newly added user |
user_imported_experiment_from_be¶
Triggered¶
User added via SDK over an experiment.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| _runId | char var(512) | Unique ID of the experiment run |
| source | char var(512) | Source used to create experiment |
user_logged_dataset_hash_be¶
Triggered¶
User logged hashed dataset.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| _runId | char var(512) | Unique ID of the experiment run |
| hash | char var(512) | Hash key |
user_login_be¶
Triggered¶
User logged in to Comet App using UI.
*** note This event contains Personally identifiable information (PII)
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| char var(512) | email of the user | |
| status | boolean | Is user account active? true / false |
| userType | char var(512) | Login method of the user: regular / github |
user_logout_be¶
Triggered¶
User logged out from Comet App using UI.
view_artifact_page_be¶
Triggered¶
Artifact page sent to user's browser.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| artifactName | char var(512) | Name of the artifact |
view_artifact_version_page_be¶
Triggered¶
Artifact version page sent to user's browser.
Additional fields¶
| Column Name | Type | Description |
|---|---|---|
| artifactName | char var(512) | Name of the artifact |
| artifactVersionId | char var(512) | Unique ID of the specific version of artifact |
| version | char var(512) | Version of the artifact |
view_artifacts_list_be¶
Triggered¶
Artifact list page sent to user's browser.
view_assets_list_be¶
Triggered¶
Asset list page sent to user's browser.