bc4bd79e90
* Basic process metrics * Enable Prometheus by an environment variable * Code formatting * Documentation for Prometheus metrics * Link from README to documentation of Prometheus * Link from README to documentation of Prometheus * Link from README to documentation of Prometheus * Separate module for metrics + tests * Metrics limited by IP * Metrics are forbidded for all requets by default * Code refactoring * allowedIps passed as a string to PrometheusMetrics * Handle missing config * METRICS_PROMETHEUS_ALLOWED_IPS added to documentation * Log info about enabled metrics * Unused code removed * package-lock.json updated * prom-client updated to 11.1.2 * Code refactoring * Do not read IP address from X-Forwarder-For header
245 lines
11 KiB
Markdown
245 lines
11 KiB
Markdown
<p align="center">
|
|
<img src="https://rawgit.com/badges/shields/master/static/logo.svg"
|
|
height="130">
|
|
</p>
|
|
<p align="center">
|
|
<a href="#backers" alt="Backers on Open Collective">
|
|
<img src="https://opencollective.com/shields/backers/badge.svg" /></a>
|
|
<a href="#sponsors" alt="Sponsors on Open Collective">
|
|
<img src="https://opencollective.com/shields/sponsors/badge.svg" /></a>
|
|
<a href="https://circleci.com/gh/badges/shields/tree/master">
|
|
<img src="https://img.shields.io/circleci/project/github/badges/shields/master.svg"
|
|
alt="build status"></a>
|
|
<a href="https://github.com/badges/shields/compare/gh-pages...master">
|
|
<img src="https://img.shields.io/github/commits-since/badges/shields/gh-pages.svg?label=commits%20to%20be%20deployed"
|
|
alt="commits to be deployed"></a>
|
|
<a href="https://lgtm.com/projects/g/badges/shields/alerts/">
|
|
<img src="https://img.shields.io/lgtm/alerts/g/badges/shields.svg?logo=lgtm&logoWidth=18"
|
|
alt="Total alerts"/></a>
|
|
<a href="https://discord.gg/HjJCwm5">
|
|
<img src="https://img.shields.io/discord/308323056592486420.svg?logo=discord"
|
|
alt="chat on Discord"></a>
|
|
<a href="https://twitter.com/intent/follow?screen_name=shields_io">
|
|
<img src="https://img.shields.io/twitter/follow/shields_io.svg?style=social&logo=twitter"
|
|
alt="follow on Twitter"></a>
|
|
</p>
|
|
|
|
This is home to [Shields.io][shields.io], a service for concise, consistent,
|
|
and legible badges in SVG and raster format, which can easily be included in
|
|
GitHub readmes or any other web page. The service supports dozens of
|
|
continuous integration services, package registries, distributions, app
|
|
stores, social networks, code coverage services, and code analysis services.
|
|
Every month it serves over 470 million images.
|
|
|
|
In addition to hosting the shields.io frontend and server code, this monorepo
|
|
hosts an [NPM library for generating badges][gh-badges], and the badge design
|
|
specification.
|
|
|
|
[shields.io]: https://shields.io/
|
|
[gh-badges]: https://www.npmjs.com/package/gh-badges
|
|
|
|
|
|
Examples
|
|
--------
|
|
|
|
* code coverage percentage: 
|
|
* stable release version: 
|
|
* package manager release: 
|
|
* status of third-party dependencies: 
|
|
* static code analysis grade: 
|
|
* [SemVer](https://semver.org/) version observance: 
|
|
* amount of [Liberapay](https://liberapay.com/) donations per week: 
|
|
* Python package downloads: 
|
|
* Chrome Web Store extension rating: 
|
|
* [Uptime Robot](https://uptimerobot.com) percentage: 
|
|
|
|
[Make your own badges!][custom badges]
|
|
(Quick example: `https://img.shields.io/badge/left-right-f39f37.svg`)
|
|
|
|
Browse a [complete list of badges][shields.io].
|
|
|
|
[custom badges]: http://shields.io/#your-badge
|
|
|
|
|
|
Contributing
|
|
------------
|
|
|
|
Shields is a community project. We invite your participation through issues
|
|
and pull requests! You can peruse the [contributing guidelines][contributing].
|
|
|
|
When adding or changing a service [please add tests][service-tests].
|
|
|
|
This project has quite a backlog of suggestions! If you're new to the project,
|
|
maybe you'd like to open a pull request to address one of them:
|
|
|
|
[](https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
|
|
|
You can read a [tutorial on how to add a badge][tutorial].
|
|
|
|
[service-tests]: https://github.com/badges/shields/blob/master/doc/service-tests.md
|
|
[tutorial]: doc/TUTORIAL.md
|
|
[contributing]: CONTRIBUTING.md
|
|
|
|
|
|
Using the badge library
|
|
-----------------------
|
|
|
|
```sh
|
|
npm install -g gh-badges
|
|
badge build passed :green .png > mybadge.png
|
|
```
|
|
|
|
```js
|
|
const { BadgeFactory } = require('gh-badges')
|
|
|
|
const bf = new BadgeFactory({ fontPath: '/path/to/Verdana.ttf' })
|
|
|
|
const format = {
|
|
text: ['build', 'passed'],
|
|
colorscheme: 'green',
|
|
template: 'flat',
|
|
}
|
|
|
|
const svg = bf.create(format)
|
|
```
|
|
|
|
View the [documentation for gh-badges][gh-badges doc].
|
|
|
|
[](https://npmjs.org/package/gh-badges)
|
|
|
|
[gh-badges doc]: https://github.com/badges/shields/blob/master/doc/gh-badges.md
|
|
|
|
|
|
Development
|
|
-----------
|
|
|
|
1. Install Node 8 or later. You can use the [package manager][] of your choice.
|
|
Tests need to pass in Node 8 and 9.
|
|
2. Clone this repository.
|
|
3. Run `npm install` to install the dependencies.
|
|
4. Run `npm run build` to build the frontend.
|
|
5. Run `npm start` to start the server.
|
|
6. Open `http://[::]:8080/` to view the home page.
|
|
|
|
To generate the frontend using production cache settings – that is,
|
|
badge preview URIs with `maxAge` – run `LONG_CACHE=true npm run build`.
|
|
|
|
To analyze the frontend bundle, run `npm install webpack-bundle-analyzer` and
|
|
then `ANALYZE=true npm start`.
|
|
|
|
[Snapshot tests][] ensure we don't inadvertently make changes that affect the
|
|
SVG or JSON output. When deliberately changing the output, run
|
|
`SNAPSHOT_DRY=1 npm run test:js:server` to preview changes to the saved
|
|
snapshots, and `SNAPSHOT_UPDATE=1 npm run test:js:server` to update them.
|
|
|
|
The server can be configured to use [Sentry][] ([configuration][sentry configuration]) and [Prometheus][] ([configuration][prometheus configuration]).
|
|
|
|
[package manager]: https://nodejs.org/en/download/package-manager/
|
|
[snapshot tests]: https://glebbahmutov.com/blog/snapshot-testing/
|
|
[Prometheus]: https://prometheus.io/
|
|
[prometheus configuration]: doc/self-hosting.md#prometheus
|
|
[Sentry]: https://sentry.io/
|
|
[sentry configuration]: doc/self-hosting.md#sentry
|
|
|
|
Hosting your own server
|
|
-----------------------
|
|
|
|
There is documentation about [hosting your own server][self-hosting].
|
|
|
|
[self-hosting]: doc/self-hosting.md
|
|
|
|
|
|
History
|
|
-------
|
|
|
|
b.adge.me was the original website for this service. Heroku back then had a
|
|
thing which made it hard to use a toplevel domain with it, hence the odd
|
|
domain. It used code developed in 2013 from a library called
|
|
[gh-badges][old-gh-badges], both developed by [Thaddée Tyl][espadrine].
|
|
The project merged with shields.io by making it use the b.adge.me code
|
|
and closed b.adge.me.
|
|
|
|
The original badge specification was developed in 2013 by
|
|
[Olivier Lacan][olivierlacan]. It was inspired by the Travis CI and similar
|
|
badges (there were a lot fewer, back then). In 2014 Thaddée Tyl redesigned
|
|
it with help from a Travis CI employee and convinced everyone to switch to
|
|
it. The old design is what today is called the plastic style; the new one
|
|
is the flat style.
|
|
|
|
You can read more about [the project's inception][thread],
|
|
[the motivation of the SVG badge specification][motivation], and
|
|
[the specification itself][spec].
|
|
|
|
[olivierlacan]: https://github.com/olivierlacan
|
|
[espadrine]: https://github.com/espadrine
|
|
[old-gh-badges]: https://github.com/badges/gh-badges
|
|
[motivation]: spec/motivation.md
|
|
[spec]: spec/SPECIFICATION.md
|
|
[thread]: https://github.com/h5bp/lazyweb-requests/issues/150
|
|
|
|
|
|
Project leaders
|
|
---------------
|
|
|
|
[espadrine](https://github.com/espadrine) is the sysadmin.
|
|
|
|
These contributors donate time on a consistent basis to help guide and
|
|
maintain the project:
|
|
|
|
* [chris48s](https://github.com/chris48s)
|
|
* [Daniel15](https://github.com/Daniel15)
|
|
* [espadrine](https://github.com/espadrine)
|
|
* [paulmelnikow](https://github.com/paulmelnikow)
|
|
* [platan](https://github.com/platan)
|
|
* [PyvesB](https://github.com/PyvesB)
|
|
* [RedSparr0w](https://github.com/RedSparr0w)
|
|
|
|
|
|
Related projects
|
|
----------------
|
|
|
|
- [badgerbadgerbadger gem][gem]
|
|
- [pybadges python library][pybadges]
|
|
|
|
[gem]: https://github.com/badges/badgerbadgerbadger
|
|
[pybadges]: https://github.com/google/pybadges
|
|
|
|
License
|
|
-------
|
|
|
|
All assets and code are under the [CC0 LICENSE](LICENSE) and in the public
|
|
domain unless specified otherwise.
|
|
|
|
The assets in `logo/` are trademarks of their respective companies and are
|
|
under their terms and license.
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
|
<a href="https://github.com/badges/shields/graphs/contributors"><img src="https://opencollective.com/shields/contributors.svg?width=890" /></a>
|
|
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/shields#backer)]
|
|
|
|
<a href="https://opencollective.com/shields#backers" target="_blank"><img src="https://opencollective.com/shields/backers.svg?width=890"></a>
|
|
|
|
|
|
## Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/shields#sponsor)]
|
|
|
|
<a href="https://opencollective.com/shields/sponsor/0/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/1/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/2/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/3/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/4/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/5/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/6/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/7/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/8/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/shields/sponsor/9/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/9/avatar.svg"></a>
|
|
|
|
|