Strategies for Using Installation Keys

Follow

Regardless of the architecture, OverOps encrypts information visible in the Automated Root Cause (ARC) screen using 256-bit AES browser-level encryption. This encryption is done using an Installation Key. When first opening an OverOps account, a new Installation Key is created. While it is possible to have all events organized within a single Installation Key, there are circumstances in which separating events across multiple keys is a better approach. For example, it may be necessary to separate events in a Development (DEV) environment from events in Production (PROD).

One Key per Environment (Recommended)

In this scenario, a unique OverOps Installation Key is used for each environment of the software development lifecycle (SDLC). For example, if the team is working in four different environments:

 

environments.png

 

An Owner or an Admin user can create four corresponding Installation Keys for each of these environments in OverOps. A user with access to all four keys can switch between the keys from the drop-down menu at the top-left of the OverOps Dashboard.

Advantages

  • Events from unique environments are isolated from each other (i.e. “don’t show me QA errors mixed with PROD errors”)
  • You can create as many keys as needed
  • Permissions are granted for each key based on the environment.

Example:

  1. QA team can only view the QA and UAT keys
  2. Production Support Team can only see PROD key
  3. DEV team can see all the keys.

Disadvantages

  • OverOps Agents/Collectors in each environment must be installed and upgraded using the corresponding Installation Key. Metrics are not available across environments
  • Events are not synchronized across the keys. E.g.: If a harmless Logged Warning is marked as Hidden on the DEV key, it must also be flagged as Hidden on every other key.

Single Key

In some cases, it may be preferable to use a single Installation Key within which all OverOps events are visible. Using the previous example with the same four environments:

environments.png

Advantages

  • Simplicity - you use the same Installation Key all OverOps component installations and upgrades
  • Events are combined into a single Dashboard
  • Metrics for a de-duplicated event are aggregated across all environments.

Disadvantages

  • Visibility to events and information in the ARC screen, such as source code and variable state, cannot be granularly controlled by teams, (i.e., anyone with access to the Installation Key can view events for all four environments).
  • Metrics for a de-duplicated event are aggregated across all environments.

One Key per Application

In this approach, a unique OverOps Installation Key is used for each application or microservice.

For example, the team has the following applications:

Apps.png

 

According to this example, there would be three corresponding Installation Keys for each of these applications in OverOps. A user with access to all three keys can switch among the keys from the drop-down menu at the top-left of the OverOps Dashboard.

Advantages

  • Permissions can be granted for all environments based on application teams
  • Errors from unique applications are isolated (i.e. “don’t show me Billing errors mixed in with Accounts errors”)
  • Create as many keys as needed
  • Permissions granted for each key based on application.

Example:

  1. Billing team can only view the Billing and Accounts keys
  2. Inventory can only see Inventory key
  3. Director of Software Engineering can see all keys.

Disadvantages

  • Events from all environments are shown within the same key for that application
  • OverOps Agents/Collectors in each application must be installed and upgraded using the corresponding Installation Key
  • Metrics are not combined across applications
  • A user cannot be granted access to a single environment for a given application.

One Key for each Environment/Application

In this approach, a unique OverOps Installation Key is used for each environment in each application. For example, the team has the following applications and environments:

 

Apps_environments.png

There are be nine corresponding Installation Keys within OverOps for each of these applications and environments, (example: Billing - DEV). User permissions to multiple environments need to be added to each key individually. A user with access to multiple keys can switch among the keys from the drop-down menu at the top-left of the OverOps Dashboard.

Advantages

  • Granular permissions may be assigned based on exact applications and environments
  • Events from unique applications and environments are totally isolated, (i.e. “don’t show me Billing - QA errors mixed in with Accounts - PROD errors”)
  • Create as many keys as needed.

Disadvantages

  • May result in a multitude of installation keys
  • Events from unique applications and environments are isolated
  • OverOps Agents/Collectors in each application and environment must be installed and upgraded using the corresponding Installation Key
  • Metrics are not consolidated across applications and environments.
  • Events are not synchronized across keys. For example, if a harmless Logged Warning is marked as Hidden on the Billing - DEV key, it must also be flagged as Hidden on each other Billing application key.
2 out of 2 found this helpful

Comments

0 comments

Please sign in to leave a comment.