plugin-request-log.js

Log all requests and request errors

Usage

Browsers

Browsers	Load `@octokit/plugin-request-log` and `@octokit/core` (or core-compatible module) directly from cdn.skypack.dev `<script type="module"> import { Octokit } from "https://cdn.skypack.dev/@octokit/core"; import { requestLog } from "https://cdn.skypack.dev/@octokit/plugin-request-log"; </script>`
Node	Install with `npm install @octokit/core @octokit/plugin-request-log`. Optionally replace `@octokit/core` with a core-compatible module `const { Octokit } = require("@octokit/core"); const { requestLog } = require("@octokit/plugin-request-log");`

Load @octokit/plugin-request-log and @octokit/core (or core-compatible module) directly from cdn.skypack.dev

<script type="module">
  import { Octokit } from "https://cdn.skypack.dev/@octokit/core";
  import { requestLog } from "https://cdn.skypack.dev/@octokit/plugin-request-log";
</script>

Node

Install with npm install @octokit/core @octokit/plugin-request-log. Optionally replace @octokit/core with a core-compatible module

const { Octokit } = require("@octokit/core");
const { requestLog } = require("@octokit/plugin-request-log");

const MyOctokit = Octokit.plugin(requestLog);
const octokit = new MyOctokit({ auth: "secret123" });

octokit.request("GET /");
// logs "GET / - 200 in 123ms

octokit.request("GET /oops");
// logs "GET / - 404 in 123ms

In order to log all request options, the log.debug option needs to be set. We recommend the console-log-level package for a configurable log level

const octokit = new MyOctokit({
  log: require("console-log-level")({
    auth: "secret123",
    level: "info",
  }),
});

Contributing

See CONTRIBUTING.md

License

MIT

Current Tags

1.0.4 ... latest (4 years ago)

5 Versions

1.0.4 ... 4 years ago
1.0.3 ... 4 years ago
1.0.2 ... 4 years ago
1.0.1 ... 4 years ago
1.0.0 ... 5 years ago