Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new PR Shopify GraphQL API log auditing #38

Merged
merged 1 commit into from
Nov 3, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions auditing/shopify-graphql-api-log-auditing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Shopify GraphQL API log auditing

## When bulk operations are pushed to Shopify, the ability to examine GraphQL API audit logs and failed scenarios to quickly fix the key problem areas greatly expedites troubleshooting.

When executing bulk operations to Shopify, mutations may fail for various reasons, like exceeding rate limits, or requesting mutation on an object that no longer exists. Shopify GraphQL API log auditing lets users troubleshoot failed or partially failed mutations. Complete transparency into API logs helps to easily debug the problem without any external support.

Auditing integrations are usually not user accessible, so every time when an operation fails, developer intervention is required. Manually auditing communication between systems is also a resource and time intensive process, often taking upwards of 6 hours. When multiple systems are mutating the same object in Shopify pinpointing exact error pathways becomes an added challenge for developers.

Shopify GraphQL API log auditing will allow users to gain full visibility into why certain operations may be failing and even search through extensive logs by keywords and specific IDs. Users can view API audit logs and instantly identify failed records without the need to contact HotWax support. User accessible audit logs will also ensure quick corrective actions.

Merchants using HotWax Commerce will already receive the feature to audit GraphQL API logs. Merchants will need to go to the MDM page and select Shopify GraphQL Job from the Shopify jobs section.

*Internal quote*

*Customer quote*