Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vs4vijay/newman-reporter-influxdb
Newman Reporter for InfluxDB
https://github.com/vs4vijay/newman-reporter-influxdb
api api-testing influxdb newman newman-reporter newman-reporters postman postman-test
Last synced: about 8 hours ago
JSON representation
Newman Reporter for InfluxDB
- Host: GitHub
- URL: https://github.com/vs4vijay/newman-reporter-influxdb
- Owner: vs4vijay
- License: mit
- Created: 2020-01-26T14:58:43.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-08-01T19:52:21.000Z (about 2 months ago)
- Last Synced: 2024-09-01T21:06:48.390Z (23 days ago)
- Topics: api, api-testing, influxdb, newman, newman-reporter, newman-reporters, postman, postman-test
- Language: JavaScript
- Homepage:
- Size: 229 KB
- Stars: 19
- Watchers: 4
- Forks: 3
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# newman-reporter-influxdb
InfluxDB reporter for [Newman](https://github.com/postmanlabs/newman) that sends the test results information to InfluxDB (1.x, 2.x) which can be used from Grafana to build dashboard.
## Getting Started
1. Install `newman`
2. Install `newman-reporter-influxdb`
3. Install InfluxDB (Get the server address, port, database name, etc)
### Prerequisites
1. `node` and `npm`
2. `newman` - `npm install -g newman`
3. [InfluxDB](https://github.com/influxdata/influxdb)
---
## Installation
```console
npm install -g newman-reporter-influxdb
```
> Installation should be done globally if newman is installed globally, otherwise install without `-g` option
---
## Usage
Specify `-r influxdb` option while running the collection
```bash
newman run -r influxdb \
--reporter-influxdb-server \
--reporter-influxdb-port \
--reporter-influxdb-name \
--reporter-influxdb-measurement
```
- By default, reporter consider influxdb version 1.x (i.e 1.7, 1.8)
- In case of InfluxDB version 2, specify version, org and bucket name as well
- `--reporter-influxdb-version 2`
- `--reporter-influxdb-org `
- `--reporter-influxdb-name `
Example:
```
# For InfluxDB version 1.x
newman run https://www.getpostman.com/collections/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65-JsLv -r influxdb \
--reporter-influxdb-server localhost \
--reporter-influxdb-port 8086 \
--reporter-influxdb-name newman_reports \
--reporter-influxdb-measurement api_results
# For InfluxDB version 2.x
newman run https://www.getpostman.com/collections/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65-JsLv -r influxdb \
--reporter-influxdb-server localhost \
--reporter-influxdb-port 8086 \
--reporter-influxdb-org viz \
--reporter-influxdb-version 2 \
--reporter-influxdb-username viz \
--reporter-influxdb-password db123456 \
--reporter-influxdb-name viz \
--reporter-influxdb-measurement api_results
```
### Options:
**Option** | **Remarks**
--- | ---
`--reporter-influxdb-server` | IP Address or Host of InfluxDB
`--reporter-influxdb-port` | Port no. (Usually `8086`)
`--reporter-influxdb-version` | InfluxDB Version `1`, `2` (default `1`)
`--reporter-influxdb-org` | InfluxDB Org (For InfluxDB version 2.x)
`--reporter-influxdb-port` | Port no. (Usually `8086`)
`--reporter-influxdb-name` | Database name (or Bucket name for InfluxDB version 2.x)
`--reporter-influxdb-measurement` | Measurement Point name (If not provided, then reporter will create measurement with prefix `newman_results-`)
`--reporter-influxdb-username` (*Optional*) | Username created for InfluxDB (e.g. `newman_user`)
`--reporter-influxdb-password` (*Optional*) | Password of the user (e.g. `p@ssw0rd`)
`--reporter-influxdb-identifier` (*Optional*) | An identifier to be passed to InfluxDB (default: `run-${Date.now()}`)
`--reporter-influxdb-mode` | Transmission Mode `http`, `https`, `udp` (default: `http`)
`--reporter-debug` | Enable debug mode (default: `false`)
---
## Compatibility
**newman-reporter-influxdb** | **InfluxDB**
--- | ---
v1.0.0+ | v1.7
v2.0.0+ | v1.8, v2.x
#### Notes:
- This reporter currently uses InfluxDB HTTP APIs / TCP Protocol to send data
---
## To Do
- [x] Convert to ES6 based version
- [x] Folder Structure
- [x] Username and Password support
- [x] Include UDP Reporter as well
- [x] HTTPS Support
- [ ] Add batch operation
- [ ] ESLint / StandardJS
- [x] CI/CD with Github Actions
- [ ] HealthCheck to InfluxDB
- [ ] Remove axios to make it lightweight
- [x] Compatibility with InfluxDB 2.x
- [ ] Tests
---
## Development
- Install Dependencies: `npm install`
- To Install Local Package:
- `npm pack`
- `npm i -g newman-reporter-..tgz`
- OR
- `make local-install`
- Run Unit Tests:
- Run Smoke Tests:
- `make test-v1`
- `make test-v2`
---
### Development Notes
```
npm publish --access public
- name: npm publish
run: |
LATEST=`npm view . version`
CURRENT=`cat package.json | jq -r .version`
if [ "$LATEST" != "$CURRENT" ]
then
npm ci
npm publish
fi
{
"scripts": {
"postpublish" : "PACKAGE_VERSION=$(cat package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag $PACKAGE_VERSION && git push --tags"
}
}
PACKAGE_VERSION=$(cat package.json \
| grep version \
| head -1 \
| awk -F: '{ print $2 }' \
| sed 's/[",]//g' \
| tr -d '[[:space:]]')
echo $PACKAGE_VERSION
https://img.shields.io/npm/v/newman-reporter-influxdb.svg
https://nodejs.org/api/http.html#http_http_request_url_options_callback
https://nodejs.dev/making-http-requests-with-nodejs
https://github.com/influxdata/influxdb/blob/1.7/services/udp/README.md
https://docs.influxdata.com/influxdb/v1.7/supported_protocols/udp/
[udp]
enabled = true
bind-address = ":8086"
database = "newman_reports_udp"
batch-size = 1000
batch-timeout = “1s”
To write, just send newline separated line protocol over UDP. Can send one point at a time (not very performant) or send batches.
$ echo "newman_results value=1" > /dev/udp/localhost/8086
$ echo "select * from newman_results" | influx -database newman_reports_udp
Connected to http://localhost:8086 version 1.7
InfluxDB shell 0.9
name: newman_results
---------
time value
2020-26-06T11:25:15.321527811Z 1
curl -G http://localhost:8086/query --data-urlencode "q=CREATE DATABASE newman_reports"
docker run --name influxdb-1.7 -p 8086:8086 influxdb:1.7
docker run --name influxdb-1.8 -p 8086:8086 influxdb:1.8
docker run --name influxdb-2 -p 8086:8086 quay.io/influxdb/influxdb:v2.0.3
```