aws / aws/graph-explorer

Send logger message as part of query request

Open
#1,217 0 comments 0 reactions 0 assignees View on GitHub
fundamental reliability tech debt
Dominant language
TypeScript
Stars
481
Forks
108
Avg merge
7d 16h
Merged PRs (30d)
8

Description

Currently, each explorer function sends a log request to the server to log out which user action is being executed. Since it is a separate request that is fire and forget (not awaited) the order the server actually executes the requests can vary. It could also transiently fail.

Instead, add a new header value that defines a "query name" to use in the logs. This will provide enough context for diagnostics, adds additional context for those explorer functions that execute more than one query, and removes a redundant request.

This header should only be added when the proxy server is used.

Contributor guide

Open the contributing guide

Research direction

Start by locating the explorer functions and the proxy-server request construction, then compare the existing log request with the query request and its headers. Done means the query name is included in proxy-server logs through a request header, explorer actions no longer send a separate fire-and-forget log request, and direct non-proxy requests are unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.