Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sysgears/apollo-logger
Apollo GraphQL Logger
https://github.com/sysgears/apollo-logger
apollo graphql logging
Last synced: about 20 hours ago
JSON representation
Apollo GraphQL Logger
- Host: GitHub
- URL: https://github.com/sysgears/apollo-logger
- Owner: sysgears
- License: mit
- Created: 2017-05-12T19:08:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T22:50:57.000Z (over 3 years ago)
- Last Synced: 2024-04-25T16:42:53.428Z (7 months ago)
- Topics: apollo, graphql, logging
- Language: TypeScript
- Size: 134 KB
- Stars: 19
- Watchers: 16
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Apollo GraphQL Logger
[](https://badge.fury.io/js/apollo-logger)
[](https://twitter.com/sysgears)
## Installation
```bash
npm install --save-dev apollo-logger
```
## Usage
For full logging you will need to attach Apollo Logger to:
- Apollo Link
- Apollo Express Server
- And PubSub
``` js
import { LoggingLink, wrapPubSub, formatResponse } from 'apollo-logger';
const logOptions = { logger: console.log };
const link = ApolloLink.from([
new LoggingLink(logOptions),
new HttpLink({uri: ...})
);
...
app.use('/graphql', bodyParser.json(), graphqlExpress({ schema: myGraphQLSchema, formatResponse: formatResponse.bind(logOptions) });
...
const pubsub = wrapPubSub(new PubSub(), logOptions);
```
## Sample output
On each example the result of operation comes after `=>`
- Query:
``` js
{"data":{"post":{"id":20,"title":"Post title 20","content":"Post content 20","__typename":"Post","comments":[{"id":39,"content":"Comment title 1 for post 20","__typename":"Comment"},{"id":40,"content":"Comment title 2 for post 20","__typename":"Comment"}]}}} <= post({"id":"20"})
```
- Mutation:
``` js
{"data":{"addCounter":{"amount":21,"__typename":"Counter"}}} <= addCounter({"amount":1})
```
- Subscription
``` js
subscribe <= onPostUpdated({"endCursor":11})
```
- Subscription message:
``` js
{"data":{"counterUpdated":{"amount":21,"__typename":"Counter"}}} <= onCounterUpdated
```
- Unsubscription
``` js
unsubscribe <= onPostUpdated({"endCursor":11})
```
- PubSub publish on a server:
``` js
pubsub publish [ 'countUpdated',
{ id: 1, created_at: null, updated_at: null, amount: 7 } ]
```
- PubSub subscribe on a server:
``` js
pubsub subscribe postsUpdated => 2
```
- PubSub unsubscribe on a server:
``` js
pubsub unsubscribe [ 2 ]
```
- PubSub message generated on a server:
``` js
pubsub msg postsUpdated({"mutation":"CREATED","id":21,"node":{"id":21,"title":"New post 1"}})
```
## License
Copyright © 2017 [SysGears INC]. This source code is licensed under the [MIT] license.
[MIT]: LICENSE
[SysGears INC]: http://sysgears.com