Files

Simon Lecoq 04a1f3ce90 Update README.md

2020-10-18 11:09:39 +02:00

22 KiB

Raw Blame History

📊 GitHub metrics

Generates your own GitHub metrics as an SVG image to put them on your profile page or elsewhere ! See what it looks like below :

🦑 Interested to get your own ?

Try it now at metrics.lecoq.io with your GitHub username !

📜 How to use ?

⚙️ Using GitHub Action on your profile repo (~5 min setup)

Setup a GitHub Action which is run periodically and push a generated SVG image on your repository.

Assuming your username is my-github-user, you can embed your metrics in your personal repository's readme like below :

![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg)

💬 How to setup ?

0. Prepare your personal repository

If you don't know yet or haven't done it yet, create a repository with the same name as your GitHub username.

The README.md of this repository will be displayed on your GitHub user profile like below :

1. Setup a GitHub token

Go to Developer settings from your GitHub account settings and select Personal access tokens to create a new token.

You'll need to create a token with the public_repo right so this GitHub Action has enough permissions to push the updated SVG metrics on your personal repository.

If you choose to use a bot account, you can put public_repo rights to the bot token and invite it as a collaborator on your personal profile repository so it has push access. This way, you can use a personnal token with no rights instead and reduce security issues.

2. Put your GitHub token in your personal repository secrets

Go to the Settings of your personal repository to create a new secret and paste your GitHub token here.

3. Create a new GitHub Action workflow on your personal repo

Create a new workflow from the Actions tab of your personal repository and paste the following. Don't forget to put your GitHub username !

name: GitHub metrics as SVG image
on:
  # Schedule the metrics update
  schedule: [{cron: "0 * * * *"}]
  # (optional) Force update a commit occurs on master branch
  # All commits tagged with [Skip GitHub Action] will be ignored by this GitHub action
  push: {branches: "master"}
jobs:
  github-metrics:
    runs-on: ubuntu-latest
    steps:
      - uses: lowlighter/metrics@latest
        with:

          # Your GitHub token
          token: ${{ secrets.METRICS_TOKEN }}

          # Additional options
          # ==========================================

          # GitHub username (defaults to "token" user)
          user: my-github-user

          # If provided, this token will be used instead of "token" for commit operations
          # You can specify a bot account to avoid virtually increasing your stats due to this action commits
          committer_token: ${{ secrets.METRICS_BOT_TOKEN }}

          # Name of SVG image output
          filename: github-metrics.svg

          # Enable Google PageSpeed metrics for account attached website
          # See https://developers.google.com/speed/docs/insights/v5/get-started for more informations
          plugin_pagespeed: no
          pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }}

          # Enable lines of code metrics
          plugin_lines: no

          # Enable repositories traffic metrics
          # *Provided GitHub token require full "repo" permissions
          plugin_traffic: no

          # Enable coding habits metrics
          plugin_habits: no

          # Skip commits flagged with [Skip GitHub Action] from commits count
          plugin_selfskip: no

          # Enable debug logs
          debug: no

A new SVG image will be generated and committed to your repository on each run. Because of this, the amount of your commits could be virtually increased which is probably unwanted.

To avoid this, you can use a bot token instead, which will still be able to track metrics of all your public repositories. If you want to also track your private repositories metrics, you'll need to pass a personal token with full repo permissions to your personal token, and use the committer_token parameter to pass the bot account token.

If you don't want to use a bot token, you can use the plugin_selfskip which will count out all your commits from your personal repository tagged with [Skip GitHub Action] made with your account, but these commits will still be linked to your account.

4. Embed the link into your README.md

Edit your README.md on your repository and link it your image :

![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg)

💕 Using the shared instance (~1 min setup, but with limitations)

For conveniency, you can use the shared instance available at metrics.lecoq.io without any additional setup.

Assuming your username is my-github-user, you can embed your metrics in your personal repository's readme like below :

![GitHub metrics](https://metrics.lecoq.io/my-github-user)

💬 Restrictions and fair use

Since GitHub API has rate limitations, the shared instance has a few limitations :

Images are cached for 1 hour
- Your generated metrics won't be updated during this amount of time
- If you enable or disable plugins in url parameters, you'll need to wait for cache expiration before these changes are applied
The rate limiter is enabled, although it won't affect already cached users metrics
Plugins are disabled
- PageSpeed plugin can still be enabled by passing ?pagespeed=1, but metrics generation can take up some time when it has not been cached yet

To ensure maximum availability, consider deploying your own instance or use the GitHub Action.

🏗️ Deploying your own instance (~15 min setup, depending on your sysadmin knowledge)

You can setup your own instance if you choose to not use the GitHub Action or you want to allow others users to use your instance.

You'll need to create a GitHub token to setup it, however you do not need to grant any additional permissions to your token since it won't push images to any of your repositories. You may still require additional rights for some plugins if you decide to enable them though.

If you intend to share your instance, it is advised to setup either an access list to restrict which users can use it, or to configure the rate limiter to avoid reaching the requests limit of GitHub API.

💬 How to setup ?

0. Prepare your server

You'll need a server where you can install and configure apps.

1. Create a GitHub token

In your account settings, go to Developer settings and select Personal access tokens to create a new token. As explained above, you do not need to grant additional permissions to the token unless you want to enable additional plugins.

2. Install the dependancies

Connect to your server and ensure NodeJS is installed (see tested versions in the build workflows).

Then run the following commands :

# Clone this repository (or your fork)
git clone https://github.com/lowlighter/metrics.git
# Install dependancies
cd metrics/
npm install --only=prod
# Copy the settings exemple
cp settings.example.json settings.json

3. Configure your instance

Open and edit settings.json to configure your instance using a text editor of your choice.

{
  //GitHub API token
    "token":"****************************************",

  //Users who are authorized to generate metrics on your instance
  //An empty list or an undefined value will be treated as "unrestricted"
    "restricted":["my-github-user"],

  //Lifetime of generated metrics (cached version will be served instead during this time window)
    "cached":3600000,

  //Number of simultaneous users who can use your instance before sending a "503 error"
  //A zero or an undefined value will be treated as "unlimited"
    "maxusers":0,

  //Rate limiter (see https://www.npmjs.com/package/express-rate-limit)
  //A null or undefined value will be treated as "disabled"
    "ratelimiter":{
      "windowMs":60000,
      "max":100
    },

  //Listening port used by your instance
    "port":3000,

  //Optimize SVG image
    "optimize":true,

  //Debug mode
  //When enabled, templates will be reloaded at each request and cache will be disabled
  //Intended for easier development and disabled by default
    "debug":false,

  //Plugins configuration
    "plugins":{
      //Google PageSpeed plugin
        "pagespeed":{
          //Enable or disable this plugin. Pass "?pagespeed=1" in url to generate website's performances
            "enabled":false,
          //Pagespeed token (see https://developers.google.com/speed/docs/insights/v5/get-started)
            "token":"****************************************"
        },
      //Lines plugin
        "lines":{
          //Enable or disable this plugin. Pass "?lines=1" in url to compute total lines you added/removed on your repositories
            "enabled":true
        },
      //Traffic plugin
        "traffic":{
          //Enable or disable this plugin. Pass "?traffic=1" in url to compute page views on your repositories in last two weeks
          //*This requires a GitHub API token with push access
            "enabled":true
        },
      //Habits plugin
        "habits":{
          //Enable or disable this plugin. Pass "?habits=1" in url to generate coding habits based on your recent activity
            "enabled":true,
          //Number of events used to compute coding habits (capped at 100 by GitHub API)
            "from":50,
        }
    }
}

4. Start your instance

Start your instance once you've finished configuring it :

npm start

And you should be able to access it on the port you provided !

5. Embed the link into your README.md

Edit your README.md on your repository and include your metrics from your server domain :

![GitHub metrics](https://my-personal-domain.com/my-github-user)

6. (optional) Setup as service on your instance

If you want to ensure that your instance will be restarted after reboots or crashes, you should setup it as a service. This is described below for linux-like systems with systemd.

Create a new service file in /etc/systemd/system :

nano /etc/systemd/system/github_metrics.service

Paste the following and edit it with the correct paths :

[Unit]
Description=GitHub metrics
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
WorkingDirectory=/path/to/metrics
ExecStart=/usr/bin/node /path/to/metrics/index.mjs

[Install]
WantedBy=multi-user.target

Reload services, enable it, start it and check it is up and running :

systemctl daemon-reload
systemctl enable github_metrics
systemctl start github_metrics
systemctl status github_metrics

⚠️ HTTP errors code

The following errors code can be encountered if on a server instance :

403 Forbidden : User is not allowed in restricted users list
404 Not found : GitHub API did not found the requested user
429 Too many requests : Thrown when rate limiter is trigerred
500 Internal error : An error ocurred while generating metrics images (logs can be seen if you're the owner of the instance)
503 Service unavailable : Maximum user capacity reached, only already cached images can be accessed for now

📚 Documentations

🧩 Plugins

Plugins are features which are disabled by default but they can provide additional metrics. In return they may require additional configuration and tend to consume additional API requests.

⏱️ PageSpeed

The pagespeed plugin allows you to add the performances of the website attached to the GitHub user account :

These are computed through Google's PageSpeed API, which returns the same results as web.dev.

💬 About

This plugin may require an API key that you can generate here although it does not seem mandatory. It is still advised to provide it to avoid 429 HTTP errors.

The website attached to the GitHub profile will be the one to be audited. Expect 10 to 30 seconds to generate the results.

Setup with GitHub actions

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_pagespeed: yes
    pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }}

Setup in your own instance

Add the following to your settings.json and pass ?pagespeed=1 in url when generating metrics.

  "plugins":{
    "pagespeed":{
      "enabled":true,
      "token":"****************************************"
    }
  }

👨‍💻 Lines

The lines of code plugin allows you to compute the number of lines of code you added and removed across all of your repositories.

💬 About

It will consume an additional GitHub request per repository.

Setup with GitHub actions

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_lines: yes

Setup in your own instance

Add the following to your settings.json and pass ?lines=1 in url when generating metrics.

  "plugins":{
    "lines":{
      "enabled":true,
    }
  }

🧮 Traffic

The repositories traffic plugin allows you to compute the number of pages views across your repositories.

💬 About

It will consume an additional GitHub request per repository.

Because of GitHub REST API limitation, the provided token will require full repo permissions to access traffic informations.

Setup with GitHub actions

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    token: ${{ secrets.METRICS_TOKEN }}
    plugin_traffic: yes

Setup in your own instance

Add the following to your settings.json and pass ?traffic=1 in url when generating metrics.

  "token":"****************************************",
  "plugins":{
    "traffic":{
      "enabled":true,
    }
  }

💡 Habits

The coding habits plugin allows you to add deduced coding about based on your recent activity, from up to 100 events.

💬 About

It will consume an additional GitHub request per event fetched.

Because of GitHub REST API limitation, the provided token will require full repo permissions to access private events. By default, events that cannot be fetched will be ignored so you can still use this plugin with a public token.

Setup with GitHub actions

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_habits: yes

Setup in your own instance

Add the following to your settings.json and pass ?habits=1 in url when generating metrics.

  "plugins":{
    "habits":{
      "enabled":true
    }
  }

⏭️ Selfskip

The selfskip plugin allows you to count out all commits tagged with [Skip GitHub Action] you authored on your personal repository from your reported commit counts.

💬 About

It will consume an additional GitHub request per page fetched of your commit activity from your personal repository.

Setup with GitHub actions

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_selfskip: yes

🗂️ Project structure

Metrics generator

src/metrics.mjs contains the metrics renderer
src/query.graphql is the GraphQL query sent to GitHub GraphQL API
src/style.css contains the style used by the generated SVG image
src/template.svg contains the template used by the generated SVG image
src/plugins/* contains the source code of metrics plugins

Metrics server instance

index.mjs contains the metrics server entry point
src/app.mjs contains the metrics server code which serves, renders, restricts/rate limit, etc.

GitHub action

action/index.mjs contains the GitHub action code
action/dist/index.js contains compiled the GitHub action code
utils/build.mjs contains the GitHub action builder

💪 Contributing and customizing

If you would like to suggest a new feature, find a bug or need help, you can fill an issue describing your problem.

If you're motivated enough, you can submit a pull request to integrate new features or to solve open issues.

Read the few sections below to get started with project structure.

Adding new metrics through GraphQL API, REST API or Third-Party service

To use GitHub GraphQL API, update the GraphQL query from src/query.graphql. Raw queried data should be exposed in data.user whereas computed data should be in data.computed, and code should be updated through src/metrics.mjs.

To use GitHub Rest API or a third-party service instead, create a new plugin in src/plugins. Plugins should be self-sufficient and re-exported from src/plugins/index.mjs, to be later included in the //Plugins section of src/metrics.mjs. Data generated should be exposed in data.computed.plugins[plugin] where plugin is your plugin's name.

Updating the SVG template

The SVG template is located in src/template.svg and include the CSS from src/style.css.

It's actually a long JavaScript template string, so you can actually include variables (e.g. `${data.user.name}`) and execute inline code, like ternary conditions (e.g. `${computed.plugins.plugin ? `<div>${computed.plugins.plugin.data}</div>` : ""}`) which are useful for conditional statements.

Metrics server and GitHub action

Most of the time, you won't need to edit these, unless you're integrating features directly tied to them. Remember that SVG image is actually generated from src/metrics.mjs, independently from metrics server and GitHub action.

Metrics server code is located in src/app.mjs and instantiates an express server app, octokits instances, middlewares (like rate-limiter) and routes.

GitHub action code is located in action/index.mjs and instantiates octokits instances and retrieves action parameters. It then use directly src/metrics.mjs to generate the SVG image and commit them to user's repository. You must run npm run build to rebuild the GitHub action.

Testing new features

To test new features, setup a metrics server with a test token and debug mode enabled. This way you'll be able to rapidly test SVG renders with your browser.

📖 Useful references

📦 Used packages

express/express.js and expressjs/compression
- To serve, compute and render a GitHub user's metrics
nfriedly/express-rate-limit
- To apply rate limiting on server and avoid spams and hitting GitHub API's own rate limit
octokit/graphql.js and octokit/rest.js
- To perform request to GitHub GraphQL API and GitHub REST API
ptarjan/node-cache
- To cache generated content
renanbastos93/image-to-base64
- To generate base64 representation of users' avatars
svg/svgo
- To optimize generated SVG
axios/axios
- To make HTTP/S requests
actions/toolkit and vercel/ncc
- To build the GitHub Action

All icons were ripped across GitHub's site, but still remains the intellectual property of GitHub. See GitHub Logos and Usage for more information.

22 KiB Raw Blame History

📊 GitHub metrics

🦑 Interested to get your own ?

📜 How to use ?

⚙️ Using GitHub Action on your profile repo (~5 min setup)

0. Prepare your personal repository

1. Setup a GitHub token

2. Put your GitHub token in your personal repository secrets

3. Create a new GitHub Action workflow on your personal repo

4. Embed the link into your README.md

💕 Using the shared instance (~1 min setup, but with limitations)

🏗️ Deploying your own instance (~15 min setup, depending on your sysadmin knowledge)

0. Prepare your server

1. Create a GitHub token

2. Install the dependancies

3. Configure your instance

4. Start your instance

5. Embed the link into your README.md

6. (optional) Setup as service on your instance

📚 Documentations

🧩 Plugins

⏱️ PageSpeed

Setup with GitHub actions

Setup in your own instance

👨‍💻 Lines

Setup with GitHub actions

Setup in your own instance

🧮 Traffic

Setup with GitHub actions

Setup in your own instance

💡 Habits

Setup with GitHub actions

Setup in your own instance

⏭️ Selfskip

Setup with GitHub actions

🗂️ Project structure

Metrics generator

Metrics server instance

GitHub action

💪 Contributing and customizing

Adding new metrics through GraphQL API, REST API or Third-Party service

Updating the SVG template

Metrics server and GitHub action

Testing new features

📖 Useful references

📦 Used packages

✨ Inspirations

22 KiB

Raw Blame History