newman-reporter-influxdb

newman-reporter-influxdb

InfluxDB reporter for Newman that sends the test results information to InfluxDB 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

---

Installation

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

newman run <collection-url> -r influxdb \
  --reporter-influxdb-server <server-ip> \
  --reporter-influxdb-port <server-port> \
  --reporter-influxdb-name <database-name> \
  --reporter-influxdb-measurement <measurement-name>

Example:

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

Options:

Option	Remarks
--reporter-influxdb-server	IP Address or Host of InfluxDB
--reporter-influxdb-port	Port no. (Usually 8086)
--reporter-influxdb-name	Database name
--reporter-influxdb-measurement	Measurement Point name (If not provided, then reporter will create measurement with prefix newman_results-<timestamp>)
--reporter-influxdb-username (Optional)	Username created for InfluxDB (e.g. newman_user)
--reporter-influxdb-password (Optional)	Password of the user (e.g. p@ssw0rd)

---

Compatibility

newman-reporter-influxdb	InfluxDB
v1.0.0+	v1.7

Notes:

• This reporter currently uses InfluxDB HTTP APIs to send data

---

To Do

• Convert to ES6 based version
• Folder Structure
• Username and Password support
• Include UDP Reporter as well
• Add batch operation
• ESLint
• CI/CD with Github Actions
• HealthCheck to InfluxDB

---

Development

• npm pack
• npm i -g newman-reporter-<name>.<version>.tgz

---

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://github.com/influxdata/influxdb/blob/1.7/services/udp/README.md