Rubrics and Component Maturity

Introduction

Rubrics let you define what a mature components looks like for your organization. They give you the ability to evaluate your components and measure their adherence to your preferred best practices. Rubrics can be used to drive production readiness and promote operational excellence in a variety of specific ways:

1. Increase the overall maturity of your entire microservices architecture
2. Increase security and reliability
3. Ensure consistency across your components
4. Enforce quality standards within your organization

Similar to how rubrics are used in schools to evaluate students’ assignments based on a set of predetermined criteria, your rubric in OpsLevel allows you to measure your component's maturity level based on customizable checks.

Categories, Levels, and Checks

In the above example image, each component has a corresponding level assigned to it. This level represents the overall grade / current maturity of that component.

But how is this level calculated? To understand that, we first need to setup our Rubric which can be found under the Component Maturity tab in the main menu.

The above is an example of a rubric that does not yet contain any checks. In this rubric, we can see that levels are represented as columns and categories as rows.

Each level is broken down into categories of checks, which must all be passed before the level is achieved. Categories organize component maturity into different subdomains (for example, security or reliability) and let you group related checks together. Categories and levels are fully customizable. See the Categories and Levels documentation for additional information.

Checks added to individual cells inside the rubric then correspond to that category and level.

If a component passes all of the checks in a level, then the service “passes” that level. For example, if a component passed all of the checks in the Bronze column, then it is considered a Bronze component. If a component passes all of the checks in the Silver column, in addition to the checks in the Bronze column, then it would be a Silver component. To learn more about how components are graded, check out the Maturity Report documentation.

Getting Started

When your OpsLevel account is created, you will start out with a simple out-of-the-box rubric containing levels and categories that can be customized. To start seeing rubrics in action, you can start by adding a check to your rubric. Checks can be added to the rubric by simply clicking the ‘Add Check’ button inside of the cell corresponding to the level and category you want the check to apply to.

Create a check

Let’s create a check to verify that every component has an owner. This check could fall under the Component Ownership category since it will help engineers quickly determine who owns what during an incident. This check is a basic requirement for all components so it should be in the Bronze level.

After clicking ‘Add Check’, we will select ‘Component Ownership’ for the check type which will verify whether or not our components have an owner defined. Make sure that the check is enabled by selecting the toggle and then hit create. To learn more about checks, you can view our Checks documentation.

Verify component levels

Now, head over to the Components page. You should now see that your components have levels assigned to them in the components table.

Components which have an owner defined pass our check and therefore meet all the conditions for passing the Bronze level (because there are no Silver or Gold checks, these components will be assigned as Gold). Components without an owner receive the ‘Beginner’ level, which is the level assigned to components not passing the lowest level of Bronze.

Review check results per component

Each component also has a Maturity Report tab which will give you a complete breakdown of which checks are passing or failing as well as the maturity of each category. You can learn more about the Maturity Report and how components are graded here.

For a more detailed report of how all your components are performing, check out the Maturity Report.

You can now start adding more checks or customizing your rubric to fit the concerns or objectives of your organization.

For more advanced control over which checks will be evaluated against specific components, please refer to our documentation on Filters.