Giter VIP home page Giter VIP logo

nr-labs-widget-pack's Introduction

New Relic One Catalog Project header

Labs Widget Pack

GitHub release (latest SemVer including pre-releases)

A library of New Relic custom chart widgets created by the New Relic Labs team, for use in New Relic dashboards.

To get started:

Widgets

Click on the short description in each section to view chart details.

Line & Bar Chart

Display changes in quantity alongside trends over time.
Bar and Line chart screenshot

Overview

Use the Line & Bar chart to understand changes in quantity values (rendered as bars) alongside trends over time (rendered as lines). For instance, you may be interested in understanding how infrastructure load is impacted by throughput on your web site. Or you may want to see if web page response time effects the total number of orders processed - these are perfect use cases for a Line & Bar Chart.

The Line & Bar chart plots data across three axes:

  • the X axis represents time
  • the left Y axis represents the values for the Bar Charts
  • the right Y axis represents the values for the Line Charts

The chart allows you to define multiple line and bar queries, so it is highly recommended that the queries are aligned in terms of units and time periods.

Requirements

In order to use this chart, there are a few requirements:

  • You must provide at least 1 bar query and 1 time query
  • Each query must use the TIMESERIES clause, with the same bucket eg. TIMESERIES 1 day
  • If using the SINCE clause it is strongly recommended to be the same across all configured queries

A valid bar query for the chart could look like this: SELECT percentile(duration, 80) as 'Load' from PageView TIMESERIES 1 day since last week

A valid line query for the chart could look like this: SELECT count(*) as 'Views' from PageView where TIMESERIES 1 day since last week

To include multiple lines and/or bars in the chart, you can either:

  • define additional queries following the guidelines above
  • include a FACET clause in your query. Note that if you are faceting on the same attribute in both the line and the bar queries, you will need to alias one of those facets in order to avoid name collisions in the chart output.

Granular Timeseries Charts

Perform timeseries queries above the default 366 bucket allowance.

Overview

Use the Granular Timeseries Chart to see longer periods of data in high granularity above the default 366 allowance.

The Granular Timeseries Chart, supports Line, Area & Sparkline chart types.

Requirements

In order to use this chart, there are a few requirements:

  • Each query must use and end with the TIMESERIES clause, and also contain the bucket eg. TIMESERIES 1 second
  • Do not use SINCE or UNTIL clauses as they will automatically be determined based on the time range picker
  • If using the LIMIT clause, this should be placed before and not after the TIMESERIES clause
  • Be aware that with longer time ranges, the chart will need more time to load. Use of this chart is ideal for shorter ranges, such as 7 - 14 days.

A valid query for the chart could look like this: SELECT count(*) FROM Transaction FACET appName TIMESERIES 1 second


Multiline Compare Chart

Display multiple comparison periods in a single timeseries chart. Multi Line Compare chart screenshot

Multiline and Event Overlay Chart

Render events as markers on a line chart. Line and Event overlay screenshot

Area and Event Overlay Chart

Render events as markers on an area chart. Area and Event overlay screenshot

Scatter and Event Overlay Chart

Render events as markers on a scatter chart. Scatter and Event overlay screenshot

Radar Chart

Plot one or more groups of values over multiple variables, and compare them on a two-dimensional plane. Radar chart screenshot

Mapbox Widget

Plot any data that includes latitude and longitude onto an interactive map, leveraging the Mapbox API.

Overview

Mapbox screenshot

Supports multiple NRQL queries and custom markers

Requirements

In order to use this chart, there are a few requirements:

  • Requires a Map Box Access Token from https://account.mapbox.com/auth/signup/
  • Query should contain one alias with 'name:SOME_VALUE' which will be used as the marker name
  • Query should have a FACET for latitude and longitude, use precision to ensure the FACET does not round the number
    FACET string(lat, precision: 5) as 'lat', string(lng, precision: 5) as 'lng' 
    
  • Rotation can be set using the following alias with 'rotate:SOME_VALUE'
  • Example Query:
    FROM FlightData SELECT latest(flightNo) as 'name:Flight No', latest(track) as 'rotate:track', latest(departure), latest(destination) FACET string(lat, precision: 5) as 'lat', string(lng, precision: 5) as 'lng' SINCE 60 seconds ago LIMIT MAX
    

List View

Display query results in a list, with smart formatting options.

Overview

List view screenshot

List View displays NRQL-queried data in a list. The list items are rows returned by the query, and formatted using a template. Below are a list of additional features.

  • Coerce values to number, date and boolean types
  • Format numbers and dates
  • Convert between digital size types (bytes, kilobytes, ...)
  • Search bar to filter list to the searched text

Requirements

For full details on how to use and format results in this chart, read the Template String documentation.


Action Loader

Incorporate buttons into your dashboards, with configurable onClick actions.

Overview

Incorporate buttons into your dashboards, with configurable onClick actions.

Example w/ Stacked Nerdlet

Nerdlet Id: service-maps.home

URL State
{"entityGuid":"MTYwNjg2MnxBUE18QVBQTElDQVRJT058NjI2OTA3NjE"}

Enabling this Nerdpack

This pack of visualizations is available via the New Relic Catalog.

To enable it in your account, go to Add Data > Apps and Visualzations and search for "Labs Widget Pack". Click the icon and subscribe this to your accounts.

Once subscribed you can browse to Apps -> Custom Visualizations to add any of the widgets to a dashboard.

Manual Deployment

If you need to customize the widgets in this pack, you can fork the code base and follow the instructions on how to Customize a Nerdpack. If you have a change you feel everyone can benefit from, please submit a PR!

Support

This project is actively maintained by the New Relic Labs team. Connect with us directly by creating issues or asking questions in the discussions section of this repo.

We also encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.

New Relic has open-sourced this project, which is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT.

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 encouraged! If you open an enhancement request, we'll invite you to contribute the change 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].

Open source license

This project is distributed under the Apache 2 license.

nr-labs-widget-pack's People

Contributors

amit-y avatar aso1124 avatar kav91 avatar nr-opensource-bot avatar rudouglas avatar tirslo avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

nr-labs-widget-pack's Issues

Multi Line Compare facet linking/filtering

Summary

Ability to add key-value filters from other widgets that have facet linking enabled to the where clause of all nrql queries. For example, clicking a table option applies that key-value filter to this widget as a where clause.

Desired Behaviour

Any out of box widget facet linking/ general dashboard filtering should also apply to the multi line compare widget.

Possible Solution

Implement NerdletStateContext to add filters to queries.

Activity marker

Tracker for Bar & Line Chart and List View release announcement.

[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 2 0 11 0 13

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, and you should update your header with the suggested one below. 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 the latest code snippet found at https://github.com/newrelic/opensource-website/wiki/Open-Source-Category-Snippets#code-snippet-3 to file

โŒ readme-contains-forum-topic #

Doesn't contain a link to the appropriate forum.newrelic.com topic (README.md). New Relic recommends directly linking the your appropriate forum.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.

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-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.

โœ… 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.

โœ… 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. Did not find a file matching the specified patterns. All files passed this test.

โœ… 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.

[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 0 0 13 0 13

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.

โœ… 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. Did not find a file matching the specified patterns. All files passed this test.

โœ… 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.