{"id":49345331,"url":"https://github.com/ns1/pulsar-rum","last_synced_at":"2026-04-27T07:02:05.627Z","repository":{"id":46184399,"uuid":"273305572","full_name":"ns1/pulsar-rum","owner":"ns1","description":"Protocol Buffer schema and example code for Bulk Data Ingestion with Pulsar.","archived":false,"fork":false,"pushed_at":"2021-11-08T20:03:45.000Z","size":138,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":18,"default_branch":"master","last_synced_at":"2026-01-14T21:43:31.611Z","etag":null,"topics":["ns1","pulsar"],"latest_commit_sha":null,"homepage":"https://ns1.com/products/pulsar","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ns1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-18T17:56:20.000Z","updated_at":"2024-01-14T00:01:25.000Z","dependencies_parsed_at":"2022-08-30T05:05:16.918Z","dependency_job_id":null,"html_url":"https://github.com/ns1/pulsar-rum","commit_stats":null,"previous_names":["nsone/pulsar-rum"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ns1/pulsar-rum","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ns1%2Fpulsar-rum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ns1%2Fpulsar-rum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ns1%2Fpulsar-rum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ns1%2Fpulsar-rum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ns1","download_url":"https://codeload.github.com/ns1/pulsar-rum/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ns1%2Fpulsar-rum/sbom","scorecard":{"id":696980,"data":{"date":"2025-08-11","repo":{"name":"github.com/ns1/pulsar-rum","commit":"9bb4907dd82421750e67dc93c0cc2c9c1eff5a01"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.4,"checks":[{"name":"Code-Review","score":7,"reason":"Found 5/7 approved changesets -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/ns1/pulsar-rum/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/ns1/pulsar-rum/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/ns1/pulsar-rum/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/ns1/pulsar-rum/codeql-analysis.yml/master?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.0.0 not signed: https://api.github.com/repos/ns1/pulsar-rum/releases/27927966","Warn: release artifact v1.0.0 does not have provenance: https://api.github.com/repos/ns1/pulsar-rum/releases/27927966"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"15 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2022-0236 / GHSA-h86h-8ppg-mxmh","Warn: Project is vulnerable to: GO-2021-0238 / GHSA-83g2-8m93-v3w7","Warn: Project is vulnerable to: GO-2022-0288","Warn: Project is vulnerable to: GO-2022-0969 / GHSA-69cg-p879-7622","Warn: Project is vulnerable to: GO-2022-1144 / GHSA-xrjj-mj9h-534m","Warn: Project is vulnerable to: GO-2023-1571 / GHSA-vvpx-j8f3-3w6h","Warn: Project is vulnerable to: GO-2023-1988 / GHSA-2wrh-6pvc-2jm9","Warn: Project is vulnerable to: GO-2023-2102 / GHSA-4374-p667-p6c8","Warn: Project is vulnerable to: GO-2023-2153 / GHSA-m425-mq94-257g / GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw","Warn: Project is vulnerable to: GO-2022-0493 / GHSA-p782-xgp4-8hr8","Warn: Project is vulnerable to: GO-2024-2611 / GHSA-8r3f-844c-mc37"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T03:58:42.888Z","repository_id":46184399,"created_at":"2025-08-22T03:58:42.888Z","updated_at":"2025-08-22T03:58:42.888Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32326122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"online","status_checked_at":"2026-04-27T02:00:06.769Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ns1","pulsar"],"created_at":"2026-04-27T07:02:03.454Z","updated_at":"2026-04-27T07:02:05.597Z","avatar_url":"https://github.com/ns1.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"Pulsar Real User Monitoring (RUM)\n=================================\n\n\u003e This project is in [active development](https://github.com/ns1/community/blob/master/project_status/ACTIVE_DEVELOPMENT.md).\n\nUtilities and sample programs for Pulsar RUM.\n\n\nBulk Beacons\n------------\n\nA method to send performance data to Pulsar in bulk.  gRPC and HTTP+JSON are\nsupported.\n\nSee comments in the `bulkbeacon.proto` definition file for how to structure messages.\nDepending on the version of the Bulk Beacon ingestion, you will have to look at its respective\ndirectory (mentioned below in the `Getting started with gRPC` section).\n\n### Versions\n\nWe currently support two formats for gRPC and HTTP+JSON for Bulk Beacons. Each one can be\nfound in `proto/bulkbeacon/{version}/bulkbeacon.proto`, with `version` taking values\nof `v1` and `v2`. \n\nVersion 1 was the first formal release of the Bulk Beacon ingestion, and version 2 \nsupports a new feature for multiple metrics. For more information, please contact\nyour Customer Success Representative.\n\n### Getting started with gRPC\n\n1. Copy the desired version of `bulkbeacon.proto` from either \n[https://github.com/ns1/pulsar-rum/tree/master/proto/bulkbeacon/v1](https://github.com/ns1/pulsar-rum/tree/master/proto/bulkbeacon/v1)\n   or [https://github.com/ns1/pulsar-rum/tree/master/proto/bulkbeacon/v2](https://github.com/ns1/pulsar-rum/tree/master/proto/bulkbeacon/v1) \ninto your project. Use your preferred method of building gRPC clients from that `.proto` file.\n2. Use `g.ns1p.net:443` as the service's target address. This works for both \n versions of the service.\n3. Enable TLS on your gRPC transport.\n4. Add your NS1 API key. You can get or create one via NS1's portal here\n https://my.nsone.net/#/account/settings.\nPlease check the examples to see how to add the authentication key.\n\nSee the [v1 example Golang client](https://github.com/ns1/pulsar-rum/blob/master/cmd/example_client_v1/main.go) \nor the [v2 example Golang client](https://github.com/ns1/pulsar-rum/blob/master/cmd/example_client_v2/main.go) \nfor more details. Additionally, check out https://grpc.io/ for more information \nregarding dependencies and compiling for other languages.\n\n### Getting started with HTTP+JSON\n\nFor HTTP+JSON you'll be POST'ing data to an HTTP endpoint based on the version of the\n service:\n \n* For V1 use `https://b.ns1p.net/v1/beacon/bulk` \n* For V2 use `https://b.ns1p.net/v2/beacon/bulk` \n\nYou'll also need an NS1 API key to get started. You can get or create one via\n NS1's portal here: https://my.nsone.net/#/account/settings.\n\nHere's an example using `curl`:\n\n```bash\ncurl -H \"X-NSONE-Key: YOUR_API_KEY_HERE\" -X POST -d {... JSON body ...}\n```\n\nYou can use the protocol buffer objects as a basis for the required JSON payload.\n The `JSON body` placeholder above is the `Beacons` protocol buffer message\n serialized to JSON.  You'll need to use helper libraries for your \n language to serialize protocol buffer objects to JSON.  Some information is \n available on [the protocol buffer docs](https://github.com/protocolbuffers/protobuf/blob/master/docs/third_party.md)\n page.\n\nHere's an example JSON message in the V2 format containing 4 payloads:\n\n```json\n{\n  \"metrics\":  [\n    {\n      \"attribution\":  {\n        \"appid\":  \"YOUR_APP_ID_HERE\",\n        \"jobid\":  \"YOUR_JOB_ID_HERE\",\n        \"geoAsn\":  {\n          \"geoCountry\":  \"US\",\n          \"geoSubdiv\":  \"NY\",\n          \"asn\":  2856\n        }\n      },\n      \"payloads\":  [\n        {\n          \"latency\":  { \"value\":  50 }\n        },\n        {\n          \"perfScore\":  {\n            \"value\":  55,\n            \"meta\":  { \"ttl\":  3200 }\n          }\n        },\n        {\n          \"avail\":  {\n            \"statusCode\":  200\n          }\n        },\n        {\n          \"availScore\":  {\n            \"value\":  1,\n            \"meta\":  { \"ttl\":  7200 }\n          }\n        }\n      ] \n    }\n  ]\n}\n```\n\n\n\nBuilding the examples\n---------------------\n\nThe examples can be built executing several commands from the `pulsar-rum` directory.\n\nTo build both examples, execute:\n```sh\n$ make\n```\n\nIf you want to build a specific version, execute:\n```shell\n$ make bulkbeacon_v1\n```\nor\n```shell\n$ make bulkbeacon_v2\n```\n\nYou can find the binaries on the `build/` directory. \n\nIf unsure, reach out with any question you could have.\n\nContributing\n------------\n\nPull Requests and issues are welcome. See the [NS1 Contribution Guidelines](https://github.com/ns1/community) \nfor more information.\n\n\nLicense\n-------\n\nCopyright (C) 2021, NSONE, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fns1%2Fpulsar-rum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fns1%2Fpulsar-rum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fns1%2Fpulsar-rum/lists"}