Help improve the tool

​

🙏 Why is this important?

By opting into sending usage statistics to Mage, it’ll help the team and community of contributors (Magers) learn what’s going wrong with the tool and what improvements can be made.

In addition to helping reduce potential errors, you’ll help inform which features are useful and which need work.

​

🤔 What usage statistics am I sending?

​

Project UUID

Each project will have a universally unique identifier. This will help Mage count how many projects have been created.

Your project UUID is stored in the project’s metadata.yaml file, located at the root of your project: [project_name]/metadata.yaml.

Here is an example of what it could look like:

variables_dir: ~/.mage_data

# ...

project_uuid: 4279d28ab1f64644b1f2f4f779be7b7e

​

Number of pipelines

Sending usage statistics will include the number of pipelines in a single project. This will help improve the coding experience when building pipelines.

​

Number of pipeline runs

Sending usage statistics will include the number of times any pipeline has ran in a single project. This will help add better pipeline management features.

​

Number of users

Sending usage statistics will include the number of users in a single project. This will help improve the collaboration capabilities of the tool.

​

Errors

When an application error occurs in Mage, the error type, error message, and offending line of code will be included in the usage statistics. This will help fix bugs and improve the developer experience.

​

Platform

The operating system, release, version, etc of the machine that Mage is running on. This information will help reproduce errors.

​

🤷‍♀️ How does this work?

Usage statistics are anonymously sent to Mage’s online server.

Here’s a sample of the JSON payload containing usage statistics that could be sent:

{
  "usage_statistic": {
    "project_uuid": "4279d28ab1f64644b1f2f4f779be7b7e",
    "pipelines": 40,
    "pipeline_runs": 357,
    "users": 13,
    "platform": "Linux-5.15.49-linuxkit-aarch64-with-glibc2.31",
    "version": "0.8.70",
    "error": {
      "message": "...",
      "traceback": "..."
    }
  }
}

​

Enable

To enable sending usage statistics, add a key in the project’s metadata.yaml file called help_improve_mage with the value true.

Here is an example:

project_uuid: 4279d28ab1f64644b1f2f4f779be7b7e
help_improve_mage: true

​

Disable

To disable, change the value of help_improve_mage to false.

Here is an example:

project_uuid: 4279d28ab1f64644b1f2f4f779be7b7e
help_improve_mage: false