Skip to content

Commit

Permalink
Superwise doc revisions
Browse files Browse the repository at this point in the history
I've added some steps and changed some wording in each step to align with the most recent updates
  • Loading branch information
iazam6 committed Dec 9, 2021
1 parent 054298b commit a649eba
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ Superwise’s KPI and incidents integration streamlines results of our out-of-th
In order to receive data from Superwise into New Relic, you’ll need to do the following:
1. **Login into your New Relic account:** Log into **[one.newrelic.com](https://one.newrelic.com)** and click on **Explorer**. On the upper hand corner, on the main navigation menu, click on **+ Add more data**.

2. **Click on Superwise:** In the search bar, type **Superwise** or scroll down to the MLOps Integration section, then click on the **Superwise icon**.
2. **Click on Superwise:** In the search bar, type **Superwise** or scroll down to the MLOps Integration section, then click on the **Superwise** icon.

3. **Select an account ID:** Select the account ID you want Superwise to integrate with.

4. **Create two access tokens:**
* Once you select an Account ID, under **Prediction data + Generate Dashboard**, click **Create a key**. This is your new **telemetry API key**.
* In addition, under **Model quality metric**, click **Create a Key**. This is your **Incident Insights key**. Keep the New Relic page open for future steps.
* Once you select an Account ID, you'll see the New Relic Integration screen. Under **Model Metrics Data**, click **Create a key**. This is your new **telemetry API key**.
* In addition, optionally, you can copy the auth token under **Incident Insights**. Keep the New Relic page open for future steps.

![Create access tokens.](./images/superwise01.png "Create access tokens")

5. **Log into the Superwise portal:** Log into the Superwise portal and go to **Notification channel settings**. Select **New Relic** and create a channel name.
5. **Log into the Superwise portal:** Now log into the Superwise portal and go to **Notification channel settings**. Select **New Relic** and create a channel name.

6. **Copy and paste the token in Superwise:** Go back to the New Relic integration dashboard and copy the two tokens you created by clicking on the **copy** icon next to the **API key** and **Insight key**. On Superwise’s portal, on the **New Relic** channel, paste the **API key** under **Incident Intelligence API**, and the **Insight key** under **Telemetry Key**. Finish by clicking **Save**.
6. **Copy and paste the key and token in Superwise:** Go back to the New Relic integration dashboard and copy the key and optional token you created by clicking on the **copy** icons. On Superwise’s portal, on the **New Relic** channel, paste the **API key** under **Model Metrics Data**, and the **Auth token** under **Incidents**. Finish by clicking **Save**.

7. **Verify the Token:** Click on the **Test** button in the Superwise channel portal, to verify both tokens are working properly. A **green** or **red** status box should appear to indicate the verification.

Expand All @@ -42,7 +42,7 @@ Once a user configures the New Relic integration in Superwise, standard model me

1. **Go to the integration dashboard:** Once you’ve tested your tokens and confirmed the integration is set up correctly, return to the New Relic integration dashboard and click on **See your data**. This will redirect you to an automatically generated dashboard powered by Superwise.

2. **Analyze Superwise’s dashboard.** Superwise’s dashboard contains 3 charts:
2. **Analyze Superwise’s dashboard.** Superwise’s dashboard in New Relic contains 3 charts:
* The **Model activity** chart displays the number of active models, their activity, and the total number of predictions during a filtered timeframe.
* The **Model input drift** detection chart displays which models are drifting and may require retraining using a model drift leveler, scaled between 0 and 100.
* The **Incident Insights** chart displays how many models have open incidents, how incidents are being distributed, and deeper details on the model incident itself.
Expand Down

0 comments on commit a649eba

Please sign in to comment.