diff --git a/.changeset/quiet-walls-attend.md b/.changeset/quiet-walls-attend.md new file mode 100644 index 00000000..3db9bba9 --- /dev/null +++ b/.changeset/quiet-walls-attend.md @@ -0,0 +1,5 @@ +--- +"@wpengine/wpgraphql-logging-wordpress-plugin": major +--- + +chore: Initial release of WPGraphQL Logging Plugin. diff --git a/plugins/wpgraphql-logging/README.md b/plugins/wpgraphql-logging/README.md index e46f0b41..7f52672b 100644 --- a/plugins/wpgraphql-logging/README.md +++ b/plugins/wpgraphql-logging/README.md @@ -12,17 +12,8 @@ A logging plugin that provides visibility into request lifecycle to help quickly [![Code Coverage](https://img.shields.io/badge/coverage-%3E90%25-brightgreen?label=Code%20Coverage)](https://github.com/wpengine/hwptoolkit/actions) [![Code Quality](https://github.com/wpengine/hwptoolkit/actions/workflows/code-quality.yml/badge.svg)](https://github.com/wpengine/hwptoolkit/actions/workflows/code-quality.yml) - ------ - -> [!CAUTION] -> This plugin is currently in a beta state. It's still under active development, so you may encounter bugs or incomplete features. Updates will be rolled out regularly. Use with caution and provide feedback if possible. You can create an issue at [https://github.com/wpengine/hwptoolkit/issues](https://github.com/wpengine/hwptoolkit/issues) - ------ - ## Overview - WPGraphQL Logging plugin provides observability and visibility into the GraphQL request and event lifecycle. This capability gives users the understandability needed to quickly identify and resolve performance issues and bottlenecks within their headless WordPress application. ### Key Features @@ -46,7 +37,9 @@ WPGraphQL Logging plugin provides observability and visibility into the GraphQL ### Option 1: Plugin Zip -You can get the latest release from . +You can get the latest release here - + +You can also download it from our release page - ### Option 2: Composer diff --git a/plugins/wpgraphql-logging/readme.txt b/plugins/wpgraphql-logging/readme.txt index 95ac2c76..1492ae3e 100644 --- a/plugins/wpgraphql-logging/readme.txt +++ b/plugins/wpgraphql-logging/readme.txt @@ -15,8 +15,6 @@ WPGraphQL Logging plugin provides observability and visibility into the GraphQL **WPGraphQL Logging** is a comprehensive logging solution for WPGraphQL that tracks and records GraphQL query execution, providing developers with detailed insights into query performance, errors, and request lifecycle events. -**Note:** This plugin is currently in BETA. While it is functional and ready for testing, some features may be subject to change based on community feedback. - = Key Features = **GraphQL Request Lifecycle Logging** @@ -74,14 +72,14 @@ For detailed documentation, guides, and examples, visit the [GitHub repository]( 1. Upload the plugin files to `/wp-content/plugins/wpgraphql-logging/`, or install the plugin through the WordPress plugins screen directly 2. Activate the plugin through the 'Plugins' screen in WordPress -3. Navigate to Settings > WPGraphQL Logging in the WordPress admin to configure settings -4. View logged queries can be found in GraphQL Logs +3. Navigate to GraphQL Logs -> Settings in the WordPress admin to configure settings +4. View logged queries can be found in GraphQL Logs -> All Logs. == Frequently Asked Questions == = Is this plugin production-ready? = -This plugin is currently in BETA. It is functional and ready for testing in staging environments. We recommend thorough testing before deploying to production. +Yes. We recommend thorough testing on a local or staging before deploying to production. By default the plugin will only log 10% of the initial requests. = Does this plugin affect GraphQL query performance? = @@ -99,17 +97,14 @@ Yes, the plugin provides extensive hooks and filters to customize logging behavi The plugin includes configurable data retention settings. You can set automatic cleanup rules to delete logs older than a specified number of days. -== Screenshots == += Where can I find documentation? = +For detailed usage instructions, developer references, and examples, please visit the [Documentation](https://github.com/wpengine/hwptoolkit/blob/main/docs/plugins/wpgraphql-logging/index.md) folder included with this plugin. -1. View all GraphQL query logs with filtering and search -2. Detailed log entry view showing query, variables, and response -3. Configuration settings for data retention and logging behavior -4. Export logs to CSV for analysis == Changelog == -= 0.1.0 - 2025-01-22 = -* Initial BETA release += 1.0.0 - 2025-11-14 = +* Initial release * Core logging functionality for WPGraphQL request lifecycle * Admin interface for viewing and filtering logs * CSV export functionality @@ -119,6 +114,9 @@ The plugin includes configurable data retention settings. You can set automatic == Upgrade Notice == += 1.0.0 = +Initial release. + = 0.1.0 = Initial BETA release. diff --git a/plugins/wpgraphql-logging/src/Logger/Database/WordPressDatabaseEntity.php b/plugins/wpgraphql-logging/src/Logger/Database/WordPressDatabaseEntity.php index bec76501..e163d0a9 100644 --- a/plugins/wpgraphql-logging/src/Logger/Database/WordPressDatabaseEntity.php +++ b/plugins/wpgraphql-logging/src/Logger/Database/WordPressDatabaseEntity.php @@ -283,7 +283,6 @@ public static function get_schema(): string { */ public static function get_table_name(): string { global $wpdb; - // @TODO - Check for multisite return $wpdb->prefix . 'wpgraphql_logging'; } diff --git a/plugins/wpgraphql-logging/tests/wpunit/Admin/View/List/ListTableTest.php b/plugins/wpgraphql-logging/tests/wpunit/Admin/View/List/ListTableTest.php index e03ce3ee..9e9403c0 100644 --- a/plugins/wpgraphql-logging/tests/wpunit/Admin/View/List/ListTableTest.php +++ b/plugins/wpgraphql-logging/tests/wpunit/Admin/View/List/ListTableTest.php @@ -96,7 +96,9 @@ public function test_column_cb_returns_checkbox_for_valid_item(): void { $result = $this->list_table->column_cb($entity); - $this->assertStringContainsString('assertStringContainsString('