graphql-log - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #llm #machine-learning #rust #linux #windows #kubernetes #vue #pytorch #ios #openai

graphql-log

(★ 97)

Add logging to your GraphQL resolvers so you know what's going on in your app.

File Explorer

Download Latest Version (.zip)

- - babel-cli_vx.x.x.js
  - babel-core_vx.x.x.js
  - babel-eslint_vx.x.x.js
  - babel-plugin-transform-runtime_vx.x.x.js
  - babel-polyfill_vx.x.x.js
  - babel-preset-env_vx.x.x.js
  - babel-preset-es2015_vx.x.x.js
  - babel-preset-flow_vx.x.x.js
  - babel-preset-stage-2_vx.x.x.js
  - deep-for-each_vx.x.x.js
  - eslint-plugin-babel_vx.x.x.js
  - eslint_vx.x.x.js
  - flow-bin_v0.x.x.js
  - husky_vx.x.x.js
  - is-function_vx.x.x.js
  - jest_v19.x.x.js
  - lint-staged_vx.x.x.js
  - prettier_vx.x.x.js
  - rimraf_vx.x.x.js
- - index.test.js
- index.js
.babelrc
.flowconfig
.gitignore
.npmignore
LICENSE.md
package.json
README.md
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/withspectrum/graphql-log

Downloads the entire project code from GitHub to your computer.

cd graphql-log

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `graphql-log`

Add logging to your GraphQL resolvers so you know what's going on in your app.

Everytime a resolver is executed it logs the full path to the resolver. The output in your terminal (when using the popular `debug` module for logging) will be something like this:

```sh
server:resolvers Message.channel +0ms
server:resolvers User.avatar +0ms
server:resolvers User.username +0ms
server:resolvers User.avatar +4ms
server:resolvers User.coverPhoto +0ms
server:resolvers User.username +0ms
```

> Note: The "server:resolvers" and "+xms" parts are added by `debug`, this module only logs the path on execution.

## Usage

This is the simplest example:

```javascript
// Require the module
const createGraphQLLogger = require('graphql-log');

// Create a logger
const logExecutions = createGraphQLLogger();

// Wrap your resolvers
logExecutions(resolvers);
```

Note that **your resolvers need to be a plain object of resolvers**. (like you'd create for `graphql-tools` `makeExecutableSchema` function)

### Options

`graphql-log` has some options:

- `logger` (function, default: `console.log`): Use a custom logger like `debug`, `pino` or any other one.
- `prefix` (string): Prefix all logs with a certain string

```javascript
const logExecutions = createGraphQLLogger({
  // Prefix all logs with resolvers.
  prefix: 'resolvers.',
});
```

#### Usage with custom loggers

Let's say you want to use the popular `debug` module for logging. Doing so would be as easy as passing it into the `logger` option:

```javascript
const debug = require('debug')('server:resolvers');

const logExecutions = createGraphQLLogger({
  logger: debug,
});
```

### Usage only in development

Logging every execution of every resolver will have a performance impact on your app, so we recommend only enabling this module in development. A common way to do so (depending on your setup) would be something like this:

```javascript
const createGraphQLLogger = require('graphql-log');

const resolvers = {/*...*/};

if (process.env.NODE_ENV === 'development') {
  const logExecutions = createGraphQLLogger();
  logExecutions(resolvers);
}
```

## Roadmap

The main thing I want to change is that instead of wrapping the resolvers this module would wrap a finished schema instead. This would make it compatible not only with folks who keep their resolvers separate, but with everybody.

That'd probably look something like this:

```javascript
// I'd love to be able to pass a schema
logExecutions(schema);
```

Good first PR?

## License

Licensed under the MIT License, Copyright ©️ 2017 Maximilian Stoiber. See [LICENSE.md](LICENSE.md) for more information.