This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
The following commit(s) were added to refs/heads/master by this push:
new 5dbc006 Initial commit of observability docs (#214)
5dbc006 is described below
commit 5dbc0061c173120443f643dc2cf1291f1e799674
Author: Aaron Ai <[email protected]>
AuthorDate: Wed Aug 31 17:52:21 2022 +0800
Initial commit of observability docs (#214)
---
docs/design.md | 8 ++++----
docs/observability.md | 14 ++++++++++++++
2 files changed, 18 insertions(+), 4 deletions(-)
diff --git a/docs/design.md b/docs/design.md
index a8dad53..5380b00 100644
--- a/docs/design.md
+++ b/docs/design.md
@@ -53,10 +53,10 @@ There are four types of client.
Client identifier provides indentity information for each client event within
the same process. A typical client identifier: `macbook-pro@90009@0@2dyeb8lep`,
which could be divided into 4 parts by the separator `@`.
-1. `macbook-pro`: hostname of device;
-2. `90009`: process identifier;
-3. `2`: client index within current process;
-4. `2dyeb8lep`: the unique string within process.
+* `macbook-pro`: hostname of device;
+* `90009`: process identifier;
+* `2`: client index within current process;
+* `2dyeb8lep`: the unique string within process.
>**Note**: Implementations of client identifier by different languages may
>vary slightly, but the uniqueness is the first principle that must be
>followed.
diff --git a/docs/observability.md b/docs/observability.md
new file mode 100644
index 0000000..adae33d
--- /dev/null
+++ b/docs/observability.md
@@ -0,0 +1,14 @@
+# Observability
+
+## Metrics
+
+## Tracing
+
+## Logging
+
+### Logging Default Path
+
+| Language | Path |
+| -------- | ----------------------------------------- |
+| CPP | `$HOME/logs/rocketmq/client.log` |
+| Java | `$HOME/logs/rocketmq/rocketmq-client.log` |
\ No newline at end of file
