Skip to content
Permalink
Browse files

Updated with minor formatting and placeholder directories

  • Loading branch information
devfreddy committed Sep 6, 2019
1 parent 248cf6f commit 2d2f95f05e9f4431330a931746db19783469edb9
Showing with 94 additions and 12 deletions.
  1. +39 −0 .github/bug_report.md
  2. +27 −0 .github/enhancement.md
  3. +28 −12 README.md
  4. 0 examples/.gitkeep
  5. 0 screenshots/.gitkeep
@@ -0,0 +1,39 @@
---
name: Bug report
about: Describe a scenario in which this project behaves unexpectedly
title: ''
labels: bug, needs-triage
assignees: ''

---

[NOTE]: # ( ^^ Provide a general summary of the issue in the title above. ^^ )

## Description

[NOTE]: # ( Describe the problem you're encountering. )
[TIP]: # ( Do NOT give us access or passwords to your New Relic account or API keys! )

## Steps to Reproduce

[NOTE]: # ( Please be as specific as possible. )

## Expected Behaviour

[NOTE]: # ( Tell us what you expected to happen. )

## Relevant Logs / Console output

[NOTE]: # ( Please provide specifics of the local error logs, Browser Dev Tools console, etc. if appropriate and possible. )

## Your Environment

[TIP]: # ( Include as many relevant details about your environment as possible. )

* NR1 CLI version used:
* Browser name and version:
* Operating System and version:

## Additional context

[TIP]: # ( Add any other context about the problem here. )
@@ -0,0 +1,27 @@
---
name: Enhancement request
about: Suggest an idea for a future version of this project
title: ''
labels: enhancement, needs-triage
assignees: ''

---

[NOTE]: # ( ^^ Provide a general summary of the request in the title above. ^^ )

## Summary

[NOTE]: # ( Provide a brief overview of what the new feature is all about. )

## Desired Behaviour

[NOTE]: # ( Tell us how the new feature should work. Be specific. )
[TIP]: # ( Do NOT give us access or passwords to your New Relic account or API keys! )

## Possible Solution

[NOTE]: # ( Not required. Suggest how to implement the addition or change. )

## Additional context

[TIP]: # ( Why does this feature matter to you? What unique circumstances do you have? )
@@ -1,6 +1,7 @@
# Datalyzer

## Usage

The Datalyzer enables a user to explore, slice and dice Event and Metric
data in NRDB in a simple, fast and intuitive way.

@@ -21,44 +22,59 @@ This project is distributed under the [Apache 2 license](blob/master/LICENSE).

A New Relic account with some data in it.

**Note**: When you select _Metrics_ (as opposed to _Events_), Datalyzer
**Note**: When you select _Metrics_ (as opposed to _Events_), Datalyzer
allows you to explore dimensional metric data that was introduced by New Relic
in September, 2019, and is supported by products such as the New Relic
[Prometheus OpenMetrics Integration](#). Traditional (nondimensional) metrics
[Prometheus OpenMetrics Integration](#). Traditional (nondimensional) metrics
collected by older New Relic products are not currently supported.

## Getting started

Clone this repository and run the following scripts:

```bash
git clone https://github.com/newrelic/nr1-datalyzer
git clone https://github.com/newrelic/nr1-datalyzer.git
cd nr1-datalyzer
npm install
npm start
```

Visit https://one.newrelic.com/?nerdpacks=local, navigate to the Datalyzer, and :sparkles:
Visit [https://one.newrelic.com/?nerdpacks=local](https://one.newrelic.com/?nerdpacks=local), navigate to the Nerdpack, and :sparkles:

## Deploying this Nerdpack

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

```bash
# this is 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, run 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](https://one.newrelic.com), navigate to the Nerdpack, and :sparkles:
# Support
## Support
New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR SUPPORT, although you can report issues and contribute to the project here on GitHub.
_Please do not report issues with this software to New Relic Global Technical Support._
## Community
### Community
New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorer's Hub. You can find this project's topic/threads here:
https://discuss.newrelic.com/c/build-on-new-relic/nr1-datalyzer
[https://discuss.newrelic.com/c/build-on-new-relic/nr1-datalyzer](https://discuss.newrelic.com/c/build-on-new-relic/nr1-datalyzer)
*(Note: URL subject to change before GA)*
## Issues / Enhancement Requests
### Issues / Enhancement Requests
Issues and enhancement requests can be submitted in the [Issues tab of this repository](issues). Please search for and review the existing open issues before submitting a new issue.
Issues and enhancement requests can be submitted in the [Issues tab of this repository](../../issues). Please search for and review the existing open issues before submitting a new issue.
# Contributing
## Contributing
Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself :grin:). Please review our [Contributors Guide](blob/master/CONTRIBUTING.md).
Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself :grin:). Please review our [Contributors Guide](CONTRIBUTING.md).
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 opensource@newrelic.com.
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 opensource@newrelic.com.
No changes.
No changes.

0 comments on commit 2d2f95f

Please sign in to comment.
You can’t perform that action at this time.