Summary

Add an icon & tagline for the NR1 VSCode Extension marketplace listing.

Desired Behavior

Let's use the standard New Relic logo from this page.

Possible Solution

Additional context

Summary

Before we start adding new features, let's verify that the approach Russ took when building the VSCode Extension is alright. Specifically, we want to find out if using child_process from node is okay.

Desired Behavior

Possible Solution

Talk to Jordi about doing a code review since he has built a VSCode Extension before.

Additional context

Address open source release checklist items under Request Security Review or Self Certify.

Summary

Is it possible to keep extension private until released into marketplace to share with internal users?

Desired Behavior

Possible Solution

Additional context

Summary

Research how to show the currently selected profile in VSCode workbench to make it more easily visible to user. If possible, implement the solution.

Desired Behavior

The profile the user has selected using the VsCode ext command: New Relic: Profiles Select Default should be clearly shown to them in the VsCode UI in the bottom information banner.

Currently it's far to the right, should we move closer to the left side? See Diagram.

Possible Solution

Add section to developer website promoting extension in set up your environment page.

Summary

One of the most requested features from user research interviews was autocompletion for imports, suggestions and inline documentation. We want to investigate how to include this with the VSCode extension.

Desired Behavior

• Users can see what's available in the NR1 package
• Users can get documentation about functions and components (params, props, etc) inline

Possible Solution

• Bundle a types file with the extension
• Create an open source NR1 types package for VSCode to use Automatic Type Acquisition

Summary

When viewing an extension in the VSCode marketplace, it has a tab called 'Changelog' with release notes. We want to understand how this tab gets populated.

Desired Behavior

Possible Solution

Additional context

To comply with our open source standards via the open source checklist, let's add an explorer's hub topic and link it in the README.

Will post something similar to what we do with the Nerdpacks which is grab some helpful bits from the README and treat it as an initial "press release" in a sense.

• Screenshot + Intro, what is it and why would you want to use it
• How to use it, install/setup
• Link to the repo

Example:
https://discuss.newrelic.com/t/announcing-a-new-relic-gatsby-site-theme/109814

Contact owner of this NRQL VSCode Extension - NRQL VSCode Extension

Determine if he's willing to apply an open source license to his extension so we can either fork it and build on, or at least be ok with including it our extension pack.

Tend to the Snyk task under Setup Repo in the Open Source Release Checklist. For the developer website, this required asking #security to add the repo to a config somewhere even thought the doc suggests it'll work automatically by being under the newrelic org.

To be more succinct with the name of the extension please change it to New Relic One.

It seems Power BI used to have a stats extension you could install to get more stats on your extension usage, but it's no longer available according to this GH issue filed with the MS Docs team. So I'm trying to determine what else can be used to get more stats on the usage of extensions in the VS Code Marketplace.

Also there an interest to use custom events in New Relic to get more detailed observability data from the use of the our New Relic One extension so I am also exploring that.

Integrate the docs search into the VSCode Extension.

Possible approaches:

1. Search command takes user to the search page and they type in search terms there.
2. User types in search term from VSCode and is taken to search page with query params.

Summary

This is to make it easy and intuitive to program with NerdPacks. Having each component available as a Snippet would lower the barrier to entry for new users getting started, as well as allowing seasoned users to code quicker, and discover new components while in VS Code

Possible Solution

I created a VSCode extension for this separately, so the majority of the work is done, it would just involve integrating them into this repo to adhere to the same conventions.
https://github.com/rudouglas/nerdpack-snippets

Interestingly, @tanben made his own VS Code ext. for a synthetics use case, and he was inquiring if we could add his functionality into our primary extension. We discussed a better approach would be to put this extension under an extension pack, so that all new relic extensions can be grouped together in the VsCode Marketplace and users can decided what extensions that need / want based on their use cases.

NPM registry and Github link to the workspace generator:

The Workspace generator helps to automated building workspaces for synthetics by quickly setting up a local version of a synthetics workspace.

https://www.npmjs.com/package/@tanben/generator-nrsynthetics-workspace
https://github.com/tanben/generator-nrsynthetics-workspace

Vs Code Ext

https://marketplace.visualstudio.com/items?itemName=BenedictoTan.step-line-generator
https://github.com/tanben/vsc-step-line-generator

NR Docs on Synthetics

https://docs.newrelic.com/docs/synthetics/synthetic-monitoring/getting-started/types-synthetic-monitors

Use Cases

1. line and step numbers are commonly used to help with troubleshooting, since synthetics stack traces doesn't line up with the line number in the UI. Having the line number in the last message before the exception is thrown helps maintainers pinpoint where the issue issue is.

2. step numbers are typically used for tracking different "step" within a testcase, for example a monitor for reservation/booking will have testcases and steps for each test cases, by tracking both we are able to identify which step in a test case is failing and how often and or how often a particular test case in the workflow is failing .

This allows us to build funnels like this:

and PDF reports likes this

3. . synthetics scripts gets really long almost 1k lines of code.

here's a sample query, goal is to identify which step in the GuestInformation testCase failed and how often the step fails, "step" number:FROM Metric select count(*) as 'calls', count(status) as 'Failed' where monitorId='xxxxxxxxxxxxxxxxxxxx' and status='Fail' facet testCase, message , step limit max since 1 hours ago

Summary

Work with Daniel to make sure language and screenshots are ready for release.

Desired Behavior

Possible Solution

Additional context

Audit current error handling and identify cases we might not be handling.

• User doesn't have any profiles added -> send user to developer center
• Standardize on how we display error messages
• What happens if I try to create a nerdpack without a name?

When running the extension on Windows, the paths to create a nerdpack are broken causing the extension to not work.

We'll want to create a very robust and useful Extesion listing page in the VS Marketplace, perhaps look at Splunks for inspiration

Add section to developer website promoting extension in NR1 CLI page

Ben has created a nerdpack debugger that he uses in VsCode and he was interested in contributing this feature to the project.

https://marketplace.visualstudio.com/items?itemName=TanBen.vsc-nr1-debugger-extpack

Description

There is a simple typo in the snippet. NerdgraphQuery needs to be NerdGraphQuery. Without this change the user has to figure out to manually correct the name.

Summary

We are going to develop the NR1 VS Code extension in the open so it's time to shift the prototype to this GitHub repo.

Desired Behavior

Code is located in this repo.
Old internal repo is archived.
Our teammates github users have proper repo access (can access this repo since it is private and can merge PRs).

We will be adding a page dedicated to vscode ext. on the site under Build apps section. This way we can link to it from blogs, emails, etc.

AC

• use an existing page template to handle page layout
• create a product video for using VsCode Ext and add to page
• explain the use of VScode and where to download it.
• Maybe create a cool icon or logo for the extension for CTA areas throughout the site.

In order to group our new relic extensions together in a pack, we need to create an extension pack.

Docs

https://code.visualstudio.com/api/references/extension-manifest#extension-packs

Examples

https://marketplace.visualstudio.com/items?itemName=johnpapa.angular-essentials
https://marketplace.visualstudio.com/items?itemName=bierner.react-native-ios-pack
https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-azureextensionpack

Hey there New Relic friends, nice extension you have here! We've featured your extension in the VS Code marketplace for this month and it looks like you could use an icon. 😄 ❤️

Summary

Get word out about the NR1 VSCode extension! John + Vi will primary be working on it with assistance from Cats Squad

• A Discuss Post (John + Vi)
• If the Developer blog is up by our launch, post it there (John + Vi)

Desired Behavior

Possible Solution

Additional context

Instead, this should be region aware.

Do a pass through of extension to find any lurking bugs.

The prototype code needs some cleanup & refactoring for it to be production code.

Specifics that have been discussed:

• Some renaming
• Removing "vs-code-test")
• Breaking up large functions
• Modifying approach to triggering CLI commands if we come across a better approach.

Summary

Not all CLI commands are supported in the prototype. The intention of this ticket is to add support for the remainder of commands that we'd like to support upon releasing the extension.

The list is going to be refined/added to, but here is the working list:

• Create launcher
• Create nerdlet
• Regenerate UUID
• List subscription(s)
• Developer docs (takes user to dev site)
• Add a profile
• Undeploy

Address open source release checklist items under Request Documentation Review.

Tend to the Open Source Release Checklist's call to setup generation of a THIRD_PARTY_NOTICES.md file and a third party manifest. We can consider referencing what was done for the developer website: newrelic/developer-website#424.

Request a boiler plate repo to be created for this new extension pack.
See opensource checklist 2.0

We want to standardize on a command naming convention so users can see all the commands for New Relic or the commands for a sub-category

The Open Source Release Checklist calls for us to "Implement a changelog (GitHug releases can handle this for you)". So far the opensource website and developer website are using github actions based on semantic commit messages. See newrelic/developer-website#411.

Summary

Create an owning account for extension in the VSCode marketplace.

##Acceptance Criteria

1. Determine who should be owners of the extension.
2. Determine who should be contributors of the extension.
3. Ensure all people have 365 account tiles added to their OKTA profiles with IT so they can access the VSC marketplace.
4. Provide account information to microsoft as that workflow is currently broken, so it's a manual process

Role types

https://docs.microsoft.com/en-us/visualstudio/extensibility/?view=vs-2019

Creator: The user can publish extensions, but cannot view or manage extensions published by other users.
Reader: The user can view extensions, but cannot publish or manage extensions.
Contributor: The user can publish and manage extensions, but cannot edit publisher settings or manage access.
Owner: The user can publish and manage extensions, edit publisher settings, and manage acces

To help users find the extension easier, let's add a link the the marketplace to download the extension in the developer center.

AC

0. Check if there are any security issues with linking out from the developer center.

1. Ad a link to the [marketplace download page]https://marketplace.visualstudio.com/items?itemName=new-relic.new-relic-extension-pack) is added to the developer center.

2. One thing to consider when linking to an external site from NR1 is that the Referer header could contain the entire URL, and those URLs contain a ton of data. To keep Microsoft from consuming our customer data, we’ll want to make sure the Referrer-Policy (oddly enough, they spelled ‘Referrer’ correctly here) is set properly. That probably looks like either Referrer-Policy: no-referrer or Referrer-Policy: origin

Add VSCode Extension to open source projects list on Open Source site.
the OSS project tag should be developer tool kit so it appears in that category on the site.

Instructions

Steps to Reproduce

This was noticed in a user research session. We are not able to reproduce this ourselves just yet. There is a recording o fthe user research session that is likely to be helpful in better understanding whether this is a bug or not. Daniel should have the video.

This happens when a user runs the select profile command but exits out of it without selecting a profile.

Expected Behavior

We should be able to change the cli profile via the code extension.

Summary

When viewing an extension in the marketplace, there is a tab in the listing called 'Feature Contributions' that outlines what the extension provides. We would like to understand how this tab gets populated

Desired Behavior

Possible Solution

Additional context

Summary

Get word out about the NR1 VSCode extension!

• A Nerdlife Post

Desired Behavior

Possible Solution

Additional context

Description

Y'all are too awesome. Can't believe you got this out so fast!

Steps to Reproduce

Your awesomeness is not reproducible.

Expected Behavior

Wasn't expecting such a rad vs code extension so fast.

Relevant Logs / Console output

ERROR: TOTALLY DOP

Your Environment

Full of wonder and awe

Additional context

I'm impressed. Congrats!

Move tracking of issues from JIRA into GitHub.

AC

• Create new story board
• Create milestone
• Create labels