Skip to content

Commit 3184273

Browse files
Ananya AgrawalAnanya Agrawal
Ananya Agrawal
authored and
Ananya Agrawal
committed
Modified logger documentation
1 parent 69b574a commit 3184273

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

logger/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Logger service:
1+
## Logger Service:
22

3-
The Logger Service operates as a standalone component/service within the Jugalbandi (JB) Manager system. Its primary purpose is to record and manage metrics from other key services: api, language, channel, flow and retriever. These metrics provide valuable insights into the performance of each service, facilitate debugging, and help track user requests and responses as well as the time taken by each service to process them.
3+
The logger service operates as a standalone component/service within the Jugalbandi (JB) Manager system. Its primary purpose is to record and manage metrics from other key services: api, language, channel, flow and retriever. These metrics provide valuable insights into the performance of each service, facilitate debugging, and help track user requests and responses as well as the time taken by each service to process them.
44

55
### Core Functionality
66

@@ -10,14 +10,14 @@ The Logger Service operates as a standalone component/service within the Jugalba
1010

1111
### Workflow
1212

13-
When a request or a response passes through a service (api, channel, language, flow, or retriever), a logger object,containing service-specific details, is created. These details include relevant identifiers (e.g., User ID, Turn ID, Channel ID) and metadata specific to the service (e.g., Message Type, Intent, Translation Type).
14-
This logger object is sent asynchronously to the Logger Service via a Kafka queue. The Logger service receives the logger object from its kafka queue and processes the message by:
13+
When a request or a response passes through a service (api, channel, language, flow, or retriever), a logger object containing service-specific details, is created. These details include relevant identifiers (e.g., User ID, Turn ID, Channel ID) and metadata specific to the service (e.g., Message Type, Intent, Translation Type).
14+
This logger object is sent asynchronously to the logger service via a kafka queue. The logger service receives the logger object from its kafka queue and processes the message by:
1515

16-
1. **Unpacking and Identifying the Source Service:**
16+
1. **Unpacking and identifying the source service:**
1717
- The message is unpacked upon receipt.
1818
- The source service from which the message originated is identified.
1919

20-
2. **Logging the Details into the Respective Table:**
20+
2. **Logging the details into the respective table:**
2121
- The corresponding service’s logging function is called in the CRUD layer.
2222
- This function in the CRUD layer performs the following actions:
2323
- Creates a database session.

0 commit comments

Comments
 (0)