From 1e6e11555c040d3f9a1a31265a8bf9f9ce54f570 Mon Sep 17 00:00:00 2001
From: Marwan Sarieddine <sarieddine.marwan@gmail.com>
Date: Fri, 28 Jun 2024 17:36:56 +0300
Subject: [PATCH] Add section on telemetry

---
 README.md      | 21 ++++++++++++++++++++-
 docs/index.rst | 24 +++++++++++++++++++++++-
 2 files changed, 43 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d13d247..616d1e1 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ This repository provides a set of tools for integrating Anyscale with Apache Air
 - **AnyscaleHook**: Facilitates communication between Airflow and Anyscale. It uses the Anyscale API to interact with the Anyscale platform, providing methods to submit jobs, query their status, and manage services.
 
 #### Operators
-- **SubmitAnyscaleJob**: This operator submits a job to Anyscale. It takes configuration parameters for the job, such as the entry point, build ID, and compute configuration. The operator uses `AnyscaleHook` to handle the submission process.
+- **SubmitAnyscaleJob**: This operator submits a job to Anyscale. It takes configuration parameters for the job, such as the entrypoint, image URI, and compute configuration. The operator uses `AnyscaleHook` to handle the submission process.
 - **RolloutAnyscaleService**: Similar to the job submission operator, this operator is designed to manage services on Anyscale. It can be used to deploy new services or update existing ones, leveraging `AnyscaleHook` for all interactions with the Anyscale API.
 
 #### Triggers
@@ -177,6 +177,25 @@ terminate_anyscale_service = PythonOperator(
 deploy_anyscale_service >> terminate_anyscale_service
 ```
 
+## Usage stats
+
+This provider collects usage stats data by default (guarded by an opt-out prompt). This data will be used by the open-source Anyscale engineering team to better understand how to the provider is being used and help guide future development.
+
+Here are the guiding principles of our collection policy:
+
+- Easy opt-out: You will be able to easily opt-out of data collection
+- Transparency — you will be able to review all data that is sent to us
+- Control — you will have control over your data, and we will honor requests to delete your data.
+
+We will not collect any personally identifiable data or proprietary code/data
+
+We will not sell data or buy data about you.
+
+You will always be able to disable the usage stats collection.
+
+To disable usage stats collection, set the environment variable `ANYSCALE__AIRFLOW_TELEMETRY_ENABLED` to `false`.
+
+
 ### Changelog
 _________
 
diff --git a/docs/index.rst b/docs/index.rst
index 93012fa..425cb45 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -21,7 +21,7 @@ Hook
 
 Operators
 ~~~~~~~~~
-- **SubmitAnyscaleJob**: This operator submits a job to Anyscale. It takes configuration parameters for the job, such as the entry point, build ID, and compute configuration. The operator uses ``AnyscaleHook`` to handle the submission process.
+- **SubmitAnyscaleJob**: This operator submits a job to Anyscale. It takes configuration parameters for the job, such as the entrypoint, image URI, and compute configuration. The operator uses ``AnyscaleHook`` to handle the submission process.
 - **RolloutAnyscaleService**: Similar to the job submission operator, this operator is designed to manage services on Anyscale. It can be used to deploy new services or update existing ones, leveraging ``AnyscaleHook`` for all interactions with the Anyscale API.
 
 Triggers
@@ -85,6 +85,28 @@ The below script uses the ``RolloutAnyscaleService`` operator to deploy a servic
 
 .. literalinclude:: ../example_dags/anyscale_service.py
 
+
+
+Usage stats
+-----------
+
+This provider collects usage stats data by default (guarded by an opt-out prompt). This data will be used by the open-source Anyscale engineering team to better understand how to the provider is being used and help guide future development.
+
+Here are the guiding principles of our collection policy:
+
+- Easy opt-out: You will be able to easily opt-out of data collection
+- Transparency — you will be able to review all data that is sent to us
+- Control — you will have control over your data, and we will honor requests to delete your data.
+
+We will not collect any personally identifiable data or proprietary code/data
+
+We will not sell data or buy data about you.
+
+You will always be able to disable the usage stats collection.
+
+To disable usage stats collection, set the environment variable \`ANYSCALE__AIRFLOW_TELEMETRY_ENABLED\` to \`false\`.
+
+
 Changelog
 ---------