From 6c0359bca5b6342a452e697d2c60b14da5c52f40 Mon Sep 17 00:00:00 2001
From: Kirk Rodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Date: Thu, 28 Nov 2024 16:35:48 -0500
Subject: [PATCH] Add nested field to structured log formatting example;
 Replace curly quotes with straight quotes.

---
 docs/src/user-guide/format-struct-logs-syntax.md | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/docs/src/user-guide/format-struct-logs-syntax.md b/docs/src/user-guide/format-struct-logs-syntax.md
index 6ce3bc60..e0af9c94 100644
--- a/docs/src/user-guide/format-struct-logs-syntax.md
+++ b/docs/src/user-guide/format-struct-logs-syntax.md
@@ -69,7 +69,10 @@ Consider the following log event:
   "@timestamp": 1427153388942,
   "level": "INFO",
   "thread": 0,
-  "latency_secs": 56.4,
+  "latency": {
+    "msecs": 56400,
+    "secs": 56.4,
+  },
   "an.odd.key{name}": "org.apache.hadoop.metrics2.impl.MetricsConfig: loaded properties from hadoop-metrics2.properties"
 }
 ```
@@ -77,14 +80,14 @@ Consider the following log event:
 We can format this using the following YScope format string:
 
 ```
-{@timestamp:timestamp:YYYY-MM-DD HH\:MM\:ss.SSS} {level} \{{thread}\} latency={latency_secs:round} {an\.odd\.key\{name\}}
+{@timestamp:timestamp:YYYY-MM-DD HH\:MM\:ss.SSS} {level} \{{thread}\} latency={latency.secs:round} {an\.odd\.key\{name\}}
 ```
 
 * In the first placeholder, we have the field name `@timestamp`, a formatter called `timestamp`, and
-  the formatter’s options which are a date format string.
+  the formatter's options which are a date format string.
 * The second and third placeholders simply stringify the values of the given fields.
-* The fourth placeholder uses the `round` formatter to round the field’s value; this placeholder
-  doesn’t specify any formatter options, so the defaults will be used.
+* The fourth placeholder uses the `round` formatter to round a nested field's value; this
+  placeholder doesn't specify any formatter options, so the defaults will be used.
 * The fifth placeholder is for a field whose name contains characters that require escaping.
 
 The formatted string will be: