npmpackage.info

Gathering detailed insights and metrics for @octokit/plugin-request-log

Other packages similar to @octokit/plugin-request-log

@octokit/plugin-throttling

9.3.2

Octokit plugin for GitHub's recommended request throttling

@octokit/plugin-retry

7.1.2

Automatic retry plugin for octokit

@octokit/core

6.1.2

Extendable client for GitHub's REST & GraphQL APIs

@octokit/plugin-paginate-rest

11.3.6

Octokit plugin to paginate REST API endpoint responses

Gathering detailed insights and metrics for @octokit/plugin-request-log

@octokit/plugin-request-log

Log all requests and request errors

5.3.1

MIT

TypeScript

953,153,384 7

Installations

npm install @octokit/plugin-request-log

Pull Requests

Open

1

Total

395

Closed

31

Merged

363

Issues

Open

0

Total

13

Closed

13

Releases

v5.3.1

Published on 16 Jul 2024

v5.3.0

Published on 05 Jun 2024

v5.2.0

Published on 02 May 2024

v5.1.1

Published on 16 Apr 2024

v5.1.0

Published on 03 Apr 2024

v5.0.0

Published on 05 Mar 2024

View all 16 releases

Developer

octokit

Developer Guide

BETA

Module System

ESM

Min. Node Version

>= 18

Typescript Support

Yes

Node Version

20.15.0

NPM Version

10.8.2 Statistics

7 Stars

418 Commits

21 Forks

7 Watching

4 Branches

28 Contributors

Updated on 26 Nov 2024

Languages

TypeScript (70.59%)

JavaScript (29.41%)

Total Downloads

Cumulative downloads

Total Downloads

953,153,384

Last day

-3.2%

1,267,250

Compared to previous day

Last week

6.3%

6,957,868

Compared to previous week

Last month

15.3%

28,048,871

Compared to previous month

Last year

11.1%

273,654,037

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

@octokit/core

Dev Dependencies

@octokit/core @octokit/tsconfig @types/fetch-mock @types/jest @types/node esbuild fetch-mock glob jest prettier semantic-release-plugin-update-version-in-files ts-jest typescript

Versions

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 esm.sh `1<script type="module"> 2 import { Octokit } from "https://esm.sh/@octokit/core"; 3 import { requestLog } from "https://esm.sh/@octokit/plugin-request-log"; 4</script>`
Node	Install with `npm install @octokit/core @octokit/plugin-request-log`. Optionally replace `@octokit/core` with a core-compatible module `1import { Octokit } from "@octokit/core"; 2import { requestLog } from "@octokit/plugin-request-log";`

Load @octokit/plugin-request-log and @octokit/core (or core-compatible module) directly from esm.sh

1<script type="module">
2  import { Octokit } from "https://esm.sh/@octokit/core";
3  import { requestLog } from "https://esm.sh/@octokit/plugin-request-log";
4</script>

Node

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

1import { Octokit } from "@octokit/core";
2import { requestLog } from "@octokit/plugin-request-log";

[!IMPORTANT] As we use conditional exports, you will need to adapt your tsconfig.json by setting "moduleResolution": "node16", "module": "node16".

See the TypeScript docs on package.json "exports".
See this helpful guide on transitioning to ESM from @sindresorhus

1const MyOctokit = Octokit.plugin(requestLog);
2const octokit = new MyOctokit({ auth: "secret123" });
3
4octokit.request("GET /");
5// logs "GET / - 200 in 123ms
6
7octokit.request("GET /oops");
8// 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

1import consoleLogLevel from "console-log-level";
2const octokit = new MyOctokit({
3  log: consoleLogLevel({
4    auth: "secret123",
5    level: "info",
6  }),
7});

Contributing

See CONTRIBUTING.md

License

MIT

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

Security-Policy

Determines if the project has published a security policy.

9

SAST

Determines if the project uses static code analysis.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

6

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 6

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add_to_octokit_project.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/codeql.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/immediate-response.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/immediate-response.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/update-prettier.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-request-log.js/update-prettier.yml/main?enable=pin
Info: 5 out of 13 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 4 out of 4 npmCommand dependencies pinned

5

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More