Get started with Apollo Studio
Hello! This article gets you up and running with Apollo Studio. None of this setup requires a paid plan.
You can sign up for Studio with either your GitHub identity or a username and password.
Go to studio.apollographql.com and click Let's get started.
Select Register a deployed graph.
Complete the signup flow, which includes:
In Studio, each graph has an associated GraphQL schema. Your first graph will use your GraphQL server's schema.
Visit studio.apollographql.com again. Now that you have an account, this opens Studio to your newly created organization.
Click New Graph in the top right. The following dialog appears:
Specify an organization and title for your graph.
Leave the graph's Graph type as Deployed.
- Development graphs can be useful for local development, but we'll create a standard deployed graph to start.
Specify your Graph Architecture:
- If your graph uses Apollo Federation, leave this as Supergraph (default).
- Otherwise (i.e., your graph consists of a single GraphQL server), switch this to Monolith.
Click Next. A dialog like the following appears (the details differ depending on which Graph Architecture you're using):
If you're using Apollo Federation, select the version you're using from the Supergraph Pipeline Track dropdown.
Now you're ready to publish your graph's schema to Apollo!
The Apollo schema registry powers nearly every feature of Apollo Studio, along with helpful developer tools like our VS Code extension.
To register your schema, first obtain a graph API key for your graph:
After you obtain your API key, select the registration method that corresponds to your graph's architecture:
After you register your schema, select your graph in Apollo Studio and open its Fields tab. You'll see a list of all of your schema's types and fields.
Now that your schema's registered, you're ready to try out one of Studio's most powerful features: the Explorer. This tool provides visibility into your entire schema and helps you build and run queries against it.
From Apollo Studio, select your graph and open its Explorer tab. Complete its Getting Started steps to see what it can do!
Studio can connect to your Slack workspace to send a notification whenever your registered schema is updated. If you configure metrics reporting, Studio can also send you a daily metrics report.
Your GraphQL server can push operation metrics to Apollo Studio, enabling you to visualize and improve performance.
To set up metrics reporting, read Sending metrics to Apollo Studio.
Your schema is now registered with Studio, and your server is pushing operation metrics!
However, to get the most out of Studio, you need to re-register your server's schema every time it changes. The easiest way to do this is to make schema registration part of every deployment in your application's continuous delivery flow.
If you set up schema reporting in Step 3 (the first schema registration option), Apollo Server automatically registers your schema every time it starts up, and no additional setup is required.
If you registered your schema with the Apollo CLI, see Registering with continuous delivery for an example.
The best way to fully familiarize yourself with Studio is to use it! Visit studio.apollographql.com and check out the all the various views and what they provide.
The docs also have plenty of information on the features available for plans of all types, including:
If you'd like to have a conversation about Apollo Studio and how it can help your organization, please contact us.