Skip to content

Latest commit

 

History

History
161 lines (123 loc) · 4.91 KB

README.md

File metadata and controls

161 lines (123 loc) · 4.91 KB
Raw

Pulsar Real User Monitoring (RUM)

This project is in active development.

Utilities and sample programs for Pulsar RUM.

Bulk Beacons

A method to send performance data to Pulsar in bulk. gRPC and HTTP+JSON are supported.

See comments in the bulkbeacon.proto definition file for how to structure messages. Depending on the version of the Bulk Beacon ingestion, you will have to look at its respective directory (mentioned below in the Getting started with gRPC section).

Versions

We currently support two formats for gRPC and HTTP+JSON for Bulk Beacons. Each one can be found in proto/bulkbeacon/{version}/bulkbeacon.proto, with version taking values of v1 and v2.

Version 1 was the first formal release of the Bulk Beacon ingestion, and version 2 supports a new feature for multiple metrics. For more information, please contact your Customer Success Representative.

Getting started with gRPC

  1. Copy the desired version of bulkbeacon.proto from either https://github.com/ns1/pulsar-rum/tree/master/proto/bulkbeacon/v1 or https://github.com/ns1/pulsar-rum/tree/master/proto/bulkbeacon/v2 into your project. Use your preferred method of building gRPC clients from that .proto file.
  2. Use g.ns1p.net:443 as the service's target address. This works for both versions of the service.
  3. Enable TLS on your gRPC transport.
  4. Add your NS1 API key. You can get or create one via NS1's portal here https://my.nsone.net/#/account/settings. Please check the examples to see how to add the authentication key.

See the v1 example Golang client or the v2 example Golang client for more details. Additionally, check out https://grpc.io/ for more information regarding dependencies and compiling for other languages.

Getting started with HTTP+JSON

For HTTP+JSON you'll be POST'ing data to an HTTP endpoint based on the version of the service:

  • For V1 use https://b.ns1p.net/v1/beacon/bulk
  • For V2 use https://b.ns1p.net/v2/beacon/bulk

You'll also need an NS1 API key to get started. You can get or create one via NS1's portal here: https://my.nsone.net/#/account/settings.

Here's an example using curl:

curl -H "X-NSONE-Key: YOUR_API_KEY_HERE" -X POST -d {... JSON body ...}

You can use the protocol buffer objects as a basis for the required JSON payload. The JSON body placeholder above is the Beacons protocol buffer message serialized to JSON. You'll need to use helper libraries for your language to serialize protocol buffer objects to JSON. Some information is available on the protocol buffer docs page.

Here's an example JSON message in the V2 format containing 4 payloads:

{
  "metrics":  [
    {
      "attribution":  {
        "appid":  "YOUR_APP_ID_HERE",
        "jobid":  "YOUR_JOB_ID_HERE",
        "geoAsn":  {
          "geoCountry":  "US",
          "geoSubdiv":  "NY",
          "asn":  2856
        }
      },
      "payloads":  [
        {
          "latency":  { "value":  50 }
        },
        {
          "perfScore":  {
            "value":  55,
            "meta":  { "ttl":  3200 }
          }
        },
        {
          "avail":  {
            "statusCode":  200
          }
        },
        {
          "availScore":  {
            "value":  1,
            "meta":  { "ttl":  7200 }
          }
        }
      ] 
    }
  ]
}

Building the examples

The examples can be built executing several commands from the pulsar-rum directory.

To build both examples, execute:

$ make

If you want to build a specific version, execute:

$ make bulkbeacon_v1

or

$ make bulkbeacon_v2

You can find the binaries on the build/ directory.

If unsure, reach out with any question you could have.

Contributing

Pull Requests and issues are welcome. See the NS1 Contribution Guidelines for more information.

License

Copyright (C) 2021, NSONE, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.