70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
|
# plugin-request-log.js
|
||
|
|
|
||
|
|
> Log all requests and request errors
|
||
|
|
|
||
|
|
[](https://www.npmjs.com/package/@octokit/plugin-request-log)
|
||
|
|
[](https://github.com/octokit/plugin-request-log.js/actions?workflow=Test)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tbody valign=top align=left>
|
||
|
|
<tr><th>
|
||
|
|
Browsers
|
||
|
|
</th><td width=100%>
|
||
|
|
|
||
|
|
Load `@octokit/plugin-request-log` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.skypack.dev](https://cdn.skypack.dev)
|
||
|
|
|
||
|
|
```html
|
||
|
|
<script type="module">
|
||
|
|
import { Octokit } from "https://cdn.skypack.dev/@octokit/core";
|
||
|
|
import { requestLog } from "https://cdn.skypack.dev/@octokit/plugin-request-log";
|
||
|
|
</script>
|
||
|
|
```
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
<tr><th>
|
||
|
|
Node
|
||
|
|
</th><td>
|
||
|
|
|
||
|
|
Install with `npm install @octokit/core @octokit/plugin-request-log`. Optionally replace `@octokit/core` with a core-compatible module
|
||
|
|
|
||
|
|
```js
|
||
|
|
const { Octokit } = require("@octokit/core");
|
||
|
|
const { requestLog } = require("@octokit/plugin-request-log");
|
||
|
|
```
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
```js
|
||
|
|
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](https://github.com/watson/console-log-level) package for a configurable log level
|
||
|
|
|
||
|
|
```js
|
||
|
|
const octokit = new MyOctokit({
|
||
|
|
log: require("console-log-level")({
|
||
|
|
auth: "secret123",
|
||
|
|
level: "info",
|
||
|
|
}),
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT](LICENSE)
|