New Relic is an observability platform built to help engineers create more perfect software. From monoliths to serverless, you can instrument everything, then analyze, troubleshoot, and optimize your entire software stack. All from one place.
New Relic uses API Key based authentication, a developer-friendly delegated access protocol. Quolum has already connected the necessary wires with New Relic. Using a sequence of click-throughs, your organization's administrator allows Quolum to make API calls to New Relic without getting access to passwords.
Step 1: Initiate a connection to New Relic
Click the Connect button from the Connections card. If you are not an admin, you can invite your organization's New Relic admin to make a connection to your New Relic organization account. When you click on the Connect button, the web browser will navigate to the New Relic login page.
Step 2: Log in to New Relic
Log in to New Relic using your organization's credentials. The exact login mechanism may depend on your New Relic plan, and the sign-in mechanism used. You may have corporate SSO such as Azure AD, GSuite, or Okta along with multi-factor authentication. Sometimes you may need to enter an API key and a token, the step by step details of which are detailed out in step 3. Once you have successfully logged-in, New Relic is going to ask you to grant access to Quolum.
Step 3: Finding New Relic API Key
Step 3.1: Click on profile on the left nav bar
As shown in the below image, click on your profile circle on the left nav bar. A Pop up will open. Click on the API Keys on the pop up.
Step 3.2: Click on Insights query keys on the right nav bar
As shown in the below image, click on the "Insights query keys" link. This will take you to the API Key details page as shown in Step 3.3.
Step 3.3: Finding API Key details
As shown in the below image, the "Account Id" will be visible on the right hand side top corner. Copy only the suffix after "Account". On the bottom right, clicking on show key, will display, the "Query Key". These are the 2 details that Quolum needs. These both needs to be inputted in the Connect Manager pop up as shown in Step 2.
Step 4: Back to Quolum
Once you have granted access to Quolum on New Relic's website, New Relic is going to send you back to Quolum's page in Step 1, where you started. The Connect button on the Connections card would now say Reconnect. Reconnect is used to reauthenticate under circumstances where the access has expired.
Under the hood
Using the API authentication protocol, Quolum now has delegated access to your New Relic Workspace. The Quolum server, running on Amazon AWS VPC, will be able to make API calls and retrieve feature-level utilization of projects, stories, and tasks. Later, this data is crunched and available for visualization on the Quolum dashboard.
Updated about 2 months ago