Review markups

Author: samtarver

articles/operator-insights/ingestion-agent-configuration-reference.md

@@ -51,12 +51,16 @@ pipelines:
   # Pipeline IDs must be unique for a given agent instance. Any URL reserved characters must be percent-encoded.
   - id: mcc-edrs
     source:
-      mcc_edrs: <mcc edrs source configuration>
-    sink: <sink configuration>
+      mcc_edrs:
+        <mcc edrs source configuration>
+    sink:
+      <sink configuration>
   - id: contoso-logs
     source:
-      sftp_pull: <sftp pull source configuration>
-    sink: <sink configuration>
+      sftp_pull:
+        <sftp pull source configuration>
+    sink:
+      <sink configuration>
 ```
 
 ## Sink configuration
@@ -153,10 +157,10 @@ source:
       # The path to a folder on the SFTP server that files will be uploaded to Azure Operator Insights from.
       base_path: /path/to/sftp/folder
       # Optional. A regular expression to specify which files in the base_path folder should be ingested. If not specified, the agent will attempt to ingest all files in the base_path folder (subject to exclude_pattern, settling_time and exclude_before_time).
-      include_pattern: ".*\.csv$"
+      include_pattern: ".*\.csv$" # Only include files which end in ".csv"
       # Optional. A regular expression to specify any files in the base_path folder which should not be ingested. Takes priority over include_pattern, so files which match both regular expressions will not be ingested.
       # The exclude_pattern can also be used to ignore whole directories, but the pattern must still match all files under that directory. e.g. `^excluded-dir/.*$` or `^excluded-dir/` but *not* `^excluded-dir$`
-      exclude_pattern: "\.backup$|^\.staging/"
+      exclude_pattern: "^\.staging/|\.backup$" # Exclude all file paths that start with ".staging/" or end in ".backup"
       # A duration, such as "10s", "5m", "1h".. During an upload run, any files last modified within the settling time are not selected for upload, as they may still be being modified.
       settling_time: 1m
       # Optional. A datetime that adheres to the RFC 3339 format. Any files last modified before this datetime will be ignored.

articles/operator-insights/monitor-troubleshoot-ingestion-agent.md

@@ -119,8 +119,8 @@ Symptoms: No data appears in Azure Data Explorer. Logs of category `Ingestion` d
 
 - Check that the agent is running on all VMs and isn't reporting errors in logs.
 - Check that files exist in the correct location on the SFTP server, and that they aren't being excluded due to file source config (see [Files are missing](#files-are-missing)).
-- Check the network connectivity and firewall configuration between the ingestion agent VM and the Data Product's input storage account.
 - Ensure that the configured SFTP user can read all directories under the `base_path`, which file source config doesn't exclude.
+- Check the network connectivity and firewall configuration between the ingestion agent VM and the Data Product's input storage account.
 
 ### Files are missing
 

articles/operator-insights/set-up-ingestion-agent.md

@@ -139,7 +139,7 @@ On the SFTP server:
 
 1. Ensure port 22/TCP to the VM is open.
 1. Create a new user, or determine an existing user on the SFTP server that the ingestion agent should use to connect to the SFTP server.
-    - The ingestion agent searches every directory under the base path, which isn't excluded, so this user must be able to read all of them.
+    - By default the ingestion agent searches every directory under the base path, so this user must be able to read all of them. Any directories that the user does not have permission to access must be excluded using the `exclude_pattern` configuration.
     > [!Note]
     > Implicitly excluding directories by not specifying them in the included pattern is not sufficient to stop the agent searching those directories. See [the configuration reference](ingestion-agent-configuration-reference.md) for more detail on excluding directories.
 1. Determine the authentication method that the ingestion agent should use to connect to the SFTP server. The agent supports: