Add request, response log for the Portkey PII plugin to the main requ…#1052
Conversation
|
DescriptionSummary By MatterAI
🔄 What ChangedThis Pull Request introduces comprehensive logging for the Portkey PII plugin. New interfaces ( 🔍 Impact of the ChangeThis change significantly enhances the observability and debugging capabilities for interactions with the Portkey PII plugin. Developers can now access detailed logs of API requests and responses, including timing and metadata, which will greatly assist in troubleshooting, performance analysis, and understanding the plugin's behavior. The structured logging also lays the groundwork for integration with external monitoring and tracing systems. 📁 Total Files Changed2 files were changed in this pull request. 🧪 Test AddedNo specific unit or integration tests were explicitly detailed or provided in the patch data for this pull request. The changes primarily focus on adding logging capabilities and refactoring existing functions to accommodate the new log object. 🔒Security VulnerabilitiesNo new security vulnerabilities were detected in the changes introduced by this pull request. The changes focus on logging and do not introduce new external dependencies or alter existing security-sensitive logic. MotivationTo improve the observability and debugging experience for the Portkey PII plugin by providing detailed request and response logs for all interactions. Type of Change
How Has This Been Tested?
Screenshots (if applicable)N/A Checklist
Related IssuesN/A Tip Quality Recommendations
Sequence DiagramsequenceDiagram
participant User as External System/User
participant H as handler (plugins/portkey/pii.ts)
participant D as detectPII (plugins/portkey/pii.ts)
participant F as fetchPortkey (plugins/portkey/globals.ts)
participant P as Portkey PII API
User->>H: Call handler(context, eventType, options)
activate H
H->>D: detectPII(textArray, parameters, env)
activate D
D->>F: fetchPortkey(env, PORTKEY_ENDPOINTS.PII, credentials, data, timeout)
activate F
F->>P: POST ${BASE_URL}${endpoint} (data, headers: x-portkey-api-key)
activate P
P-->>F: HTTP Response (status, headers, body)
deactivate P
alt Successful Response
F-->>D: { response: PIIResponse[], log: LogObject }
else Error during API call
F--x D: Throw { error, log: LogObject }
end
deactivate F
alt Successful PII Detection
D-->>H: { results: PIIResult[], log: LogObject }
else Error from fetchPortkey
D--x H: Propagate Error { error, log: LogObject }
end
deactivate D
alt Successful Handler Execution
H-->>User: { error: null, verdict, data, transformedData, transformed, log: LogObject }
else Error in Handler
H-->>User: { error: Error, verdict, data, transformedData, transformed, log: LogObject }
end
deactivate H
|
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
2 participants
Title: Add request, response log for the Portkey PII plugin to the main request trace
🔄 What Changed
🔍 Impact of the Change
📁 Total Files Changed
🧪 Test Added
N/A - No tests were added in this PR
🔒 Security Vulnerabilities
No security vulnerabilities were introduced. The PR improves security observability.
Quality Recommendations
Add proper error handling for the case when both the Cloudflare service binding and regular post request fail
Consider adding type safety for the error object in the catch block
Add validation for the response data before processing it
Consider adding unit tests for the new logging functionality