Skip to content
This repository was archived by the owner on Apr 25, 2023. It is now read-only.

Commit f78708b

Browse files
authored
add apollo sdk docs (#299)
1 parent 694af42 commit f78708b

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

docs-content/general/2_company/open-source/self-host-hobby.md

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ cd docker
1414
docker compose up -d --build
1515
```
1616

17+
After a brief frontend load time, the app should be accessible at https://localhost:3000
18+
19+
For deploying on Linux with Docker, we recommend having at least 16 CPU cores, 32GB RAM, 256GB disk.
1720
Reach out to our [community](https://community.highlight.io/) with any questions!
1821

1922
# Limitations
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Apollo Server
3+
slug: apollo-server
4+
createdAt: 2022-04-01T20:28:14.000Z
5+
updatedAt: 2022-04-15T02:07:22.000Z
6+
---
7+
8+
Highlight ships `@highlight-run/node` with a plugin `ApolloServerHighlightPlugin` specifically for the apollo server.
9+
The plugin will trace graphql resolver errors and report them to Highlight.
10+
11+
## Usage
12+
13+
The usage of the Apollo plugin requires the [Node.js integration](../../../sdk/nodejs.md) to be configured.
14+
Ensure that `@highlight-run/node` updated to version 2.2.0 or greater. Then, add `ApolloServerHighlightPlugin` to
15+
your `ApolloServer` plugins definition.
16+
17+
```typescript
18+
import {ApolloServerHighlightPlugin} from '@highlight-run/node';
19+
20+
// ...
21+
22+
const server = new ApolloServer({
23+
typeDefs,
24+
resolvers,
25+
plugins: [ApolloServerHighlightPlugin({projectID: 'YOUR_PROJECT_ID'})]
26+
});
27+
```
28+
29+
### Verify
30+
31+
To validate your Highlight backend setup, you can have a graphql resolver throw an error and check that the
32+
error is visible on [app.highlight.io](http://app.highlight.io/errors).

0 commit comments

Comments
 (0)