Improve logging & monitoring docs (#10618)

Co-authored-by: Kaxil Naik <[email protected]>
apache · Aug 30, 2020 · 9b2efc6 · 9b2efc6
1 parent 2ca615c
commit 9b2efc6
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/docs/logging-monitoring/index.rst b/docs/logging-monitoring/index.rst
@@ -18,10 +18,21 @@
 Logging & Monitoring
 ====================
 
-This section contains guides on how to keep your instance and your workflows in good condition.
+Since data pipelines are generally run without any manual supervision, observability is critical.
+
+Airflow has support for multiple logging mechanisms, as well as a built-in mechanism to emit metrics for gathering, processing, and visualization in other downstream systems. The logging capabilities are critical for diagnosis of problems which may occur in the process of running data pipelines.
+
+In addition to the standard logging and metrics capabilities, Airflow supports the ability to detect errors in the operation of Airflow itself, using an Airflow health check. Since Airflow is generally used for running data pipelines in production, it also supports real-time error notification via integration with Sentry.
 
 .. toctree::
     :maxdepth: 1
     :glob:
 
-    *
+    logging-architecture
+    logging-tasks
+    metrics
+
+    check-health
+    errors
+
+    tracking-user-activity
diff --git a/docs/logging-monitoring/logging-architecture.rst b/docs/logging-monitoring/logging-architecture.rst
@@ -26,7 +26,7 @@ Airflow supports a variety of logging and monitoring mechanisms as shown below.
 
 By default, Airflow supports logging into the local file system. These include logs from the Web server, the Scheduler, and the Workers running tasks. This is suitable for development environments and for quick debugging.
 
-For cloud deployments, Airflow also has hooks contributed by the Community for logging to cloud storage such as AWS, Google Cloud, and Azure.
+For cloud deployments, Airflow also has handlers contributed by the Community for logging to cloud storage such as AWS, Google Cloud, and Azure.
 
 The logging settings and options can be specified in the Airflow Configuration file, which as usual needs to be available to all the Airflow process: Web server, Scheduler, and Workers.
 

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -959,6 +959,7 @@ ntlm
 num
 oauth
 objectORfile
+observability
 od
 odbc
 ok
-Original file line number
+Diff line change
@@ Expand Up / @@ -959,6 +959,7 @@ ntlm @@
     num
     oauth
     objectORfile
+    observability
     od
     odbc
     ok
@@ Expand Down @@