Integrating with Apollo Studio

amaster507 · June 30, 2020, 6:22pm

When I previously built an Apollo GraphQL server, I had integrated it with the Apollo Studio (formerly Graph Manager) and it did some nice daily reporting on the free plan. It would be nice if it was possible to tie Dgraph’s GraphQL endpoint to this service.

I am not sure of the magic that Dgraph uses to generate the graphql endpoint, but if it natively uses Apollo Server then connecting it to Apollo Studio would be simply providing an environment variable with a user’s API key from Apollo Studio.

Apollo Server has built-in support for pushing traces to Apollo Studio. To set it up, you provide it a graph API key from Studio.

After you obtain a graph API key, assign it to the APOLLO_KEY environment variable ( ENGINE_API_KEY prior to version 2.13.0 of Apollo Server) in your production server’s environment.

Now the next time you start your production server, it will automatically begin pushing trace data to Studio:

vardhanapoorv · July 2, 2020, 2:24pm

Hi @amaster507
You won’t be able to get that natively, though you should be able to achieve that by having an Apollo Server in front of the Dgraph GraphQL endpoint.

amaster507 · July 2, 2020, 3:01pm

github.com

dgraph-io/dgraph/blob/ad0914a0c6dbd3ef2774433594765712c09456b4/graphql/schema/response.go#L191


}

// Trace : Apollo Tracing is a GraphQL extension for tracing resolver performance.Response
// https://github.com/apollographql/apollo-tracing
// Not part of the standard itself, it gets reported in GraphQL "extensions".
// It's for reporting tracing data through all the resolvers in a GraphQL query.
// Our results aren't as 'deep' as a traditional GraphQL server in that the Dgraph
// layer resolves in a single step, rather than iteratively.  So we'll report on
// all the top level queries/mutations.
//
// Currently, only reporting in the GraphQL result, but also planning to allow
// exposing to Apollo Engine as per:
// https://www.apollographql.com/docs/references/setup-analytics/#engine-reporting-endpoint
type Trace struct {
	// (comments from Apollo Tracing spec)

	// Apollo Tracing Spec version
	Version int `json:"version"`

	// Timestamps in RFC 3339 nano format.
	StartTime string `json:"startTime,"`

When this gets done, it should be the solution to my question. Is this in any of the current roadmaps?

michaelcompton · July 3, 2020, 5:47am

Hi, there isn’t any connection to Apollo Studio at the moment. We’d have to build something bespoke for that. Which is something that we’ve thought of doing (as indicated in the comment).

Integrations like this aren’t in the current block of work - though Slash GraphQL https://dgraph.io/slash-graphql does have some monitoring.

I think it would be nice to consider adding some more integrations like this. If this is something that’s really needed for you, can you add a github issue that clearly explains what the requirements are and we’ll consider adding it to the roadmap.

behnam-io · June 1, 2022, 9:51pm

@amaster507 Is there any updates with your issue? I’m aslo trying to find a way to use apollo server with my docker version of dgraph

@vardhanapoorv can you give a bit more guide on this if possible? I couldn’t find any tutorial on how to set it

amaster507 · June 1, 2022, 11:32pm

I have given up for now.

Topic		Replies	Views
Dgraph graphql query integration wtih custom grapql server GraphQL kind:question , dgraph	9	667	September 22, 2020
How to use Dgraph with Apollo Server? Dgraph	1	1192	March 3, 2021
Anyone using DGraph with its GraphQL API directly connected to the frontend in production? GraphQL	4	665	October 1, 2021
Using Dgraph in a Golang server running a GraphQL endpoint Dgraph	11	2174	March 10, 2020
Overview - Graphql Documentation	0	392	August 28, 2020

Integrating with Apollo Studio

Related topics