OpsLevel Logo
Product

Visibility

Catalog

Keep an automated record of truth

Integrations

Unify your entire tech stack

AI Engine

Restoring knowledge & generating insight

Standards

Scorecards

Measure and improve software health

Campaigns

Action on cross-cutting initiatives with ease

Checks

Get actionable insights

Developer Autonomy

Service Templates

Spin up new services within guardrails

Self-service Actions

Empower devs to do more on their own

Knowledge Center

Tap into API & Tech Docs in one single place

Featured Resource

Click-through Tour: OpsLevel Overview
Click-through Tour: OpsLevel Overview
Read more
Use Cases

Use cases

Improve Standards

Set and rollout best practices for your software

Drive Ownership

Build accountability and clarity into your catalog

Developer Experience

Free up your team to focus on high-impact work

Featured Resource

The Ultimate Guide to Microservices Versioning Best Practices
The Ultimate Guide to Microservices Versioning Best Practices
Read more
Customers
Our customers

We support leading engineering teams to deliver high-quality software, faster.

More customers
Hudl
Hudl goes from Rookie to MVP with OpsLevel
Read more
Hudl
Keller Williams
Keller Williams’ software catalog becomes a vital source of truth
Read more
Keller Williams
Duolingo
How Duolingo automates service creation and maintenance to tackle more impactful infra work
Read more
Duolingo
Resources
Our resources

Explore our library of helpful resources and learn what your team can do with OpsLevel.

All resources

Resource types

Blog

Resources, tips, and the latest in engineering insights

Guide

Practical resources to roll out new programs and features

Demo

Videos of our product and features

Events

Live and on-demand conversations

Interactive Demo

See OpsLevel in action

Pricing

Flexible and designed for your unique needs

Docs
Log In
Book a demo
Log In
Book a demo
No items found.
Share this
Table of contents
 link
 
Resources
Blog

Custom Event Checks: Easily integrate any data source with OpsLevel

Product
Standardization
Platform engineer
Developer
SRE
Checks
Custom Event Checks: Easily integrate any data source with OpsLevel
OpsLevel
|
December 13, 2024

Shifting to a microservice architecture comes with well-known benefits. Isolation between systems and teams means feature teams can iterate faster and the entire software engineering organization can scale with more efficiency and agility.

But these benefits also come with tradeoffs. Microservices bring increased operational complexity in the form of increased surface area and more diverse tech stacks.

For central platform or SRE teams, this increased diversity in technologies makes their work more challenging. Tracking, monitoring, and supporting a variety of services–ensuring their reliability–can start to feel like taking care of beloved (or idiosyncratic) pets instead of managing herds of cattle.

An example of tool sprawl in a software development organization
Tool sprawl contributes to every microservice becoming a snowflake, or 1 of 1.

Custom Event Checks: Intuitive Building Blocks

At OpsLevel, we’ve built our service ownership platform with microservices top of mind, so we’re ready to support teams no matter what technologies or tooling they need to integrate with. One way we make this possible is with a new framework called Custom Event Checks.

Like any check within our broader Service Maturity model, the goal is to evaluate services against your preferred standards or best practices. With Custom Event Checks (CECs), the data source for these checks can be nearly anything.

OpsLevel easily receives arbitrary JSON payloads from any source–homegrown systems, open-source tooling, or 3rd party vendors we don’t yet integrate with. The JSON data is then parsed, mapped to the corresponding services in your OpsLevel account, and evaluated against the relevant logic for determining whether a service has passed or failed that CEC.

Custom Event Checks: Under the hood

The magic of CECs is that they’re simultaneously all-purpose, powerful, and simple to create. To illustrate that, let’s take a look at the process from start to finish. For our example, imagine an SRE wants to incorporate Sentry issues into their evaluation of their company’s external-facing services.

The check writer can quickly create a CEC endpoint for Sentry in OpsLevel. Then they can write a check, based on jq, which will parse data extracted from Sentry’s API, map the JSON payload to services in OpsLevel, and evaluate the the payload data against any custom logic. For example, a check writer might look for any:

     
  • services with more than 10 unresolved issues
  •  
  • services with any issues impacting more than 100 users
  •  
  • services with more than 3 reoccurring (i.e. Regressions) issues

An individual check will only produce pass/fail results for one of the specific scenarios above, but CEC endpoints and payloads can be easily reused across multiple checks for capturing pass/fails results at different levels or thresholds.

An example of tool sprawl in a software development organization
Editing a custom event check that evaluates whether or not services have 10 or fewer unresolved Sentry issues.


CECs are designed so that check writing doesn’t need sophisticated knowledge of OpsLevel’s data model or API. All that’s required is familiarity with the payload’s schema and basic jq in order to parse out service identifiers and the success condition, as pictured above.

Lastly, processing of data actually kicks off when OpsLevel receives a JSON payload to the Sentry CEC endpoint. Often data will reach a CEC endpoint via a webhook triggered in an external system or tool, but any method–e.g. bash script, cron job, serverless function–that pushes JSON to OpsLevel will work.

Next Steps: % if check.failed %

Once a CEC is producing boolean results per service as intended, as a check writer, it’s time to consider what action you want service owners to take–particularly if their service is failing the check. Ideally you want to provide service owners with information on why that check failed and what changes they should make in order to pass the check.

To make the process easy for everyone, CECs include a customizable result message. The message supports the open-source template language Liquid, including a set of variables for accessing check state and data from the check payload. The result messages also supports markdown for making the message easy to read.

How will you use Custom Event Checks?

In order to make Service Ownership at scale achievable for service owners and platform teams, a central source of truth for information about your microservices is needed.

With OpsLevel and Custom Event Checks, building and automating that repository of service metadata and maturity is easier than ever. Ready to get started? Request your OpsLevel demo today.

More resources

Fast code, firm control: A leadership report on AI coding adoption
Blog
Fast code, firm control: A leadership report on AI coding adoption

AI is writing your code; are you ready?

Read more
March Product Updates
Blog
March Product Updates

Some of the big releases from the month of March.

Read more
How Generative AI Is Changing Software Development: Key Insights from the DORA Report
Blog
How Generative AI Is Changing Software Development: Key Insights from the DORA Report

Discover the key findings from the 2024 DORA Report on Generative AI in Software Development. Learn how OpsLevel’s AI-powered tools enhance productivity, improve code quality, and simplify documentation, while helping developers avoid common pitfalls of AI adoption.

Read more
Product
Software catalogMaturityIntegrationsSelf-serviceKnowledge CenterBook a meeting
Company
About usCareersContact usCustomersPartnersSecurity
Resources
DocsEventsBlogPricingDemoGuide to Internal Developer PortalsGuide to Production Readiness
Comparisons
OpsLevel vs BackstageOpsLevel vs CortexOpsLevel vs Atlassian CompassOpsLevel vs Port
Subscribe
Join our newsletter to stay up to date on features and releases.
By subscribing you agree to with our Privacy Policy and provide consent to receive updates from our company.
SOC 2AICPA SOC
© 2024 J/K Labs Inc. All rights reserved.
Terms of Use
Privacy Policy
Responsible Disclosure
By using this website, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Data Processing Agreement for more information.
Okay!