newrelic / nr1-pageview-map Goto Github PK

View Code? Open in Web Editor NEW

3.0 28.0 13.0 4.54 MB

NR1 Pageview Map allows you to explore Browser data geographically.

Home Page: https://discuss.newrelic.com/t/new-relic-one-page-view-map-nerdpack/87602

License: Apache License 2.0

JavaScript 94.21% SCSS 5.79%

newrelic nerdpack nr1 nr1-pageview-map pageview-map browser

nr1-pageview-map's Introduction

PageView Map (nr1-pageview-map)

Usage

PageView Map uses Browser data to plot activity on a map visualization, allowing you to do geographic exploration of your data.

Open Source License

This project is distributed under the Apache 2 license.

Dependencies

New Relic Browser.

Getting started

First, ensure that you have Git and NPM installed. If you're unsure whether you have one or both of them installed, run the following command(s) (If you have them installed these commands will return a version number, if not, the commands won't be recognized):

git --version
npm -v

Next, clone this repository and run the following scripts:

nr1 nerdpack:clone -r https://github.com/newrelic/nr1-pageview-map.git
cd nr1-pageview-map
npm start

Visit https://one.newrelic.com/?nerdpacks=local, navigate to the Nerdpack via Entity Explorer > choose a Browser application > click on PageView Map in the left hand navigation, and ✨

Deploying this Nerdpack

Open a command prompt in the nerdpack's directory and run the following commands.

# To create a new uuid for the nerdpack so that you can deploy it to your account:
# nr1 nerdpack:uuid -g [--profile=your_profile_name]

# To see a list of APIkeys / profiles available in your development environment:
# nr1 credentials:list

nr1 nerdpack:publish [--profile=your_profile_name]
nr1 nerdpack:deploy [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]
nr1 nerdpack:subscribe [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]

Visit https://one.newrelic.com, navigate to the Nerdpack, and ✨

Community Support

New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices. Like all New Relic open source community projects, there's a related topic in the New Relic Explorers Hub. You can find this project's topic/threads here:

https://discuss.newrelic.com/t/new-relic-one-page-view-map-nerdpack/87602

Please do not report issues with PageView Map to New Relic Global Technical Support. Instead, visit the Explorers Hub for troubleshooting and best-practices.

Issues / Enhancement Requests

Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.

Security

As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.

Contributing

Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself 😁). Please review our Contributors Guide.

Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at [email protected].

nr1-pageview-map's People

Contributors

Stargazers

Watchers

Forkers

tangollama urszulae danperovich ddarwin talwar jbeveland27 dulcineapena1 isabella232 jgibson02 suraj-webkul ghas-results newrelic-csec mlong-nr

nr1-pageview-map's Issues

Apdex T value not being acknowledged, instead possible falling back to default Apdex T value (0.5)

Description

For some reason our deployment of "PageView Map" on our Browser app is not acknowledging the Apdex T value correctly and it would seem instead is just taking the default Apdex T value of "0.5", hence all the geo location points on the map are showing a red critical status (since all durations are way over the default Apdex T value of 0.5), which should not be the case.

Steps to Reproduce

Our Apdex T value:

Example of all geo points showing a critical status.

This Browser app is still running a fairly old version of the Browser agent (1071), so not sure that is the reason. Is there a minimum required Browser agent version required for the correct Apdex T value to be acknowledged?

Feat: Support SPA

Summary

NR Browser captures PageView events for traditional websites, and captures BrowserInteraction events for Single-Page Apps (SPA).

https://github.com/newrelic/nr1-browser-analyzer intelligently asks for a given entity, which of these two is populated for the app, and tailors the app experience based on the data collected.

Desired Behaviour

For a given entity, query to see which event we're collecting, and utilize this to drive the map.

Possible Solution

See https://github.com/newrelic/nr1-browser-analyzer for one implementation of this.

chore: upgrade eslint

rm -r node_modules
npm uninstall eslint
npm install --save-dev eslint

chore: utilize timeRangeToNrql from the community library

Replace createSinceQueryFragment with timeRangeToNrql from the @newrelic/nr1-community library for consistent behavior across apps.

Slide out card does not close...

The close button is not respected and the color of the map circle color seems to be off-pallete (the neon green).

chore: update package-lock.json

The version in the package.json doesn't match up with what's in the package-lock.json

Upgrade the project meta data to support new catalog commands

Add metadata to the repository that matches the example laid out here.

Add a config.json file to a catalog directory in the repo root, matching this format.
Add a documentation.md file to a catalog directory in the repo root, matching this format.
(Optional) If there's additional documentation referenced in the repo, add a additionalInfo.md file to a catalog directory in the repo root, matching this format.
Add one or more screenshots to a catalog/screenshots directory in the repo root, matching this format.

chore: package.json nr1 attribute

The newer versions of the nr1 cli move the nr1 attribute out of the packaage.json and into a top-level (project root) nr1.json file.

Make this update to ensure others don't encounter issues or a disconnected experience.

feat: preserve zoom level onClick

Summary

After zooming into the map (utilizing touchpad), when you select a point, it centers you on that point but zooms back out.

Desired Behavior

Preserve zoom-level so you don't feel like you're being jostled/bounced around.

Possible Solution

Add a listener to the map for onZoomLevel (or similar) and store the zoom level in local state.

Clicking circle zooms out instead of remains in current zoom

Description

Expect to NOT zoom out when I click on any state circle

Steps to Reproduce

Begin zoomed out. Click any circle (I clicked a state within the US). While observing current display of the original circle, click another circle related to a US state. Notice that it zooms back out.

Expected Behaviour

I expect that when I click on another circle, the screen will not zoom back out.

refactor: move PlatformStateContext.Consumer usage

Move down in the component tree
Utilize inside of detail-panels vs. passing as a prop

[Repolinter] Open Source Policy Issues

Repolinter Report

🤖This issue was automatically generated by repolinter-action, developed by the Open Source and Developer Advocacy team at New Relic. This issue will be automatically updated or closed when changes are pushed. If you have any problems with this tool, please feel free to open a GitHub issue or give us a ping in #help-opensource.

This Repolinter run generated the following results:

❗ Error	❌ Fail	⚠️ Warn	✅ Pass	Ignored	Total
0	1	0	12	0	13

Fail
- ❌ code-of-conduct-should-not-exist-here
Passed

Fail #

❌ `code-of-conduct-should-not-exist-here` #

New Relic has moved the CODE_OF_CONDUCT file to a centralized location where it is referenced automatically by every repository in the New Relic organization. Because of this change, any other CODE_OF_CONDUCT file in a repository is now redundant and should be removed. For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view. Found files. Below is a list of files or patterns that failed:

CODE_OF_CONDUCT.md
- 🔨 Suggested Fix: Remove file

Passed #

Click to see rules

✅ `license-file-exists` #

Found file (LICENSE). New Relic requires that all open source projects have an associated license contained within the project. This license must be permissive (e.g. non-viral or copyleft), and we recommend Apache 2.0 for most use cases. For more information please visit https://docs.google.com/document/d/1vML4aY_czsY0URu2yiP3xLAKYufNrKsc7o4kjuegpDw/edit.

✅ `readme-file-exists` #

Found file (README.md). New Relic requires a README file in all projects. This README should give a general overview of the project, and should point to additional resources (security, contributing, etc.) where developers and users can learn further. For more information please visit https://github.com/newrelic/open-source-tools/tree/master/javascript/oss-template.

✅ `readme-starts-with-nr1-catalog-header` #

The first 1 lines contain all of the requested patterns. (README.md). The README of a community plus project should have a NR1 Catalog header at the start of the README. If you already have a NR1 Catalog header and this rule is failing, your header may be out of date, and you should update your header with the suggested one below. For more information please visit https://opensource.newrelic.com/oss-category/.

✅ `readme-contains-security-section` #

Contains a security section (README.md). New Relic recommends having a Security section in your README to address concerns such as vulnerability reporting. This security section should also contain a link to the security policy (found under the "Security" tab of the repository). For an example of this section, please see the NR1 Catalog Template. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.

✅ `readme-contains-link-to-security-policy` #

Contains a link to the security policy for this repository (README.md). New Relic recommends referencing the open source security policy (https://github.com/newrelic/<repo-name>/security/policy or ../../security/policy) in a Security section in the README. For an example of this, please see the NR1 Catalog Template. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.

✅ `readme-contains-discuss-topic` #

Contains a link to the appropriate discuss.newrelic.com topic (README.md). New Relic recommends directly linking the your appropriate discuss.newrelic.com topic in the README, allowing developer an alternate method of getting support. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.

✅ `third-party-notices-file-exists` #

Found file (THIRD_PARTY_NOTICES.md). A THIRD_PARTY_NOTICES.md file must be present to grant attribution to all dependencies being used by this project. For JavaScript projects, you can generate this file using the oss-cli. For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view.

✅ `github-actions-workflow-file-exists` #

Found file (.github/workflows/catalog.yml). Any Community Plus project must integrate with GitHub actions. For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view.

✅ `nr1-catalog-config-file-exists` #

Found file (catalog/config.json).

✅ `nr1-catalog-screenshots-directory-exists` #

Found file (catalog/screenshots).

✅ `nr1-catalog-documentation-file-exists` #

Found file (catalog/documentation.md).

✅ `package-scripts-present` #

An eslint-check and eslint-fix npm script found in file (package.json). NPM scripts for ESLint (eslint-check and eslint-fix) are required to properly integrate with the nerdpack system.

Remove master branch now that we have a main branch

[Repolinter] Open Source Policy Issues

Repolinter Report

This Repolinter run generated the following results:

❗ Error	❌ Fail	⚠️ Warn	✅ Pass	Ignored	Total
0	3	0	9	0	12

Fail
Passed

Fail #

❌ `readme-starts-with-nr1-catalog-header` #

The README of a community plus project should have a NR1 Catalog header at the start of the README. If you already have a NR1 Catalog header and this rule is failing, your header may be out of date. For more information please visit https://opensource.newrelic.com/oss-category/. Below is a list of files or patterns that failed:

README.md: The first 1 lines do not contain the pattern(s): Open source NR1 Catalog header (see https://opensource.newrelic.com/oss-category).
- 🔨 Suggested Fix: prepend [![New Relic One Catalog Project header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/New_Relic_One_Catalog_Project.png)](https://opensource.newrelic.com/oss-category/#new-relic-one-catalog-project) to file

❌ `readme-contains-security-section` #

Doesn't contain a security section (README.md). New Relic recommends having a Security section in your README to address concerns such as vulnerability reporting. This security section should also contain a link to the security policy (found under the "Security" tab of the repository). For an example of this section, please see the NR1 Catalog Template. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.

❌ `readme-contains-link-to-security-policy` #

Doesn't contain a link to the security policy for this repository (README.md). New Relic recommends referencing the open source security policy (https://github.com/newrelic/<repo-name>/security/policy or ../../security/policy) in a Security section in the README. For an example of this, please see the NR1 Catalog Template. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.

Passed #

Click to see rules

✅ `license-file-exists` #

✅ `readme-file-exists` #

✅ `readme-contains-discuss-topic` #

✅ `third-party-notices-file-exists` #

✅ `github-actions-workflow-file-exists` #

Found file (.github/workflows/pr.yml). Any Community Plus project must integrate with GitHub actions. For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view.

✅ `nr1-catalog-config-file-exists` #

Found file (catalog/config.json).

✅ `nr1-catalog-screenshots-directory-exists` #

Found file (catalog/screenshots).

✅ `nr1-catalog-documentation-file-exists` #

Found file (catalog/documentation.md).

✅ `package-scripts-present` #

An eslint-check and eslint-fix npm script found in file (package.json). NPM scripts for ESLint (eslint-check and eslint-fix) are required to properly integrate with the nerdpack system.

feat: unable to access entity notification

Add a notification/warning/explanation when accessing an entity this Nerdpack UUID (account) does not have access to.

nr1-customer-journey has some language around this.

newrelic / nr1-pageview-map Goto Github PK

nr1-pageview-map's Introduction

PageView Map (nr1-pageview-map)

Usage

Open Source License

Dependencies

Getting started

Deploying this Nerdpack

Community Support

Issues / Enhancement Requests

Security

Contributing

nr1-pageview-map's People

Contributors

Stargazers

Watchers

Forkers

nr1-pageview-map's Issues

Description

Steps to Reproduce

Summary

Desired Behaviour

Possible Solution

Summary

Desired Behavior

Possible Solution

Description

Steps to Reproduce

Expected Behaviour

Repolinter Report

Fail #

❌ code-of-conduct-should-not-exist-here #

Passed #

✅ license-file-exists #

✅ readme-file-exists #

✅ readme-starts-with-nr1-catalog-header #

✅ readme-contains-security-section #

✅ readme-contains-link-to-security-policy #

✅ readme-contains-discuss-topic #

✅ third-party-notices-file-exists #

✅ github-actions-workflow-file-exists #

✅ nr1-catalog-config-file-exists #

✅ nr1-catalog-screenshots-directory-exists #

✅ nr1-catalog-documentation-file-exists #

✅ package-scripts-present #

Repolinter Report

Fail #

❌ readme-starts-with-nr1-catalog-header #

❌ readme-contains-security-section #

❌ readme-contains-link-to-security-policy #

Passed #

✅ license-file-exists #

✅ readme-file-exists #

✅ readme-contains-discuss-topic #

✅ third-party-notices-file-exists #

✅ github-actions-workflow-file-exists #

✅ nr1-catalog-config-file-exists #

✅ nr1-catalog-screenshots-directory-exists #

✅ nr1-catalog-documentation-file-exists #

✅ package-scripts-present #

Recommend Projects

Recommend Topics

Recommend Org

❌ `code-of-conduct-should-not-exist-here` #

✅ `license-file-exists` #

✅ `readme-file-exists` #

✅ `readme-starts-with-nr1-catalog-header` #

✅ `readme-contains-security-section` #

✅ `readme-contains-link-to-security-policy` #

✅ `readme-contains-discuss-topic` #

✅ `third-party-notices-file-exists` #

✅ `github-actions-workflow-file-exists` #

✅ `nr1-catalog-config-file-exists` #

✅ `nr1-catalog-screenshots-directory-exists` #

✅ `nr1-catalog-documentation-file-exists` #

✅ `package-scripts-present` #

❌ `readme-starts-with-nr1-catalog-header` #

❌ `readme-contains-security-section` #

❌ `readme-contains-link-to-security-policy` #

✅ `license-file-exists` #

✅ `readme-file-exists` #

✅ `readme-contains-discuss-topic` #

✅ `third-party-notices-file-exists` #

✅ `github-actions-workflow-file-exists` #

✅ `nr1-catalog-config-file-exists` #

✅ `nr1-catalog-screenshots-directory-exists` #

✅ `nr1-catalog-documentation-file-exists` #

✅ `package-scripts-present` #