[GitHub] [incubator-pinot] xiaohui-sun commented on a change in pull request #4146: [TE] Migrating documentation to readthedocs.io

[GitBox <gi...@apache.org>]

xiaohui-sun commented on a change in pull request #4146: [TE] Migrating documentation to readthedocs.io
URL: https://github.com/apache/incubator-pinot/pull/4146#discussion_r277070362
 
 

 ##########
 File path: thirdeye/docs/basic_config.rst
 ##########
 @@ -0,0 +1,374 @@
+..
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements.  See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership.  The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License.  You may obtain a copy of the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied.  See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+..
+
+Basic Alert Setup
+==============================
+
+Prerequisites
+-------------
+
+1. Before setting up an alert, you need to make sure you have the
+data/metrics in ThirdEye.
+
+- Pinot metrics are loaded. See :ref:`pinot`
+
+- MySQL or Presto metrics are imported. See :ref:`import-sql-metric`.
+
+2. Before running detection (i.e. `./run-backend.sh`), you need to have production MySQL database setup, since the demo database does not support 
+simultaneous connections from front end and back end. See :ref:`production`.
+
+Setting up an Alert in ThirdEye
+-------------------------------
+
+Setting up an alert in ThirdEye is a **2 step process**. It involves
+writing two configuration files on the ThirdEye UI. These configurations
+empower you to fully control the anomaly detection and unlocks the
+flexibility to fine tune the platform to meet your needs.
+
+The goal of these two configurations are
+
+1. Setting up the  **detection** configuration - for  **how to detect anomalies**.
+
+2. Setting up the  **subscription** configuration - for  **how you want to be subscribed or notified**.
+
+We use YAML as the configuration file format. YAML is an
+indentation-based markup language which aims to be both easy to read and
+easy to write. You may refer a quick YAML
+tutorial  `here <https://gettaurus.org/docs/YAMLTutorial/>`__. 
+
+Step 1: Login to ThirdEye and click on the** *Create Alert* option
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Go to  `go/thirdeye <https://go.corp.linkedin.com/thirdeye>`__ and
+login. Click on "Create Alert" tab you see at the right top corner of
+the page. This should land you on the page where you can now setup the
+ThirdEye alerts. As we discussed above, there are 2 configurations
+(detection and subscription) you would need to fill in.
+
+Step 2: Writing the Detection Configuration (Define anomaly detection in YAML)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This configuration defines what kind of rules and detection functions
+you want to run on the metrics. You may edit and tweak this
+configuration even after setting up the alerts.
+
+You can take the help of the template in the UI and the below sub-steps
+to complete this configuration.
+
+If you just want to play around, you may look at an existing sample
+configuration file here
+:ref:`templates-detection`,
+edit them accordingly and move on to the next step (Step 3).
+
+
+a. Provide the basic information in the detection configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Basic information starts with the name of detection pipeline,
+description, metric name, dataset name and pipeline type. All these
+fields are mandatory.
+
+The description of these properties is shown as comments below:
+
+.. code-block:: yaml
+
+   # Give a unique name for this anomaly detection pipeline.
+   detectionName: name_of_the_detection
+
+   # Tell the alert recipients what it means if this alert is fired
+   description: If this alert fires then it means so-and-so and check so-and-so for irregularities
+
+   # The metric you want to do anomaly detection on.
+   metric: metric_name
+
+   # The data set name for the metric.
+   dataset: dataset_name
+
+   # Only "composite" is supported now.
 
 Review comment:
   "Composite* is not needed. Please remove it from all the docs.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org