forked from asyncapi/cli
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add METRICS_COLLECTION markdown file
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Metrics collection guideline | ||
|
||
AsyncAPI CLI collects **anonymous metrics** . | ||
You can find examples of the metrics we collect [here]() an [there](). | ||
You can always disable this by setting the environment variable BLABLA to false. | ||
|
||
'AsyncAPI anonymously tracks command executions to improve the specification and tools, ensuring no sensitive data reaches our servers. It aids in comprehending how AsyncAPI tools are used and adopted, facilitating ongoing improvements to our specifications and tools. | ||
|
||
## What we collect | ||
We are collecting the following metrics: | ||
|
||
- asyncapi_adoption.action.invoked | ||
|
||
- asyncapi_adoption.action.executed | ||
|
||
|
||
## Where we collect | ||
... | ||
|
||
## How to disable tracking | ||
To disable tracking, set the "ASYNCAPI_METRICS" env variable to "false" when executing the command. For instance: `ASYNCAPI_METRICS=false asyncapi validate <spec-file-path>` | ||
|
||
Remember that keeping this tracking enabled will help AsyncAPI community to provide better specifications and tools in the future. |