Skip to content

Commit

Permalink
update(dependencies,repo-name): Update dependencies to latest and upd…
Browse files Browse the repository at this point in the history
…ate repo name reference from verddacio-metrics-middleware to verdaccio-prometheus-middleware
  • Loading branch information
Ed Clement committed Nov 23, 2021
1 parent 3b396c7 commit 8b65515
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 87 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# verdaccio-metrics-middleware
# verdaccio-prometheus-middleware
Metrics middleware plugin for Verdaccio. Collects metrics specifically for package tarball install/download requests and
exposes them at a configurable metrics endpoint (defaults to `/-/metrics`). The metrics are produced in the standard
[prometheus metrics text format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-format-example).
Expand All @@ -15,6 +15,14 @@ _every_ request:
Optionally, an additional `packageGroup` label can be applied *if* a `packageGroups` option is added to the plugin
configuration.

## Installation
Because of how Verdaccio loads plugins, you will need to install this package using an `npm` alias in your `package.json`:
```json
"dependencies": {
"verdaccio-metrics": "npm:@xlts.dev/verdaccio-prometheus-middleware"
}
```

## Configuration
Complete configuration example:
```yaml
Expand Down
2 changes: 1 addition & 1 deletion jest.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module.exports = {
name: 'verdaccio-metrics-middleware',
name: 'verdaccio-prometheus-middleware',
verbose: true,
collectCoverage: true,
collectCoverageFrom: ['src/**/*.ts', '!src/index.ts'],
Expand Down
152 changes: 76 additions & 76 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 8b65515

Please sign in to comment.