MKP Tenant Portal

The MKP tenant portal, which is the My Kentik Portal that will be seen by the users of a given tenant, is covered in the following topics:

Note: For information on the management of your organization's My Kentik Portal in the Kentik portal, see My Kentik Portal.

An example of the My Kentik Portal as displayed to a tenant user.
 

Tenant Portal Access

The specific elements included in your organization's MKP portal vary depending on the settings for each tenant. To see the MKP portal as it will be presented to a given tenant, do one of the following:

  • Click the View v4 Tenant Portal button (users icon) at the right of that tenant's row in the Tenants List (on the Tenants tab of the My Kentik Portal page). At this point you'll be taken to the tenant MKP portal, to which you'll be signed on as if you are the tenant (“spoofing”).
  • Log into the tenant portal directly.:
    - The domain to log onto for your MKP tenant portal can be found on the Domain tab of the MKP Settings page (see MKP Domain Settings).
    - If you're not already a registered user for the tenant whose MKP portal you'd like to access, see MKP User Activation.

Note: To “unspoof” you must click on the user menu at the right of the navbar and choose Exit Tenant View from the drop-down menu (see screenshot at right). When you unspoof you are taken to your Kentik portal landing page (Network Explorer).

 

Tenant Portal Page

The main page of the MKP tenant portal contains the following UI elements:

  • Library: A tab that shows tenant users a Library similar to the Library in the Kentik portal. The page displays a categorized set of cards that each represent a view (Dashboard or Saved View) that has been assigned to this tenant, either directly or via a package (see Tenant View Settings). To access a given view, click on the corresponding card.
  • Traffic Explorer: A tab that shows tenant users a subset of the information that Kentik portal users see on the Traffic tab of Network Explorer.
    Note: This tab is visible only to Kentik users who access the MKP tenant portal via the View v4 Tenant Portal button, but not to tenant users who sign into the tenant portal directly.
  • Alerting indicators: If any alert policies have been assigned to this tenant, either directly (see Tenant Policy Settings) or via a package (see Package Policy Settings), then the main page of the tenant portal will include an Alerting pane at the upper right, which will include these indicators:
    - Alarms: Shows a count of alerts that are in ALARM state, meaning that conditions defined in the alert policy have been met and notifications have been triggered. Click on the indicator to go to the Tenant Alerting Page.
    - Mitigations: Shows a count of currently in-progress mitigations. Click on the indicator to go to the Tenant Mitigations Page.
 

Tenant Alerting Page

The Alerting page in the MKP tenant portal is covered in the following topics:

The Alerting page tells MKP tenant portal users about active or historical traffic anomalies.
 
top  |  section

Tenant Alerting UI

The Alerting page in a tenant's MKP portal provides information about alarms generated by the alert policies that have been assigned to a given tenant, either directly (see Tenant Policy Settings) or via a package (see Package Policy Settings). The page includes the following UI elements:

  • Configure Notifications: A button that takes you to the Tenant Notifications Page.
    Note: Visible only to tenants, not to tenant users.
  • Group By: Choose a property (e.g. severity) from the drop-down menu to group the alarms in the Alarms List by the value of that property. The table supports grouping by alert policy, severity, key, and status.
  • Active Mitigations: Indicates the number of mitigations currently underway involving traffic related to this tenant. Click the Active Mitigations link to go to the Tenant Mitigations Page.
  • Filters pane: Set filters to narrow the alarms listed in the Alarms List (see Alarms List Filters).
  • Alarms List: A table listing the alarms generated by the alert policies assigned to the tenant (see Tenant Alarms List).
 
top  |  section

Tenant Alarms List

The Alarms List on the tenant Alerting page is a table providing information about alarms generated by the alert policies assigned to the tenant. Each row in the table represents an individual alarm. The table includes the following columns:

  • Severity: The severity value (Critical, Severe, Major, Warning, Minor, or Notice) of the alert policy threshold that generated the alarm.
  • State: A label corresponding to the current state of the alarm, either Alarm, ACK required, or Cleared (see Alert Status).
  • Alert Policy: The name of the alert policy, assigned to the tenant either directly or via a package, containing the threshold that generated the alarm.
  • Key: A unique combination of values for a given set of dimensions (see About Keys). An alarm is generated when the dimensions in that alarm's key definition match values (absolute or relative to a baseline) specified in a threshold.
  • Value: The dimension value that caused an alarm to be generated.
  • Time: The date-time at which the alarm was generated.

Notes:
- The list is filtered by the Alarms List Filters.
- To see further details about an individual alarm, click the alarm's row to open an inline Alarm Details Card.

 
top  |  section

Alarms List Filters

The filters in this pane determine which alarms are listed in the Tenant Alarms List:

  • Show Historical:
    - If on, the list will include alarms that have been resolved (state = Cleared).
    - If off (default), the list will show only the most recent instance of each unresolved alarm (state = Alarm or Ack Required).
  • Time Range (only if Show Historical is on): A set of radio buttons that determines how old the alarms in the list can be.
  • Alert Policy Status: These checkboxes enable you to narrow the list only to alarms whose current state matches the following:
    - Alarm: Show alarms that haven't yet been cleared or acknowledged.
    - Ack Required: Show alarms whose policy requires that they be acknowledged before being cleared.
    - Cleared (shown only when Show Historical switch is on): Show alarms that have been cleared.
  • Severity: Use the checkboxes to include or exclude alarms whose severity is Critical, Severe, Major, Warning, Minor, or Notice.
  • Clear all (appears only when you've specified one or more filters): Click to clear all current filters.
 
top  |  section

Alarm Details Card

The details card for a given alarm opens when the row for that alarm is clicked in the Alarms List, expanding the alarm's row to show the following additional information:

  • Alert Policy: The name of the policy whose threshold generated the alarm.
  • View Details: A button that takes you to an Alarm Details page where you can see additional details about the insight. The details provided on the page will be the same as the information provided on a details page for custom insights in the main Kentik portal (see Insight Details Page).
  • Traffic Chart: A time series chart showing what caused the alarm, for example traffic volume that exceeded a percent of baseline that was specified in the alert policy's threshold.
  • Alarm ID: A Kentik-generated unique reference for the alarm.
  • Dimensions: Name-value pairs for each of the dimensions in the alarm's key (see About Keys). An alarm is generated when the values of dimensions in the key match values (absolute or relative to a baseline) specified in the alert policy threshold.
An expanded row in the Alarms List shows additional details about an individual alarm.
 

Tenant Mitigations Page

The Mitigations page in the MKP tenant portal is covered in the following topics:

 
top  |  section

Tenant Mitigations UI

The Mitigations page in a tenant's MKP portal provides information about mitigations currently underway involving traffic related to this tenant. The page includes the following UI elements:

 
top  |  section

Tenant Mitigations List

The Mitigations List on the tenant Mitigations page is a table providing information about mitigations triggered by the alert policies assigned to the tenant. Each row in the table represents an individual mitigation. The table includes the following columns:

  • State: Two icons representing mitigation states (see Mitigation Status):
    - The current state of the mitigation.
    - The state that the mitigation will be in next.
  • Triggered By: The alert policy that triggered the mitigation.
  • Mitigation: The following information about the mitigation:
    - ID: The Kentik-generated unique ID for the mitigation.
    - Alarm: The Kentik-generated unique ID for the alarm that triggered the mitigation.
    - Method: The mitigation method associated with this mitigation (see Mitigation Platforms and Methods).
    - Platform: The mitigation platform associated with this mitigation.
  • Target / Dimensions: The specific instances of the dimension that the mitigation method used to identify which traffic to mitigate.
  • Date (UTC): The date-time at which the mitigation began.
  • Actions: Depending on the current state of the mitigation this column may contain a Stop icon (). Click it to stop an in-progress mitigation.
    Note: Kentik-registered users of MKP (landlords) can perform additional mitigation actions beyond those available to tenants or tenant users.

Notes:
- The list is filtered by the Mitigations List Filters.
- To see further details about an individual alarm, click the alarm's row to open a Mitigation Details Pane that slides out from the right of the page.

 
top  |  section

Mitigations List Filters

The mitigations displayed in the Mitigations List can be filtered using the controls in the filtering pane on the right. The pane includes the following filters:

  • Show Historical:
    - If on, the list will include past mitigations that have been archived.
    - If off (default), the list will show only currently active mitigations.
  • Time Range (only if Show Historical is on): A set of radio buttons that determines how old the mitigations in the list can be.
  • Clear all (appears only when you've specified one or more filters): Click to clear all current filters.
  • Mitigation ID: Include only mitigations whose ID equals or contains the entered numbers.
  • Alarm ID: Include only mitigations for which the ID of the triggering alarm equals or contains the entered numbers.
  • Policy: Include only mitigations for which the name of the triggering alert policy equals or contains the entered string.
  • Target: Include only mitigations for which the entered text matches specific instances of the dimension that the mitigation method used to identify which traffic to mitigate.
  • Dimension: Include only mitigations for which the entered text matches the dimension that the mitigation method used to identify which traffic to mitigate.
  • Exact: A switch that determines whether the string entered in the Dimension field is matched strictly or loosely.
 
top  |  section

Mitigation Details Pane

The details pane for a given mitigation slides out from the right of the page when the row for that mitigation is clicked in the Mitigations List, showing the following additional information:

  • Mitigation ID: The Kentik-generated unique ID for the mitigation.
  • Policy: The alert policy that triggered the mitigation.
  • Alarm: The Kentik-generated unique ID for the alarm that triggered the mitigation.
  • View Insight: Takes you to the Insight Details Page for the alert policy (a.k.a. custom insight) that triggered this mitigation.
  • Method: The mitigation method associated with this mitigation (see Mitigation Platforms and Methods).
  • Platform: The mitigation platform associated with this mitigation.
  • Target / Dimensions: The specific instances of the dimension that the mitigation method used to identify which traffic to mitigate.
  • Event list: A table listing, in chronological order, events involving the mitigation:
    - State: The mitigation state at the time of the event.
    - Event: The event.
    - Date (UTC): The date-time of the event.
 

Tenant Notifications Page

Tenant notifications, which allow My Kentik Portal tenants to set up alerts for tenant users, are covered in the following topics:

 
top  |  section

About Tenant Notifications

Tenant notifications are alert notifications in response to network traffic conditions that meet the criteria defined in one of the policy thresholds defined in Tenant Policy Settings. Tenant notifications are available to a tenant when the Enable Notifications switch is on in the individual threshold settings for an alert policy that is assigned to that tenant (either directly or as part of a package). While this switch enables the tenant to set up notifications, the notification settings themselves are accessed from within the tenant MKP portal.

Notifications enable you to define channels via which your MKP portal can communicate with users.
 
top  |  section

Tenant Notifications Access

To access the notification settings in the MKP tenant portal:

  1. Go to the MKP portal for a given tenant by clicking the View v4 Tenant Portal button (users icon) in the Tenants List.
  2. Click the Configure Notifications button in the Tenant Alerting UI, which takes you to the Tenant Notifications page.
 
top  |  section

Tenant Notifications UI

The Tenant Notifications page is used to manage the notification channels used by a given tenant. The page includes the following UI elements:

  • Filter field: Narrows the notification channels shown in the Channels List to those whose Name or Type column contains the entered text.
  • Add Notification: A button that opens the Add Notification dialog.
  • Channels List: A table listing the tenant's collection of notification channels (see Tenant Channels List).
  • Filters pane: A set of checkboxes that, when checked, filter the channels listed in the Channels List. The checkboxes fall into the following categories:
    - Status: Enabled or disabled.
    - Type: The type of the channel (e.g. email, Custom Webhook, OpsGenie, PagerDuty, ServiceNow, or syslog). A type only appears in the Filters pane if there's an existing channel of that type.
 
top  |  section

Tenant Channels List

The Channels List is a table that lists the notification channels set up in this tenant. The list includes the following columns:

  • Name: The name assigned to the channel in the channel settings dialog (Add Notification or Edit Notification).
  • Type: The type of the channel. Supported types include email, Custom Webhook, OpsGenie, PagerDuty, ServiceNow, and syslog.
  • Status: Indicates whether the channel is currently enabled or disabled.
  • Edit: Opens the Edit notification dialog, enabling you to change the channel settings.
  • Remove button (trash icon): Remove the notification channel from the tenant's collection of channels.
 
top  |  section

Tenant Channel Settings

The settings of an individual notification channel are made in a channel settings dialog (Add Notification or Edit Notification). The fields and controls of the dialog are the same as those of the dialog used to add or edit notification channels in the main Kentik portal (see Notification Dialogs UI).

 

Tenant User Profile

The User Profile in the MKP tenant portal is covered in the following topics:

The User Profile enables users to manage their experience in the tenant portal.
 
top  |  section

About the Tenant Profile

Like the main Kentik portal, the MKP tenant portal includes a User Profile that covers information and settings related to the individual user. To access the User Profile, click the User icon at the far right of the main navbar, then choose Profile from the drop-down menu. Once you're at the Profile, you'll see three tabs across the top, each of which corresponds to a set of user-specific settings that do not affect other users in this tenant.

 
top  |  section

Tenant Profile General Settings

The General tab includes the User Information pane and the Defaults pane.

User Information Pane

This pane displays basic information specific to the individual user (editable where indicated):

  • Role (read-only field): Administrator or Member (see About Users).
  • Full name (editable field): The user's full name as specified when the user was added or last edited.
  • Email (editable field): The email address specified when the user was added or last edited.
  • Update User Information (button): Saves any changes made to user information.

Defaults Pane

This pane displays the following setting:

  • Time zone (radio buttons): The time zone in which times are expressed, either UTC or local.
 
top  |  section

Tenant Profile Authentication Settings

The Authentication tab contains User Profile settings that support user authentication. For details on these settings, refer to Two-factor Authentication.

 
top  |  section

Tenant Profile Visualizations Settings

The Visualizations tab contains settings that enable you to customize the appearance of the MKP tenant portal for an individual user. For details on these settings, refer to Visualizations Settings.

© 2014- Kentik
In this article:
×