Create pluggable observability backend architecture for fetching observability data #74
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![wso2-engineering[bot]](https://avatars.githubusercontent.com/in/1856828?s=60&v=4){kind=small}
Comment on lines
+35
to
+38
| public function main() returns error? { | ||
|
|
||
| if defaultObservabilityBackend == "opensearch" { | ||
| check observabilityBackendListener.attach(observability:opensearchService, "/"); |
There was a problem hiding this comment.
Log Improvement Suggestion No: 1
Suggested change
| public function main() returns error? { | |
| if defaultObservabilityBackend == "opensearch" { | |
| check observabilityBackendListener.attach(observability:opensearchService, "/"); | |
| public function main() returns error? { | |
| if defaultObservabilityBackend == "opensearch" { | |
| log:printInfo("Starting observability backend service with OpenSearch configuration"); | |
| check observabilityBackendListener.attach(observability:opensearchService, "/"); |
Comment on lines
+38
to
+41
| check observabilityBackendListener.attach(observability:opensearchService, "/"); | ||
| check observabilityBackendListener.'start(); | ||
| runtime:registerListener(observabilityBackendListener); | ||
| log:printInfo("Observability backend service is running at " + defaultObservabilityServiceHost + ":" + defaultObservabilityServicePort.toString()); |
There was a problem hiding this comment.
Log Improvement Suggestion No: 2
Suggested change
| check observabilityBackendListener.attach(observability:opensearchService, "/"); | |
| check observabilityBackendListener.'start(); | |
| runtime:registerListener(observabilityBackendListener); | |
| log:printInfo("Observability backend service is running at " + defaultObservabilityServiceHost + ":" + defaultObservabilityServicePort.toString()); | |
| check observabilityBackendListener.attach(observability:opensearchService, "/"); | |
| check observabilityBackendListener.'start(); | |
| runtime:registerListener(observabilityBackendListener); | |
| log:printInfo("Observability backend service started successfully"); | |
| log:printInfo("Observability backend service is running at " + defaultObservabilityServiceHost + ":" + defaultObservabilityServicePort.toString()); |
| function init() { | ||
| log:printInfo("Observability service started with OpenSearch backend"); | ||
| } | ||
|
|
There was a problem hiding this comment.
Log Improvement Suggestion No: 3
Suggested change
| resource function post logs(@http:Header {name: "X-API-Key"} string? apiKeyHeader, @http:Payload types:LogEntryRequest logRequest) returns types:LogEntriesResponse|http:BadRequest|error { | |
| log:printInfo("Received log query request"); |
Comment on lines
+250
to
+252
| string queryJson = logQuery.toJsonString(); | ||
|
|
||
| // Execute the search request |
There was a problem hiding this comment.
Log Improvement Suggestion No: 4
Suggested change
| string queryJson = logQuery.toJsonString(); | |
| // Execute the search request | |
| http:Response response = check opensearchClient->post(path = "/ballerina-application-logs-*/_search", | |
| message = queryJson, | |
| headers = {"Content-Type": "application/json"}); | |
| log:printDebug("OpenSearch query executed successfully for log entries"); |
Comment on lines
54
to
58
|
|
||
| // Get authorization header | ||
| string|http:HeaderNotFoundError authHeader = request.getHeader("Authorization"); | ||
| if authHeader is http:HeaderNotFoundError { | ||
| return error("Authorization header is required for fetching logs"); |
There was a problem hiding this comment.
Log Improvement Suggestion No: 5
Suggested change
| // Get authorization header | |
| string|http:HeaderNotFoundError authHeader = request.getHeader("Authorization"); | |
| if authHeader is http:HeaderNotFoundError { | |
| return error("Authorization header is required for fetching logs"); | |
| // Get authorization header | |
| string|http:HeaderNotFoundError authHeader = request.getHeader("Authorization"); | |
| if authHeader is http:HeaderNotFoundError { | |
| log:printError("Authorization header not found in request"); | |
| return error("Authorization header is required for fetching logs"); | |
| } |
Comment on lines
63
to
66
|
|
||
| // Build base OpenSearch query with common filters | ||
| isolated function buildBaseQuery(types:LogEntryRequest logRequest, types:UserContext userContext) returns map<json>|error { | ||
| map<json> query = { | ||
| "query": { | ||
| "bool": { | ||
| "must": [], | ||
| "filter": [] | ||
| } | ||
| } | ||
| }; | ||
| // Validate and filter log request based on user access | ||
| types:LogEntryRequest validatedLogRequest = check getUserValidatedLogRequest(logRequest, userContext); | ||
|
|
There was a problem hiding this comment.
Log Improvement Suggestion No: 6
Suggested change
| // Build base OpenSearch query with common filters | |
| isolated function buildBaseQuery(types:LogEntryRequest logRequest, types:UserContext userContext) returns map<json>|error { | |
| map<json> query = { | |
| "query": { | |
| "bool": { | |
| "must": [], | |
| "filter": [] | |
| } | |
| } | |
| }; | |
| // Validate and filter log request based on user access | |
| types:LogEntryRequest validatedLogRequest = check getUserValidatedLogRequest(logRequest, userContext); | |
| // Validate and filter log request based on user access | |
| types:LogEntryRequest validatedLogRequest = check getUserValidatedLogRequest(logRequest, userContext); | |
| log:printInfo("Processing log request for user: " + userContext.username); | |
| http:Response|error response = observabilityBackendClient->post("/logs", validatedLogRequest, { |
There was a problem hiding this comment.
AI Agent Log Improvement Checklist
- The log-related comments and suggestions in this review were generated by an AI tool to assist with identifying potential improvements. Purpose of reviewing the code for log improvements is to improve the troubleshooting capabilities of our products.
- Please make sure to manually review and validate all suggestions before applying any changes. Not every code suggestion would make sense or add value to our purpose. Therefore, you have the freedom to decide which of the suggestions are helpful.
✅ Before merging this pull request:
- Review all AI-generated comments for accuracy and relevance.
- Complete and verify the table below. We need your feedback to measure the accuracy of these suggestions and the value they add. If you are rejecting a certain code suggestion, please mention the reason briefly in the suggestion for us to capture it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This will allow the users to provide custom observability backends.
Front-end server will communicate with the back-end observability service and the observability service will fetch the data from the custom observability backend provided with the configuration.
By default, the OpenSearch backend will be hosted inside the ICP server.
For creating custom observability backends, users can use the OpenAPI specification created for observability backend.
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning