WPGraphQL Logging - Create Plugin Configuration

[colinmurphy]

Overview

We need to add basic configuration functionality and admin UI for the plugin.

Criteria

We need to build the following:

1. Plugin core functionality e.g. settings page, tabs, data sanitisation
2. Functionality for whether we log data or not
3. Integrate the configuration with logging plugin and add tests to ensure it works.
4. Update examples on how to extend the admin functionality

Note

We can add other configuration tabs for data management and security when developing those features.

Data Logging Functionality Configuration

• Enabled (Yes/No)
• IP restrictions
• Rate limiting and data sampling
• WPGraphQL filtering (log certain requests)
• User based logging (log with certain admin capabilities)
• Performance metrics (log with memory or time threshold above X)
• HTTP Header Configuration
• Log point selection (select if you want to log for one, two or three current events that we log for)

[colinmurphy]

Some notes from a meeting on plugin configuration:

A few ideas around configuration:

• IP restrictions
• Regex to only log certain queries
• Allow sampling to not log all queries
• Rate limiting (for heavy production sites)

We need to ensure anything we do build onto the existing alpha plugin, allows developers to extend the functionality so they can add their own custom logic on whether to log a request.

[colinmurphy]

@wpengine/headless-open-source

Updated the task description to include what the initial functionality will be. Thanks @josephfusco and @moonmeister for the discussions last week around configuration.

[colinmurphy]

The first PR can be found here #384

For the integration of these rules, here is what we are proposing to implement

Rules

• If not enabled
  return false
• If events are selected
  • Event is not selected - return false
• If admin option enabled
  • If not admin - return false
• If IP restriction has values
  • If IP is in array of whitelisted IPs
• If WPGraphQL filtering has values
  • if the query does not match - return false
• If Performance Metric is enabled
  • If the time is less than threshold - return false
• If Data sampling is enabled
  • We do a math random and if it doesn't match - return false

Screenshot

Note

We will add a filter to allow users to change the value here too e.g. maybe you want to add a custom rule.