GraphQL Schema Registry

The Stellate Schema Registry is a collection of Dashboard pages that give you metrics information, but from a schema perspective. By selecting the Schema Registry tab in the Dashboard, you can actually understand how your users are using your graph or how your operations use your schema specifically.

Just like GraphQL Metrics, the Schema Registry operates out-of-the-box. As soon as you begin using the metrics plugin and start sending data, you'll be able to observe your requests flowing in and your metrics. At this point, you should also be able to see Schema Registry data.

Schema Registry benefits

As a centralized schema repository, the Schema Registry makes it simple to track changes and ensure consistency across different versions of the schema. It provides a comprehensive view of the schema structure, including types, fields, and relationships, allowing you to understand and analyze the schema evolution over time.

The Stellate Schema Registry offers several benefits that make it a valuable tool for understanding GraphQL schemas:

  • Centralized Repository: The Schema Registry serves as a centralized location to store and organize your GraphQL schema definitions. It provides a single source of truth for your schema, making it easier to track changes.
  • Schema Diffs: With the Schema Registry, you can understand what changed between different schema versions. You can track changes made to the schema, such as adding or removing fields, introducing new types, or deprecating existing ones. This allows you to track and compare changes over time, ensuring that you have a clear understanding of how your schema has evolved.
  • Collaboration and Consistency: The Schema Registry promotes collaboration among teams working on the same GraphQL schema. Teams can easily see the current schema, changes to it, and see a list of prior schemas.

Use the Schema Registry in the Dashboard

You can use the Stellate Dashboard UI to perform tasks such as viewing metrics, schema versions, and viewing your schema elements. To use the Stellate Schema Registry:

  1. Sign in to your Stellate account: Go to the Stellate website and sign in using your credentials.
  2. Navigate to your Stellate Services and click on the Service that you want to work with. ****
  3. Click on the Schema tab.
  4. Click on one of the following Schema Registry options in the left navigation bar:
    1. Insights - Displays information about your schema operations, types, and fields.
    2. Versions - Shows a list of your schema versions.
    3. Explorer - Provides views of your schema elements by type with filters for least and most used, least and most errors, and lowest and highest CHR.

If you encounter any difficulties or have specific questions, reach out to customer service for further assistance.

Get Schema Insights

Once you have navigated to the Schema Registry, click schema Insights (in the left Nav) to get the schema metrics highlights. You can view these metrics to improve your understanding of your schema usage.

The Insights display also includes filter and time frame views. These option are located on the right side of the page:

  • Click the Filter menu to filter by Cache Name, Operation Name, Scopes and many more filter options.
  • Click the time frame menu to see data from the last 15 minutes to the last 30 days.

Insight Views for Types, Fields, and Operations

Select the Types tab to view a list of schema types view lets you analyze types by Most used, Highest latency, Highest error rate and what Types are used or unused in the schema.

In the following illustration, we see that the Order type has the highest latency. You can leverage this information to see what to optimize. By going through the type metrics, you can reduce latency, analyze and fix types with high error rates, and track what types are most used.

Diagram presenting “Schema Registry Insights”

You can also click on an items such as Order to drill down and get more granular information. For example, in the following illustration, we can view details about the Order type in our schema and discover if we need to modify it.

Diagram presenting “Schema Registry details

You can drill down again into the information and get deeper insights by clicking on the items under Fields. This gives you the ability to understand your schema at a very deep level of detail. Take the time to click various entries and labels to discover different views of the data.

You can view and analyze similar information for schema fields and operations. Just select each tab to see the metrics. These schema-based metrics views, give you the power to optimize your schema and queries.

The Fields view provides a similar details view as Types providing a granular look at the metrics for a particular field.

When you drill down on an operation in the the Operations view, it displays a Query panel containing the query in the Config Editor, so you can see the query structure.

Note: The Operations detail page also allows you to purge the cache. Use care when selecting that option.

Get Schema Version Information

In the left navigation bar, click schema Versions to view and different versions of your schema. You can track changes and compare versions to see the differences in each version over time.

Schema Versions - in this panel you can view a schema and click on another schema to see the changes in that schema. For each schema version there is an associated schema change panel providing change information about that version. You can check a specific schema to see a breaking change and when it occurred.

Schema Changes - this panel lets you see breaking changes, schema updates, and fields added on various types.

Explore Schema Type Details

In the left navigation bar, click schema Explorer to view all of your schema types and get detail schema type information. This view lets you look at Type information to see Errors, Cache Hit Rates (CHR), Requests and what operations are using those requests.

Search - The Explorer view includes a search field at the top left of the page. Use Search to can find a specific type by name or if several types include those letters, the search returns all of them.

Filter Menu - You can filter the Type information to look at Types by Most used/Least Used, Most Errors/Least Errors, and Highest CHR/Lowest CHR. This menu appears at the top left of the Explorer page.

Details - The Details panel provides an overview of Last Seen, Origin Response time in milliseconds, and the Cache Response time in milliseconds. The Details panel also includes lists of Fields, Operations, Mutations. Click on entries for any of these items to get finer grained information about that entry. The Details panel also includes Requests and Errors graphs.

Discover more

Push Your GraphQL Schema

About GraphQL Metrics